@circle-fin/adapter-ethers-v6 1.0.1 → 1.1.1

package/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/index.d.ts

@@ -596,10 +596,11 @@ interface EvmPreparedChainRequest {
      * Estimate the gas cost for the contract execution.
      *
      * @param overrides - Optional parameters to override the default estimation behavior
+     * @param fallback - Optional fallback gas information to use if the estimation fails
      * @returns A promise that resolves to the estimated gas information
      * @throws If the estimation fails
      */
-    estimate(overrides?: EvmEstimateOverrides): Promise<EstimatedGas>;
+    estimate(overrides?: EvmEstimateOverrides, fallback?: EstimatedGas): Promise<EstimatedGas>;
     /**
      * Execute the prepared contract call.
      *
@@ -677,7 +678,7 @@ interface SolanaPreparedChainRequest {
     /** The type of the chain request. */
     type: 'solana';
     /** Estimate the compute units and fee for the transaction. */
-    estimate(overrides?: SolanaEstimateOverrides): Promise<EstimatedGas>;
+    estimate(overrides?: SolanaEstimateOverrides, fallback?: EstimatedGas): Promise<EstimatedGas>;
     /** Execute the prepared transaction. */
     execute(overrides?: SolanaExecuteOverrides): Promise<string>;
 }
@@ -709,7 +710,7 @@ interface NoopPreparedChainRequest {
      * Placeholder for the estimate method.
      * @returns The estimated gas cost.
      */
-    estimate: () => Promise<EstimatedGas>;
+    estimate: (overrides?: EvmEstimateOverrides | SolanaEstimateOverrides, fallback?: EstimatedGas) => Promise<EstimatedGas>;
     /**
      * Placeholder for the execute method.
      * @returns The transaction hash.
@@ -1178,6 +1179,14 @@ interface CCTPv2ActionMap {
          * the adapter's default address.
          */
         readonly destinationAddress?: string;
+        /**
+         * The mint recipient address from the decoded CCTP message.
+         *
+         * This is the actual address encoded in the burn message where tokens will be minted.
+         * For Solana, this is already the Associated Token Account (ATA) address, not the owner.
+         * For EVM chains, this is the recipient's wallet address.
+         */
+        readonly mintRecipient?: string;
     };
     /**
      * Initiate a cross-chain USDC transfer using a custom bridge contract with preapproval funnel.
@@ -1967,10 +1976,23 @@ interface AdapterCapabilities {
  */
 declare abstract class Adapter<TAdapterCapabilities extends AdapterCapabilities = AdapterCapabilities> {
     /**
-     * The type of the chain.
-     * @example 'evm', 'solana'
+     * The type of the chain for this adapter.
+     *
+     * - For concrete adapters, this should be a real chain type (e.g., `'evm'`, `'solana'`, etc.) from the ChainType union.
+     * - For hybrid adapters (adapters that route to concrete adapters supporting multiple ecosystems),
+     *   set this property to the string literal `'hybrid'`.
+     *
+     * Note: `'hybrid'` is not a legal ChainType and should only be used as a marker for multi-ecosystem adapters.
+     * Hybrid adapters do not interact directly with any chain, but instead route requests to a concrete underlying adapter.
+     *
+     * @example
+     *   // For an EVM-only adapter:
+     *   chainType = 'evm'
+     *
+     *   // For a hybrid adapter:
+     *   chainType = 'hybrid'
      */
-    abstract chainType: ChainType;
+    abstract chainType: ChainType | 'hybrid';
     /**
      * Capabilities of this adapter, defining address control model and supported chains.
      *
@@ -2052,7 +2074,7 @@ declare abstract class Adapter<TAdapterCapabilities extends AdapterCapabilities
      * })
      * ```
      */
-    prepareAction<TActionKey extends ActionKeys>(action: TActionKey, params: ActionPayload<TActionKey>, ctx?: OperationContext<TAdapterCapabilities>): Promise<PreparedChainRequest>;
+    prepareAction<TActionKey extends ActionKeys>(action: TActionKey, params: ActionPayload<TActionKey>, ctx: OperationContext<TAdapterCapabilities>): Promise<PreparedChainRequest>;
     /**
      * Prepares a transaction for future gas estimation and execution.
      *
@@ -2106,10 +2128,10 @@ declare abstract class Adapter<TAdapterCapabilities extends AdapterCapabilities
      * This address is used as the default sender for transactions
      * and interactions initiated by this adapter.
      *
-     * @param chain - Optional chain definition for chain-specific address resolution (used by EVM adapters)
+     * @param chain - The chain to use for address resolution.
      * @returns A promise that resolves to the blockchain address as a string.
      */
-    abstract getAddress(chain?: ChainDefinition): Promise<string>;
+    abstract getAddress(chain: ChainDefinition): Promise<string>;
     /**
      * Switches the adapter to operate on the specified chain.
      *
@@ -2180,7 +2202,7 @@ declare abstract class Adapter<TAdapterCapabilities extends AdapterCapabilities
      * Validate that the target chain is supported by this adapter.
      *
      * @param targetChain - The chain to validate.
-     * @throws Error if the chain is not supported.
+     * @throws KitError with INVALID_CHAIN code if the chain is not supported by this adapter.
      */
     validateChainSupport(targetChain: ChainDefinition): void;
     /**
@@ -3043,7 +3065,7 @@ declare class EthersAdapter<TAdapterCapabilities extends AdapterCapabilities = A
      * adapter interface, it is effectively required and enforced at runtime. This ensures
      * the adapter is connected to the correct chain before querying the signer.
      *
-     * @param chain - The chain to use for address resolution (provided by OperationContext)
+     * @param chain - The chain to use for address resolution.
      * @returns A promise that resolves to the signer's address
      * @throws Error when no chain is provided
      *
@@ -3055,17 +3077,8 @@ declare class EthersAdapter<TAdapterCapabilities extends AdapterCapabilities = A
      * const address = await adapter.getAddress(Ethereum)
      * console.log('Wallet address:', address)
      * ```
-     *
-     * @example
-     * ```typescript
-     * // In practice, address resolution happens automatically
-     * const prepared = await adapter.prepare(params, {
-     *   chain: 'Ethereum'
-     *   // Address automatically resolved via getAddress() internally
-     * })
-     * ```
      */
-    getAddress(chain?: EVMChainDefinition): Promise<string>;
+    getAddress(chain: EVMChainDefinition): Promise<string>;
     /**
      * Waits for a transaction to be mined and confirmed on the blockchain.
      *