Class Builder

Builder for Cells

Constructors

constructor

new Builder(): Builder
Returns Builder
- Defined in src/boc/Builder.ts:35

Properties

`Private` _bits

_bits: BitBuilder

`Private` _refs

_refs: Cell[]

Accessors

availableBits

get availableBits(): number
Available bits

Returns number
- Defined in src/boc/Builder.ts:57

availableRefs

get availableRefs(): number
Available references

Returns number
- Defined in src/boc/Builder.ts:64

bits

get bits(): number
Bits written so far

Returns number
- Defined in src/boc/Builder.ts:43

refs

get refs(): number
References written so far

Returns number
- Defined in src/boc/Builder.ts:50

Methods

asCell

asCell(): Cell
Convert to cell

Returns Cell
cell
- Defined in src/boc/Builder.ts:486

asSlice

asSlice(): Slice
Convert to slice

Returns Slice
slice
- Defined in src/boc/Builder.ts:494

endCell

endCell(opts?): Cell
Complete cell
Parameters
- Optional opts: {
  exotic?: boolean;
  }
  options
  - Optional exotic?: boolean
Returns Cell
cell
- Defined in src/boc/Builder.ts:474

store

store(writer): Builder
Store object in this builder
Parameters
- writer: Writable | ((builder) => void)
  Writable or writer functuin
Returns Builder
- Defined in src/boc/Builder.ts:389

storeAddress

storeAddress(address): Builder
Store address
Parameters
- address: Maybe<Address | ExternalAddress>
Returns Builder
this builder
- Defined in src/boc/Builder.ts:258

storeBit

storeBit(value): Builder
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 Builder
this builder
- Defined in src/boc/Builder.ts:73

storeBits

storeBits(src): Builder
Write bits from BitString
Parameters
- src: BitString
  source bits
Returns Builder
this builder
- Defined in src/boc/Builder.ts:83

storeBuffer

storeBuffer(src, bytes?): Builder
Store Buffer
Parameters
- src: Buffer
  source buffer
- Optional bytes: Maybe<number>
  optional number of bytes to write
Returns Builder
this builder
- Defined in src/boc/Builder.ts:94

storeBuilder

storeBuilder(src): Builder
Store builder
Parameters
- src: Builder
  builder to store
Returns Builder
this builder
- Defined in src/boc/Builder.ts:337

storeCoins

storeCoins(amount): Builder
Store coins value
Parameters
- amount: number | bigint
  amount of coins
Returns Builder
this builder
- Defined in src/boc/Builder.ts:233

storeDict

storeDict<K, V>(dict?, key?, value?): Builder
Store dictionary in this builder
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- Optional dict: Maybe<Dictionary<K, V>>
  dictionary to store
- Optional key: Maybe<DictionaryKey<K>>
- Optional value: Maybe<DictionaryValue<V>>
Returns Builder
this builder
- Defined in src/boc/Builder.ts:450

storeDictDirect

storeDictDirect<K, V>(dict, key?, value?): Builder
Store dictionary in this builder directly
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- dict: Dictionary<K, V>
  dictionary to store
- Optional key: Maybe<DictionaryKey<K>>
- Optional value: Maybe<DictionaryValue<V>>
Returns Builder
this builder
- Defined in src/boc/Builder.ts:464

storeInt

storeInt(value, bits): Builder
Store int value
Parameters
- value: number | bigint
  value as bigint or number
- bits: number
  number of bits to write
Returns Builder
this builder
- Defined in src/boc/Builder.ts:153

storeMaybeBuffer

storeMaybeBuffer(src, bytes?): Builder
Store Maybe Buffer
Parameters
- src: null | Buffer
  source buffer or null
- Optional bytes: Maybe<number>
  optional number of bytes to write
Returns Builder
this builder
- Defined in src/boc/Builder.ts:110

storeMaybeBuilder

storeMaybeBuilder(src?): Builder
Store builder if not null
Parameters
- Optional src: Maybe<Builder>
  builder to store
Returns Builder
this builder
- Defined in src/boc/Builder.ts:346

storeMaybeCoins

storeMaybeCoins(amount): Builder
Store maybe coins value
Parameters
- amount: Maybe<number | bigint>
  amount of coins, null or undefined
