Class CoinMigratorClient

The CoinMigratorClient class provides methods to interact with the Coin Migrator contract on the Aptos blockchain. It extends the AptosContractWrapperBaseClass and includes functionalities to convert coins to FA and vice versa, as well as retrieve the FA address.

Remarks

This client is designed to work with the Coin Migrator contract and provides a high-level API for coin migration operations. The client can be instantiated in two ways:

  1. Using the constructor directly with a provider and optional signer
  2. Using the static buildWithDefaultSigner method which automatically configures the client with the provider's pool profile account

Example

// Using buildWithDefaultSigner
const provider = new AptosProvider();
const client = CoinMigratorClient.buildWithDefaultSigner(provider);

// Using constructor directly
const provider = new AptosProvider();
const signer = provider.getPoolProfileAccount();
const client = new CoinMigratorClient(provider, signer);

// Convert coins to FA
const tx = await client.coinToFa(1000n, "0x1::aptos_coin::AptosCoin");

Param: provider

The AptosProvider instance used to interact with the Aptos blockchain.

Param: signer

Optional Ed25519Account signer for transaction signing.

Hierarchy (View Summary)

Constructors

constructor

Properties

coinMigratorContract

Methods

aptosCoinToFa buildTx callViewMethod coinToFa fundAccount getAccounAptBalance getAptosCoinFaAddress getEventsFromAccount getFaAddress getFaBalance getSigner getTxEvents sendTxAndAwaitResponse setSigner withModuleSigner withSigner buildWithDefaultSigner

Constructors

constructor

Properties

coinMigratorContract

coinMigratorContract: CoinMigratorContract

Methods

aptosCoinToFa

  • aptosCoinToFa(amount: bigint): Promise<CommittedTransactionResponse>

    Converts a specified amount of Aptos Coins to FA (Fungible Asset).

    Parameters

    • amount: bigint

      The amount of coins to be converted, represented as a bigint.

    Returns Promise<CommittedTransactionResponse>

    A promise that resolves to a CommittedTransactionResponse object containing the transaction details.

buildTx

  • buildTx(
        user: AccountAddress,
        functionId: `${string}::${string}::${string}`,
        funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[],
        typeArgs?: string[],
    ): Promise<SimpleTransaction>

    Builds a transaction for the specified user, function, and arguments.

    Parameters

    • user: AccountAddress

      The account address of the user initiating the transaction.

    • functionId: `${string}::${string}::${string}`

      The identifier of the Move function to be called.

    • funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[]

      An array of arguments for the entry function.

    • typeArgs: string[] = []

    Returns Promise<SimpleTransaction>

    A promise that resolves to a SimpleTransaction object.

callViewMethod

  • callViewMethod<T extends MoveValue[]>(
        functionId: `${string}::${string}::${string}`,
        funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[],
        typeArgs?: string[],
    ): Promise<T>

    Calls a view method on the Aptos blockchain.

    Type Parameters

    • T extends MoveValue[]

      The type of the return value, which extends an array of MoveValue.

    Parameters

    • functionId: `${string}::${string}::${string}`

      The identifier of the function to call.

    • funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[]

      The arguments to pass to the function.

    • typeArgs: string[] = []

      Optional generic type arguments for the function (e.g. ["0x1::aptos_coin::AptosCoin"]).

    Returns Promise<T>

    • A promise that resolves to the result of the view method call.

coinToFa

  • coinToFa(
        amount: bigint,
        coinType: string,
    ): Promise<CommittedTransactionResponse>

    Converts a specified amount of coins to FA (Fungible Asset).

    Parameters

    • amount: bigint

      The amount of coins to be converted, represented as a bigint.

    • coinType: string

      The coin type generic over CoinType e.g. "0x1::aptos_coin::AptosCoin".

    Returns Promise<CommittedTransactionResponse>

    A promise that resolves to a CommittedTransactionResponse object containing the transaction details.

fundAccount

  • fundAccount(
        account: AccountAddress,
        amount: bigint,
    ): Promise<UserTransactionResponse>

    Funds an account with a specified amount.

    Parameters

    • account: AccountAddress

      The address of the account to be funded.

    • amount: bigint

      The amount to fund the account with, in bigint.

    Returns Promise<UserTransactionResponse>

    A promise that resolves to a UserTransactionResponse.

