Class BcsEnum<T, Name>

BcsType for a Move enum: a tagged union of named variants.

Type Parameters

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

Hierarchy (View Summary)

BcsType<
    EnumOutputShape<
        { [K in keyof T]: T[K] extends BcsType<infer U, any> ? U : true },
    >,
    EnumInputShape<
        {
            [K in keyof T]: T[K] extends BcsType<any, infer U, any>
                ? U
                : boolean | object | null
        },
    >,
    Name,
>
- BcsEnum

Index

Constructors

constructor

new BcsEnum<
    T extends Record<string, BcsType<any, any, string> | null>,
    const Name extends string = string,
>(
    __namedParameters: BcsEnumOptions<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[];
            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;
            readUleb: () => number;
            get data(): Uint8Array<ArrayBufferLike>;
            get offset(): number;
            set offset(v: number): void;
        };
        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: Uint8Array<ArrayBufferLike> | number[]) => 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,
                sizeLimit?: number,
            ) => Uint8Array<ArrayBuffer>;
            getEncodeResult: () => Uint8Array<ArrayBuffer>;
            initEncode: () => void;
            writeRawBytes: (bytes: Uint8Array) => void;
            writeUleb: (n: number) => void;
            get offset(): number;
            set offset(v: number): void;
        };
    },
): BcsEnum<T, Name>
Type Parameters
- T extends Record<string, BcsType<any, any, string> | null>
- const Name extends string = string
Parameters
- __namedParameters: BcsEnumOptions<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[];
          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;
          readUleb: () => number;
          get data(): Uint8Array<ArrayBufferLike>;
          get offset(): number;
          set offset(v: number): void;
      };
      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: Uint8Array<ArrayBufferLike> | number[]) => 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,
              sizeLimit?: number,
          ) => Uint8Array<ArrayBuffer>;
          getEncodeResult: () => Uint8Array<ArrayBuffer>;
          initEncode: () => void;
          writeRawBytes: (bytes: Uint8Array) => void;
          writeUleb: (n: number) => void;
          get offset(): number;
          set offset(v: number): void;
      };
  }
Returns BcsEnum<T, Name>
Overrides BcsType.constructor
- Defined in bcs/src/bcs-type.ts:432

Properties

_codec

_codec: {
    kind?: string;
    read: () => EnumOutputShape;
    write: (value: EnumInputShape) => void;
}

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

$inferInput

$inferInput: EnumInputShape

$inferType

$inferType: EnumOutputShape

name

name: Name

serializedSize

serializedSize: (
value: EnumInputShape,
options?: BcsWriterOptions,
) => number | null

toBytes

toBytes: (
value: EnumInputShape,
options?: BcsWriterOptions,
) => Uint8Array<ArrayBuffer>

validate

validate: (value: EnumInputShape) => void

Methods

fromBase58

fromBase58(
    b58: string,
): EnumOutputShape<
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    },
    Extract<keyof T, string>,
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    }[keyof T] extends Type
        ? Type extends BcsType<U, U, string> ? U : never
        : never,
>
Parameters
- b58: string
Returns EnumOutputShape<
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    },
    Extract<keyof T, string>,
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    }[keyof T] extends Type
        ? Type extends BcsType<U, U, string> ? U : never
        : never,
>
Inherited from BcsType.fromBase58
- Defined in bcs/src/bcs-type.ts:137

fromBase64

fromBase64(
    b64: string,
): EnumOutputShape<
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    },
    Extract<keyof T, string>,
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    }[keyof T] extends Type
        ? Type extends BcsType<U, U, string> ? U : never
        : never,
>
Parameters
- b64: string
Returns EnumOutputShape<
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    },
    Extract<keyof T, string>,
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    }[keyof T] extends Type
        ? Type extends BcsType<U, U, string> ? U : never
        : never,
>
Inherited from BcsType.fromBase64
- Defined in bcs/src/bcs-type.ts:141

fromHex

fromHex(
    hex: string,
): EnumOutputShape<
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    },
    Extract<keyof T, string>,
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    }[keyof T] extends Type
        ? Type extends BcsType<U, U, string> ? U : never
        : never,
>
Parameters
- hex: string
Returns EnumOutputShape<
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    },
    Extract<keyof T, string>,
    {
        [K in string
        | number
        | symbol]: T[K] extends BcsType<U, any, string> ? U : true
    }[keyof T] extends Type
        ? Type extends BcsType<U, U, string> ? U : never
        : never,
>
Inherited from BcsType.fromHex
- Defined in bcs/src/bcs-type.ts:133

