@circle-fin/usdckit - v0.18.0
    Preparing search index...

    Type Alias TransferParams

    Parameters for the transfer function.

    type TransferParams = {
        amount:
            | NativeUnits
            | BaseUnits
            | ((account: Account) => Promise<NativeUnits | BaseUnits>);
        chain?: Chain;
        fees?:
            | FeeValuesEIP1559
            | ((params: EstimateFeesPerGasParams) => Promise<FeeValuesEIP1559>);
        from?: Address | Account | (Address | Account)[];
        gas?: bigint;
        to: Address | Account;
        token?: Address | ChainContract | null;
    }
    Index

    Properties

    amount chain? fees? from? gas? to token?

    Properties

    amount:
        | NativeUnits
        | BaseUnits
        | ((account: Account) => Promise<NativeUnits | BaseUnits>)

    The amount to be transferred. Can be specified directly or as a function that returns a promise resolving to the amount.

    chain?: Chain

    The blockchain network on which the transaction will be executed.

    fees?:
        | FeeValuesEIP1559
        | ((params: EstimateFeesPerGasParams) => Promise<FeeValuesEIP1559>)

    The fee values for the transaction. Can be specified directly or as a function that returns a promise resolving to the fee values.

    from?: Address | Account | (Address | Account)[]

    The sender's address or account. Can be a single address/account or an array of addresses/accounts.

    gas?: bigint

    The gas limit for the transaction.

    to: Address | Account

    The recipient's address or account.

    token?: Address | ChainContract | null

    The address of the token or chain contract, if applicable.

    Settings

    Member Visibility

    On This Page

    Properties