Builder.md

ton3-core / Builder

Class: Builder

Cell Builder

Table of contents

Constructors

• constructor

Accessors

• size
• bits
• bytes
• refs
• remainder

Methods

• storeSlice
• storeRef
• storeMaybeRef
• storeRefs
• storeBit
• storeBits
• storeInt
• storeUint
• storeVarInt
• storeVarUint
• storeBytes
• storeString
• storeAddress
• storeCoins
• storeDict
• clone
• cell

Constructors

constructor

• new Builder(size?)

Parameters

Name	Type	Default value
size	number	1023

Accessors

size

• get size(): number

Returns instance maximum allowed size in bits.

readonly

Returns

number

---

bits

• get bits(): Bit[]

Returns instance stored bits Bit.

readonly

Returns

Bit[]

---

bytes

• get bytes(): Uint8Array

Returns instance stored bits in bytes.

readonly

Returns

Uint8Array

---

refs

• get refs(): Cell[]

Returns instance stored refs Cell.

readonly

Returns

Cell[]

---

remainder

• get remainder(): number

Returns instance unused space in bits.

readonly

Returns

number

Methods

storeSlice

▸ storeSlice(slice): Builder

Merge Slice into instance.

Parameters

Name	Type	Description
slice	Slice	An instance of a Slice.

Returns

Builder

---

storeRef

▸ storeRef(ref): Builder

Add cell to instance refs.

Parameters

Name	Type	Description
ref	Cell	Cell to reference.

Returns

Builder

---

storeMaybeRef

▸ storeMaybeRef(ref): Builder

Add unary one bit and cell to instance refs or unary zero bit.

Parameters

Name	Type	Description
ref	Cell	Cell or null to reference.

Returns

Builder

---

storeRefs

▸ storeRefs(refs): Builder

Add multiple cells to instance refs.

Parameters

Name	Type	Description
refs	Cell[]	Array of Cell to reference.

Returns

Builder

---

storeBit

▸ storeBit(bit): Builder

Store one bit in instance.

Parameters

Name	Type	Description
bit	BitLike	1 or 0.

Returns

Builder

---

storeBits

▸ storeBits(bits): Builder

Store multiple bits as array in instance.

Parameters

Name	Type	Description
bits	BitLike[]	Array of 1 and/or 0.

Returns

Builder

---

storeInt

▸ storeInt(value, size): Builder

Store an integer in instance.

Parameters

Name	Type	Description
value	number | bigint	Int.
size	number	Size in bits of allocated space for value.

Returns

Builder

---

storeUint

▸ storeUint(value, size): Builder

Store an unsigned integer in instance.

Parameters

Name	Type	Description
value	number | bigint	UInt.
size	number	Size in bits of allocated space for value.

Returns

Builder

---

storeVarInt

▸ storeVarInt(value, length): Builder

Parameters

Name	Type
value	number | bigint
length	number

Returns

Builder

---

storeVarUint

▸ storeVarUint(value, length): Builder

Parameters

Name	Type
value	number | bigint
length	number

Returns

Builder

---

storeBytes

▸ storeBytes(value): Builder

Store a bytes array in instance.

Parameters

Name	Type	Description
value	Uint8Array | number[]	Array of bytes.

Returns

Builder

---

storeString

▸ storeString(value): Builder

Store a string in instance.

Parameters

Name	Type	Description
value	string	Any string, Unicode is suppported.

Returns

Builder

---

storeAddress

▸ storeAddress(address): Builder

Store an Address in instance.

Parameters

Name	Type	Description
address	Address	Smart contract address as Address or as null.

Returns

Builder

---

storeCoins

▸ storeCoins(coins): Builder

Store a Coins in instance.

Parameters

Name	Type	Description
coins	Coins	Toncoin as Coins.

Returns

Builder

---

storeDict

▸ storeDict(hashmap): Builder

Store a HashmapE in instance.

Parameters

Name	Type	Description
hashmap	HashmapE<any, any>	HashmapE.

Returns

Builder

---

clone

▸ clone(): Builder

Returns this instance copy as a new instance.

Returns

Builder

---

cell

▸ cell(type?): Cell

Returns builded Cell.

example

import { Builder } from 'ton3-core'

const bits = [ 1, 0, 0, 1 ]
const cell = new Builder(bits.length)
    .storeBits(bits)
    .cell()

Parameters

Name	Type	Default value
type	CellType	CellType.Ordinary

Returns

Cell