Class Builder

Builder for Cells

Constructors

constructor

new Builder(): Builder
Returns Builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:28

Accessors

availableBits

get availableBits(): number
Available bits

Returns number
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:40

availableRefs

get availableRefs(): number
Available references

Returns number
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:44

bits

get bits(): number
Bits written so far

Returns number
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:32

refs

get refs(): number
References written so far

Returns number
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:36

Methods

asCell

asCell(): Cell
Convert to cell

Returns Cell
cell
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:244

asSlice

asSlice(): Slice
Convert to slice

Returns Slice
slice
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:249

endCell

endCell(opts?: { exotic?: boolean }): Cell
Complete cell
Parameters
- Optionalopts: { exotic?: boolean }
  options
Returns Cell
cell
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:237

store

store(writer: Writable | ((builder: Builder) => void)): this
Store object in this builder
Parameters
- writer: Writable | ((builder: Builder) => void)
  Writable or writer functuin
Returns this
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:195

storeAddress

storeAddress(address: Maybe<Address | ExternalAddress>): this
Store address
Parameters
- address: Maybe<Address | ExternalAddress>
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:144

storeBit

storeBit(value: number | boolean): this
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 this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:50

storeBits

storeBits(src: BitString): this
Write bits from BitString
Parameters
- src: BitString
  source bits
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:56

storeBuffer

storeBuffer(src: Buffer, bytes?: Maybe<number>): this
Store Buffer
Parameters
- src: Buffer
  source buffer
- Optionalbytes: Maybe<number>
  optional number of bytes to write
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:63

storeBuilder

storeBuilder(src: Builder): this
Store builder
Parameters
- src: Builder
  builder to store
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:172

storeCoins

storeCoins(amount: number | bigint): this
Store coins value
Parameters
- amount: number | bigint
  amount of coins
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:132

storeDict

storeDict<K extends DictionaryKeyTypes, V>(
    dict?: Maybe<Dictionary<K, V>>,
    key?: Maybe<DictionaryKey<K>>,
    value?: Maybe<DictionaryValue<V>>,
): this
Store dictionary in this builder
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- Optionaldict: Maybe<Dictionary<K, V>>
  dictionary to store
- Optionalkey: Maybe<DictionaryKey<K>>
- Optionalvalue: Maybe<DictionaryValue<V>>
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:225

storeDictDirect

storeDictDirect<K extends DictionaryKeyTypes, V>(
    dict: Dictionary<K, V>,
    key?: Maybe<DictionaryKey<K>>,
    value?: Maybe<DictionaryValue<V>>,
): this
Store dictionary in this builder directly
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- dict: Dictionary<K, V>
  dictionary to store
- Optionalkey: Maybe<DictionaryKey<K>>
- Optionalvalue: Maybe<DictionaryValue<V>>
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:231

storeInt

storeInt(value: number | bigint, bits: number): this
Store int value
Parameters
- value: number | bigint
  value as bigint or number
- bits: number
  number of bits to write
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:91

storeMaybeBuffer

storeMaybeBuffer(src: null | Buffer, bytes?: Maybe<number>): this
Store Maybe Buffer
Parameters
- src: null | Buffer
  source buffer or null
- Optionalbytes: Maybe<number>
  optional number of bytes to write
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:70

storeMaybeBuilder

storeMaybeBuilder(src?: Maybe<Builder>): this
Store builder if not null
Parameters
- Optionalsrc: Maybe<Builder>
  builder to store
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:178

storeMaybeCoins

storeMaybeCoins(amount: Maybe<number | bigint>): this
Store maybe coins value
Parameters
- amount: Maybe<number | bigint>
  amount of coins, null or undefined
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:138

storeMaybeInt

storeMaybeInt(value: Maybe<number | bigint>, bits: number): this
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 this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:98

storeMaybeRef

storeMaybeRef(cell?: Maybe<Cell | Builder>): this
Store reference if not null
Parameters
- Optionalcell: Maybe<Cell | Builder>
  cell or builder to store
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:156

storeMaybeSlice

storeMaybeSlice(src?: Maybe<Slice>): this
Store slice in this builder if not null
Parameters
- Optionalsrc: Maybe<Slice>
  source slice
Returns this
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:166

storeMaybeStringRefTail

storeMaybeStringRefTail(src?: Maybe<null | string>): this
Store maybe string tail in ref
Parameters
- Optionalsrc: Maybe<null | string>
  source string
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:219

storeMaybeStringTail

storeMaybeStringTail(src?: Maybe<string>): this
Store string tail
Parameters
- Optionalsrc: Maybe<string>
  source string
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:207

storeMaybeUint

storeMaybeUint(value: Maybe<number | bigint>, bits: number): this
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 this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:84

storeMaybeVarInt

storeMaybeVarInt(value: Maybe<number | bigint>, bits: number): this
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 this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:126

storeMaybeVarUint

storeMaybeVarUint(value: Maybe<number | bigint>, bits: number): this
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 this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:112

storeMaybeWritable

storeMaybeWritable(
writer?: Maybe<Writable | ((builder: Builder) => void)>,
): this
Store writer or builder if not null
Parameters
- Optionalwriter: Maybe<Writable | ((builder: Builder) => void)>
  writer or builder to store
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:190

storeRef

storeRef(cell: Cell | Builder): this
Store reference
Parameters
- cell: Cell | Builder
  cell or builder to store
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:150

storeSlice

storeSlice(src: Slice): this
Store slice it in this builder
Parameters
- src: Slice
  source slice
Returns this
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:161

storeStringRefTail

storeStringRefTail(src: string): this
Store string tail in ref
Parameters
- src: string
  source string
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:213

storeStringTail

storeStringTail(src: string): this
Store string tail
Parameters
- src: string
  source string
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:201

storeUint

storeUint(value: number | bigint, bits: number): this
Store uint value
Parameters
- value: number | bigint
  value as bigint or number
- bits: number
  number of bits to write
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:77

storeVarInt

storeVarInt(value: number | bigint, bits: number): this
Store varint value
Parameters
- value: number | bigint
  value as bigint or number
- bits: number
  number of bits to write to header
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:119

storeVarUint

storeVarUint(value: number | bigint, bits: number): this
Store varuint value
Parameters
- value: number | bigint
  value as bigint or number
- bits: number
  number of bits to write to header
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:105

storeWritable

storeWritable(writer: ((builder: Builder) => void) | Writable): this
Store writer or builder
Parameters
- writer: ((builder: Builder) => void) | Writable
  writer or builder to store
Returns this
this builder
- Defined in node_modules/@ton/core/dist/boc/Builder.d.ts:184

Class Builder

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Builder

Accessors

availableBits

Returns number

availableRefs

Returns number

bits

Returns number

refs

Returns number

Methods

asCell

Returns Cell

asSlice

Returns Slice

endCell

Parameters

Returns Cell

store

Parameters

Returns this

storeAddress

Parameters

Returns this

storeBit

Parameters

Returns this

storeBits

Parameters

Returns this

storeBuffer

Parameters

Returns this

storeBuilder

Parameters

Returns this

storeCoins

Parameters

Returns this

storeDict

Type Parameters

Parameters

Returns this

storeDictDirect

Type Parameters

Parameters

Returns this

storeInt

Parameters

Returns this

storeMaybeBuffer

Parameters

Returns this

storeMaybeBuilder

Parameters

Returns this

storeMaybeCoins

Parameters

Returns this

storeMaybeInt

Parameters

Returns this

storeMaybeRef

Parameters

Returns this

storeMaybeSlice

Parameters

Returns this

storeMaybeStringRefTail

Parameters

Returns this

storeMaybeStringTail

Parameters