Class Slice

constructor

• new Slice(reader: BitReader, refs: Cell[]): Slice

  Parameters

  • reader: BitReader
  • refs: Cell[]

  Returns Slice

[SymbolInspect]

offsetBits

• get offsetBits(): number

  Get offset bits

  Returns number

offsetRefs

• get offsetRefs(): number

  Get offset refs

  Returns number

remainingBits

• get remainingBits(): number

  Get remaining bits

  Returns number

remainingRefs

• get remainingRefs(): number

  Get remaining refs

  Returns number

asBuilder

• asBuilder(): Builder

  Returns Builder

asCell

• asCell(): Cell

  Convert slice to cell

  Returns Cell

clone

• clone(fromStart?: boolean): Slice

  Clone slice

  Parameters

  • OptionalfromStart: boolean

  Returns Slice

  cloned slice

endParse

• endParse(): void

  Checks if slice is empty

  Returns void

loadAddress

• loadAddress(): Address

  Load internal Address

  Returns Address

  Address

loadAddressAny

• loadAddressAny(): null | Address | ExternalAddress

  Load address

  Returns null | Address | ExternalAddress

  Address, ExternalAddress or null

loadBit

• loadBit(): boolean

  Load a single bit

  Returns boolean

  true or false depending on the bit value

loadBits

• loadBits(bits: number): BitString

  Load bits as a new BitString

  Parameters

  • bits: number

    number of bits to read

  Returns BitString

  new BitString

loadBoolean

• loadBoolean(): boolean

  Load a boolean

  Returns boolean

  true or false depending on the bit value

loadBuffer

• loadBuffer(bytes: number): Buffer

  Load byte buffer

  Parameters

  • bytes: number

    number of bytes to load

  Returns Buffer

  Buffer

loadCoins

• loadCoins(): bigint

  Load coins

  Returns bigint

  coins value

loadDict

• loadDict<K extends DictionaryKeyTypes, V>(
      key: DictionaryKey<K>,
      value: DictionaryValue<V>,
  ): Dictionary<K, V>

  Loads dictionary

  Type Parameters

  • K extends DictionaryKeyTypes
  • V

  Parameters

  • key: DictionaryKey<K>

    key description
  • value: DictionaryValue<V>

    value description

  Returns Dictionary<K, V>

  Dictionary<K, V>

loadDictDirect

• loadDictDirect<K extends DictionaryKeyTypes, V>(
      key: DictionaryKey<K>,
      value: DictionaryValue<V>,
  ): Dictionary<K, V>

  Loads dictionary directly from current slice

  Type Parameters

  • K extends DictionaryKeyTypes
  • V

  Parameters

  • key: DictionaryKey<K>

    key description
  • value: DictionaryValue<V>

    value description

  Returns Dictionary<K, V>

  Dictionary<K, V>

loadExternalAddress

• loadExternalAddress(): ExternalAddress

  Load external address

  Returns ExternalAddress

  ExternalAddress

loadInt

• loadInt(bits: number): number

  Load int

  Parameters

  • bits: number

    number of bits to read

  Returns number

  int value

loadIntBig

• loadIntBig(bits: number): bigint

  Load int

  Parameters

  • bits: number

    number of bits to read

  Returns bigint

  int value

loadMaybeAddress

• loadMaybeAddress(): null | Address

  Load optional internal Address

  Returns null | Address

  Address or null

loadMaybeBoolean

• loadMaybeBoolean(): null | boolean

  Load maybe boolean

  Returns null | boolean

  true or false depending on the bit value or null

loadMaybeCoins

• loadMaybeCoins(): null | bigint

  Load maybe coins

  Returns null | bigint

  coins value or null

loadMaybeExternalAddress

• loadMaybeExternalAddress(): null | ExternalAddress

  Load optional external address

  Returns null | ExternalAddress

  ExternalAddress or null

loadMaybeInt

• loadMaybeInt(bits: number): null | number

  Load maybe uint

  Parameters

  • bits: number

    number of bits to read

  Returns null | number

  uint value or null

loadMaybeIntBig

• loadMaybeIntBig(bits: number): null | bigint

  Load maybe uint

  Parameters

  • bits: number

    number of bits to read

  Returns null | bigint

  uint value or null

loadMaybeRef

