Class Build

constructor

• new Build(config: AptosConfig): Build

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

  Parameters

  • config: AptosConfig

    The configuration settings for the Aptos client.

  Returns Build

  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
          nodeUrl: "https://testnet.aptos.dev", // specify the node URL
      });
  
      // Initialize the Aptos client
      const aptos = new Aptos(config);
  
      console.log("Aptos client initialized:", aptos);
  }
  runExample().catch(console.error);
  Copy

multiAgent

• multiAgent(
      args: {
          data: InputGenerateTransactionPayloadData;
          options?: InputGenerateTransactionOptions;
          secondarySignerAddresses: AccountAddressInput[];
          sender: AccountAddressInput;
          withFeePayer?: boolean;
      },
  ): Promise<MultiAgentTransaction>

  Build a multi-agent transaction that allows multiple signers to authorize a transaction.

  Parameters

  • args: {
        data: InputGenerateTransactionPayloadData;
        options?: InputGenerateTransactionOptions;
        secondarySignerAddresses: AccountAddressInput[];
        sender: AccountAddressInput;
        withFeePayer?: boolean;
    }

    The parameters for creating the multi-agent transaction.

    • data: InputGenerateTransactionPayloadData

      The transaction data.

    • Optionaloptions?: InputGenerateTransactionOptions

      Optional transaction configurations.

    • secondarySignerAddresses: AccountAddressInput[]

      An array of the secondary signers' account addresses.

    • sender: AccountAddressInput

      The sender account address.

    • OptionalwithFeePayer?: boolean

      Whether there is a fee payer for the transaction.

  Returns Promise<MultiAgentTransaction>

  MultiAgentTransaction

  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() {
    // Build a multi-agent transaction
    const transaction = await aptos.multiAgent({
      sender: "0x1", // replace with a real sender account address
      data: {
        // Transaction data structure
        function: "0x1::aptos_account::transfer",
        functionArguments: ["0x2", 100], // replace with a real destination account address and amount
      },
      secondarySignerAddresses: ["0x3", "0x4"], // replace with real secondary signer addresses
      options: {
        // Optional transaction configurations
        maxGasAmount: "1000",
        gasUnitPrice: "1",
      },
    });
  
    console.log(transaction);
  }
  runExample().catch(console.error);
  Copy

simple

• simple(
      args: {
          data: InputGenerateTransactionPayloadData;
          options?: InputGenerateTransactionOptions;
          sender: AccountAddressInput | Account;
          withFeePayer?: boolean;
      },
  ): Promise<SimpleTransaction>

  Build a simple transaction.

  This function allows you to create a transaction with specified sender and data.

  Parameters

  • args: {
        data: InputGenerateTransactionPayloadData;
        options?: InputGenerateTransactionOptions;
        sender: AccountAddressInput | Account;
        withFeePayer?: boolean;
    }

    • data: InputGenerateTransactionPayloadData

      The transaction data.

    • Optionaloptions?: InputGenerateTransactionOptions

      Optional transaction configurations.

    • sender: AccountAddressInput | Account

      The sender account or account address.

    • OptionalwithFeePayer?: boolean

      Whether there is a fee payer for the transaction.

  Returns Promise<SimpleTransaction>

  SimpleTransaction

  Example

  import { Account, Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
  
  const config = new AptosConfig({ network: Network.TESTNET });
  const aptos = new Aptos(config);
  const sender = Account.generate();
  
  async function runExample() {
    // Build a simple transaction
    const transaction = await aptos.transaction.build.simple({
      sender,
      data: {
        function: "0x1::aptos_account::transfer",
        functionArguments: ["0x2", 100], // replace with a real destination account address
      },
      options: {
        gasUnitPrice: 100, // specify your own gas unit price if needed
        maxGasAmount: 1000, // specify your own max gas amount if needed
      },
    });
  
    console.log(transaction);
  }
  runExample().catch(console.error);
  Copy

Readonlyconfig