Class Coin

constructor

• new Coin(config: AptosConfig): Coin

  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 Coin

  Example

  import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
  
  async function runExample() {
      // Create a new Aptos client with testnet configuration
      const config = new AptosConfig({ network: Network.TESTNET });
      const aptos = new Aptos(config);
  
      console.log("Aptos client initialized:", aptos);
  }
  runExample().catch(console.error);
  Copy

transferCoinTransaction

• transferCoinTransaction(
      args: {
          amount: AnyNumber;
          coinType?: `${string}::${string}::${string}`;
          options?: InputGenerateTransactionOptions;
          recipient: AccountAddressInput;
          sender: AccountAddressInput;
      },
  ): Promise<SimpleTransaction>

  Generate a transfer coin transaction that can be simulated, signed, and submitted. This function helps you create a transaction to transfer a specified amount of coins from one account to another within the Aptos network.

  Parameters

  • args: {
        amount: AnyNumber;
        coinType?: `${string}::${string}::${string}`;
        options?: InputGenerateTransactionOptions;
        recipient: AccountAddressInput;
        sender: AccountAddressInput;
    }

    The arguments for the transfer transaction.

    • amount: AnyNumber

      The amount of coins to transfer.

    • OptionalcoinType?: `${string}::${string}::${string}`

      Optional. The coin struct type to transfer. Defaults to 0x1::aptos_coin::AptosCoin.

    • Optionaloptions?: InputGenerateTransactionOptions

      Optional. Additional options for generating the transaction.

    • recipient: AccountAddressInput

      The recipient account address.

    • sender: AccountAddressInput

      The sender account address.

  Returns Promise<SimpleTransaction>

  SimpleTransaction

  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() {
    // Generate a transfer coin transaction
    const transaction = await aptos.transferCoinTransaction({
      sender: "0x1", // replace with a real sender account address
      recipient: "0x2", // replace with a real recipient account address
      amount: 10,
    });
  
    console.log(transaction);
  }
  runExample().catch(console.error);
  Copy

Readonlyconfig