Class TransactionManagement

constructor

• new TransactionManagement(config: AptosConfig): TransactionManagement

  Initializes a new instance of the Aptos client with the provided configuration settings. This allows you to interact with the Aptos blockchain using the specified network and options.

  Parameters

  • config: AptosConfig

    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.

    • constructor:function

      • new AptosConfig(settings?: AptosSettings): AptosConfig

        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.

        Parameters

        • Optionalsettings: AptosSettings

          Optional configuration settings for the Aptos client.

          • Optional Readonlyclient?: Client

          • Optional ReadonlyclientConfig?: ClientConfig

          • Optional Readonlyfaucet?: string

          • Optional ReadonlyfaucetConfig?: FaucetConfig

          • Optional Readonlyfullnode?: string

          • Optional ReadonlyfullnodeConfig?: FullNodeConfig

          • Optional Readonlyindexer?: string

          • Optional ReadonlyindexerConfig?: IndexerConfig

          • Optional Readonlynetwork?: Network

          • Optional Readonlypepper?: string

          • Optional Readonlyprover?: string

        Returns AptosConfig

        Example

        import { 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);
        Copy

    • Readonlyclient: Client

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

    • Optional ReadonlyclientConfig?: ClientConfig

      Optional client configurations

    • Optional Readonlyfaucet?: string

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

    • Optional ReadonlyfaucetConfig?: FaucetConfig

      Optional specific Faucet configurations

    • Optional Readonlyfullnode?: string

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

    • Optional ReadonlyfullnodeConfig?: ClientHeadersType

      Optional specific Fullnode configurations

    • Optional Readonlyindexer?: string

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

    • Optional ReadonlyindexerConfig?: ClientHeadersType

      Optional specific Indexer configurations

    • Readonlynetwork: Network

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

    • Optional Readonlypepper?: string

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

    • Optional Readonlyprover?: string

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

    • getRequestUrl:function

      • getRequestUrl(apiType: AptosApiType): string

        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.

        Parameters

        • apiType: AptosApiType

          The type of Aptos API to get the URL for. This can be one of the following: FULLNODE, FAUCET, INDEXER, PEPPER, PROVER.

        Returns string

        Example

        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);
        Copy

    • isPepperServiceRequest:function

      • isPepperServiceRequest(url: string): boolean

        Checks if the provided URL is a known pepper service endpoint.

        Parameters

        • url: string

          The URL to check against the known pepper service endpoints.

        Returns boolean

        Example

        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);
        Copy

    • isProverServiceRequest:function

      • isProverServiceRequest(url: string): boolean

        Checks if the provided URL is a known prover service endpoint.

        Parameters

        • url: string

          The URL to check against known prover service endpoints.

        Returns boolean

        A boolean indicating whether the URL is a known prover service endpoint.

        Example

        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}`);
        Copy

  Returns TransactionManagement

  Example

  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 network to use
          nodeUrl: "https://testnet.aptos.dev" // replace with your node URL
      });
  
      // Initialize the Aptos client with the configuration
      const aptos = new Aptos(config);
  
      console.log("Aptos client initialized successfully.");
  }
  runExample().catch(console.error);
  Copy

forSingleAccount

• forSingleAccount(
      args: {
          data: InputGenerateTransactionPayloadData[];
          options?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">;
          sender: Account;
      },
  ): void

  Send batch transactions for a single account.

  This function uses a transaction worker that receives payloads to be processed and submitted to chain. Note that this process is best for submitting multiple transactions that don't rely on each other, i.e. batch funds, batch token mints, etc.

  If any worker failure, the functions throws an error.

  Parameters

  • args: {
        data: InputGenerateTransactionPayloadData[];
        options?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">;
        sender: Account;
    }

    • data: InputGenerateTransactionPayloadData[]

      An array of transaction payloads

    • Optionaloptions?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">

      optional. Transaction generation configurations (excluding accountSequenceNumber)

    • sender: Account

      The sender account to sign and submit the transaction

  Returns void

  void. Throws if any error

account

Readonlyconfig

transactionWorker