Class BcsTuple<T, Name>

Type Parameters

const T extends readonly BcsType<any>[]
const Name extends string = `(${JoinString<
{ [K in keyof T]: T[K] extends BcsType<any, any, infer T> ? T : never },
", ",
>})`

Hierarchy (View Summary)

BcsType<
    {
        -readonly [K in keyof T]: T[K] extends BcsType<infer T, any>
            ? T
            : never
    },
    { [K in keyof T]: T[K] extends BcsType<any, infer T> ? T : never },
    Name,
>
- BcsTuple

Index

Constructors

constructor

new BcsTuple<
    const T extends readonly BcsType<any, any, string>[],
    const Name extends
        string = `(${JoinString<
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<any, any, T> ? T : never
        },
        ", ",
    >})`,
>(
    __namedParameters: BcsTupleOptions<T, Name>,
): BcsTuple<T, Name>
Type Parameters
- const T extends readonly BcsType<any, any, string>[]
- const Name extends string = `(${JoinString<
      {
          [K in string
          | number
          | symbol]: T[K] extends BcsType<any, any, T> ? T : never
      },
      ", ",
  >})`
Parameters
- __namedParameters: BcsTupleOptions<T, Name>
Returns BcsTuple<T, Name>
Overrides BcsType.constructor
- Defined in packages/bcs/dist/bcs-type.d.mts:134

Properties

_codec

_codec: {
    kind?: string;
    read: () => {
        -readonly [K in string
        | number
        | symbol]: T[K] extends BcsType<T, any, string> ? T : never
    };
    write: (
        value: {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        },
    ) => void;
}

$inferInput

