Class BcsStruct<T, Name>

BcsType for a Move struct: an ordered set of named, typed fields.

Type Parameters

T extends Record<string, BcsType<any>>
const Name extends string = string

Hierarchy (View Summary)

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

Index

Constructors

constructor

new BcsStruct<
    T extends Record<string, BcsType<any, any, string>>,
    const Name extends string = string,
>(
    __namedParameters: BcsStructOptions<T, Name> & {
        decoder?: {
            buildEnumDecoder: (
                variantKeys: string[],
                variantReaders: ((() => unknown) | null)[],
                enumName?: string,
            ) => () => unknown;
            buildFixedArrayDecoder: (
                len: number,
                elemReader: () => unknown,
                kind?: string,
            ) => () => unknown;
            buildMapDecoder: (
                keyReader: () => unknown,
                valueReader: () => unknown,
            ) => () => unknown;
            buildOptionDecoder: (
                innerReader: () => unknown,
            ) => { decode: () => unknown; parse: (bytes: Uint8Array) => unknown };
            buildStructDecoder: (
                keys: string[],
                readers: (() => unknown)[],
            ) => () => unknown;
            buildTupleDecoder: (readers: (() => unknown)[]) => () => unknown;
            buildVectorDecoder: (
                elemReader: () => unknown,
                kind?: string,
            ) => () => unknown;
            bulkDecodeBool: (n: number) => boolean[];
            bulkDecodeU16: (n: number) => number[];
            bulkDecodeU32: (n: number) => number[];
            bulkDecodeU64: (n: number) => string[];
            bulkDecodeU8: (n: number) => number[];
            data: Uint8Array<ArrayBufferLike>;
            decodeBool: () => boolean;
            decodeByteVector: () => Uint8Array;
            decodeFixedBytes: (size: number) => Uint8Array;
            decodeString: () => string;
            decodeU128: () => string;
            decodeU16: () => number;
            decodeU256: () => string;
            decodeU32: () => number;
            decodeU64: () => string;
            decodeU8: () => number;
            init: (data: Uint8Array) => void;
            offset: number;
            readUleb: () => number;
        };
        encoder?: {
            buildEnumEncoder: (
                variantKeys: string[],
                variantWriters: (((v: unknown) => void) | null)[],
            ) => (v: unknown) => void;
            buildFixedArrayEncoder: (
                len: number,
                elemWriter: (v: unknown) => void,
                kind?: string,
            ) => (v: unknown) => void;
            buildMapEncoder: (
                keyWriter: (v: unknown) => void,
                valueWriter: (v: unknown) => void,
            ) => (v: unknown) => void;
            buildOptionEncoder: (
                innerWriter: (v: unknown) => void,
            ) => (v: unknown) => void;
            buildStructEncoder: (
                keys: string[],
                writers: ((v: unknown) => void)[],
            ) => (v: unknown) => void;
            buildTupleEncoder: (
                writers: ((v: unknown) => void)[],
            ) => (v: unknown) => void;
            buildVectorEncoder: (
                elemWriter: (v: unknown) => void,
                kind?: string,
            ) => (v: unknown) => void;
            bulkEncodeBool: (a: boolean[]) => void;
            bulkEncodeU16: (a: number[]) => void;
            bulkEncodeU32: (a: number[]) => void;
            bulkEncodeU64: (a: (string | number | bigint)[]) => void;
            bulkEncodeU8: (a: number[] | Uint8Array<ArrayBufferLike>) => void;
            encodeBool: (v: boolean) => void;
            encodeByteVector: (v: Iterable<number>) => void;
            encodeFixedBytes: (v: Iterable<number>, size: number) => void;
            encodeString: (v: string) => void;
            encodeU128: (v: string | number | bigint) => void;
            encodeU16: (v: number) => void;
            encodeU256: (v: string | number | bigint) => void;
            encodeU32: (v: number) => void;
            encodeU64: (v: string | number | bigint) => void;
            encodeU8: (v: number) => void;
            ensure: (n: number) => void;
            fastSerialize: (
                writeFn: (value: unknown) => void,
                value: unknown,
            ) => Uint8Array<ArrayBuffer>;
            getEncodeResult: () => Uint8Array<ArrayBuffer>;
            initEncode: () => void;
            offset: number;
            writeRawBytes: (bytes: Uint8Array) => void;
            writeUleb: (n: number) => void;
        };
    },
): BcsStruct<T, Name>
Type Parameters
- T extends Record<string, BcsType<any, any, string>>
- const Name extends string = string
Parameters
- __namedParameters: BcsStructOptions<T, Name> & {
      decoder?: {
          buildEnumDecoder: (
              variantKeys: string[],
              variantReaders: ((() => unknown) | null)[],
              enumName?: string,
          ) => () => unknown;
          buildFixedArrayDecoder: (
              len: number,
              elemReader: () => unknown,
              kind?: string,
          ) => () => unknown;
          buildMapDecoder: (
              keyReader: () => unknown,
              valueReader: () => unknown,
          ) => () => unknown;
          buildOptionDecoder: (
              innerReader: () => unknown,
          ) => { decode: () => unknown; parse: (bytes: Uint8Array) => unknown };
          buildStructDecoder: (
              keys: string[],
              readers: (() => unknown)[],
          ) => () => unknown;
          buildTupleDecoder: (readers: (() => unknown)[]) => () => unknown;
          buildVectorDecoder: (
              elemReader: () => unknown,
              kind?: string,
          ) => () => unknown;
          bulkDecodeBool: (n: number) => boolean[];
          bulkDecodeU16: (n: number) => number[];
          bulkDecodeU32: (n: number) => number[];
          bulkDecodeU64: (n: number) => string[];
          bulkDecodeU8: (n: number) => number[];
          data: Uint8Array<ArrayBufferLike>;
          decodeBool: () => boolean;
          decodeByteVector: () => Uint8Array;
          decodeFixedBytes: (size: number) => Uint8Array;
          decodeString: () => string;
          decodeU128: () => string;
          decodeU16: () => number;
          decodeU256: () => string;
          decodeU32: () => number;
          decodeU64: () => string;
          decodeU8: () => number;
          init: (data: Uint8Array) => void;
          offset: number;
          readUleb: () => number;
      };
      encoder?: {
          buildEnumEncoder: (
              variantKeys: string[],
              variantWriters: (((v: unknown) => void) | null)[],
          ) => (v: unknown) => void;
          buildFixedArrayEncoder: (
              len: number,
              elemWriter: (v: unknown) => void,
              kind?: string,
          ) => (v: unknown) => void;
          buildMapEncoder: (
              keyWriter: (v: unknown) => void,
              valueWriter: (v: unknown) => void,
          ) => (v: unknown) => void;
          buildOptionEncoder: (
              innerWriter: (v: unknown) => void,
          ) => (v: unknown) => void;
          buildStructEncoder: (
              keys: string[],
              writers: ((v: unknown) => void)[],
          ) => (v: unknown) => void;
          buildTupleEncoder: (
              writers: ((v: unknown) => void)[],
          ) => (v: unknown) => void;
          buildVectorEncoder: (
              elemWriter: (v: unknown) => void,
              kind?: string,
          ) => (v: unknown) => void;
          bulkEncodeBool: (a: boolean[]) => void;
          bulkEncodeU16: (a: number[]) => void;
          bulkEncodeU32: (a: number[]) => void;
          bulkEncodeU64: (a: (string | number | bigint)[]) => void;
          bulkEncodeU8: (a: number[] | Uint8Array<ArrayBufferLike>) => void;
          encodeBool: (v: boolean) => void;
          encodeByteVector: (v: Iterable<number>) => void;
          encodeFixedBytes: (v: Iterable<number>, size: number) => void;
          encodeString: (v: string) => void;
          encodeU128: (v: string | number | bigint) => void;
          encodeU16: (v: number) => void;
          encodeU256: (v: string | number | bigint) => void;
          encodeU32: (v: number) => void;
          encodeU64: (v: string | number | bigint) => void;
          encodeU8: (v: number) => void;
          ensure: (n: number) => void;
          fastSerialize: (
              writeFn: (value: unknown) => void,
              value: unknown,
          ) => Uint8Array<ArrayBuffer>;
          getEncodeResult: () => Uint8Array<ArrayBuffer>;
          initEncode: () => void;
          offset: number;
          writeRawBytes: (bytes: Uint8Array) => void;
          writeUleb: (n: number) => void;
      };
  }
