PHP WebShell
Текущая директория: /opt/BitGoJS/node_modules/@aptos-labs/ts-sdk/src/api
Просмотр файла: object.ts
// Copyright © Aptos Foundation
// SPDX-License-Identifier: Apache-2.0
import { AnyNumber, GetObjectDataQueryResponse, OrderByArg, PaginationArgs } from "../types";
import { AccountAddressInput } from "../core";
import { AptosConfig } from "./aptosConfig";
import { ProcessorType } from "../utils";
import { waitForIndexerOnVersion } from "./utils";
import { getObjectDataByObjectAddress } from "../internal/object";
/**
* A class to query all `Object` related queries on Aptos.
*/
export class AptosObject {
/**
* Creates an instance of the Aptos client with the provided configuration.
* This allows interaction with the Aptos blockchain using the specified settings.
*
* @param config - The configuration settings for the Aptos client.
* @param config.network - The network to connect to (e.g., mainnet, testnet).
* @param config.nodeUrl - The URL of the Aptos node to connect to.
* @param config.faucetUrl - The URL of the faucet for funding accounts (optional).
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* async function runExample() {
* // Create a configuration for the Aptos client
* const config = new AptosConfig({
* network: Network.TESTNET, // Specify the desired network
* nodeUrl: "https://testnet.aptos.dev", // Replace with your node URL
* });
*
* // Create an instance of the Aptos client
* const aptos = new Aptos(config);
*
* console.log("Aptos client created successfully", aptos);
* }
* runExample().catch(console.error);
* ```
*/
constructor(readonly config: AptosConfig) {}
/**
* Fetches the object data based on the specified object address.
*
* @param args.objectAddress - The object address to retrieve data for.
* @param args.minimumLedgerVersion - Optional minimum ledger version to wait for.
* @param args.options - Optional configuration options for pagination and ordering.
*
* @returns The object data corresponding to the provided address.
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* const config = new AptosConfig({ network: Network.TESTNET });
* const aptos = new Aptos(config);
*
* async function runExample() {
* // Fetching object data by object address
* const objectData = await aptos.getObjectDataByObjectAddress({
* objectAddress: "0x1", // replace with a real object address
* });
*
* console.log(objectData);
* }
* runExample().catch(console.error);
* ```
*/
async getObjectDataByObjectAddress(args: {
objectAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<GetObjectDataQueryResponse[0]>;
}): Promise<GetObjectDataQueryResponse[0]> {
await waitForIndexerOnVersion({
config: this.config,
minimumLedgerVersion: args.minimumLedgerVersion,
processorType: ProcessorType.OBJECT_PROCESSOR,
});
return getObjectDataByObjectAddress({
aptosConfig: this.config,
...args,
});
}
}
Выполнить команду
Для локальной разработки. Не используйте в интернете!