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

    Class Provider

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    circle_createContractExecutionTransaction circle_createTransaction circle_createWallets circle_createWalletSet circle_deriveWallet circle_estimateContractExecutionFee circle_estimateTransferFee circle_getNotificationSignature circle_getTransaction circle_getWallet circle_getWalletsWithBalances circle_getWalletTokenBalance circle_importContract circle_listWallets circle_signTransaction circle_signTypedData request

    Constructors

    Methods

    • Parameters

      • params: {
            abiFunctionSignature?: string;
            abiParameters?: any[];
            amount?: string;
            blockchain?: Blockchain;
            callData?: `0x${string}`;
            contractAddress: string;
            fee: FeeConfiguration<FeeLevel>;
            idempotencyKey?: string;
            refId?: string;
            sourceAddress?: `0x${string}`;
            walletId?: string;
        }
        • OptionalabiFunctionSignature?: string

          The contract ABI function signature to be interacted with in the smart contract. Example: burn(uint256).

        • OptionalabiParameters?: any[]

          The parameters required by the contract ABI function to perform the contract interaction. Supported types include string, number, and boolean.

        • Optionalamount?: string

          Specifies the transfer amount in decimal format.

        • Optionalblockchain?: Blockchain
        • OptionalcallData?: `0x${string}`

          The raw transaction data, must be an even-length hexadecimal string with the 0x prefix. callData cannot be used simultaneously with abiFunctionSignature or abiParameters.

        • contractAddress: string

          The blockchain address of the contract to be executed.

        • fee: FeeConfiguration<FeeLevel>

          Configuration that determines the fees that will be paid.

        • OptionalidempotencyKey?: string

          The optional idempotency key. An idempotency key is a unique identifier used to identify and handle duplicate requests in order to ensure idempotent behavior, where multiple identical requests have the same effect as a single request.

          We will generate one if you do not provide it.

        • OptionalrefId?: string

          An optional client-provided reference or description for the transaction.

        • OptionalsourceAddress?: `0x${string}`
        • OptionalwalletId?: string

      Returns Promise<Transaction>

    • Parameters

      • __namedParameters: { method: string; params?: unknown[] }

      Returns Promise<unknown>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods