@ember-finance/sdk 2.11.0 → 2.12.0-ccip.0

package/dist/src/evm-vaults/on-chain-calls/user.js

@@ -637,6 +637,67 @@ export class EVMUserCalls extends EVMOnChainCalls {
         }, refundAddress);
         return this.execCall(txCall, options);
     }
+    /**
+     * Bridges a receipt token to a destination chain using the vault's CCIP pool.
+     *
+     * The counterpart to bridgeSendToken. Call getBridgeTransportForVault first
+     * and pick the matching method — a vault has exactly one active bridge, and
+     * calling the wrong one throws rather than silently doing nothing.
+     *
+     * Two differences from the LayerZero path worth knowing:
+     *  - the allowance goes to the CCIP Router, not to the pool, because the
+     *    Router is what pulls the tokens;
+     *  - the destination is named by network, and the chain selector is read
+     *    from the configured lane. An unconfigured route throws here rather
+     *    than reverting on chain.
+     *
+     * @param destinationNetwork Destination network name, e.g. "atlantic"
+     * @param tokenAddress Receipt token address (also the vault identifier in EVM deployment data)
+     * @param amount Amount to bridge in local token decimals
+     * @param receiver Recipient wallet address on the destination chain
+     * @param feeQuote Fee quote returned by reader.getCcipFeeQuote
+     * @param options Optional bridge/send overrides
+     * @returns Transaction execution response
+     */
+    async bridgeSendTokenViaCcip(destinationNetwork, tokenAddress, amount, receiver, feeQuote, options) {
+        if (!this.provider) {
+            throw new Error("Provider required for bridge send read operations and allowance checks");
+        }
+        const pool = this.parser.getCcipTokenPoolByVaultAddress(tokenAddress);
+        if (!pool?.router) {
+            throw new Error(`CCIP token pool not found for token address: ${tokenAddress}`);
+        }
+        const lane = this.parser.getCcipLaneByVaultAndNetwork(tokenAddress, destinationNetwork);
+        if (!lane?.remoteChainSelector) {
+            throw new Error(`No CCIP lane configured from this chain to "${destinationNetwork}" for token ${tokenAddress}`);
+        }
+        const amountBigInt = BigInt(amount);
+        // The Router moves the tokens, so it is the Router that needs approval.
+        const token = new ethers.Contract(tokenAddress, ["function allowance(address,address) view returns (uint256)"], this.provider);
+        const currentAllowance = await token.allowance(await this.getWalletAddress(), pool.router);
+        if (currentAllowance < amountBigInt) {
+            throw new Error(`Insufficient allowance for bridge transfer. Current allowance: ${currentAllowance}, required: ${amountBigInt}`);
+        }
+        const txCall = this.txBuilder.ccipSend(pool.router, {
+            destinationChainSelector: lane.remoteChainSelector,
+            receiver,
+            amount: amountBigInt,
+            feeToken: options?.feeToken,
+            destinationGasLimit: options?.destinationGasLimit
+        }, tokenAddress, feeQuote.fee);
+        return this.execCall(txCall, options);
+    }
+    /**
+     * Reports which bridge a vault uses, or undefined if it has none.
+     *
+     * A vault has exactly one active bridge, but different vaults use different
+     * ones, so branch on this rather than assuming either transport.
+     *
+     * @param tokenAddress Receipt token address (also the vault identifier in EVM deployment data)
+     */
+    getBridgeTransportForVault(tokenAddress) {
+        return this.parser.getBridgeTransportByVaultAddress(tokenAddress);
+    }
     // ============================================
     // Read-Only Methods
     // ============================================

package/dist/src/evm-vaults/on-chain-calls/vault-reader.d.ts

@@ -1,6 +1,6 @@
 import { Provider } from "ethers";
 import { EVMDeploymentParser } from "../utils/deployment-parser.js";
-import { EvmProtocolInfo, IOFTSendParam, IOFTFeeQuote, IOFTVaultSupportedChain, IParkingLotInfo } from "../interfaces/index.js";
+import { EvmProtocolInfo, IOFTSendParam, IOFTFeeQuote, IOFTVaultSupportedChain, IParkingLotInfo, ICcipSendParam, ICcipFeeQuote } from "../interfaces/index.js";
 import { NumStr } from "../../common/types.js";
 import { Chain, VaultsApi } from "../../api/v2/index.js";
 /**
@@ -524,4 +524,17 @@ export declare class EVMVaultReader {
      * @returns Combined fee quote including native fee and expected amounts
      */
     getOFTFeeQuote(vaultId: string, sendParam: IOFTSendParam, payInLzToken?: boolean): Promise<IOFTFeeQuote>;
+    /**
+     * Quotes what a CCIP bridge send will cost.
+     *
+     * The counterpart to getOFTFeeQuote. CCIP charges one fee rather than
+     * LayerZero's native/LZ-token pair, and quotes no received amount: a
+     * burn-and-mint pool mints exactly what it burned, so the amount received is
+     * the amount sent.
+     *
+     * @param vaultId The vault (receipt token) address on the source chain
+     * @param sendParam Destination, receiver and amount
+     * @returns The fee and the token it is charged in
+     */
+    getCcipFeeQuote(vaultId: string, sendParam: ICcipSendParam): Promise<ICcipFeeQuote>;
 }

