Class Dictionary<K, V>

Type Parameters

K extends DictionaryKeyTypes
V

Index

Constructors

`Private` constructor

new Dictionary<K, V>(values, key, value): Dictionary<K, V>
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- values: Map<string, V>
- key: null | DictionaryKey<K>
- value: null | DictionaryValue<V>
Returns Dictionary<K, V>
- Defined in src/dict/Dictionary.ts:282

Properties

`Private` `Readonly` _key

_key: null | DictionaryKey<K>

`Private` `Readonly` _map

_map: Map<string, V>

`Private` `Readonly` _value

_value: null | DictionaryValue<V>

`Static` Keys

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

Type declaration

Address: (() => DictionaryKey<Address>)
Standard address key

Returns
DictionaryKey
- - (): DictionaryKey<Address>
  - Returns DictionaryKey<Address>
BigInt: ((bits) => DictionaryKey<bigint>)
Create standard big integer key

Returns
DictionaryKey
- - (bits): DictionaryKey<bigint>
  - Parameters
    - bits: number
      number of bits
    Returns DictionaryKey<bigint>
BigUint: ((bits) => DictionaryKey<bigint>)
Create standard unsigned big integer key

Returns
DictionaryKey
- - (bits): DictionaryKey<bigint>
  - Parameters
    - bits: number
      number of bits
    Returns DictionaryKey<bigint>
BitString: ((bits) => DictionaryKey<BitString>)
Create BitString key

Returns
DictionaryKey Point is that Buffer has to be 8 bit aligned, while key is TVM dictionary doesn't have to be aligned at all.
- - (bits): DictionaryKey<BitString>
  - Parameters
    - bits: number
      key length
    Returns DictionaryKey<BitString>
Buffer: ((bytes) => DictionaryKey<Buffer>)
Create standard buffer key

Returns
DictionaryKey
- - (bytes): DictionaryKey<Buffer>
  - Parameters
    - bytes: number
      number of bytes of a buffer
    Returns DictionaryKey<Buffer>
Int: ((bits) => DictionaryKey<number>)
Create integer key

Returns
DictionaryKey
- - (bits): DictionaryKey<number>
  - Parameters
    - bits: number
      bits of integer
    Returns DictionaryKey<number>
Uint: ((bits) => DictionaryKey<number>)
Create standard unsigned integer key

Returns
DictionaryKey
- - (bits): DictionaryKey<number>
  - Parameters
    - bits: number
      number of bits
    Returns DictionaryKey<number>

`Static` Values

Values: {
    Address: (() => DictionaryValue<Address>);
    BigInt: ((bits) => DictionaryValue<bigint>);
    BigUint: ((bits) => DictionaryValue<bigint>);
    BigVarInt: ((bits) => DictionaryValue<bigint>);
    BigVarUint: ((bits) => DictionaryValue<bigint>);
    BitString: ((bits) => DictionaryValue<BitString>);
    Bool: (() => DictionaryValue<boolean>);
    Buffer: ((bytes) => DictionaryValue<Buffer>);
    Cell: (() => DictionaryValue<Cell>);
    Dictionary: (<K, V>(key, value) => DictionaryValue<Dictionary<K, V>>);
    Int: ((bits) => DictionaryValue<number>);
    Uint: ((bits) => DictionaryValue<number>);
} = ...

Type declaration

Address: (() => DictionaryValue<Address>)
Create standard address value

Returns
DictionaryValue
- - (): DictionaryValue<Address>
  - Returns DictionaryValue<Address>
BigInt: ((bits) => DictionaryValue<bigint>)
Create standard integer value

Returns
DictionaryValue
- - (bits): DictionaryValue<bigint>
  - Parameters
    - bits: number
    Returns DictionaryValue<bigint>
BigUint: ((bits) => DictionaryValue<bigint>)
Create standard unsigned integer value

Returns
DictionaryValue
- - (bits): DictionaryValue<bigint>
  - Parameters
    - bits: number
      number of bits
    Returns DictionaryValue<bigint>
BigVarInt: ((bits) => DictionaryValue<bigint>)
Create big var int

Returns
DictionaryValue
- - (bits): DictionaryValue<bigint>
  - Parameters
    - bits: number
      nubmer of header bits
    Returns DictionaryValue<bigint>
BigVarUint: ((bits) => DictionaryValue<bigint>)
Create big var int

Returns
DictionaryValue
- - (bits): DictionaryValue<bigint>
  - Parameters
    - bits: number
      nubmer of header bits
    Returns DictionaryValue<bigint>
BitString: ((bits) => DictionaryValue<BitString>)
Create BitString value

Returns
DictionaryValue Point is that Buffer is not applicable when length is not 8 bit alligned.
- - (bits): DictionaryValue<BitString>
  - Parameters
    - bits: number
    Returns DictionaryValue<BitString>
Bool: (() => DictionaryValue<boolean>)
Create standard boolean value

Returns
DictionaryValue
- - (): DictionaryValue<boolean>
  - Returns DictionaryValue<boolean>
Buffer: ((bytes) => DictionaryValue<Buffer>)
Create Builder value

Returns
DictionaryValue
- - (bytes): DictionaryValue<Buffer>
  - Parameters
    - bytes: number
      number of bytes of a buffer
    Returns DictionaryValue<Buffer>
Cell: (() => DictionaryValue<Cell>)
Create standard cell value

Returns
DictionaryValue
- - (): DictionaryValue<Cell>
  - Returns DictionaryValue<Cell>
