Class AptosConfig

This class holds the config information for the SDK client instance.

Example

const aptosConfig = new AptosConfig({network:Network.TESTNET})

Constructors

constructor

Properties

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

Methods

getRequestUrl isPepperServiceRequest isProverServiceRequest

Constructors

constructor

  • new AptosConfig(settings?): AptosConfig

  • Parameters

    Returns AptosConfig

Properties

Readonlyclient

client: Client

The client instance the SDK uses. Defaults to `@aptos-labs/aptos-client

Optional ReadonlyclientConfig

clientConfig?: ClientConfig

Optional client configurations

Optional Readonlyfaucet

faucet?: string

The optional hardcoded faucet URL to send requests to instead of using the network

Optional ReadonlyfaucetConfig

faucetConfig?: FaucetConfig

Optional specific Faucet configurations

Optional Readonlyfullnode

fullnode?: string

The optional hardcoded fullnode URL to send requests to instead of using the network

Optional ReadonlyfullnodeConfig

fullnodeConfig?: ClientHeadersType

Optional specific Fullnode configurations

Optional Readonlyindexer

indexer?: string

The optional hardcoded indexer URL to send requests to instead of using the network

Optional ReadonlyindexerConfig

indexerConfig?: ClientHeadersType

Optional specific Indexer configurations

Readonlynetwork

network: Network

The Network that this SDK is associated with. Defaults to DEVNET

Optional Readonlypepper

pepper?: string

The optional hardcoded pepper service URL to send requests to instead of using the network

Optional Readonlyprover

prover?: string

The optional hardcoded prover service URL to send requests to instead of using the network

Methods

getRequestUrl

  • getRequestUrl(apiType): string
  • Internal

    Returns the URL endpoint to send the request to. If a custom URL was provided in the config, that URL is returned. If a custom URL was provided but not URL endpoints, an error is thrown. Otherwise, the URL endpoint is derived from the network.

    Parameters

    • apiType: AptosApiType

      The type of Aptos API to get the URL for.

    Returns string

isPepperServiceRequest

  • isPepperServiceRequest(url): boolean
  • Internal

    Checks if the URL is a known pepper service endpoint

    Parameters

    • url: string

    Returns boolean

isProverServiceRequest

  • isProverServiceRequest(url): boolean
  • Internal

    Checks if the URL is a known prover service endpoint

    Parameters

    • url: string

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods