PHP WebShell
Текущая директория: /opt/BitGoJS/node_modules/@aptos-labs/ts-sdk/dist/esm/api
Просмотр файла: event.d.mts
import { GetEventsResponse } from '../types/indexer.mjs';
import { MoveStructId, AnyNumber, PaginationArgs, OrderByArg, WhereArg } from '../types/types.mjs';
import { EventsBoolExp } from '../types/generated/types.mjs';
import { AccountAddressInput } from '../core/accountAddress.mjs';
import { AptosConfig } from './aptosConfig.mjs';
import '../types/generated/operations.mjs';
import '../utils/apiEndpoints.mjs';
import '../bcs/serializer.mjs';
import '../core/hex.mjs';
import '../core/common.mjs';
import '../bcs/deserializer.mjs';
import '../transactions/instances/transactionArgument.mjs';
import '../utils/const.mjs';
/**
* A class to query all `Event` Aptos related queries.
*/
declare class Event {
readonly config: AptosConfig;
/**
* Initializes a new instance of the Aptos client with the provided configuration.
*
* @param config - The configuration settings for the Aptos client.
* @param config.network - The network to connect to (e.g., Testnet, Mainnet).
* @param config.nodeUrl - The URL of the Aptos node to connect to.
* @param config.faucetUrl - The URL of the faucet to use for funding accounts.
*
* @example
* ```typescript
* import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
*
* async function runExample() {
* // Create a new Aptos client with Testnet configuration
* const config = new AptosConfig({ network: Network.TESTNET }); // Specify your own network if needed
* const aptos = new Aptos(config);
*
* console.log("Aptos client initialized:", aptos);
* }
* runExample().catch(console.error);
* ```
*/
constructor(config: AptosConfig);
/**
* Retrieve module events based on a specified event type.
* This function allows you to query for events that are associated with a particular module event type in the Aptos blockchain.
*
* @param args - The arguments for retrieving module events.
* @param args.eventType - The event type to filter the results.
* @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
* @param args.options - Optional pagination and ordering parameters for the event results.
*
* @returns Promise<GetEventsResponse> - A promise that resolves to the retrieved events.
*
* @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() {
* // Retrieve module events for a specific event type
* const events = await aptos.getModuleEventsByEventType({
* eventType: "0x1::transaction_fee::FeeStatement", // specify the event type
* minimumLedgerVersion: 1, // optional: specify minimum ledger version if needed
* });
*
* console.log(events); // log the retrieved events
* }
* runExample().catch(console.error);
* ```
*/
getModuleEventsByEventType(args: {
eventType: MoveStructId;
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
}): Promise<GetEventsResponse>;
/**
* Retrieve events associated with a specific account address and creation number.
*
* @param args - The parameters for retrieving account events.
* @param args.accountAddress - The account address to query events for.
* @param args.creationNumber - The event creation number to filter the events.
* @param args.minimumLedgerVersion - Optional minimum ledger version to sync up to before querying.
*
* @returns Promise<GetEventsResponse>
*
* @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() {
* // Get events for the account at creation number 0
* const events = await aptos.getAccountEventsByCreationNumber({
* accountAddress: "0x1", // replace with a real account address
* creationNumber: 0,
* });
*
* console.log(events);
* }
* runExample().catch(console.error);
* ```
*/
getAccountEventsByCreationNumber(args: {
accountAddress: AccountAddressInput;
creationNumber: AnyNumber;
minimumLedgerVersion?: AnyNumber;
}): Promise<GetEventsResponse>;
/**
* Retrieve events associated with a specific account address and event type.
*
* @param args.accountAddress - The account address to query events for.
* @param args.eventType - The type of event to filter by.
* @param args.minimumLedgerVersion - Optional ledger version to sync up to before querying.
* @param args.options - Optional pagination and ordering parameters for the event query.
*
* @returns Promise<GetEventsResponse>
*
* @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() {
* // Get events for a specific account and event type
* const events = await aptos.getAccountEventsByEventType({
* accountAddress: "0x1", // replace with a real account address
* eventType: "0x1::transaction_fee::FeeStatement", // replace with a real event type
* minimumLedgerVersion: 1, // optional, specify if needed
* });
*
* console.log(events);
* }
* runExample().catch(console.error);
* ```
*/
getAccountEventsByEventType(args: {
accountAddress: AccountAddressInput;
eventType: MoveStructId;
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
}): Promise<GetEventsResponse>;
/**
* Retrieve all events from the Aptos blockchain.
* An optional `where` clause can be provided to filter the results based on specific criteria.
*
* @param args Optional parameters for the query.
* @param args.minimumLedgerVersion Optional ledger version to sync up to before querying.
* @param args.options Optional pagination and filtering options.
* @param args.options.where Optional condition to filter events.
* @param args.options.offset Optional pagination offset.
* @param args.options.limit Optional maximum number of events to return.
* @param args.options.orderBy Optional ordering of the results.
*
* @returns GetEventsQuery response type containing the events.
*
* @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() {
* // Retrieve all events
* const events = await aptos.getEvents();
*
* // Retrieve events with filtering by account address
* const whereCondition = {
* account_address: { _eq: "0x123" }, // replace with a real account address
* };
* const filteredEvents = await aptos.getEvents({
* options: { where: whereCondition },
* });
*
* console.log(events);
* console.log(filteredEvents);
* }
* runExample().catch(console.error);
* ```
*/
getEvents(args?: {
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<GetEventsResponse[0]> & WhereArg<EventsBoolExp>;
}): Promise<GetEventsResponse>;
}
export { Event };
Выполнить команду
Для локальной разработки. Не используйте в интернете!