Class BitBuilder

Class for building bit strings

Hierarchy

BitBuilder

Index

Constructors

Properties

_buffer _length

Accessors

Methods

buffer build writeAddress writeBit writeBits writeBuffer writeCoins writeInt writeUint writeVarInt writeVarUint

Constructors

constructor

new BitBuilder(size?: number): BitBuilder
Parameters
- size: number = 1023
Returns BitBuilder
- Defined in src/boc/BitBuilder.ts:22

Properties

`Private` _buffer

_buffer: Buffer

`Private` _length

_length: number

Accessors

length

get length(): number
Current number of bits written

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

Methods

buffer

buffer(): Buffer
Build into Buffer

Returns
result buffer

Returns Buffer
- Defined in src/boc/BitBuilder.ts:317

build

build(): BitString
Build BitString

Returns
result bit string

Returns BitString
- Defined in src/boc/BitBuilder.ts:309

writeAddress

writeAddress(address: Maybe<Address | ExternalAddress>): void
Write address
Parameters
- address: Maybe<Address | ExternalAddress>
  
  write address or address external
Returns void
- Defined in src/boc/BitBuilder.ts:276

writeBit

writeBit(value: number | boolean): void
Write a single bit
Parameters
- value: number | boolean
  
  bit to write, true or positive number for 1, false or zero or negative for 0
Returns void
- Defined in src/boc/BitBuilder.ts:38

writeBits

writeBits(src: BitString): void
Copy bits from BitString
Parameters
- src: BitString
  
  source bits
Returns void
- Defined in src/boc/BitBuilder.ts:59

writeBuffer

writeBuffer(src: Buffer): void
Write bits from buffer
Parameters
- src: Buffer
  
  source buffer
Returns void
- Defined in src/boc/BitBuilder.ts:69

writeCoins

writeCoins(amount: number | bigint): void
Write coins in var uint format
Parameters
- amount: number | bigint
  
  amount to write
Returns void
- Defined in src/boc/BitBuilder.ts:268

writeInt

writeInt(value: number | bigint, bits: number): void
Write int value
Parameters
- value: number | bigint
  
  value as bigint or number
- bits: number
  
  number of bits to write
Returns void
- Defined in src/boc/BitBuilder.ts:159

writeUint

writeUint(value: number | bigint, bits: number): void
Write uint value
Parameters
- value: number | bigint
  
  value as bigint or number
- bits: number
  
  number of bits to write
Returns void
- Defined in src/boc/BitBuilder.ts:90

writeVarInt

writeVarInt(value: number | bigint, bits: number): void
Wrtie var int value, used for serializing coins
Parameters
- value: number | bigint
  
  value to write as bigint or number
- bits: number
  
  header bits to write size
Returns void
- Defined in src/boc/BitBuilder.ts:239

writeVarUint

writeVarUint(value: number | bigint, bits: number): void
Wrtie var uint value, used for serializing coins
Parameters
- value: number | bigint
  
  value to write as bigint or number
- bits: number
  
  header bits to write size
Returns void
- Defined in src/boc/BitBuilder.ts:207

Generated using TypeDoc