Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BigMapAbstraction

Hierarchy

  • BigMapAbstraction

Index

Constructors

constructor

Methods

get

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

    Fetch one value in a big map

    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

getMultipleValues

  • 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.

    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

toJSON

  • toJSON(): string

toString

  • toString(): string

Generated using TypeDoc