@aptos-labs/ts-sdk/dist/internal/table.js

Aptos TypeScript SDK

import { postAptosFullNode } from "../client/index.js";
import { GetTableItemsData, GetTableItemsMetadata } from "../types/generated/queries.js";
import { queryIndexer } from "./general.js";
/**
 * Retrieves a specific item from a table in the Aptos blockchain.
 *
 * @param args - The arguments for retrieving the table item.
 * @param args.aptosConfig - The configuration for connecting to the Aptos blockchain.
 * @param args.handle - The identifier for the table from which to retrieve the item.
 * @param args.data - The request data for the table item.
 * @param args.options - Optional parameters for the request, including ledger version.
 * @group Implementation
 */
export async function getTableItem(args) {
    const { aptosConfig, handle, data, options } = args;
    const response = await postAptosFullNode({
        aptosConfig,
        originMethod: "getTableItem",
        path: `tables/${handle}/item`,
        params: { ledger_version: options?.ledgerVersion },
        body: data,
    });
    return response.data;
}
/**
 * Retrieves table items data based on specified conditions and pagination options.
 *
 * @param args - The arguments for retrieving table items data.
 * @param args.aptosConfig - The configuration object for Aptos.
 * @param args.options - Optional parameters for pagination and filtering.
 * @param args.options.offset - The number of items to skip before starting to collect the result set.
 * @param args.options.limit - The maximum number of items to return.
 * @param args.options.where - Conditions to filter the table items.
 * @param args.options.orderBy - The criteria to sort the results.
 * @group Implementation
 */
export async function getTableItemsData(args) {
    const { aptosConfig, options } = args;
    const graphqlQuery = {
        query: GetTableItemsData,
        variables: {
            where_condition: options?.where,
            offset: options?.offset,
            limit: options?.limit,
            order_by: options?.orderBy,
        },
    };
    const data = await queryIndexer({
        aptosConfig,
        query: graphqlQuery,
        originMethod: "getTableItemsData",
    });
    return data.table_items;
}
/**
 * Retrieves metadata for table items based on specified options.
 *
 * @param args - The arguments for retrieving table items metadata.
 * @param args.aptosConfig - The configuration object for Aptos.
 * @param args.options - Optional parameters for pagination and filtering.
 * @param args.options.offset - The number of items to skip before starting to collect the result set.
 * @param args.options.limit - The maximum number of items to return.
 * @param args.options.where - Conditions to filter the results.
 * @param args.options.orderBy - The order in which to return the results.
 * @returns A promise that resolves to an array of table metadata.
 * @group Implementation
 */
export async function getTableItemsMetadata(args) {
    const { aptosConfig, options } = args;
    const graphqlQuery = {
        query: GetTableItemsMetadata,
        variables: {
            where_condition: options?.where,
            offset: options?.offset,
            limit: options?.limit,
            order_by: options?.orderBy,
        },
    };
    const data = await queryIndexer({
        aptosConfig,
        query: graphqlQuery,
        originMethod: "getTableItemsMetadata",
    });
    return data.table_metadatas;
}
//# sourceMappingURL=table.js.map