Class BcsEnum<T, Name>

$inferInput

$inferType

name

read

serializedSize

validate

fromBase58

• fromBase58(
      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,
  >

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,
  >

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,
  >

parse

• parse(bytes: Uint8Array): EnumOutputShape

  Parameters

  • bytes: Uint8Array

  Returns EnumOutputShape

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
                  : null | boolean | object
          },
      >,
  >

  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
                  : null | boolean | object
          },
      >,
  >

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
                  : null | boolean | object
          },
      >,
      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 : null | boolean | object
        },
    >
  • NewName extends string = Name

  Parameters

  • __namedParameters: {
        input?: (val: Input2) => EnumInputShape;
        output?: (value: EnumOutputShape) => T2;
    } & BcsTypeOptions<T2, Input2, NewName>

  Returns BcsType<T2, Input2, NewName>

write

• write(value: EnumInputShape, writer: BcsWriter): void

  Parameters

  • value: EnumInputShape
  • writer: BcsWriter

  Returns void