Class Submit

constructor

• new Submit(config): Submit

• 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 Submit

  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, // Use the TESTNET for testing
          nodeUrl: "https://testnet.aptos.dev", // Specify the node URL
          faucetUrl: "https://faucet.testnet.aptos.dev" // Specify the faucet URL
      });
  
      // Initialize the Aptos client with the configuration
      const aptos = new Aptos(config);
  
      console.log("Aptos client initialized:", aptos);
  }
  runExample().catch(console.error);
  Copy

multiAgent

• multiAgent(args): Promise<PendingTransactionResponse>

• Submits a multi-agent transaction to the Aptos network, allowing multiple signers to authorize the transaction. This function is useful for scenarios where a transaction requires approval from multiple accounts.

  Parameters

  • args: {
        additionalSignersAuthenticators: AccountAuthenticator[];
        feePayerAuthenticator?: AccountAuthenticator;
        senderAuthenticator: AccountAuthenticator;
        transaction: AnyRawTransaction;
    }

    The parameters for the multi-agent transaction.

    • additionalSignersAuthenticators: AccountAuthenticator[]

      An array of authenticators for additional signers.

    • OptionalfeePayerAuthenticator?: AccountAuthenticator

      An optional authenticator for the fee payer account.

    • senderAuthenticator: AccountAuthenticator

      The authenticator for the sender account.

    • transaction: AnyRawTransaction

      The raw transaction to be submitted.

  Returns Promise<PendingTransactionResponse>

  Example

  import { Aptos, AptosConfig, Network, Account } from "@aptos-labs/ts-sdk";
  
  const config = new AptosConfig({ network: Network.TESTNET });
  const aptos = new Aptos(config);
  
  async function runExample() {
    const sender = Account.generate(); // Generate a new sender account
    const additionalSigner1 = Account.generate(); // Generate an additional signer account
    const additionalSigner2 = Account.generate(); // Generate another additional signer account
  
    const transaction = await aptos.transaction.build.simple({
      sender: sender.accountAddress,
      data: {
        function: "0x1::aptos_account::transfer",
        functionArguments: [additionalSigner1.accountAddress, 100],
      },
    });
  
    const response = await aptos.multiAgent({
      transaction,
      senderAuthenticator: sender.getAuthenticator(), // Use the sender's authenticator
      additionalSignersAuthenticators: [
        additionalSigner1.getAuthenticator(), // Use the first additional signer's authenticator
        additionalSigner2.getAuthenticator(), // Use the second additional signer's authenticator
      ],
    });
  
    console.log(response); // Log the response from the transaction submission
  }
  runExample().catch(console.error);
  Copy

simple

• simple(args): Promise<PendingTransactionResponse>

• Submits a transaction to the Aptos blockchain using the provided transaction details and authenticators. This function allows you to execute transactions securely by specifying the sender and optional fee payer authenticators.

  Parameters

  • args: {
        feePayerAuthenticator?: AccountAuthenticator;
        senderAuthenticator: AccountAuthenticator;
        transaction: AnyRawTransaction;
    }

    The arguments for submitting the transaction.

    • OptionalfeePayerAuthenticator?: AccountAuthenticator

      The optional authenticator for the fee payer's account.

    • senderAuthenticator: AccountAuthenticator

      The authenticator for the sender's account.

    • transaction: AnyRawTransaction

      The raw transaction data to be submitted.

  Returns Promise<PendingTransactionResponse>

  Example

  import { Aptos, AptosConfig, Network, Account } from "@aptos-labs/ts-sdk";
  
  const config = new AptosConfig({ network: Network.TESTNET });
  const aptos = new Aptos(config);
  
  async function runExample() {
    const sender = Account.generate(); // Generate a new sender account
    const transaction = await aptos.transaction.build.simple({
      sender: sender.accountAddress,
      data: {
        function: "0x1::aptos_account::transfer",
        functionArguments: [Account.generate().accountAddress, 100], // Replace with a real destination account
      },
    });
  
    // Submit the transaction
    const response = await aptos.simple({
      transaction,
      senderAuthenticator: sender.getAuthenticator(), // Use the sender's authenticator
    });
  
    console.log("Transaction submitted:", response);
  }
  runExample().catch(console.error);
  Copy

Readonlyconfig