Taquito TypeDocs
    Preparing search index...

    Interface StorageProvider

    interface StorageProvider {
        getBigMapKeyByID<T>(
            id: string,
            keyToEncode: BigMapKeyType,
            schema: Schema,
            block?: BlockIdentifier,
        ): Promise<T>;
        getBigMapKeysByID<T>(
            id: string,
            keysToEncode: BigMapKeyType[],
            schema: Schema,
            block?: BlockIdentifier,
            batchSize?: number,
        ): Promise<MichelsonMap<MichelsonMapKey, T | undefined>>;
        getBigMapValuesPageByID?<T>(
            id: string,
            schema: Schema,
            options?: BigMapValuesOptions,
        ): Promise<BigMapValuesPage<T>>;
        getSaplingDiffByID(
            id: string,
            block?: BlockIdentifier,
        ): Promise<SaplingDiffResponse>;
        getStorage<T>(
            contract: string,
            schema?: unknown,
            block?: BlockIdentifier,
        ): Promise<T>;
        isBigMapEmptyByID?(id: string, block?: BlockIdentifier): Promise<boolean>;
        listBigMapValuesByID?<T>(
            id: string,
            schema: Schema,
            options?: BigMapValuesOptions,
        ): Promise<T[]>;
    }

    Hierarchy (View Summary)

    Index
    getBigMapKeyByID getBigMapKeysByID getBigMapValuesPageByID? getSaplingDiffByID getStorage isBigMapEmptyByID? listBigMapValuesByID?

    • Fetch multiple values in a big map

      Type Parameters

      • T

      Parameters

      • id: string

        Big Map ID

      • keysToEncode: BigMapKeyType[]

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

      • schema: Schema

        Big Map schema (can be determined using your contract type)

      • Optionalblock: BlockIdentifier

        optional block level to fetch the values from

      • OptionalbatchSize: number

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

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

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

    • Optional. Return one finite page of decoded big-map values and the hash of the block it was read at The returned blockHash must be the exact hash of the block the values were read at.

      Type Parameters

      • T

      Parameters

      • id: string

        Big Map ID

      • schema: Schema

        Big Map schema (can be determined using your contract type)

      • Optionaloptions: BigMapValuesOptions

        optional offset, length and block of the page

      Returns Promise<BigMapValuesPage<T>>

    • Optional. Return one finite page of decoded big-map values with a single request at the given block

      Type Parameters

      • T

      Parameters

      • id: string

        Big Map ID

      • schema: Schema

        Big Map schema (can be determined using your contract type)

      • Optionaloptions: BigMapValuesOptions

        optional offset, length and block of the page

      Returns Promise<T[]>

    Settings
    Member Visibility

    On This Page
    Methods