Class Builder

Builder for Cells

Hierarchy

Builder

Constructors

constructor

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

Properties

`Private` _bits

_bits: any

`Private` _refs

_refs: any

Accessors

availableBits

get availableBits(): number
Available bits

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

availableRefs

get availableRefs(): number
Available references

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

bits

get bits(): number
Bits written so far

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

refs

get refs(): number
References written so far

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

Methods

asCell

asCell(): Cell
Convert to cell

Returns
cell

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

asSlice

asSlice(): Slice
Convert to slice

Returns
slice

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

endCell

endCell(): Cell
Complete cell

Returns
cell

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

store

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

storeAddress

storeAddress(address: Maybe<Address | ExternalAddress>): Builder
Store address

Returns
this builder
Parameters
- address: Maybe<Address | ExternalAddress>
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:129

storeBit

storeBit(value: number | boolean): Builder
Write a single bit

Returns
this builder
Parameters
- value: number | boolean
  
  bit to write, true or positive number for 1, false or zero or negative for 0
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:43

storeBits

storeBits(src: BitString): Builder
Write bits from BitString

Returns
this builder
Parameters
- src: BitString
  
  source bits
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:49

storeBuffer

storeBuffer(src: Buffer): Builder
Store Buffer

Returns
this builder
Parameters
- src: Buffer
  
  source buffer
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:55

storeBuilder

storeBuilder(src: Builder): Builder
Store builder

Returns
this builder
Parameters
- src: Builder
  
  builder to store
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:157

storeCoins

storeCoins(amount: number | bigint): Builder
Store coins value

Returns
this builder
Parameters
- amount: number | bigint
  
  amount of coins
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:117

storeDict

storeDict<K, V>(dict?: Maybe<Dictionary<K, V>>): Builder
Store dictionary in this builder

Returns
this builder
Type Parameters
- K
- V
Parameters
- Optional dict: Maybe<Dictionary<K, V>>
  
  dictionary to store
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:210

storeDictDirect

storeDictDirect<K, V>(dict: Dictionary<K, V>): Builder
Store dictionary in this builder directly

Returns
this builder
Type Parameters
- K
- V
Parameters
- dict: Dictionary<K, V>
  
  dictionary to store
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:216

storeInt

storeInt(value: number | bigint, bits: number): Builder
Store int value

Returns
this builder
Parameters
- value: number | bigint
  
  value as bigint or number
- bits: number
  
  number of bits to write
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:76

storeMaybeBuilder

storeMaybeBuilder(src?: Maybe<Builder>): Builder
Store builder if not null

Returns
this builder
Parameters
- Optional src: Maybe<Builder>
  
  builder to store
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:163

storeMaybeCoins

storeMaybeCoins(amount: Maybe<number | bigint>): Builder
Store maybe coins value

Returns
this builder
Parameters
- amount: Maybe<number | bigint>
  
  amount of coins, null or undefined
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:123

storeMaybeInt

storeMaybeInt(value: Maybe<number | bigint>, bits: number): Builder
Store maybe int value

Returns
this builder
Parameters
- value: Maybe<number | bigint>
  
  value as bigint or number, null or undefined
- bits: number
  
  number of bits to write
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:83

storeMaybeRef

storeMaybeRef(cell?: Maybe<Cell | Builder>): Builder
Store reference if not null

Returns
this builder
Parameters
- Optional cell: Maybe<Cell | Builder>
  
  cell or builder to store
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:141

storeMaybeSlice

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

storeMaybeStringRefTail

storeMaybeStringRefTail(src?: Maybe<null | string>): Builder
Store maybe string tail in ref

Returns
this builder
Parameters
- Optional src: Maybe<null | string>
  
  source string
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:204

storeMaybeStringTail

storeMaybeStringTail(src?: Maybe<string>): Builder
Store string tail

Returns
this builder
Parameters
- Optional src: Maybe<string>
  
  source string
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:192

storeMaybeUint

storeMaybeUint(value: Maybe<number | bigint>, bits: number): Builder
Store maybe uint value

Returns
this builder
Parameters
- value: Maybe<number | bigint>
  
  value as bigint or number, null or undefined
- bits: number
  
  number of bits to write
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:69

storeMaybeVarInt

storeMaybeVarInt(value: Maybe<number | bigint>, bits: number): Builder
Store maybe varint value

Returns
this builder
Parameters
- value: Maybe<number | bigint>
  
  value as bigint or number, null or undefined
- bits: number
  
  number of bits to write to header
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:111

storeMaybeVarUint

storeMaybeVarUint(value: Maybe<number | bigint>, bits: number): Builder
Store maybe varuint value

Returns
this builder
Parameters
- value: Maybe<number | bigint>
  
  value as bigint or number, null or undefined
- bits: number
  
  number of bits to write to header
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:97

storeMaybeWritable

storeMaybeWritable(writer?: Maybe<Writable | ((builder: Builder) => void)>): Builder
Store writer or builder if not null

Returns
this builder
Parameters
- Optional writer: Maybe<Writable | ((builder: Builder) => void)>
  
  writer or builder to store
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:175

storeRef

storeRef(cell: Cell | Builder): Builder
Store reference

Returns
this builder
Parameters
- cell: Cell | Builder
  
  cell or builder to store
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:135

storeSlice

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

storeStringRefTail

storeStringRefTail(src: string): Builder
Store string tail in ref

Returns
this builder
Parameters
- src: string
  
  source string
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:198

storeStringTail

storeStringTail(src: string): Builder
Store string tail

Returns
this builder
Parameters
- src: string
  
  source string
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:186

storeUint

storeUint(value: number | bigint, bits: number): Builder
Store uint value

Returns
this builder
Parameters
- value: number | bigint
  
  value as bigint or number
- bits: number
  
  number of bits to write
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:62

storeVarInt

storeVarInt(value: number | bigint, bits: number): Builder
Store varint value

Returns
this builder
Parameters
- value: number | bigint
  
  value as bigint or number
- bits: number
  
  number of bits to write to header
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:104

storeVarUint

storeVarUint(value: number | bigint, bits: number): Builder
Store varuint value

Returns
this builder
Parameters
- value: number | bigint
  
  value as bigint or number
- bits: number
  
  number of bits to write to header
Returns Builder
- Defined in node_modules/ton-core/dist/boc/Builder.d.ts:90

storeWritable

storeWritable(writer: Writable | ((builder: Builder) => void)): Builder
Store writer or builder

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

Generated using TypeDoc