Type Alias AptosSettings

Configuration options for initializing the SDK, allowing customization of its behavior and interaction with the Aptos network.

type AptosSettings = {
    archivalFallback?: boolean;
    client?: Client;
    clientConfig?: ClientConfig;
    faucet?: string;
    faucetConfig?: FaucetConfig;
    fullnode?: string;
    fullnodeConfig?: FullNodeConfig;
    indexer?: string;
    indexerConfig?: IndexerConfig;
    network?: Network;
    pepper?: string;
    pluginSettings?: PluginSettings;
    prover?: string;
    transactionGenerationConfig?: TransactionGenerationConfig;
}

Index

Properties

archivalFallback? client? clientConfig? faucet? faucetConfig? fullnode? fullnodeConfig? indexer? indexerConfig? network? pepper? pluginSettings? prover? transactionGenerationConfig?

Properties

`Optional` `Readonly`archivalFallback

archivalFallback?: boolean

Whether reads of pruned history are retried against the archival endpoint the node advertises. Defaults to true.

`Optional` `Readonly`client

client?: Client

`Optional` `Readonly`clientConfig

clientConfig?: ClientConfig

`Optional` `Readonly`faucet

faucet?: string

`Optional` `Readonly`faucetConfig

faucetConfig?: FaucetConfig

`Optional` `Readonly`fullnode

fullnode?: string

`Optional` `Readonly`fullnodeConfig

fullnodeConfig?: FullNodeConfig

`Optional` `Readonly`indexer

indexer?: string

`Optional` `Readonly`indexerConfig

indexerConfig?: IndexerConfig

`Optional` `Readonly`network

network?: Network

`Optional` `Readonly`pepper

pepper?: string

`Optional` `Readonly`pluginSettings

pluginSettings?: PluginSettings

`Optional` `Readonly`prover

prover?: string

`Optional` `Readonly`transactionGenerationConfig

transactionGenerationConfig?: TransactionGenerationConfig