Class BitReader

Class for reading bit strings

Hierarchy

BitReader

Constructors

constructor

new BitReader(bits: BitString, offset?: number): BitReader
Parameters
- bits: BitString
- offset: number = 0
Returns BitReader
- Defined in src/boc/BitReader.ts:14

Properties

`Private` _bits

_bits: BitString

`Private` _checkpoints

_checkpoints: number[] = []

`Private` _offset

_offset: number

Accessors

remaining

get remaining(): number
Number of bits remaining

Returns number
- Defined in src/boc/BitReader.ts:22

Methods

`Private` _loadExternalAddress

_loadExternalAddress(): ExternalAddress
Returns ExternalAddress
- Defined in src/boc/BitReader.ts:479

`Private` _loadInternalAddress

_loadInternalAddress(): Address
Returns Address
- Defined in src/boc/BitReader.ts:458

`Private` _preloadBuffer

_preloadBuffer(bytes: number, offset: number): Buffer
Parameters
- bytes: number
- offset: number
Returns Buffer
- Defined in src/boc/BitReader.ts:442

`Private` _preloadInt

_preloadInt(bits: number, offset: number): bigint
Preload int from specific offset

Returns
read value as bigint
Parameters
- bits: number
  
  bits to preload
- offset: number
  
  offset to start from
Returns bigint
- Defined in src/boc/BitReader.ts:406

`Private` _preloadUint

_preloadUint(bits: number, offset: number): bigint
Preload uint from specific offset

Returns
read value as bigint
Parameters
- bits: number
  
  bits to preload
- offset: number
  
  offset to start from
Returns bigint
- Defined in src/boc/BitReader.ts:429

clone

clone(): BitReader
Clone BitReader

Returns BitReader
- Defined in src/boc/BitReader.ts:396

loadAddress

loadAddress(): Address
Load Address

Returns
Address

Returns Address
- Defined in src/boc/BitReader.ts:291

loadAddressAny

loadAddressAny(): null | Address | ExternalAddress
Read address of any type

Returns
Address or ExternalAddress or null

Returns null | Address | ExternalAddress
- Defined in src/boc/BitReader.ts:349

loadBit

loadBit(): boolean
Load a single bit

Returns
true if the bit is set, false otherwise

Returns boolean
- Defined in src/boc/BitReader.ts:59

loadBits

loadBits(bits: number): BitString
Load bit string

Returns
new bitstring
Parameters
- bits: number
  
  number of bits to read
Returns BitString
- Defined in src/boc/BitReader.ts:78

loadBuffer

loadBuffer(bytes: number): Buffer
Load buffer

Returns
new buffer
Parameters
- bytes: number
  
  number of bytes
Returns Buffer
- Defined in src/boc/BitReader.ts:98

loadCoins

loadCoins(): bigint
Load coins value

Returns
read value as bigint

Returns bigint
- Defined in src/boc/BitReader.ts:275

loadExternalAddress

loadExternalAddress(): ExternalAddress
Load external address

Returns
ExternalAddress

Returns ExternalAddress
- Defined in src/boc/BitReader.ts:320

loadInt

loadInt(bits: number): number
Load int value

Returns
read value as bigint
Parameters
- bits: number
  
  int bits
Returns number
- Defined in src/boc/BitReader.ts:156

loadIntBig

loadIntBig(bits: number): bigint
Load int value as bigint

Returns
read value as bigint
Parameters
- bits: number
  
  int bits
Returns bigint
- Defined in src/boc/BitReader.ts:167

loadMaybeAddress

loadMaybeAddress(): null | Address
Load internal address

Returns
Address or null

Returns null | Address
- Defined in src/boc/BitReader.ts:304

loadMaybeExternalAddress

loadMaybeExternalAddress(): null | ExternalAddress
Load external address

Returns
ExternalAddress or null

Returns null | ExternalAddress
- Defined in src/boc/BitReader.ts:333

loadPaddedBits

loadPaddedBits(bits: number): BitString
Load bit string that was padded to make it byte alligned. Used in BOC serialization
Parameters
- bits: number
Returns BitString
- Defined in src/boc/BitReader.ts:369

loadUint

loadUint(bits: number): number
Load uint value

Returns
read value as number
Parameters
- bits: number
  
  uint bits
