We have upgraded the product to App Kit and recommend using it for all production deployments. USDCKit will remain available as a private beta product. Thank you.
@circle-fin/usdckit - v0.25.4
    Preparing search index...
    • Type Parameters

      • TAddress extends Address = Address

      Parameters

      • client: ExtendedViemClient
      • address: TAddress
      • chain:
            | {
                blockchainId: "SOL";
                blockchainVm: "SVM";
                blockExplorers: {
                    default: { name: "Solscan"; url: "https://solscan.io/" };
                };
                blockTime?: number;
                contracts: {
                    EURC: { address: `0x${string}`; read: { decimals: () => 6 } };
                    USDC: { address: `0x${string}`; read: { decimals: () => 6 } };
                };
                custom?: Record<string, unknown>;
                ensTlds?: readonly string[];
                experimental_preconfirmationTime?: number;
                extendSchema?: Record<string, unknown>;
                fees?: ChainFees<undefined>;
                formatters?: undefined;
                id: number;
                name: "Solana Mainnet";
                nativeCurrency: { decimals: 9; name: "Solana"; symbol: "SOL" };
                prepareTransactionRequest?:
                    | PrepareTransactionRequestFn
                    | [
                        fn: PrepareTransactionRequestFn,
                        options: { runAt: readonly PrepareTransactionRequestPhase[] },
                    ];
                rpcUrls: {
                    default: { http: readonly ["https://api.mainnet-beta.solana.com"] };
                };
                serializers?: ChainSerializers<undefined, TransactionSerializable>;
                sourceId?: number;
                testnet?: boolean;
                verifyHash?: ChainVerifyHashFn;
            }
            | {
                blockchainId: "SOL-DEVNET";
                blockchainVm: "SVM";
                blockExplorers: {
                    default: {
                        name: "Solscan";
                        url: "https://solscan.io/?cluster=devnet";
                    };
                };
                blockTime?: number;
                contracts: {
                    EURC: { address: `0x${string}`; read: { decimals: () => 6 } };
                    USDC: {
                        abi: undefined;
                        address: `0x${string}`;
                        read: { decimals: () => 6 };
                    };
                };
                custom?: Record<string, unknown>;
                ensTlds?: readonly string[];
                experimental_preconfirmationTime?: number;
                extendSchema?: Record<string, unknown>;
                fees?: ChainFees<undefined>;
                formatters?: undefined;
                id: number;
                name: "Solana Devnet";
                nativeCurrency: { decimals: 9; name: "Solana"; symbol: "SOL" };
                prepareTransactionRequest?:
                    | PrepareTransactionRequestFn
                    | [
                        fn: PrepareTransactionRequestFn,
                        options: { runAt: readonly PrepareTransactionRequestPhase[] },
                    ];
                rpcUrls: { default: { http: readonly ["https://api.devnet.solana.com"] } };
                serializers?: ChainSerializers<undefined, TransactionSerializable>;
                sourceId?: number;
                testnet: true;
                verifyHash?: ChainVerifyHashFn;
            }
        • {
              blockchainId: "SOL";
              blockchainVm: "SVM";
              blockExplorers: {
                  default: { name: "Solscan"; url: "https://solscan.io/" };
              };
              blockTime?: number;
              contracts: {
                  EURC: { address: `0x${string}`; read: { decimals: () => 6 } };
                  USDC: { address: `0x${string}`; read: { decimals: () => 6 } };
              };
              custom?: Record<string, unknown>;
              ensTlds?: readonly string[];
              experimental_preconfirmationTime?: number;
              extendSchema?: Record<string, unknown>;
              fees?: ChainFees<undefined>;
              formatters?: undefined;
              id: number;
              name: "Solana Mainnet";
              nativeCurrency: { decimals: 9; name: "Solana"; symbol: "SOL" };
              prepareTransactionRequest?:
                  | PrepareTransactionRequestFn
                  | [
                      fn: PrepareTransactionRequestFn,
                      options: { runAt: readonly PrepareTransactionRequestPhase[] },
                  ];
              rpcUrls: {
                  default: { http: readonly ["https://api.mainnet-beta.solana.com"] };
              };
              serializers?: ChainSerializers<undefined, TransactionSerializable>;
              sourceId?: number;
              testnet?: boolean;
              verifyHash?: ChainVerifyHashFn;
          }
          • ReadonlyblockchainId: "SOL"
          • ReadonlyblockchainVm: "SVM"
          • blockExplorers: { default: { name: "Solscan"; url: "https://solscan.io/" } }

            Collection of block explorers

          • OptionalblockTime?: number

            Block time in milliseconds.

          • contracts: {
                EURC: { address: `0x${string}`; read: { decimals: () => 6 } };
                USDC: { address: `0x${string}`; read: { decimals: () => 6 } };
            }

            Collection of contracts

          • Optionalcustom?: Record<string, unknown>

            Custom chain data.

            use .extend instead.

          • OptionalensTlds?: readonly string[]

            Collection of ENS TLDs for the chain.

          • Optionalexperimental_preconfirmationTime?: number

            Preconfirmation time in milliseconds.

          • OptionalextendSchema?: Record<string, unknown>

            Extend schema.

          • Optionalfees?: ChainFees<undefined>

            Modifies how fees are derived.

          • Optionalformatters?: undefined

            Modifies how data is formatted and typed (e.g. blocks and transactions)

          • id: number

            ID in number form

          • name: "Solana Mainnet"

            Human-readable name

          • nativeCurrency: { decimals: 9; name: "Solana"; symbol: "SOL" }

            Currency used by chain

          • OptionalprepareTransactionRequest?:
                | PrepareTransactionRequestFn
                | [
                    fn: PrepareTransactionRequestFn,
                    options: { runAt: readonly PrepareTransactionRequestPhase[] },
                ]

            Function to prepare a transaction request. Runs before the transaction is filled.

          • rpcUrls: { default: { http: readonly ["https://api.mainnet-beta.solana.com"] } }

            Collection of RPC endpoints

          • Optionalserializers?: ChainSerializers<undefined, TransactionSerializable>

            Modifies how data is serialized (e.g. transactions).

          • OptionalsourceId?: number

            Source Chain ID (ie. the L1 chain)

          • Optionaltestnet?: boolean

            Flag for test networks

          • OptionalverifyHash?: ChainVerifyHashFn

            Chain-specific signature verification.

        • {
              blockchainId: "SOL-DEVNET";
              blockchainVm: "SVM";
              blockExplorers: {
                  default: { name: "Solscan"; url: "https://solscan.io/?cluster=devnet" };
              };
              blockTime?: number;
              contracts: {
                  EURC: { address: `0x${string}`; read: { decimals: () => 6 } };
                  USDC: {
                      abi: undefined;
                      address: `0x${string}`;
                      read: { decimals: () => 6 };
                  };
              };
              custom?: Record<string, unknown>;
              ensTlds?: readonly string[];
              experimental_preconfirmationTime?: number;
              extendSchema?: Record<string, unknown>;
              fees?: ChainFees<undefined>;
              formatters?: undefined;
              id: number;
              name: "Solana Devnet";
              nativeCurrency: { decimals: 9; name: "Solana"; symbol: "SOL" };
              prepareTransactionRequest?:
                  | PrepareTransactionRequestFn
                  | [
                      fn: PrepareTransactionRequestFn,
                      options: { runAt: readonly PrepareTransactionRequestPhase[] },
                  ];
              rpcUrls: { default: { http: readonly ["https://api.devnet.solana.com"] } };
              serializers?: ChainSerializers<undefined, TransactionSerializable>;
              sourceId?: number;
              testnet: true;
              verifyHash?: ChainVerifyHashFn;
          }
          • ReadonlyblockchainId: "SOL-DEVNET"
          • ReadonlyblockchainVm: "SVM"
          • blockExplorers: { default: { name: "Solscan"; url: "https://solscan.io/?cluster=devnet" } }

            Collection of block explorers

          • OptionalblockTime?: number

            Block time in milliseconds.

          • contracts: {
                EURC: { address: `0x${string}`; read: { decimals: () => 6 } };
                USDC: {
                    abi: undefined;
                    address: `0x${string}`;
                    read: { decimals: () => 6 };
                };
            }

            Collection of contracts

          • Optionalcustom?: Record<string, unknown>

            Custom chain data.

            use .extend instead.

          • OptionalensTlds?: readonly string[]

            Collection of ENS TLDs for the chain.

          • Optionalexperimental_preconfirmationTime?: number

            Preconfirmation time in milliseconds.

          • OptionalextendSchema?: Record<string, unknown>

            Extend schema.

          • Optionalfees?: ChainFees<undefined>

            Modifies how fees are derived.

          • Optionalformatters?: undefined

            Modifies how data is formatted and typed (e.g. blocks and transactions)

          • id: number

            ID in number form

          • name: "Solana Devnet"

            Human-readable name

          • nativeCurrency: { decimals: 9; name: "Solana"; symbol: "SOL" }

            Currency used by chain

          • OptionalprepareTransactionRequest?:
                | PrepareTransactionRequestFn
                | [
                    fn: PrepareTransactionRequestFn,
                    options: { runAt: readonly PrepareTransactionRequestPhase[] },
                ]

            Function to prepare a transaction request. Runs before the transaction is filled.

          • rpcUrls: { default: { http: readonly ["https://api.devnet.solana.com"] } }

            Collection of RPC endpoints

          • Optionalserializers?: ChainSerializers<undefined, TransactionSerializable>

            Modifies how data is serialized (e.g. transactions).

          • OptionalsourceId?: number

            Source Chain ID (ie. the L1 chain)

          • testnet: true

            Flag for test networks

          • OptionalverifyHash?: ChainVerifyHashFn

            Chain-specific signature verification.

      Returns Readonly<
          {
              address: Address<TAddress>;
              signTransactions(
                  transactions: readonly Readonly<
                      { messageBytes: TransactionMessageBytes; signatures: SignaturesMap },
                  >[],
                  config?: BaseTransactionSignerConfig,
              ): Promise<readonly Readonly<Record<Address, SignatureBytes>>[]>;
          },
      >