getAccounAptBalance

  • getAccounAptBalance(
        account: Ed25519Account,
        accountAddress: AccountAddress,
        versionToWaitFor?: bigint,
    ): Promise<bigint>

    Retrieves the Aptos balance of a specified account.

    Parameters

    • account: Ed25519Account

      The Ed25519 account object.

    • accountAddress: AccountAddress

      The address of the account to retrieve the balance for.

    • OptionalversionToWaitFor: bigint

      (Optional) The specific version to wait for before retrieving the balance.

    Returns Promise<bigint>

    A promise that resolves to the balance of the account in bigint.

getAptosCoinFaAddress

  • getAptosCoinFaAddress(): Promise<AccountAddress>

    Retrieves the FA (Fungible Address) associated with the Aptos Coin migrator contract.

    This method calls the GetFaAddrFuncAddr view method on the coin migrator contract and maps the response to an AccountAddress object.

    Returns Promise<AccountAddress>

    A promise that resolves to the FA address as an AccountAddress object.

getEventsFromAccount

  • getEventsFromAccount(
        account: AccountAddress,
        limit: number,
    ): Promise<
        {
            account_address: string;
            creation_number: any;
            data: any;
            event_index: any;
            indexed_type: string;
            sequence_number: any;
            transaction_block_height: any;
            transaction_version: any;
            type: string;
        }[],
    >

    Retrieves events associated with a specific account.

    Parameters

    • account: AccountAddress

      The address of the account to retrieve events for.

    • limit: number

      The maximum number of events to retrieve.

    Returns Promise<
        {
            account_address: string;
            creation_number: any;
            data: any;
            event_index: any;
            indexed_type: string;
            sequence_number: any;
            transaction_block_height: any;
            transaction_version: any;
            type: string;
        }[],
    >

    A promise that resolves to an array of event objects, each containing:

    • account_address: The address of the account.
    • creation_number: The creation number of the event.
    • data: The data associated with the event.
    • event_index: The index of the event.
    • sequence_number: The sequence number of the event.
    • transaction_block_height: The block height of the transaction.
    • transaction_version: The version of the transaction.
    • type: The type of the event.
    • indexed_type: The indexed type of the event.

getFaAddress

  • getFaAddress(coinType: string): Promise<AccountAddress>

    Retrieves the FA (Fungible Address) associated with the coin migrator contract.

    Parameters

    • coinType: string

      The coin type generic over CoinType e.g. "0x1::aptos_coin::AptosCoin". This method calls the GetFaAddrFuncAddr view method on the coin migrator contract and maps the response to an AccountAddress object.

    Returns Promise<AccountAddress>

    A promise that resolves to the FA address as an AccountAddress object.

getFaBalance

  • getFaBalance(coinType: string, owner: AccountAddress): Promise<bigint>

    Retrieves the FA (Fungible Address) balance associated with the coin migrator contract.

    Parameters

    • coinType: string

      The coin type generic over CoinType e.g. "0x1::aptos_coin::AptosCoin". This method calls the getFaBalanceFuncAddr view method on the coin migrator contract and maps the response to bigint.

    • owner: AccountAddress

    Returns Promise<bigint>

    A promise that resolves to the FA balance as a bigint.

getSigner

getTxEvents

  • getTxEvents(txHash: HexInput): Promise<{ data: unknown }[]>

    Retrieves the events associated with a given transaction hash.

    Parameters

    • txHash: HexInput

      The hash of the transaction to retrieve events for.

    Returns Promise<{ data: unknown }[]>

    A promise that resolves to an array of objects containing the event data.

    Remarks

    This method fetches the transaction details using the provided Aptos provider. It then checks if the transaction response is of type BlockMetadataTransactionResponse or UserTransactionResponse to extract the events. The event data is parsed from JSON and returned in an array.

sendTxAndAwaitResponse

  • sendTxAndAwaitResponse(
        functionId: `${string}::${string}::${string}`,
        funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[],
        typeArgs?: string[],
    ): Promise<CommittedTransactionResponse>

    Sends a transaction and awaits the response.

    Parameters

    • functionId: `${string}::${string}::${string}`

      The ID of the Move function to be called.

    • funcArgs: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[]

      An array of arguments for the entry function.

    • typeArgs: string[] = []

    Returns Promise<CommittedTransactionResponse>

    A promise that resolves to the committed transaction response.

setSigner

withModuleSigner

withSigner

StaticbuildWithDefaultSigner

Settings

Member Visibility

On This Page

Constructors
Properties
Methods