Class BigMapAbstraction

Constructors

constructor

Methods

get getMultipleValues toJSON toString

Constructors

constructor

Methods

get

  • get<T>(keyToEncode, block?): Promise<undefined | T>

  • Type Parameters

    • T

    Parameters

    • keyToEncode: BigMapKeyType
    • Optional block: number

      optional block level to fetch the values from (head will be use by default)

    Returns Promise<undefined | T>

    Return a well formatted json object of a big map value or undefined if the key is not found in the big map

    Description

    Fetch one value in a big map

getMultipleValues

  • getMultipleValues<T>(keysToEncode, block?, batchSize?): Promise<MichelsonMap<MichelsonMapKey, undefined | T>>

  • Type Parameters

    • T

    Parameters

    • keysToEncode: BigMapKeyType[]

      Array of keys to query (will be encoded properly according to the schema)

    • Optional block: number

      optional block level to fetch the values from

    • batchSize: number = 5

      optional batch size representing the number of requests to execute in parallel

    Returns Promise<MichelsonMap<MichelsonMapKey, undefined | T>>

    A MichelsonMap containing the keys queried in the big map and their value in a well-formatted JSON object format

    Description

    Fetch multiple values in a big map All values will be fetched on the same block level. If a block is specified in the request, the values will be fetched at it. Otherwise, a first request will be done to the node to fetch the level of the head and all values will be fetched at this level. If one of the keys does not exist in the big map, its value will be set to undefined.

toJSON

toString

Settings

Member Visibility

Theme

On This Page

constructorgetgetMultipleValuestoJSONtoString

Generated using TypeDoc