parse

parse(bytes: Uint8Array): EnumOutputShape
Parameters
- bytes: Uint8Array
Returns EnumOutputShape
Inherited from BcsType.parse
- Defined in bcs/src/bcs-type.ts:115

read

read(reader: BcsReader): EnumOutputShape
Parameters
- reader: BcsReader
Returns EnumOutputShape
Deprecated
Use parse instead.
Inherited from BcsType.read
- Defined in bcs/src/bcs-type.ts:102

serialize

serialize(
    value: EnumInputShape,
    options?: BcsWriterOptions,
): SerializedBcs<
    EnumOutputShape<
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<U, any, string> ? U : true
        },
        Extract<keyof T, string>,
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<U, any, string> ? U : true
        }[keyof T] extends Type
            ? Type extends BcsType<U, U, string> ? U : never
            : never,
    >,
    EnumInputShape<
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<any, U, any>
                ? U
                : boolean | object | null
        },
    >,
>
Parameters
- value: EnumInputShape
- Optionaloptions: BcsWriterOptions
Returns SerializedBcs<
    EnumOutputShape<
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<U, any, string> ? U : true
        },
        Extract<keyof T, string>,
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<U, any, string> ? U : true
        }[keyof T] extends Type
            ? Type extends BcsType<U, U, string> ? U : never
            : never,
    >,
    EnumInputShape<
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<any, U, any>
                ? U
                : boolean | object | null
        },
    >,
>
Inherited from BcsType.serialize
- Defined in bcs/src/bcs-type.ts:145

toBase58

toBase58(value: EnumInputShape): string
Parameters
- value: EnumInputShape
Returns string
Inherited from BcsType.toBase58
- Defined in bcs/src/bcs-type.ts:158

toBase64

toBase64(value: EnumInputShape): string
Parameters
- value: EnumInputShape
Returns string
Inherited from BcsType.toBase64
- Defined in bcs/src/bcs-type.ts:154

toHex

toHex(value: EnumInputShape): string
Parameters
- value: EnumInputShape
Returns string
Inherited from BcsType.toHex
- Defined in bcs/src/bcs-type.ts:150

transform

transform<
    T2 = EnumOutputShape<
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<U, any, string> ? U : true
        },
        Extract<keyof T, string>,
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<U, any, string> ? U : true
        }[keyof T] extends Type
            ? Type extends BcsType<U, U, string> ? U : never
            : never,
    >,
    Input2 = EnumInputShape<
        {
            [K in string
            | number
            | symbol]: T[K] extends BcsType<any, U, any>
                ? U
                : boolean | object | null
        },
    >,
    NewName extends string = Name,
>(
    __namedParameters: {
        input?: (val: Input2) => EnumInputShape;
        output?: (value: EnumOutputShape) => T2;
    } & BcsTypeOptions<T2, Input2, NewName>,
): BcsType<T2, Input2, NewName>
Type Parameters
- T2 = EnumOutputShape<
      {
          [K in string
          | number
          | symbol]: T[K] extends BcsType<U, any, string> ? U : true
      },
      Extract<keyof T, string>,
      {
          [K in string
          | number
          | symbol]: T[K] extends BcsType<U, any, string> ? U : true
      }[keyof T] extends Type
          ? Type extends BcsType<U, U, string> ? U : never
          : never,
  >
- Input2 = EnumInputShape<
      {
          [K in string
          | number
          | symbol]: T[K] extends BcsType<any, U, any> ? U : boolean | object | null
      },
  >
- NewName extends string = Name
Parameters
- __namedParameters: {
  input?: (val: Input2) => EnumInputShape;
  output?: (value: EnumOutputShape) => T2;
  } & BcsTypeOptions<T2, Input2, NewName>
Returns BcsType<T2, Input2, NewName>
Inherited from BcsType.transform
- Defined in bcs/src/bcs-type.ts:162

write

write(value: EnumInputShape, _writer?: BcsWriter): void
Parameters
- value: EnumInputShape
- Optional_writer: BcsWriter
Returns void
Deprecated
Use toBytes or serialize instead.
Inherited from BcsType.write
- Defined in bcs/src/bcs-type.ts:127

Class BcsEnum<T, Name>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BcsEnum<T, Name>

Properties

_codec

$inferInput

$inferType

name

serializedSize

toBytes

validate

Methods

fromBase58

Parameters

fromBase64

Parameters

fromHex

Parameters

parse

Parameters

Returns EnumOutputShape

read

Parameters

Returns EnumOutputShape

Deprecated

serialize

Parameters

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