Returns Builder
this builder
- Defined in src/boc/Builder.ts:243

storeMaybeInt

storeMaybeInt(value, bits): Builder
Store maybe int value
Parameters
- value: Maybe<number | bigint>
  value as bigint or number, null or undefined
- bits: number
  number of bits to write
Returns Builder
this builder
- Defined in src/boc/Builder.ts:164

storeMaybeRef

storeMaybeRef(cell?): Builder
Store reference if not null
Parameters
- Optional cell: Maybe<Builder | Cell>
  cell or builder to store
Returns Builder
this builder
- Defined in src/boc/Builder.ts:292

storeMaybeSlice

storeMaybeSlice(src?): Builder
Store slice in this builder if not null
Parameters
- Optional src: Maybe<Slice>
  source slice
Returns Builder
- Defined in src/boc/Builder.ts:322

storeMaybeStringRefTail

storeMaybeStringRefTail(src?): Builder
Store maybe string tail in ref
Parameters
- Optional src: Maybe<null | string>
  source string
Returns Builder
this builder
- Defined in src/boc/Builder.ts:435

storeMaybeStringTail

storeMaybeStringTail(src?): Builder
Store string tail
Parameters
- Optional src: Maybe<string>
  source string
Returns Builder
this builder
- Defined in src/boc/Builder.ts:409

storeMaybeUint

storeMaybeUint(value, bits): Builder
Store maybe uint value
Parameters
- value: Maybe<number | bigint>
  value as bigint or number, null or undefined
- bits: number
  number of bits to write
Returns Builder
this builder
- Defined in src/boc/Builder.ts:137

storeMaybeVarInt

storeMaybeVarInt(value, bits): Builder
Store maybe varint value
Parameters
- value: Maybe<number | bigint>
  value as bigint or number, null or undefined
- bits: number
  number of bits to write to header
Returns Builder
this builder
- Defined in src/boc/Builder.ts:218

storeMaybeVarUint

storeMaybeVarUint(value, bits): Builder
Store maybe varuint value
Parameters
- value: Maybe<number | bigint>
  value as bigint or number, null or undefined
- bits: number
  number of bits to write to header
Returns Builder
this builder
- Defined in src/boc/Builder.ts:191

storeMaybeWritable

storeMaybeWritable(writer?): Builder
Store writer or builder if not null
Parameters
- Optional writer: Maybe<Writable | ((builder) => void)>
  writer or builder to store
Returns Builder
this builder
- Defined in src/boc/Builder.ts:375

storeRef

storeRef(cell): Builder
Store reference
Parameters
- cell: Builder | Cell
  cell or builder to store
Returns Builder
this builder
- Defined in src/boc/Builder.ts:268

storeSlice

storeSlice(src): Builder
Store slice it in this builder
Parameters
- src: Slice
  source slice
Returns Builder
- Defined in src/boc/Builder.ts:307

storeStringRefTail

storeStringRefTail(src): Builder
Store string tail in ref
Parameters
- src: string
  source string
Returns Builder
this builder
- Defined in src/boc/Builder.ts:424

storeStringTail

storeStringTail(src): Builder
Store string tail
Parameters
- src: string
  source string
Returns Builder
this builder
- Defined in src/boc/Builder.ts:399

storeUint

storeUint(value, bits): Builder
Store uint value
Parameters
- value: number | bigint
  value as bigint or number
- bits: number
  number of bits to write
Returns Builder
this builder
- Defined in src/boc/Builder.ts:126

storeVarInt

storeVarInt(value, bits): Builder
Store varint value
Parameters
- value: number | bigint
  value as bigint or number
- bits: number
  number of bits to write to header
Returns Builder
this builder
- Defined in src/boc/Builder.ts:207

storeVarUint

storeVarUint(value, bits): Builder
Store varuint value
Parameters
- value: number | bigint
  value as bigint or number
- bits: number
  number of bits to write to header
Returns Builder
this builder
- Defined in src/boc/Builder.ts:180

storeWritable

storeWritable(writer): Builder
Store writer or builder
Parameters
- writer: Writable | ((builder) => void)
  writer or builder to store
Returns Builder
this builder
- Defined in src/boc/Builder.ts:361