Class BitReader

Class for reading bit strings

Constructors

constructor

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

Properties

`Private` _bits

_bits: BitString

`Private` _checkpoints

_checkpoints: number[] = []

`Private` _offset

_offset: number

Accessors

offset

get offset(): number
Offset in source bit string

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

remaining

get remaining(): number
Number of bits remaining

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

Methods

`Private` _loadExternalAddress

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

`Private` _loadInternalAddress

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

`Private` _preloadBuffer

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

`Private` _preloadInt

_preloadInt(bits, offset): bigint
Preload int from specific offset
Parameters
- bits: number
  bits to preload
- offset: number
  offset to start from
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:421

`Private` _preloadUint

_preloadUint(bits, offset): bigint
Preload uint from specific offset
Parameters
- bits: number
  bits to preload
- offset: number
  offset to start from
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:444

`Private` _toSafeInteger

_toSafeInteger(src, alt): number
Parameters
- src: bigint
- alt: string
Returns number
- Defined in src/boc/BitReader.ts:513

clone

clone(): BitReader
Clone BitReader

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

loadAddress

loadAddress(): Address
Load Address

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

loadAddressAny

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

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

loadBit

loadBit(): boolean
Load a single bit

Returns boolean
true if the bit is set, false otherwise
- Defined in src/boc/BitReader.ts:74

loadBits

loadBits(bits): BitString
Load bit string
Parameters
- bits: number
  number of bits to read
Returns BitString
new bitstring
- Defined in src/boc/BitReader.ts:93

loadBuffer

loadBuffer(bytes): Buffer
Load buffer
Parameters
- bytes: number
  number of bytes
Returns Buffer
new buffer
- Defined in src/boc/BitReader.ts:113

loadCoins

loadCoins(): bigint
Load coins value

Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:290

loadExternalAddress

loadExternalAddress(): ExternalAddress
Load external address

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

loadInt

loadInt(bits): number
Load int value
Parameters
- bits: number
  int bits
Returns number
read value as bigint
- Defined in src/boc/BitReader.ts:171

loadIntBig

loadIntBig(bits): bigint
Load int value as bigint
Parameters
- bits: number
  int bits
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:182

loadMaybeAddress

loadMaybeAddress(): null | Address
Load internal address

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

loadMaybeExternalAddress

loadMaybeExternalAddress(): null | ExternalAddress
Load external address

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

loadPaddedBits

loadPaddedBits(bits): 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:384

loadUint

loadUint(bits): number
Load uint value
Parameters
- bits: number
  uint bits
Returns number
read value as number
- Defined in src/boc/BitReader.ts:133

loadUintBig

loadUintBig(bits): bigint
Load uint value as bigint
Parameters
- bits: number
  uint bits
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:142

loadVarInt

loadVarInt(bits): number
Load varint value
Parameters
- bits: number
  number of bits to read the size
Returns number
read value as bigint
- Defined in src/boc/BitReader.ts:251

loadVarIntBig

loadVarIntBig(bits): bigint
Load varint value
Parameters
- bits: number
  number of bits to read the size
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:261

loadVarUint

loadVarUint(bits): number
Load varuint value
Parameters
- bits: number
  number of bits to read the size
Returns number
read value as bigint
- Defined in src/boc/BitReader.ts:211

loadVarUintBig

loadVarUintBig(bits): bigint
Load varuint value
Parameters
- bits: number
  number of bits to read the size
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:221

preloadBit

preloadBit(): boolean
Preload bit

Returns boolean
true if the bit is set, false otherwise
- Defined in src/boc/BitReader.ts:84

preloadBits

preloadBits(bits): BitString
Preload bit string
Parameters
- bits: number
  number of bits to read
Returns BitString
new bitstring
- Defined in src/boc/BitReader.ts:104

preloadBuffer

preloadBuffer(bytes): Buffer
Preload buffer
Parameters
- bytes: number
  number of bytes
Returns Buffer
new buffer
- Defined in src/boc/BitReader.ts:124

preloadCoins

preloadCoins(): bigint
Preload coins value

Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:298

preloadInt

preloadInt(bits): number
Preload int value
Parameters
- bits: number
  int bits
Returns number
read value as bigint
- Defined in src/boc/BitReader.ts:193

preloadIntBig

preloadIntBig(bits): bigint
Preload int value
Parameters
- bits: number
  int bits
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:202

preloadUint

preloadUint(bits): number
Preload uint value
Parameters
- bits: number
  uint bits
Returns number
read value as number
- Defined in src/boc/BitReader.ts:153

preloadUintBig

preloadUintBig(bits): bigint
Preload uint value as bigint
Parameters
- bits: number
  uint bits
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:162

preloadVarInt

preloadVarInt(bits): number
Preload varint value
Parameters
- bits: number
  number of bits to read the size
Returns number
read value as bigint
- Defined in src/boc/BitReader.ts:271

preloadVarIntBig

preloadVarIntBig(bits): bigint
Preload varint value
Parameters
- bits: number
  number of bits to read the size
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:281

preloadVarUint

preloadVarUint(bits): number
Preload varuint value
Parameters
- bits: number
  number of bits to read the size
Returns number
read value as bigint
- Defined in src/boc/BitReader.ts:231

preloadVarUintBig

preloadVarUintBig(bits): bigint
Preload varuint value
Parameters
- bits: number
  number of bits to read the size
Returns bigint
read value as bigint
- Defined in src/boc/BitReader.ts:241

reset

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

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

save

save(): void
Save checkpoint

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

skip

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