Returns BcsStruct<T, Name>
Overrides BcsType.constructor
- Defined in packages/bcs/dist/bcs-type.d.mts:123

Properties

_codec

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

Internal codec holding the fast read/write closures and an optional kind tag used by bulk encoder/decoder dispatch.

$inferInput

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

$inferType

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

name

name: Name

serializedSize

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

toBytes

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

validate

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

Methods

fromBase58

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

fromBase64

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

fromHex

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

parse

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

read

read(
    reader: BcsReader,
): {
    [K in string | number | symbol]: T[K] extends BcsType<U, any, string>
        ? U
        : never
}
Decode from a BcsReader. Syncs the singleton decoder to the reader's state, runs the fast decode path, then syncs the position back. For the common case, use parse() instead.
Parameters
- reader: BcsReader
Returns {
    [K in string | number | symbol]: T[K] extends BcsType<U, any, string>
        ? U
        : never
}
Inherited from BcsType.read
- Defined in packages/bcs/dist/bcs-type.d.mts:47

serialize

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

toBase58

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

toBase64

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

toHex

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

transform

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

write

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

Class BcsStruct<T, Name>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BcsStruct<T, Name>

Properties

_codec

$inferInput

$inferType

name

serializedSize

toBytes

validate

Methods

fromBase58

Parameters

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

fromBase64

Parameters

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

fromHex

Parameters

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

parse

Parameters

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

read

Parameters

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

serialize

Parameters

Returns SerializedBcs< { [K in string | number | symbol]: T[K] extends BcsType<U, any, string> ? U : never }, { [K in string | number | symbol]: T[K] extends BcsType<any, U, string> ? U : 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

Settings

On This Page

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

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

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

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

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

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