package/dist/src/evm-vaults/on-chain-calls/vault-reader.js

@@ -4,6 +4,8 @@ import EmberVaultABI from "../../abis/EmberVault.json" with { type: "json" };
 import EmberETHVaultABI from "../../abis/EmberETHVault.json" with { type: "json" };
 import EmberProtocolConfigABI from "../../abis/EmberProtocolConfig.json" with { type: "json" };
 import ERC20TokenABI from "../../abis/ERC20Token.json" with { type: "json" };
+import CcipRouterABI from "../../abis/CcipRouter.json" with { type: "json" };
+import { ZERO_ADDRESS, encodeCcipReceiver, encodeCcipExtraArgs } from "../utils/ccip.js";
 import EmberVaultOFTAdapterABI from "../../abis/EmberVaultMintBurnOFTAdapter.json" with { type: "json" };
 import EmberDepositParkingLotABI from "../../abis/EmberDepositParkingLot.json" with { type: "json" };
 import { Configuration, VaultsApi } from "../../api/v2/index.js";
@@ -736,4 +738,32 @@ export class EVMVaultReader {
             maxAmountLD: oftQuote.oftLimit.maxAmountLD
         };
     }
+    /**
+     * Quotes what a CCIP bridge send will cost.
+     *
+     * The counterpart to getOFTFeeQuote. CCIP charges one fee rather than
+     * LayerZero's native/LZ-token pair, and quotes no received amount: a
+     * burn-and-mint pool mints exactly what it burned, so the amount received is
+     * the amount sent.
+     *
+     * @param vaultId The vault (receipt token) address on the source chain
+     * @param sendParam Destination, receiver and amount
+     * @returns The fee and the token it is charged in
+     */
+    async getCcipFeeQuote(vaultId, sendParam) {
+        const pool = this.parser.getCcipTokenPoolByVaultAddress(vaultId);
+        if (!pool?.router) {
+            throw new Error(`CCIP token pool not found for vault: ${vaultId}`);
+        }
+        const feeToken = sendParam.feeToken ?? ZERO_ADDRESS;
+        const router = new Contract(pool.router, CcipRouterABI.abi, this.provider);
+        const fee = await router.getFee(sendParam.destinationChainSelector, {
+            receiver: encodeCcipReceiver(sendParam.receiver),
+            data: "0x",
+            tokenAmounts: [{ token: vaultId, amount: sendParam.amount }],
+            feeToken,
+            extraArgs: encodeCcipExtraArgs(sendParam.destinationGasLimit)
+        });
+        return { fee, feeToken };
+    }
 }

package/dist/src/evm-vaults/utils/ccip.d.ts

@@ -0,0 +1,23 @@
+/** The native currency, as CCIP names it when no fee token is given. */
+export declare const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+/**
+ * Encodes a receiver for a CCIP message.
+ *
+ * CCIP carries the receiver as `bytes` rather than `address`, because the far
+ * end of a lane need not be an EVM chain. On an EVM destination that is the
+ * address left-padded to 32 bytes, which is why the same account looks
+ * different on the two sides of a transfer.
+ */
+export declare const encodeCcipReceiver: (receiver: string) => string;
+/**
+ * Encodes CCIP extraArgs.
+ *
+ * `allowOutOfOrderExecution` is true because a token transfer carries no
+ * message the destination has to apply in sequence; requiring ordering would
+ * make one stuck message block every later one on the lane.
+ *
+ * gasLimit is 0 by default: a plain token transfer runs no code on the
+ * destination beyond the pool's own mint, and paying for gas that is never used
+ * only raises the fee.
+ */
+export declare const encodeCcipExtraArgs: (destinationGasLimit?: bigint) => string;

package/dist/src/evm-vaults/utils/ccip.js

@@ -0,0 +1,32 @@
+import { AbiCoder, getAddress, zeroPadValue } from "ethers";
+/** The native currency, as CCIP names it when no fee token is given. */
+export const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+/**
+ * Tag for CCIP's EVMExtraArgsV2, the first four bytes of
+ * keccak256("CCIP EVMExtraArgsV2"). Verified against a deployed ramp.
+ */
+const EVM_EXTRA_ARGS_V2_TAG = "0x181dcf10";
+/**
+ * Encodes a receiver for a CCIP message.
+ *
+ * CCIP carries the receiver as `bytes` rather than `address`, because the far
+ * end of a lane need not be an EVM chain. On an EVM destination that is the
+ * address left-padded to 32 bytes, which is why the same account looks
+ * different on the two sides of a transfer.
+ */
+export const encodeCcipReceiver = (receiver) => zeroPadValue(getAddress(receiver), 32);
+/**
+ * Encodes CCIP extraArgs.
+ *
+ * `allowOutOfOrderExecution` is true because a token transfer carries no
+ * message the destination has to apply in sequence; requiring ordering would
+ * make one stuck message block every later one on the lane.
+ *
+ * gasLimit is 0 by default: a plain token transfer runs no code on the
+ * destination beyond the pool's own mint, and paying for gas that is never used
+ * only raises the fee.
+ */
+export const encodeCcipExtraArgs = (destinationGasLimit = 0n) => {
+    const encoded = AbiCoder.defaultAbiCoder().encode(["uint256", "bool"], [destinationGasLimit, true]);
+    return EVM_EXTRA_ARGS_V2_TAG + encoded.slice(2);
+};

