Initializes a new instance of the Aptos client with the provided configuration.
The configuration settings for the Aptos client.
Represents the configuration settings for an Aptos SDK client instance. This class allows customization of various endpoints and client settings.
Initializes an instance of the Aptos client with the specified settings. This allows users to configure various aspects of the client, such as network and endpoints.
Optionalsettings: AptosSettingsOptional configuration settings for the Aptos client.
Optional Readonlyclient?: ClientOptional ReadonlyclientConfig?: ClientConfigOptional Readonlyfaucet?: stringOptional ReadonlyfaucetConfig?: FaucetConfigOptional Readonlyfullnode?: stringOptional ReadonlyfullnodeConfig?: FullNodeConfigOptional Readonlyindexer?: stringOptional ReadonlyindexerConfig?: IndexerConfigOptional Readonlynetwork?: NetworkOptional Readonlypepper?: stringOptional Readonlyprover?: stringimport { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
async function runExample() {
// Create a new Aptos client with default settings
const config = new AptosConfig({ network: Network.TESTNET }); // Specify the network
const aptos = new Aptos(config);
console.log("Aptos client initialized:", aptos);
}
runExample().catch(console.error);
Readonlyclient: ClientThe client instance the SDK uses. Defaults to `@aptos-labs/aptos-client
Optional ReadonlyclientConfig?: ClientConfigOptional client configurations
Optional Readonlyfaucet?: stringThe optional hardcoded faucet URL to send requests to instead of using the network
Optional ReadonlyfaucetConfig?: FaucetConfigOptional specific Faucet configurations
Optional Readonlyfullnode?: stringThe optional hardcoded fullnode URL to send requests to instead of using the network
Optional ReadonlyfullnodeConfig?: ClientHeadersTypeOptional specific Fullnode configurations
Optional Readonlyindexer?: stringThe optional hardcoded indexer URL to send requests to instead of using the network
Optional ReadonlyindexerConfig?: ClientHeadersTypeOptional specific Indexer configurations
Readonlynetwork: NetworkThe Network that this SDK is associated with. Defaults to DEVNET
Optional Readonlypepper?: stringThe optional hardcoded pepper service URL to send requests to instead of using the network
Optional Readonlyprover?: stringThe optional hardcoded prover service URL to send requests to instead of using the network
Returns the URL endpoint to send the request to based on the specified API type. If a custom URL was provided in the configuration, that URL is returned. Otherwise, the URL endpoint is derived from the network.
The type of Aptos API to get the URL for. This can be one of the following: FULLNODE, FAUCET, INDEXER, PEPPER, PROVER.
import { Aptos, AptosConfig, Network, AptosApiType } from "@aptos-labs/ts-sdk";
const config = new AptosConfig({ network: Network.TESTNET });
const aptos = new Aptos(config);
async function runExample() {
// Getting the request URL for the FULLNODE API
const url = config.getRequestUrl(AptosApiType.FULLNODE);
console.log("Request URL for FULLNODE:", url);
}
runExample().catch(console.error);
Checks if the provided URL is a known pepper service endpoint.
The URL to check against the known pepper service endpoints.
import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
const config = new AptosConfig({ network: Network.TESTNET });
const aptos = new Aptos(config);
async function runExample() {
const url = "https://example.pepper.service"; // replace with a real pepper service URL
// Check if the URL is a known pepper service endpoint
const isPepperService = config.isPepperServiceRequest(url);
console.log(`Is the URL a known pepper service? ${isPepperService}`);
}
runExample().catch(console.error);
Checks if the provided URL is a known prover service endpoint.
The URL to check against known prover service endpoints.
A boolean indicating whether the URL is a known prover service endpoint.
import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
const config = new AptosConfig({ network: Network.TESTNET });
const aptos = new Aptos(config);
// Check if the URL is a known prover service endpoint
const url = "https://prover.testnet.aptos.dev"; // replace with a real URL if needed
const isProver = config.isProverServiceRequest(url);
console.log(`Is the URL a known prover service? ${isProver}`);
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);
Retrieve events associated with a specific account address and creation number.
The parameters for retrieving account events.
The account address to query events for.
The event creation number to filter the events.
OptionalminimumLedgerVersion?: AnyNumberOptional minimum ledger version to sync up to before querying.
Promise
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);
Retrieve events associated with a specific account address and event type.
The account address to query events for.
The type of event to filter by.
OptionalminimumLedgerVersion?: AnyNumberOptional ledger version to sync up to before querying.
Optionaloptions?: PaginationArgs & OrderByArg<Optional pagination and ordering parameters for the event query.
Promise
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);
Retrieve all events from the Aptos blockchain.
An optional where clause can be provided to filter the results based on specific criteria.
Optionalargs: {Optional parameters for the query.
OptionalminimumLedgerVersion?: AnyNumberOptional ledger version to sync up to before querying.
Optionaloptions?: PaginationArgs & OrderByArg<Optional pagination and filtering options.
GetEventsQuery response type containing the events.
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);
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.
The arguments for retrieving module events.
The event type to filter the results.
OptionalminimumLedgerVersion?: AnyNumberOptional ledger version to sync up to before querying.
Optionaloptions?: PaginationArgs & OrderByArg<Optional pagination and ordering parameters for the event results.
Promise
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);
A class to query all
EventAptos related queries.