• loadMaybeRef(): null | Cell

  Load optional reference

  Returns null | Cell

  Cell or null

loadMaybeStringRefTail

• loadMaybeStringRefTail(): null | string

  Load maybe string tail from ref

  Returns null | string

  string or null

loadMaybeStringTail

• loadMaybeStringTail(): null | string

  Load maybe string tail

  Returns null | string

  string or null

loadMaybeUint

• loadMaybeUint(bits: number): null | number

  Load maybe uint

  Parameters

  • bits: number

    number of bits to read

  Returns null | number

  uint value or null

loadMaybeUintBig

• loadMaybeUintBig(bits: number): null | bigint

  Load maybe uint

  Parameters

  • bits: number

    number of bits to read

  Returns null | bigint

  uint value or null

loadRef

• loadRef(): Cell

  Load reference

  Returns Cell

  Cell

loadStringRefTail

• loadStringRefTail(): string

  Load string tail from ref

  Returns string

  string

loadStringTail

• loadStringTail(): string

  Load string tail

  Returns string

loadUint

• loadUint(bits: number): number

  Load uint

  Parameters

  • bits: number

    number of bits to read

  Returns number

  uint value

loadUintBig

• loadUintBig(bits: number): bigint

  Load uint

  Parameters

  • bits: number

    number of bits to read

  Returns bigint

  uint value

loadVarInt

• loadVarInt(bits: number): number

  Load varint

  Parameters

  • bits: number

    number of bits to read in header

  Returns number

  varint value

loadVarIntBig

• loadVarIntBig(bits: number): bigint

  Load varint

  Parameters

  • bits: number

    number of bits to read in header

  Returns bigint

  varint value

loadVarUint

• loadVarUint(bits: number): number

  Load varuint

  Parameters

  • bits: number

    number of bits to read in header

  Returns number

  varuint value

loadVarUintBig

• loadVarUintBig(bits: number): bigint

  Load varuint

  Parameters

  • bits: number

    number of bits to read in header

  Returns bigint

  varuint value

preloadBit

• preloadBit(): boolean

  Preload a signle bit

  Returns boolean

  true or false depending on the bit value

preloadBits

• preloadBits(bits: number): BitString

  Preload bits as a new BitString

  Parameters

  • bits: number

    number of bits to read

  Returns BitString

  new BitString

preloadBuffer

• preloadBuffer(bytes: number): Buffer

  Load byte buffer

  Parameters

  • bytes: number

    number of bytes to load

  Returns Buffer

  Buffer

preloadCoins

• preloadCoins(): bigint

  Preload coins

  Returns bigint

  coins value

preloadInt

• preloadInt(bits: number): number

  Preload int

  Parameters

  • bits: number

    number of bits to read

  Returns number

  int value

preloadIntBig

• preloadIntBig(bits: number): bigint

  Preload int

  Parameters

  • bits: number

    number of bits to read

  Returns bigint

  int value

preloadMaybeRef

• preloadMaybeRef(): null | Cell

  Preload optional reference

  Returns null | Cell

  Cell or null

preloadRef

• preloadRef(): Cell

  Preload reference

  Returns Cell

  Cell

preloadUint

• preloadUint(bits: number): number

  Preload uint

  Parameters

  • bits: number

    number of bits to read

  Returns number

  uint value

preloadUintBig

• preloadUintBig(bits: number): bigint

  Preload uint

  Parameters

  • bits: number

    number of bits to read

  Returns bigint

  uint value

preloadVarInt

• preloadVarInt(bits: number): number

  Preload varint

  Parameters

  • bits: number

    number of bits to read in header

  Returns number

  varint value

preloadVarIntBig

• preloadVarIntBig(bits: number): bigint

  Preload varint

  Parameters

  • bits: number

    number of bits to read in header

  Returns bigint

  varint value

preloadVarUint

• preloadVarUint(bits: number): number

  Preload varuint

  Parameters

  • bits: number

    number of bits to read in header

  Returns number

  varuint value

preloadVarUintBig

• preloadVarUintBig(bits: number): bigint

  Preload varuint

  Parameters

  • bits: number

    number of bits to read in header

  Returns bigint

  varuint value

skip

• skip(bits: number): this

  Skip bits

  Parameters

  • bits: number

  Returns this

toString

• toString(): string

  Print slice as string by converting it to cell

  Returns string

  string