$inferInput: {
    [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
        ? T
        : never
}

$inferType

$inferType: {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}

name

name: Name

serializedSize

serializedSize: (
    value: {
        [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
            ? T
            : never
    },
    options?: BcsWriterOptions,
) => number | null

toBytes

toBytes: (
    value: {
        [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
            ? T
            : never
    },
    options?: BcsWriterOptions,
) => Uint8Array<ArrayBuffer>

validate

validate: (
    value: {
        [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
            ? T
            : never
    },
) => void

Methods

fromBase58

fromBase58(
    b58: string,
): {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Parameters
- b58: string
Returns {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Inherited from BcsType.fromBase58
- Defined in packages/bcs/dist/bcs-type.d.mts:39

fromBase64

fromBase64(
    b64: string,
): {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Parameters
- b64: string
Returns {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Inherited from BcsType.fromBase64
- Defined in packages/bcs/dist/bcs-type.d.mts:40

fromHex

fromHex(
    hex: string,
): {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Parameters
- hex: string
Returns {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Inherited from BcsType.fromHex
- Defined in packages/bcs/dist/bcs-type.d.mts:38

parse

parse(
    bytes: Uint8Array,
): {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Parameters
- bytes: Uint8Array
Returns {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Inherited from BcsType.parse
- Defined in packages/bcs/dist/bcs-type.d.mts:35

read

read(
    reader: BcsReader,
): {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Parameters
- reader: BcsReader
Returns {
    -readonly [K in string | number | symbol]: T[K] extends BcsType<
        T,
        any,
        string,
    >
        ? T
        : never
}
Deprecated
Use parse instead.
Inherited from BcsType.read
- Defined in packages/bcs/dist/bcs-type.d.mts:34

serialize

serialize(
    value: {
        [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
            ? T
            : never
    },
    options?: BcsWriterOptions,
): SerializedBcs<
    {
        -readonly [K in string
        | number
        | symbol]: T[K] extends BcsType<T, any, string> ? T : never
    },
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<any, T, string> ? T : never
    },
>
Parameters
- value: {
      [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
          ? T
          : never
  }
- Optionaloptions: BcsWriterOptions
Returns SerializedBcs<
    {
        -readonly [K in string
        | number
        | symbol]: T[K] extends BcsType<T, any, string> ? T : never
    },
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<any, T, string> ? T : never
    },
>
Inherited from BcsType.serialize
- Defined in packages/bcs/dist/bcs-type.d.mts:41

toBase58

toBase58(
    value: {
        [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
            ? T
            : never
    },
): string
Parameters
- value: {
      [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
          ? T
          : never
  }
Returns string
Inherited from BcsType.toBase58
- Defined in packages/bcs/dist/bcs-type.d.mts:44

toBase64

toBase64(
    value: {
        [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
            ? T
            : never
    },
): string
Parameters
- value: {
      [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
          ? T
          : never
  }
Returns string
Inherited from BcsType.toBase64
- Defined in packages/bcs/dist/bcs-type.d.mts:43

toHex

toHex(
    value: {
        [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
            ? T
            : never
    },
): string
Parameters
- value: {
      [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
          ? T
          : never
  }
Returns string
Inherited from BcsType.toHex
- Defined in packages/bcs/dist/bcs-type.d.mts:42

transform

transform<
    T2 = {
        -readonly [K in string
        | number
        | symbol]: T[K] extends BcsType<T, any, string> ? T : never
    },
    Input2 = {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<any, T, string> ? T : never
    },
    NewName extends string = Name,
>(
    __namedParameters: {
        input?: (
            val: Input2,
        ) => {
            [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
                ? T
                : never
        };
        output?: (
            value: {
                -readonly [K in string | number | symbol]: T[K] extends BcsType<
                    T,
                    any,
                    string,
                >
                    ? T
                    : never
            },
        ) => T2;
    } & BcsTypeOptions<T2, Input2, NewName>,
): BcsType<T2, Input2, NewName>
Type Parameters
- T2 = {
      -readonly [K in string | number | symbol]: T[K] extends BcsType<
          T,
          any,
          string,
      >
          ? T
          : never
  }
- Input2 = {
      [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
          ? T
          : never
  }
- NewName extends string = Name
Parameters
- __namedParameters: {
      input?: (
          val: Input2,
      ) => {
          [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
              ? T
              : never
      };
      output?: (
          value: {
              -readonly [K in string | number | symbol]: T[K] extends BcsType<
                  T,
                  any,
                  string,
              >
                  ? T
                  : never
          },
      ) => T2;
  } & BcsTypeOptions<T2, Input2, NewName>
Returns BcsType<T2, Input2, NewName>
Inherited from BcsType.transform
- Defined in packages/bcs/dist/bcs-type.d.mts:45

write

write(
    value: {
        [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
            ? T
            : never
    },
    _writer?: BcsWriter,
): void
Parameters
- value: {
      [K in string | number | symbol]: T[K] extends BcsType<any, T, string>
          ? T
          : never
  }
- Optional_writer: BcsWriter
Returns void
Deprecated
Use toBytes or serialize instead.
Inherited from BcsType.write
- Defined in packages/bcs/dist/bcs-type.d.mts:37

Class BcsTuple<T, Name>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BcsTuple<T, Name>

Properties

_codec

$inferInput

$inferType

name

serializedSize

toBytes

validate

Methods

fromBase58

Parameters

Returns { -readonly [K in string | number | symbol]: T[K] extends BcsType< T, any, string, > ? T : never}

fromBase64

Parameters

Returns { -readonly [K in string | number | symbol]: T[K] extends BcsType< T, any, string, > ? T : never}

fromHex

Parameters

Returns { -readonly [K in string | number | symbol]: T[K] extends BcsType< T, any, string, > ? T : never}

parse

Parameters

Returns { -readonly [K in string | number | symbol]: T[K] extends BcsType< T, any, string, > ? T : never}

read

Parameters

Returns { -readonly [K in string | number | symbol]: T[K] extends BcsType< T, any, string, > ? T : never}

Deprecated

serialize

Parameters

Returns SerializedBcs< { -readonly [K in string | number | symbol]: T[K] extends BcsType<T, any, string> ? T : never }, { [K in string | number | symbol]: T[K] extends BcsType<any, T, string> ? T : never },>

toBase58

Parameters

Returns string

toBase64

Parameters

Returns string

toHex

Parameters

Returns string

transform

Type Parameters

Parameters

Returns BcsType<T2, Input2, NewName>

write

Parameters

Returns void

Deprecated

Settings

On This Page

Returns {
-readonly [K in string | number | symbol]: T[K] extends BcsType<
T,
any,
string,
>
? T
: never
}

Returns {
-readonly [K in string | number | symbol]: T[K] extends BcsType<
T,
any,
string,
>
? T
: never
}

Returns {
-readonly [K in string | number | symbol]: T[K] extends BcsType<
T,
any,
string,
>
? T
: never
}

Returns {
-readonly [K in string | number | symbol]: T[K] extends BcsType<
T,
any,
string,
>
? T
: never
}

Returns {
-readonly [K in string | number | symbol]: T[K] extends BcsType<
T,
any,
string,
>
? T
: never
}

Returns SerializedBcs<
{
-readonly [K in string
| number
| symbol]: T[K] extends BcsType<T, any, string> ? T : never
},
{
[K in string
| number
| symbol]: T[K] extends BcsType<any, T, string> ? T : never
},
>