Class Dictionary<K, V>

Type Parameters

K extends DictionaryKeyTypes
V

Index

Properties

Accessors

Methods

[iterator] clear delete generateMerkleProof generateMerkleProofDirect generateMerkleUpdate get has keys set store storeDirect values empty load loadDirect

Properties

`Static`Keys

Keys: {
    Address: () => DictionaryKey<Address>;
    BigInt: (bits: number) => DictionaryKey<bigint>;
    BigUint: (bits: number) => DictionaryKey<bigint>;
    BitString: (bits: number) => DictionaryKey<BitString>;
    Buffer: (bytes: number) => DictionaryKey<Buffer>;
    Int: (bits: number) => DictionaryKey<number>;
    Uint: (bits: number) => DictionaryKey<number>;
}

Type declaration

Address: () => DictionaryKey<Address>
Standard address key
BigInt: (bits: number) => DictionaryKey<bigint>
Create standard big integer key
BigUint: (bits: number) => DictionaryKey<bigint>
Create standard unsigned big integer key
BitString: (bits: number) => DictionaryKey<BitString>
Create BitString key
Buffer: (bytes: number) => DictionaryKey<Buffer>
Create standard buffer key
Int: (bits: number) => DictionaryKey<number>
Create integer key
Uint: (bits: number) => DictionaryKey<number>
Create standard unsigned integer key

`Static`Values

Values: {
    Address: () => DictionaryValue<Address>;
    BigInt: (bits: number) => DictionaryValue<bigint>;
    BigUint: (bits: number) => DictionaryValue<bigint>;
    BigVarInt: (bits: number) => DictionaryValue<bigint>;
    BigVarUint: (bits: number) => DictionaryValue<bigint>;
    BitString: (bits: number) => DictionaryValue<BitString>;
    Bool: () => DictionaryValue<boolean>;
    Buffer: (bytes: number) => DictionaryValue<Buffer>;
    Cell: () => DictionaryValue<Cell>;
    Dictionary: <K_1 extends DictionaryKeyTypes, V_1>(
        key: DictionaryKey<K_1>,
        value: DictionaryValue<V_1>,
    ) => DictionaryValue<Dictionary<K_1, V_1>>;
    Int: (bits: number) => DictionaryValue<number>;
    Uint: (bits: number) => DictionaryValue<number>;
}

Type declaration

Address: () => DictionaryValue<Address>
Create standard address value
BigInt: (bits: number) => DictionaryValue<bigint>
Create standard integer value
BigUint: (bits: number) => DictionaryValue<bigint>
Create standard unsigned integer value
BigVarInt: (bits: number) => DictionaryValue<bigint>
Create big var int
BigVarUint: (bits: number) => DictionaryValue<bigint>
Create big var int
BitString: (bits: number) => DictionaryValue<BitString>
Create BitString value
Bool: () => DictionaryValue<boolean>
Create standard boolean value
Buffer: (bytes: number) => DictionaryValue<Buffer>
Create Builder value
Cell: () => DictionaryValue<Cell>
Create standard cell value
Dictionary: <K_1 extends DictionaryKeyTypes, V_1>(
key: DictionaryKey<K_1>,
value: DictionaryValue<V_1>,
) => DictionaryValue<Dictionary<K_1, V_1>>
Create dictionary value
Int: (bits: number) => DictionaryValue<number>
Create standard integer value
Uint: (bits: number) => DictionaryValue<number>
Create standard unsigned integer value

Accessors

size

get size(): number
Returns number
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:172

Methods

[iterator]

"[iterator]"(): IterableIterator<[K, V]>
Returns IterableIterator<[K, V]>
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:178

clear

clear(): void
Returns void
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:177

delete

delete(key: K): boolean
Parameters
- key: K
Returns boolean
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:176

generateMerkleProof

generateMerkleProof(keys: K[]): Cell
Generate merkle proof for multiple keys in the dictionary
Parameters
- keys: K[]
  an array of the keys
Returns Cell
generated merkle proof cell
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:188

generateMerkleProofDirect

generateMerkleProofDirect(keys: K[]): Cell
Low level method for generating pruned dictionary directly. The result can be used as a part of a bigger merkle proof
Parameters
- keys: K[]
  an array of the keys
Returns Cell
cell that contains the pruned dictionary
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:195

generateMerkleUpdate

generateMerkleUpdate(key: K, newValue: V): Cell
Parameters
- key: K
- newValue: V
Returns Cell
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:196

get

get(key: K): undefined | V
Parameters
- key: K
Returns undefined | V
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:173

has

has(key: K): boolean
Parameters
- key: K
Returns boolean
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:174

keys

keys(): K[]
Returns K[]
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:179

set

set(key: K, value: V): this
Parameters
- key: K
- value: V
Returns this
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:175