Dictionary: (<K, V>(key, value) => DictionaryValue<Dictionary<K, V>>)
Create dictionary value
- - <K, V>(key, value): DictionaryValue<Dictionary<K, V>>
  - Type Parameters
    - K extends DictionaryKeyTypes
    - V
    Parameters
    - key: DictionaryKey<K>
    - value: DictionaryValue<V>
    Returns DictionaryValue<Dictionary<K, V>>
Int: ((bits) => DictionaryValue<number>)
Create standard integer value

Returns
DictionaryValue
- - (bits): DictionaryValue<number>
  - Parameters
    - bits: number
    Returns DictionaryValue<number>
Uint: ((bits) => DictionaryValue<number>)
Create standard unsigned integer value

Returns
DictionaryValue
- - (bits): DictionaryValue<number>
  - Parameters
    - bits: number
      number of bits
    Returns DictionaryValue<number>

Accessors

size

get size(): number
Returns number
- Defined in src/dict/Dictionary.ts:288

Methods

[iterator]

[iterator](): IterableIterator<[K, V]>
Returns IterableIterator<[K, V]>
- Defined in src/dict/Dictionary.ts:314

clear

clear(): void
Returns void
- Defined in src/dict/Dictionary.ts:310

delete

delete(key): boolean
Parameters
- key: K
Returns boolean
- Defined in src/dict/Dictionary.ts:305

generateMerkleProof

generateMerkleProof(keys): 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 src/dict/Dictionary.ts:400

generateMerkleProofDirect

generateMerkleProofDirect(keys): 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 src/dict/Dictionary.ts:410

generateMerkleUpdate

generateMerkleUpdate(key, newValue): Cell
Parameters
- key: K
- newValue: V
Returns Cell
- Defined in src/dict/Dictionary.ts:414

get

get(key): undefined | V
Parameters
- key: K
Returns undefined | V
- Defined in src/dict/Dictionary.ts:292

has

has(key): boolean
Parameters
- key: K
Returns boolean
- Defined in src/dict/Dictionary.ts:296

keys

keys(): K[]
Returns K[]
- Defined in src/dict/Dictionary.ts:321

set

set(key, value): this
Parameters
- key: K
- value: V
Returns this
- Defined in src/dict/Dictionary.ts:300

store

store(builder, key?, value?): void
Parameters
- builder: Builder
- Optional key: Maybe<DictionaryKey<K>>
- Optional value: Maybe<DictionaryValue<V>>
Returns void
- Defined in src/dict/Dictionary.ts:329

storeDirect

storeDirect(builder, key?, value?): void
Parameters
- builder: Builder
- Optional key: Maybe<DictionaryKey<K>>
- Optional value: Maybe<DictionaryValue<V>>
Returns void
- Defined in src/dict/Dictionary.ts:364

values

values(): V[]
Returns V[]
- Defined in src/dict/Dictionary.ts:325

`Static` empty

empty<K, V>(key?, value?): Dictionary<K, V>
Create an empty map
Type Parameters
- K extends DictionaryKeyTypes
- V
Parameters
- Optional key: Maybe<DictionaryKey<K>>
  key type
- Optional value: Maybe<DictionaryValue<V>>
  value type
Returns Dictionary<K, V>
Dictionary<K, V>
- Defined in src/dict/Dictionary.ts:218

`Static` load

load<K, V>(key, value, sc): 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: Slice | Cell
Returns Dictionary<K, V>
Dictionary<K, V>
- Defined in src/dict/Dictionary.ts:233

`Static` loadDirect

loadDirect<K, V>(key, value, sc): 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 | Slice | Cell
  slice
Returns Dictionary<K, V>
Dictionary<K, V>
- Defined in src/dict/Dictionary.ts:260

Class Dictionary<K, V>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Type Parameters

Parameters

Returns Dictionary<K, V>

Properties

Private Readonly _key

Private Readonly _map

Private Readonly _value

Static Keys

Type declaration

Address: (() => DictionaryKey<Address>)

Returns

Returns DictionaryKey<Address>

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

Returns

Parameters

Returns DictionaryKey<bigint>

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

Returns

Parameters

Returns DictionaryKey<bigint>

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

Returns

Parameters

Returns DictionaryKey<BitString>

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

Returns

Parameters

Returns DictionaryKey<Buffer>

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

Returns

Parameters

Returns DictionaryKey<number>

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

Returns

Parameters

Returns DictionaryKey<number>

Static Values

Type declaration

Address: (() => DictionaryValue<Address>)

Returns

Returns DictionaryValue<Address>

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

Returns

Parameters

Returns DictionaryValue<bigint>

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

Returns

Parameters

Returns DictionaryValue<bigint>

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

Returns

Parameters

Returns DictionaryValue<bigint>

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

Returns

Parameters

Returns DictionaryValue<bigint>

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

Returns

Parameters

Returns DictionaryValue<BitString>

Bool: (() => DictionaryValue<boolean>)

Returns

Returns DictionaryValue<boolean>

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

Returns

Parameters

Returns DictionaryValue<Buffer>

Cell: (() => DictionaryValue<Cell>)

Returns

Returns DictionaryValue<Cell>

`Private` constructor

`Private` `Readonly` _key

`Private` `Readonly` _map

`Private` `Readonly` _value

`Static` Keys

`Static` Values

`Static` empty

`Static` load

`Static` loadDirect