@ember-finance/sdk 2.0.0 → 2.0.2

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

@@ -1,19 +1,21 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./interfaces"), exports);
-__exportStar(require("./on-chain-calls"), exports);
-__exportStar(require("./utils"), exports);
+export * from "./interfaces/index.js";
+export * from "./on-chain-calls/index.js";
+export * from "./utils/index.js";
+/**
+ * Converts an EVM address to bytes32 format
+ * @param address EVM address (with or without 0x prefix)
+ * @returns 32-byte hex string
+ */
+export function addressToBytes32(address) {
+    const clean = address.toLowerCase().replace("0x", "");
+    return "0x" + clean.padStart(64, "0");
+}
+/**
+ * Converts a bytes32 value back to an EVM address.
+ * @param bytes32 32-byte hex string
+ * @returns EVM address (checksummed)
+ */
+export function bytes32ToAddress(bytes32) {
+    const clean = bytes32.toLowerCase().replace("0x", "");
+    return "0x" + clean.slice(-40);
+}

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

@@ -1,53 +1,81 @@
 import { Signer, Provider, TransactionResponse, TransactionReceipt, Log, LogDescription } from "ethers";
+import type { EvmProtocolInfo as ApiEvmProtocolInfo } from "../../api/v2/models/evm-protocol-info.js";
+import { Chain } from "../../api/v2/index.js";
 /**
- * Represents the deployment configuration for the Ember Protocol on EVM-compatible chains
+ * Minimal chain metadata used to map LayerZero chain IDs to Ember chain identifiers.
  */
-export interface IEvmDeployment {
-    network: string;
-    chainId: string;
-    contracts: {
-        protocolConfig: {
-            proxyAddress: string;
-            implementationAddress: string;
-            ownerAddress: string;
-            version: string;
-            deployedAt: string;
-            deploymentBlockNumber: number;
-        };
-        receiptTokens: {
-            [key: string]: {
-                proxyAddress: string;
-                implementationAddress: string;
-                ownerAddress: string;
-                name: string;
-                symbol: string;
-                decimals: number;
-                version: string;
-                deployedAt: string;
-                deploymentBlockNumber: number;
-            };
-        };
-        vaults: {
-            [key: string]: {
-                proxyAddress: string;
-                implementationAddress: string;
-                ownerAddress: string;
-                name: string;
-                baseToken: string;
-                receiptToken: string;
-                baseTokenPriceFeed: string;
-                baseTokenName: string;
-                admin: string;
-                operator: string;
-                rateManager: string;
-                protocolConfig: string;
-                maxTVL: string;
-                version: string;
-                deployedAt: string;
-                deploymentBlockNumber: number;
-            };
-        };
-    };
+export interface IChainMetadata {
+    /** Ember chain identifier (e.g., "base", "arbitrum") */
+    identifier: string;
+    /** LayerZero chain ID for this chain */
+    lzChainId?: number;
+    /** Additional API fields from supported chains response */
+    [key: string]: unknown;
+}
+/**
+ * Deployment type for SDK internals, based on generated EvmProtocolInfo.
+ * Keeps required fields strict for parser usage.
+ */
+export type EvmProtocolInfo = ApiEvmProtocolInfo;
+/**
+ * Parameters for an OFT send operation (LayerZero SendParam struct)
+ */
+export interface IOFTSendParam {
+    /** LayerZero endpoint ID of the destination chain */
+    dstEid: number;
+    /** Recipient address on the destination chain in bytes32 format */
+    to: string;
+    /** Amount to send in local decimals */
+    amountLD: bigint;
+    /** Minimum amount to receive on destination in local decimals (slippage protection) */
+    minAmountLD: bigint;
+    /** Extra options for LayerZero (hex string, defaults to "0x") */
+    extraOptions?: string;
+    /** Compose message for additional execution on destination (hex string, defaults to "0x") */
+    composeMsg?: string;
+    /** OFT command (hex string, defaults to "0x") */
+    oftCmd?: string;
+}
+/**
+ * Quoted fee for a bridge send operation
+ */
+export interface IOFTFeeQuote {
+    /** Native gas fee required to pay LayerZero (in wei) */
+    nativeFee: bigint;
+    /** LZ token fee (typically 0 when paying in native token) */
+    lzTokenFee: bigint;
+    /** Amount that will be deducted from the sender */
+    amountSentLD: bigint;
+    /** Amount that will be received on the destination chain */
+    amountReceivedLD: bigint;
+    /** Minimum sendable amount from the OFT limit */
+    minAmountLD: bigint;
+    /** Maximum sendable amount from the OFT limit */
+    maxAmountLD: bigint;
+}
+/**
+ * A destination chain supported by an OFT adapter (has a peer configured)
+ */
+export interface IOFTVaultSupportedChain extends Chain {
+    /** Resolved OFT adapter contract address from deployment */
+    adapterAddress: string;
+    /** Input vault identifier used to resolve the adapter */
+    vaultId: string;
+    /** LayerZero endpoint ID of the destination chain */
+    lzEndpointId: number;
+    /** Ember API chain identifier (e.g., "base", "arbitrum") */
+    chainIdentifier: string | undefined;
+    /** Peer OFT adapter address on the destination chain (bytes32) */
+    peerAddress: string;
+}
+/**
+ * Messaging fee struct for OFT send (LayerZero MessagingFee)
+ */
+export interface IOFTMessagingFee {
+    /** Native fee in wei */
+    nativeFee: bigint;
+    /** LZ token fee (0 to pay in native token) */
+    lzTokenFee: bigint;
 }
 /**
  * Optional parameters for EVM transaction building
@@ -135,6 +163,23 @@ export interface IUserCallOptions extends IEvmCallOptions {
     /** Receiver address for shares/funds. Defaults to the caller's address if not provided */
     receiver?: string;
 }