package/dist/src/evm-vaults/utils/deployment-parser.d.ts

@@ -1,4 +1,4 @@
-import { EvmOFTAdapter } from "../../api/v2/index.js";
+import { EvmCcipLane, EvmCcipTokenPool, EvmOFTAdapter } from "../../api/v2/index.js";
 import { EvmProtocolInfo } from "../interfaces/index.js";
 export declare class EVMDeploymentParser {
     deployment: EvmProtocolInfo;
@@ -124,4 +124,30 @@ export declare class EVMDeploymentParser {
      * @param vaultAddress The vault address (receipt token address in EVM deployment data)
      */
     getOFTAdapterObjectByVaultAddress(vaultAddress: string): EvmOFTAdapter | undefined;
+    /**
+     * Finds the CCIP token pool entry for a given vault address.
+     * @param vaultAddress The vault address (receipt token address in EVM deployment data)
+     */
+    getCcipTokenPoolByVaultAddress(vaultAddress: string): EvmCcipTokenPool | undefined;
+    /**
+     * Reports which bridge a vault uses, or undefined if it has none.
+     *
+     * A vault has exactly one active bridge, but different vaults use different
+     * ones, so call this before choosing between the LayerZero and CCIP send
+     * methods rather than assuming either.
+     *
+     * @param vaultAddress The vault address (receipt token address in EVM deployment data)
+     */
+    getBridgeTransportByVaultAddress(vaultAddress: string): "LayerZero" | "CCIP" | undefined;
+    /**
+     * Finds the configured CCIP lane from a vault to a destination network.
+     *
+     * Lanes are keyed by the destination's CCIP chain selector, which nothing
+     * outside CCIP knows, so this looks the lane up by network name instead.
+     * A missing lane means the route is not configured — sending would revert.
+     *
+     * @param vaultAddress The vault address on the source chain
+     * @param destinationNetwork The destination network name, e.g. "atlantic"
+     */
+    getCcipLaneByVaultAndNetwork(vaultAddress: string, destinationNetwork: string): EvmCcipLane | undefined;
 }

package/dist/src/evm-vaults/utils/deployment-parser.js

@@ -206,4 +206,41 @@ export class EVMDeploymentParser {
         }
         return entry;
     }
+    /**
+     * Finds the CCIP token pool entry for a given vault address.
+     * @param vaultAddress The vault address (receipt token address in EVM deployment data)
+     */
+    getCcipTokenPoolByVaultAddress(vaultAddress) {
+        return Object.values(this.deployment.contracts?.ccipTokenPools ?? {}).find(pool => pool.vaultAddress?.toLowerCase() === vaultAddress.toLowerCase());
+    }
+    /**
+     * Reports which bridge a vault uses, or undefined if it has none.
+     *
+     * A vault has exactly one active bridge, but different vaults use different
+     * ones, so call this before choosing between the LayerZero and CCIP send
+     * methods rather than assuming either.
+     *
+     * @param vaultAddress The vault address (receipt token address in EVM deployment data)
+     */
+    getBridgeTransportByVaultAddress(vaultAddress) {
+        if (this.getCcipTokenPoolByVaultAddress(vaultAddress))
+            return "CCIP";
+        if (this.getOFTAdapterObjectByVaultAddress(vaultAddress))
+            return "LayerZero";
+        return undefined;
+    }
+    /**
+     * Finds the configured CCIP lane from a vault to a destination network.
+     *
+     * Lanes are keyed by the destination's CCIP chain selector, which nothing
+     * outside CCIP knows, so this looks the lane up by network name instead.
+     * A missing lane means the route is not configured — sending would revert.
+     *
+     * @param vaultAddress The vault address on the source chain
+     * @param destinationNetwork The destination network name, e.g. "atlantic"
+     */
+    getCcipLaneByVaultAndNetwork(vaultAddress, destinationNetwork) {
+        const pool = this.getCcipTokenPoolByVaultAddress(vaultAddress);
+        return Object.values(pool?.lanes ?? {}).find(lane => lane.remoteNetwork?.toLowerCase() === destinationNetwork.toLowerCase());
+    }
 }

package/dist/src/evm-vaults/utils/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./deployment-parser.js";
 export * from "./permit-utils.js";
+export * from "./ccip.js";

package/dist/src/evm-vaults/utils/index.js

@@ -1,2 +1,3 @@
 export * from "./deployment-parser.js";
 export * from "./permit-utils.js";
+export * from "./ccip.js";

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@ember-finance/sdk",
     "description": "Ember Protocol SDK",
-    "version": "2.11.0",
+    "version": "2.12.0-ccip.0",
     "type": "module",
     "module": "./dist/index.js",
     "main": "./dist/index.js",