Class BcsReader

BCS data reader. Each instance owns its own decoder with independent state, so multiple readers never interfere with each other or with BcsType.parse().

Example

const reader = new BcsReader(bytes);
const a = reader.read32();
const b = reader.read64();

Index

Constructors

constructor

new BcsReader(
    data?: Uint8Array<ArrayBufferLike>,
    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;
    },
): BcsReader
Parameters
- Optionaldata: Uint8Array<ArrayBufferLike>
  Data to read from. Creates an independent decoder.
- Optionaldecoder: {
      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;
  }
  Optional: use an existing decoder instead of creating one.
  - 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
Returns BcsReader
- Defined in bcs/src/reader.ts:23

Accessors

bytePosition

get bytePosition(): number
Returns number
- Defined in bcs/src/reader.ts:31
set bytePosition(value: number): void
Parameters
- value: number
Returns void
- Defined in bcs/src/reader.ts:34

bytes

get bytes(): Uint8Array
Returns Uint8Array
- Defined in bcs/src/reader.ts:28

position

get position(): number
Returns number
- Defined in bcs/src/reader.ts:37

Methods

read128

read128(): string
Returns string
- Defined in bcs/src/reader.ts:57

read16

read16(): number
Returns number
- Defined in bcs/src/reader.ts:48

read256

read256(): string
Returns string
- Defined in bcs/src/reader.ts:60

read32

read32(): number
Returns number
- Defined in bcs/src/reader.ts:51

read64

read64(): string
Returns string
- Defined in bcs/src/reader.ts:54

read8

read8(): number
Returns number
- Defined in bcs/src/reader.ts:45

readBytes

readBytes(num: number): Uint8Array
Parameters
- num: number
Returns Uint8Array
- Defined in bcs/src/reader.ts:63

readULEB

readULEB(): number
Returns number
- Defined in bcs/src/reader.ts:66

readVec

readVec(cb: (reader: BcsReader, i: number, length: number) => any): any[]
Parameters
- cb: (reader: BcsReader, i: number, length: number) => any
Returns any[]
- Defined in bcs/src/reader.ts:69

shift

shift(bytes: number): this
Parameters
- bytes: number
Returns this
- Defined in bcs/src/reader.ts:41

Class BcsReader

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

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

Returns BcsReader

Accessors

bytePosition

Returns number

Parameters

Returns void

bytes

Returns Uint8Array

position

Returns number

Methods

read128

Returns string

read16

Returns number

read256

Returns string

read32

Returns number

read64

Returns string

read8

Returns number

readBytes

Parameters

Returns Uint8Array

readULEB

Returns number

readVec

Parameters

Returns any[]

shift

Parameters

Returns this

Settings

On This Page

buildEnumDecoder: (
variantKeys: string[],
variantReaders: ((() => unknown) | null)[],
enumName?: string,
) => () => unknown

buildOptionDecoder: (
innerReader: () => unknown,
) => { decode: () => unknown; parse: (bytes: Uint8Array) => unknown }