Returns number
- Defined in src/boc/BitReader.ts:118

loadUintBig

loadUintBig(bits: number): bigint
Load uint value as bigint

Returns
read value as bigint
Parameters
- bits: number
  
  uint bits
Returns bigint
- Defined in src/boc/BitReader.ts:127

loadVarInt

loadVarInt(bits: number): number
Load varint value

Returns
read value as bigint
Parameters
- bits: number
  
  number of bits to read the size
Returns number
- Defined in src/boc/BitReader.ts:236

loadVarIntBig

loadVarIntBig(bits: number): bigint
Load varint value

Returns
read value as bigint
Parameters
- bits: number
  
  number of bits to read the size
Returns bigint
- Defined in src/boc/BitReader.ts:246

loadVarUint

loadVarUint(bits: number): number
Load varuint value

Returns
read value as bigint
Parameters
- bits: number
  
  number of bits to read the size
Returns number
- Defined in src/boc/BitReader.ts:196

loadVarUintBig

loadVarUintBig(bits: number): bigint
Load varuint value

Returns
read value as bigint
Parameters
- bits: number
  
  number of bits to read the size
Returns bigint
- Defined in src/boc/BitReader.ts:206

preloadBit

preloadBit(): boolean
Preload bit

Returns
true if the bit is set, false otherwise

Returns boolean
- Defined in src/boc/BitReader.ts:69

preloadBits

preloadBits(bits: number): BitString
Preload bit string

Returns
new bitstring
Parameters
- bits: number
  
  number of bits to read
Returns BitString
- Defined in src/boc/BitReader.ts:89

preloadBuffer

preloadBuffer(bytes: number): Buffer
Preload buffer

Returns
new buffer
Parameters
- bytes: number
  
  number of bytes
Returns Buffer
- Defined in src/boc/BitReader.ts:109

preloadCoins

preloadCoins(): bigint
Preload coins value

Returns
read value as bigint

Returns bigint
- Defined in src/boc/BitReader.ts:283

preloadInt

preloadInt(bits: number): number
Preload int value

Returns
read value as bigint
Parameters
- bits: number
  
  int bits
Returns number
- Defined in src/boc/BitReader.ts:178

preloadIntBig

preloadIntBig(bits: number): bigint
Preload int value

Returns
read value as bigint
Parameters
- bits: number
  
  int bits
Returns bigint
- Defined in src/boc/BitReader.ts:187

preloadUint

preloadUint(bits: number): number
Preload uint value

Returns
read value as number
Parameters
- bits: number
  
  uint bits
Returns number
- Defined in src/boc/BitReader.ts:138

preloadUintBig

preloadUintBig(bits: number): bigint
Preload uint value as bigint

Returns
read value as bigint
Parameters
- bits: number
  
  uint bits
Returns bigint
- Defined in src/boc/BitReader.ts:147

preloadVarInt

preloadVarInt(bits: number): number
Preload varint value

Returns
read value as bigint
Parameters
- bits: number
  
  number of bits to read the size
Returns number
- Defined in src/boc/BitReader.ts:256

preloadVarIntBig

preloadVarIntBig(bits: number): bigint
Preload varint value

Returns
read value as bigint
Parameters
- bits: number
  
  number of bits to read the size
Returns bigint
- Defined in src/boc/BitReader.ts:266

preloadVarUint

preloadVarUint(bits: number): number
Preload varuint value

Returns
read value as bigint
Parameters
- bits: number
  
  number of bits to read the size
Returns number
- Defined in src/boc/BitReader.ts:216

preloadVarUintBig

preloadVarUintBig(bits: number): bigint
Preload varuint value

Returns
read value as bigint
Parameters
- bits: number
  
  number of bits to read the size
Returns bigint
- Defined in src/boc/BitReader.ts:226

reset

reset(): void
Reset to the beginning or latest checkpoint

Returns void
- Defined in src/boc/BitReader.ts:40

save

save(): void
Save checkpoint

Returns void
- Defined in src/boc/BitReader.ts:51

skip

skip(bits: number): void
Skip bits
Parameters
- bits: number
  
  number of bits to skip
Returns void
- Defined in src/boc/BitReader.ts:30

Generated using TypeDoc