+/**
+ * Optional parameters for high-level OFT bridge send calls.
+ */
+export interface IBridgeSendOptions extends IEvmCallOptions {
+    /** Minimum amount to receive on destination; defaults to amount */
+    minAmount?: bigint;
+    /** Additional LayerZero options bytes */
+    extraOptions?: string;
+    /** Optional compose message bytes */
+    composeMsg?: string;
+    /** Optional OFT command bytes */
+    oftCmd?: string;
+    /** Whether to pay fees in the LZ token */
+    payInLzToken?: boolean;
+    /** Refund address for excess fee; defaults to caller wallet */
+    refundAddress?: string;
+}
 /**
  * EIP-2612 Permit signature components
  */

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

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

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

@@ -1,7 +1,7 @@
 import { Signer, Provider } from "ethers";
-import { EVMOnChainCalls } from "./onchain-calls";
-import { IEvmDeployment, IEvmCallOptions, EvmOnChainCallResponse } from "../interfaces";
-import { NumStr } from "../../common/types";
+import { EVMOnChainCalls } from "./onchain-calls.js";
+import { EvmProtocolInfo, IEvmCallOptions, EvmOnChainCallResponse } from "../interfaces/index.js";
+import { NumStr } from "../../common/types.js";
 /**
  * Admin Calls for Ember Protocol on EVM
  *
@@ -32,7 +32,7 @@ import { NumStr } from "../../common/types";
  * ```
  */
 export declare class EVMAdminCalls extends EVMOnChainCalls {
-    constructor(_deployment: IEvmDeployment, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
+    constructor(_deployment: EvmProtocolInfo, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
     /**
      * Update the admin address of a vault
      * @param vaultAddress The address of the vault

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

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EVMAdminCalls = void 0;
-const onchain_calls_1 = require("./onchain-calls");
+import { EVMOnChainCalls } from "./onchain-calls.js";
 /**
  * Admin Calls for Ember Protocol on EVM
  *
@@ -31,7 +28,7 @@ const onchain_calls_1 = require("./onchain-calls");
  * await adminCalls.updateVaultAdmin(vaultAddress, newAdminAddress);
  * ```
  */
-class EVMAdminCalls extends onchain_calls_1.EVMOnChainCalls {
+export class EVMAdminCalls extends EVMOnChainCalls {
     constructor(_deployment, _signer, _provider, _walletAddress) {
         super(_deployment, _signer, _provider, _walletAddress);
     }
@@ -144,4 +141,3 @@ class EVMAdminCalls extends onchain_calls_1.EVMOnChainCalls {
         return this.execCall(txCall, options);
     }
 }
-exports.EVMAdminCalls = EVMAdminCalls;

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

@@ -1,7 +1,7 @@
-export * from "./tx-builder";
-export * from "./onchain-calls";
-export * from "./admin";
-export * from "./operator";
-export * from "./vault-admin";
-export * from "./user";
-export * from "./vault-reader";
+export * from "./tx-builder.js";
+export * from "./onchain-calls.js";
+export * from "./admin.js";
+export * from "./operator.js";
+export * from "./vault-admin.js";
+export * from "./user.js";
+export * from "./vault-reader.js";

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

@@ -1,23 +1,7 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./tx-builder"), exports);
-__exportStar(require("./onchain-calls"), exports);
-__exportStar(require("./admin"), exports);
-__exportStar(require("./operator"), exports);
-__exportStar(require("./vault-admin"), exports);
-__exportStar(require("./user"), exports);
-__exportStar(require("./vault-reader"), exports);
+export * from "./tx-builder.js";
+export * from "./onchain-calls.js";
+export * from "./admin.js";
+export * from "./operator.js";
+export * from "./vault-admin.js";
+export * from "./user.js";
+export * from "./vault-reader.js";

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

@@ -1,7 +1,7 @@
 import { Signer, Provider, Log } from "ethers";
-import { EVMDeploymentParser } from "../utils/deployment-parser";
-import { EvmOnChainCallResponse, IEvmCallOptions, IEvmDeployment, ITransactionCall, IParsedEvent } from "../interfaces";
-import { EVMTxBuilder } from "./tx-builder";
+import { EVMDeploymentParser } from "../utils/deployment-parser.js";
+import { EvmOnChainCallResponse, IEvmCallOptions, EvmProtocolInfo, ITransactionCall, IParsedEvent } from "../interfaces/index.js";
+import { EVMTxBuilder } from "./tx-builder.js";
 /**
  * EVM On-Chain Calls for Ember Protocol
  *
@@ -33,12 +33,12 @@ export declare class EVMOnChainCalls {
     signer?: Signer;
     provider?: Provider;
     walletAddress?: string;
-    constructor(_deployment: IEvmDeployment, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
+    constructor(_deployment: EvmProtocolInfo, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
     /**
      * Updates the deployment configuration
      * @param newDeployment The new deployment configuration
      */
-    updateDeployment(newDeployment: IEvmDeployment): void;
+    updateDeployment(newDeployment: EvmProtocolInfo): void;
     /**
      * Gets the wallet address
      * @returns The wallet address

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

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EVMOnChainCalls = void 0;
-const ethers_1 = require("ethers");
-const deployment_parser_1 = require("../utils/deployment-parser");
-const tx_builder_1 = require("./tx-builder");
+import { Interface } from "ethers";
+import { EVMDeploymentParser } from "../utils/deployment-parser.js";
+import { EVMTxBuilder } from "./tx-builder.js";
 /**
  * EVM On-Chain Calls for Ember Protocol
  *
@@ -29,10 +26,10 @@ const tx_builder_1 = require("./tx-builder");
  * console.log("Events:", result.events);
  * ```
  */
-class EVMOnChainCalls {
+export class EVMOnChainCalls {
     constructor(_deployment, _signer, _provider, _walletAddress) {
-        this.parser = new deployment_parser_1.EVMDeploymentParser(_deployment);
-        this.txBuilder = new tx_builder_1.EVMTxBuilder(_deployment);
+        this.parser = new EVMDeploymentParser(_deployment);
+        this.txBuilder = new EVMTxBuilder(_deployment);
         this.signer = _signer;
         this.provider = _provider;
         this.walletAddress = _walletAddress;
@@ -64,7 +61,7 @@ class EVMOnChainCalls {
      * @returns Encoded transaction ready to send
      */
     encodeTransaction(txCall) {
-        const iface = new ethers_1.Interface(txCall.abi);
+        const iface = new Interface(txCall.abi);
         const data = iface.encodeFunctionData(txCall.functionName, txCall.args);
         return {
             to: txCall.to,
@@ -80,7 +77,7 @@ class EVMOnChainCalls {
      * @returns Decoded result
      */
     decodeResult(abi, functionName, data) {
-        const iface = new ethers_1.Interface(abi);
+        const iface = new Interface(abi);
         return iface.decodeFunctionResult(functionName, data);
     }
     /**
@@ -90,7 +87,7 @@ class EVMOnChainCalls {
      * @returns Array of parsed events
      */
     parseEvents(logs, abi) {
-        const iface = new ethers_1.Interface(abi);
+        const iface = new Interface(abi);
         const events = [];
         for (const log of logs) {
             try {
@@ -187,4 +184,3 @@ class EVMOnChainCalls {
         return response;
     }
 }
-exports.EVMOnChainCalls = EVMOnChainCalls;

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

@@ -1,7 +1,7 @@
 import { Signer, Provider } from "ethers";
-import { EVMOnChainCalls } from "./onchain-calls";
-import { IEvmDeployment, IEvmCallOptions, EvmOnChainCallResponse } from "../interfaces";
-import { NumStr } from "../../common/types";
+import { EVMOnChainCalls } from "./onchain-calls.js";
+import { EvmProtocolInfo, IEvmCallOptions, EvmOnChainCallResponse } from "../interfaces/index.js";
+import { NumStr } from "../../common/types.js";
 /**
  * Operator Calls for Ember Protocol on EVM
  *
@@ -34,7 +34,7 @@ import { NumStr } from "../../common/types";
  * ```
  */
 export declare class EVMOperatorCalls extends EVMOnChainCalls {
-    constructor(_deployment: IEvmDeployment, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
+    constructor(_deployment: EvmProtocolInfo, _signer?: Signer, _provider?: Provider, _walletAddress?: string);
     /**
      * Update the rate of a vault
      * Note: This requires the rate manager role, which may or may not be the operator

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

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EVMOperatorCalls = void 0;
-const onchain_calls_1 = require("./onchain-calls");
+import { EVMOnChainCalls } from "./onchain-calls.js";
 /**
  * Operator Calls for Ember Protocol on EVM
  *
@@ -33,7 +30,7 @@ const onchain_calls_1 = require("./onchain-calls");
  * await operatorCalls.withdrawFromVaultWithoutRedeemingShares(vaultAddress, subAccount, amount);
  * ```
  */
-class EVMOperatorCalls extends onchain_calls_1.EVMOnChainCalls {
+export class EVMOperatorCalls extends EVMOnChainCalls {
     constructor(_deployment, _signer, _provider, _walletAddress) {
         super(_deployment, _signer, _provider, _walletAddress);
     }
@@ -96,4 +93,3 @@ class EVMOperatorCalls extends onchain_calls_1.EVMOnChainCalls {
         return this.execCall(txCall, options);
     }
 }
-exports.EVMOperatorCalls = EVMOperatorCalls;

package/dist/src/evm-vaults/on-chain-calls/tx-builder.d.ts

@@ -1,6 +1,6 @@
-import { EVMDeploymentParser } from "../utils";
-import { IEvmDeployment, VaultPauseOperation, ITransactionCall, IPermitSignature } from "../interfaces";
-import { NumStr } from "../../common/types";
+import { EVMDeploymentParser } from "../utils/index.js";
+import { EvmProtocolInfo, VaultPauseOperation, ITransactionCall, IPermitSignature, IOFTSendParam, IOFTMessagingFee } from "../interfaces/index.js";
+import { NumStr } from "../../common/types.js";
 /**
  * EVM Transaction Builder for Ember Protocol (ERC-4626 Compatible)
  *
@@ -38,12 +38,12 @@ import { NumStr } from "../../common/types";
  */
 export declare class EVMTxBuilder {
     parser: EVMDeploymentParser;
-    constructor(_deployment: IEvmDeployment);
+    constructor(_deployment: EvmProtocolInfo);
     /**
      * Updates the deployment configuration
      * @param newDeployment The new deployment configuration
      */
-    updateDeployment(newDeployment: IEvmDeployment): void;
+    updateDeployment(newDeployment: EvmProtocolInfo): void;
     /**
      * Gets the chain ID from the deployment
      */
@@ -310,4 +310,23 @@ export declare class EVMTxBuilder {
      * Gets the ERC20Token ABI
      */
     static getERC20ABI(): unknown[];
+    /**
+     * Gets the EmberVaultOFTAdapter ABI
+     */
+    static getOFTAdapterABI(): unknown[];
+    /**
+     * Builds the transaction to bridge receipt tokens to another chain via LayerZero OFT.
+     *
+     * The caller must first:
+     * 1. Approve the adapter to spend the receipt token (`approveToken`).
+     * 2. Obtain a fee quote (`EVMVaultReader.getOFTFeeQuote`) and pass the result as `fee`.
+     *    Set `value` on the returned `ITransactionCall` to `fee.nativeFee`.
+     *
+     * @param adapterAddress The OFT adapter contract address
+     * @param sendParam The bridge send parameters (destination, recipient, amounts, options)
+     * @param fee The messaging fee (native + LZ token fee) obtained from a prior quote
+     * @param refundAddress Address to receive any excess native fee refund
+     * @returns Transaction call object
+     */
+    bridgeSend(adapterAddress: string, sendParam: IOFTSendParam, fee: IOFTMessagingFee, refundAddress: string): ITransactionCall;
 }