Class MichelsonMap<K, T>

constructor

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

  Type Parameters

  • K extends MichelsonMapKey
  • T

  Parameters

  • OptionalmapType: 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: K): void

  Parameters

  • key: K

  Returns void

entries

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

  Returns Generator<[K, T]>

forEach

• forEach(cb: (value: T, key: K, map: MichelsonMap<K, T>) => void): void

  Parameters

  • cb: (value: T, key: K, map: MichelsonMap<K, T>) => void

  Returns void

get

• get(key: K): T | undefined

  Parameters

  • key: K

  Returns T | undefined

has

• has(key: K): boolean

  Parameters

  • key: K

  Returns boolean

keys

• keys(): Generator<K>

  Returns Generator<K>

removeType

• removeType(): void

  Returns void

set

• set(key: K, value: T): void

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

  Parameters

  • key: K
  • value: T

  Returns void

  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

  Remarks

  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: MichelsonV1Expression): void

  Parameters

  • mapType: MichelsonV1Expression

  Returns void

values

• values(): Generator<T>

  Returns Generator<T>

StaticfromLiteral

• fromLiteral(
      obj: { [key: string]: any },
      mapType?: MichelsonV1Expression,
  ): MichelsonMap<MichelsonMapKey, unknown>

  Parameters

  • obj: { [key: string]: any }
  • OptionalmapType: MichelsonV1Expression

  Returns MichelsonMap<MichelsonMapKey, unknown>

StaticisMichelsonMap

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

  Parameters

  • obj: any

  Returns obj is MichelsonMap<any, any>