Class MichelsonMap<K, T>

constructor

• new MichelsonMap<K, T>(mapType?): MichelsonMap<K, T>

• Type Parameters

  • K extends MichelsonMapKey
  • T

  Parameters

  • Optional mapType: MichelsonV1Expression

    If specified key and value will be type-checked before being added to the map

  Returns MichelsonMap<K, T>

  Example

  new MichelsonMap({ prim: "map", args: [{prim: "string"}, {prim: "int"}]})
  Copy

[michelsonMapTypeSymbol]

size

• get size(): number

• Returns number

clear

• clear(): void

• Returns void

delete

• delete(key): void

• Parameters

  • key: K

  Returns void

entries

• entries(): Generator<[K, T], any, unknown>

• Returns Generator<[K, T], any, unknown>

forEach

• forEach(cb): void

• Parameters

  • cb: ((value, key, map) => void)
    • • (value, key, map): void

      • Parameters

        • value: T
        • key: K
        • map: MichelsonMap<K, T>

        Returns void

  Returns void

get

• get(key): undefined | T

• Parameters

  • key: K

  Returns undefined | T

has

• has(key): boolean

• Parameters

  • key: K

  Returns boolean

keys

• keys(): Generator<K, any, unknown>

• Returns Generator<K, any, unknown>

removeType

• removeType(): void

• Returns void

set

• set(key, value): void

• Parameters

  • key: K
  • value: T

  Returns void

  Description

  Set a key and a value in the MichelsonMap. If the key already exists, override the current value.

  Example

  map.set("myKey", "myValue") // Using a string as key
  Copy

  Example

  map.set({0: "test", 1: "test1"}, "myValue") // Using a pair as key
  Copy

  Warn

  The same key can be represented in multiple ways, depending on the type of the key. This duplicate key situation will cause a runtime error (duplicate key) when sending the map data to the Tezos RPC node.

  For example, consider a contract with a map whose key is of type boolean. If you set the following values in MichelsonMap: map.set(false, "myValue") and map.set(null, "myValue").

  You will get two unique entries in the MichelsonMap. These values will both be evaluated as falsy by the MichelsonEncoder and ultimately rejected by the Tezos RPC.

setType

• setType(mapType): void

• Parameters

  • mapType: MichelsonV1Expression

  Returns void

values

• values(): Generator<T, any, unknown>

• Returns Generator<T, any, unknown>

Static fromLiteral

• fromLiteral(obj, mapType?): MichelsonMap<MichelsonMapKey, unknown>

• Parameters

  • obj: {
        [key: string]: any;
    }

    • [key: string]: any

  • Optional mapType: MichelsonV1Expression

  Returns MichelsonMap<MichelsonMapKey, unknown>

Static isMichelsonMap

• isMichelsonMap(obj): obj is MichelsonMap<any, any>

• Parameters

  • obj: any

  Returns obj is MichelsonMap<any, any>