store

store(
    builder: Builder,
    key?: Maybe<DictionaryKey<K>>,
    value?: Maybe<DictionaryValue<V>>,
): void
Parameters
- builder: Builder
- Optionalkey: Maybe<DictionaryKey<K>>
- Optionalvalue: Maybe<DictionaryValue<V>>
Returns void
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:181

storeDirect

storeDirect(
    builder: Builder,
    key?: Maybe<DictionaryKey<K>>,
    value?: Maybe<DictionaryValue<V>>,
): void
Parameters
- builder: Builder
- Optionalkey: Maybe<DictionaryKey<K>>
- Optionalvalue: Maybe<DictionaryValue<V>>
Returns void
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:182

values

values(): V[]
Returns V[]
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:180

`Static`empty

empty<K extends DictionaryKeyTypes, V>(
key?: Maybe<DictionaryKey<K>>,
value?: Maybe<DictionaryValue<V>>,
): Dictionary<K, V>
Create an empty map
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- Optionalkey: Maybe<DictionaryKey<K>>
  key type
- Optionalvalue: Maybe<DictionaryValue<V>>
  value type
Returns Dictionary<K, V>
Dictionary<K, V>
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:149

`Static`load

load<K extends DictionaryKeyTypes, V>(
    key: DictionaryKey<K>,
    value: DictionaryValue<V>,
    sc: Cell | Slice,
): Dictionary<K, V>
Load dictionary from slice
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- key: DictionaryKey<K>
  key description
- value: DictionaryValue<V>
  value description
- sc: Cell | Slice
Returns Dictionary<K, V>
Dictionary<K, V>
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:157

`Static`loadDirect

loadDirect<K extends DictionaryKeyTypes, V>(
    key: DictionaryKey<K>,
    value: DictionaryValue<V>,
    sc: null | Cell | Slice,
): Dictionary<K, V>
Low level method for rare dictionaries from system contracts. Loads dictionary from slice directly without going to the ref.
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- key: DictionaryKey<K>
  key description
- value: DictionaryValue<V>
  value description
- sc: null | Cell | Slice
  slice
Returns Dictionary<K, V>
Dictionary<K, V>
- Defined in node_modules/@ton/core/dist/dict/Dictionary.d.ts:167

Class Dictionary<K, V>

Type Parameters

Index

Properties

Accessors

Methods

Properties

StaticKeys

Type declaration

Address: () => DictionaryKey<Address>

BigInt: (bits: number) => DictionaryKey<bigint>

BigUint: (bits: number) => DictionaryKey<bigint>

BitString: (bits: number) => DictionaryKey<BitString>

Buffer: (bytes: number) => DictionaryKey<Buffer>

Int: (bits: number) => DictionaryKey<number>

Uint: (bits: number) => DictionaryKey<number>

StaticValues

Type declaration

Address: () => DictionaryValue<Address>

BigInt: (bits: number) => DictionaryValue<bigint>

BigUint: (bits: number) => DictionaryValue<bigint>

BigVarInt: (bits: number) => DictionaryValue<bigint>

BigVarUint: (bits: number) => DictionaryValue<bigint>

BitString: (bits: number) => DictionaryValue<BitString>

Bool: () => DictionaryValue<boolean>

Buffer: (bytes: number) => DictionaryValue<Buffer>

Cell: () => DictionaryValue<Cell>

Dictionary: <K_1 extends DictionaryKeyTypes, V_1>( key: DictionaryKey<K_1>, value: DictionaryValue<V_1>,) => DictionaryValue<Dictionary<K_1, V_1>>

Int: (bits: number) => DictionaryValue<number>

Uint: (bits: number) => DictionaryValue<number>

Accessors

size

Returns number

Methods

[iterator]

Returns IterableIterator<[K, V]>

clear

Returns void

delete

Parameters

Returns boolean

generateMerkleProof

Parameters

Returns Cell

generateMerkleProofDirect

Parameters

Returns Cell

generateMerkleUpdate

Parameters

Returns Cell

get

Parameters

Returns undefined | V

has

Parameters

Returns boolean

keys

Returns K[]

set

Parameters

Returns this

store

Parameters

Returns void

storeDirect

Parameters

Returns void

values

Returns V[]

Staticempty

Type Parameters

Parameters

Returns Dictionary<K, V>

Staticload

Type Parameters

Parameters

Returns Dictionary<K, V>

StaticloadDirect

Type Parameters

Parameters

`Static`Keys

`Static`Values

Dictionary: <K_1 extends DictionaryKeyTypes, V_1>(
key: DictionaryKey<K_1>,
value: DictionaryValue<V_1>,
) => DictionaryValue<Dictionary<K_1, V_1>>

`Static`empty

`Static`load

`Static`loadDirect