@ember-finance/sdk 1.0.29 → 1.1.1

package/dist/src/common/types.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Type alias for numeric values that can be strings or numbers
+ */
+export type NumStr = string | number | bigint;

package/dist/src/common/types.js

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

package/dist/src/ember-vaults.d.ts

@@ -0,0 +1,169 @@
+import { Signer as SuiSigner, SuiClient } from "@firefly-exchange/library-sui";
+import { Signer as EvmSigner, Provider as EvmProvider } from "ethers";
+import { ISuiDeployment } from "./sui-vaults/interfaces";
+import { TxBuilder as SuiTxBuilder } from "./sui-vaults/on-chain-calls";
+import { AdminCalls as SuiAdminCalls } from "./sui-vaults/on-chain-calls/admin";
+import { OperatorCalls as SuiOperatorCalls } from "./sui-vaults/on-chain-calls/operator";
+import { UserCalls as SuiUserCalls } from "./sui-vaults/on-chain-calls/user";
+import { VaultAdminCalls as SuiVaultAdminCalls } from "./sui-vaults/on-chain-calls/vault-admin";
+import { SuiDeploymentParser } from "./sui-vaults/utils/deployment-parser";
+import { IEvmDeployment } from "./evm-vaults/interfaces";
+import { EVMTxBuilder } from "./evm-vaults/on-chain-calls/tx-builder";
+import { EVMAdminCalls } from "./evm-vaults/on-chain-calls/admin";
+import { EVMOperatorCalls } from "./evm-vaults/on-chain-calls/operator";
+import { EVMUserCalls } from "./evm-vaults/on-chain-calls/user";
+import { EVMVaultAdminCalls } from "./evm-vaults/on-chain-calls/vault-admin";
+import { EVMDeploymentParser } from "./evm-vaults/utils/deployment-parser";
+import { AccountsApi, VaultsApi } from "./api";
+export type PlatformEnv = "prod" | "staging" | "dev";
+export type ChainType = "sui" | "evm";
+/**
+ * SUI-specific initialization options
+ */
+export interface SuiInitOptions {
+    chainType: "sui";
+    network: string;
+    suiClient: SuiClient;
+    signer?: SuiSigner;
+    walletAddress?: string;
+    deployment?: ISuiDeployment;
+    basePath?: string;
+    environment?: PlatformEnv;
+}
+/**
+ * EVM-specific initialization options
+ */
+export interface EvmInitOptions {
+    chainType: "evm";
+    signer?: EvmSigner;
+    provider?: EvmProvider;
+    walletAddress?: string;
+    deployment?: IEvmDeployment;
+    basePath?: string;
+    environment?: PlatformEnv;
+}
+export type EmberVaultsInitOptions = SuiInitOptions | EvmInitOptions;
+/**
+ * SUI-specific EmberVaults instance type
+ */
+export interface SuiEmberVaults {
+    chainType: "sui";
+    suiClient: SuiClient;
+    signer?: SuiSigner;
+    parser: SuiDeploymentParser;
+    walletAddress?: string;
+    txBuilder: SuiTxBuilder;
+    network: string;
+    admin: SuiAdminCalls;
+    operator: SuiOperatorCalls;
+    vaultAdmin: SuiVaultAdminCalls;
+    user: SuiUserCalls;
+    deployment: ISuiDeployment;
+}
+/**
+ * EVM-specific EmberVaults instance type
+ */
+export interface EvmEmberVaults {
+    chainType: "evm";
+    signer?: EvmSigner;
+    provider?: EvmProvider;
+    parser: EVMDeploymentParser;
+    walletAddress?: string;
+    txBuilder: EVMTxBuilder;
+    admin: EVMAdminCalls;
+    operator: EVMOperatorCalls;
+    vaultAdmin: EVMVaultAdminCalls;
+    user: EVMUserCalls;
+    deployment: IEvmDeployment;
+}
+/**
+ * EmberVaults - Unified interface for both SUI and EVM chains
+ *
+ * @example SUI initialization:
+ * ```typescript
+ * const ember = new EmberVaults({
+ *   chainType: "sui",
+ *   network: "mainnet",
+ *   suiClient,
+ *   signer,
+ *   walletAddress
+ * });
+ * await ember.init();
+ * ```
+ *
+ * @example EVM initialization:
+ * ```typescript
+ * const ember = new EmberVaults({
+ *   chainType: "evm",
+ *   signer,
+ *   provider,
+ *   deployment
+ * });
+ * ```
+ */
+export declare class EmberVaults {
+    readonly chainType: ChainType;
+    apiHost: string;
+    api: AccountsApi;
+    vaultsApi: VaultsApi;
+    private _suiClient?;
+    private _suiSigner?;
+    private _suiParser?;
+    private _suiTxBuilder?;
+    private _suiAdmin?;
+    private _suiOperator?;
+    private _suiVaultAdmin?;
+    private _suiUser?;
+    private _suiDeployment?;
+    private _suiNetwork?;
+    private _evmSigner?;
+    private _evmProvider?;
+    private _evmParser?;
+    private _evmTxBuilder?;
+    private _evmAdmin?;
+    private _evmOperator?;
+    private _evmVaultAdmin?;
+    private _evmUser?;
+    private _evmDeployment?;
+    private _walletAddress?;
+    constructor(options: EmberVaultsInitOptions);
+    private _initSui;
+    private _initEvm;
+    /**
+     * Initialize by fetching deployment from API (SUI only currently)
+     */
+    init(): Promise<void>;
+    /**
+     * Updates the deployment configuration
+     * @param newDeployment The new deployment configuration (ISuiDeployment or IEvmDeployment)
+     */
+    updateDeployment(newDeployment: ISuiDeployment | IEvmDeployment): void;
+    get suiClient(): SuiClient;
+    get network(): string;
+    get provider(): EvmProvider | undefined;
+    get walletAddress(): string | undefined;
+    get signer(): SuiSigner | EvmSigner | undefined;
+    get parser(): SuiDeploymentParser | EVMDeploymentParser;
+    get txBuilder(): SuiTxBuilder | EVMTxBuilder;
+    get admin(): SuiAdminCalls | EVMAdminCalls;
+    get operator(): SuiOperatorCalls | EVMOperatorCalls;
+    get vaultAdmin(): SuiVaultAdminCalls | EVMVaultAdminCalls;
+    get user(): SuiUserCalls | EVMUserCalls;
+    get deployment(): ISuiDeployment | IEvmDeployment;
+    /**
+     * Check if this is a SUI instance
+     */
+    isSui(): this is EmberVaults & SuiEmberVaults;
+    /**
+     * Check if this is an EVM instance
+     */
+    isEvm(): this is EmberVaults & EvmEmberVaults;
+    /**
+     * Get SUI-specific instance (throws if not SUI)
+     */
+    asSui(): SuiEmberVaults;
+    /**
+     * Get EVM-specific instance (throws if not EVM)
+     */
+    asEvm(): EvmEmberVaults;
+}

package/dist/src/ember-vaults.js

@@ -0,0 +1,239 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmberVaults = void 0;
+const on_chain_calls_1 = require("./sui-vaults/on-chain-calls");
+const admin_1 = require("./sui-vaults/on-chain-calls/admin");
+const operator_1 = require("./sui-vaults/on-chain-calls/operator");
+const user_1 = require("./sui-vaults/on-chain-calls/user");
+const vault_admin_1 = require("./sui-vaults/on-chain-calls/vault-admin");
+const deployment_parser_1 = require("./sui-vaults/utils/deployment-parser");
+const tx_builder_1 = require("./evm-vaults/on-chain-calls/tx-builder");
+const admin_2 = require("./evm-vaults/on-chain-calls/admin");
+const operator_2 = require("./evm-vaults/on-chain-calls/operator");
+const user_2 = require("./evm-vaults/on-chain-calls/user");
+const vault_admin_2 = require("./evm-vaults/on-chain-calls/vault-admin");
+const deployment_parser_2 = require("./evm-vaults/utils/deployment-parser");
+// API imports
+const api_1 = require("./api");
+const environmentConfig = {
+    prod: {
+        apiHost: "https://vaults.api.sui-prod.bluefin.io"
+    },
+    staging: {
+        apiHost: "https://vaults.api.sui-staging.bluefin.io"
+    },
+    dev: {
+        apiHost: "https://vaults.api.sui-dev.bluefin.io"
+    }
+};
+/**
+ * EmberVaults - Unified interface for both SUI and EVM chains
+ *
+ * @example SUI initialization:
+ * ```typescript
+ * const ember = new EmberVaults({
+ *   chainType: "sui",
+ *   network: "mainnet",
+ *   suiClient,
+ *   signer,
+ *   walletAddress
+ * });
+ * await ember.init();
+ * ```
+ *
+ * @example EVM initialization:
+ * ```typescript
+ * const ember = new EmberVaults({
+ *   chainType: "evm",
+ *   signer,
+ *   provider,
+ *   deployment
+ * });
+ * ```
+ */
+class EmberVaults {
+    constructor(options) {
+        this.chainType = options.chainType;
+        this._walletAddress = options.walletAddress;
+        const environment = options.environment ?? "prod";
+        this.apiHost = options.basePath || environmentConfig[environment].apiHost;
+        this.api = new api_1.AccountsApi(new api_1.Configuration({ basePath: this.apiHost }));
+        this.vaultsApi = new api_1.VaultsApi(new api_1.Configuration({ basePath: this.apiHost }));
+        if (options.chainType === "sui") {
+            this._initSui(options);
+        }
+        else {
+            this._initEvm(options);
+        }
+    }
+    _initSui(options) {
+        this._suiNetwork = options.network;
+        this._suiClient = options.suiClient;
+        this._suiSigner = options.signer;
+        this._suiDeployment = options.deployment || {};
+        this._walletAddress = options.walletAddress || options.signer?.toSuiAddress();
+        this._suiParser = new deployment_parser_1.SuiDeploymentParser(this._suiDeployment);
+        this._suiTxBuilder = new on_chain_calls_1.TxBuilder(this._suiDeployment);
+        this._suiAdmin = new admin_1.AdminCalls(options.network, options.suiClient, this._suiDeployment, options.signer, this._walletAddress);
+        this._suiOperator = new operator_1.OperatorCalls(options.network, options.suiClient, this._suiDeployment, options.signer, this._walletAddress);
+        this._suiVaultAdmin = new vault_admin_1.VaultAdminCalls(options.network, options.suiClient, this._suiDeployment, options.signer, this._walletAddress);
+        this._suiUser = new user_1.UserCalls(options.network, options.suiClient, this._suiDeployment, options.signer, this._walletAddress);
+    }
+    _initEvm(options) {
+        this._evmSigner = options.signer;
+        this._evmProvider = options.provider;
+        this._evmDeployment = options.deployment || {};
+        this._evmParser = new deployment_parser_2.EVMDeploymentParser(this._evmDeployment);
+        this._evmTxBuilder = new tx_builder_1.EVMTxBuilder(this._evmDeployment);
+        this._evmAdmin = new admin_2.EVMAdminCalls(this._evmDeployment, options.signer, options.provider, options.walletAddress);
+        this._evmOperator = new operator_2.EVMOperatorCalls(this._evmDeployment, options.signer, options.provider, options.walletAddress);
+        this._evmVaultAdmin = new vault_admin_2.EVMVaultAdminCalls(this._evmDeployment, options.signer, options.provider, options.walletAddress);
+        this._evmUser = new user_2.EVMUserCalls(this._evmDeployment, options.signer, options.provider, options.walletAddress);
+    }
+    /**
+     * Initialize by fetching deployment from API (SUI only currently)
+     */
+    async init() {
+        // Assuming that the vaults Api will return the correct deployment for the requested chain
+        // TODO: We might need to provide an input to the vaults Api
+        // so it knows for which chain the deployment is requested ??
+        // Confirm above with Burhan/Shahzaib
+        const deployment = await this.vaultsApi.getVaultsProtocolInfo();
+        const deploymentData = deployment.data;
+        this.updateDeployment(deploymentData);
+    }
+    /**
+     * Updates the deployment configuration
+     * @param newDeployment The new deployment configuration (ISuiDeployment or IEvmDeployment)
+     */
+    updateDeployment(newDeployment) {
+        if (this.chainType === "sui") {
+            const suiDeployment = newDeployment;
+            this._suiDeployment = suiDeployment;
+            this._suiParser?.updateDeployment(suiDeployment);
+            this._suiTxBuilder?.updateDeployment(suiDeployment);
+            this._suiAdmin?.updateDeployment(suiDeployment);
+            this._suiOperator?.updateDeployment(suiDeployment);
+            this._suiVaultAdmin?.updateDeployment(suiDeployment);
+            this._suiUser?.updateDeployment(suiDeployment);
+        }
+        else {
+            const evmDeployment = newDeployment;
+            this._evmDeployment = evmDeployment;
+            this._evmParser?.updateDeployment(evmDeployment);
+            this._evmTxBuilder?.updateDeployment(evmDeployment);
+            this._evmAdmin?.updateDeployment(evmDeployment);
+            this._evmOperator?.updateDeployment(evmDeployment);
+            this._evmVaultAdmin?.updateDeployment(evmDeployment);
+            this._evmUser?.updateDeployment(evmDeployment);
+        }
+    }
+    // ============================================
+    // SUI Getters
+    // ============================================
+    get suiClient() {
+        if (this.chainType !== "sui")
+            throw new Error("suiClient is only available for SUI chain");
+        return this._suiClient;
+    }
+    get network() {
+        if (this.chainType !== "sui")
+            throw new Error("network is only available for SUI chain");
+        return this._suiNetwork;
+    }
+    // ============================================
+    // EVM Getters
+    // ============================================
+    get provider() {
+        if (this.chainType !== "evm")
+            throw new Error("provider is only available for EVM chain");
+        return this._evmProvider;
+    }
+    // ============================================
+    // Common Getters (chain-specific implementations)
+    // ============================================
+    get walletAddress() {
+        return this._walletAddress;
+    }
+    get signer() {
+        return this.chainType === "sui" ? this._suiSigner : this._evmSigner;
+    }
+    get parser() {
+        return this.chainType === "sui" ? this._suiParser : this._evmParser;
+    }
+    get txBuilder() {
+        return this.chainType === "sui" ? this._suiTxBuilder : this._evmTxBuilder;
+    }
+    get admin() {
+        return this.chainType === "sui" ? this._suiAdmin : this._evmAdmin;
+    }
+    get operator() {
+        return this.chainType === "sui" ? this._suiOperator : this._evmOperator;
+    }
+    get vaultAdmin() {
+        return this.chainType === "sui" ? this._suiVaultAdmin : this._evmVaultAdmin;
+    }
+    get user() {
+        return this.chainType === "sui" ? this._suiUser : this._evmUser;
+    }
+    get deployment() {
+        return this.chainType === "sui" ? this._suiDeployment : this._evmDeployment;
+    }
+    // ============================================
+    // Type Guards for chain-specific access
+    // ============================================
+    /**
+     * Check if this is a SUI instance
+     */
+    isSui() {
+        return this.chainType === "sui";
+    }
+    /**
+     * Check if this is an EVM instance
+     */
+    isEvm() {
+        return this.chainType === "evm";
+    }
+    /**
+     * Get SUI-specific instance (throws if not SUI)
+     */
+    asSui() {
+        if (!this.isSui())
+            throw new Error("This EmberVaults instance is not configured for SUI");
+        return {
+            chainType: "sui",
+            suiClient: this._suiClient,
+            signer: this._suiSigner,
+            parser: this._suiParser,
+            walletAddress: this._walletAddress,
+            txBuilder: this._suiTxBuilder,
+            network: this._suiNetwork,
+            admin: this._suiAdmin,
+            operator: this._suiOperator,
+            vaultAdmin: this._suiVaultAdmin,
+            user: this._suiUser,
+            deployment: this._suiDeployment
+        };
+    }
+    /**
+     * Get EVM-specific instance (throws if not EVM)
+     */
+    asEvm() {
+        if (!this.isEvm())
+            throw new Error("This EmberVaults instance is not configured for EVM");
+        return {
+            chainType: "evm",
+            signer: this._evmSigner,
+            provider: this._evmProvider,
+            parser: this._evmParser,
+            walletAddress: this._walletAddress,
+            txBuilder: this._evmTxBuilder,
+            admin: this._evmAdmin,
+            operator: this._evmOperator,
+            vaultAdmin: this._evmVaultAdmin,
+            user: this._evmUser,
+            deployment: this._evmDeployment
+        };
+    }
+}
+exports.EmberVaults = EmberVaults;

package/dist/src/{vaults → evm-vaults}/index.d.ts

@@ -1,5 +1,3 @@
-export * from "./ember-vaults";
-export * from "./api";
 export * from "./interfaces";
 export * from "./on-chain-calls";
 export * from "./utils";

package/dist/src/{vaults → evm-vaults}/index.js

@@ -14,8 +14,6 @@ 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("./ember-vaults"), exports);
-__exportStar(require("./api"), exports);
 __exportStar(require("./interfaces"), exports);
 __exportStar(require("./on-chain-calls"), exports);
 __exportStar(require("./utils"), exports);

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

@@ -0,0 +1,168 @@
+import { Signer, Provider, TransactionResponse, TransactionReceipt, Log, LogDescription } from "ethers";
+/**
+ * Represents the deployment configuration for the Ember Protocol on EVM-compatible chains
+ */
+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;
+            };
+        };
+    };
+}
+/**
+ * Optional parameters for EVM transaction building
+ */
+export interface IEvmTxBuilderParams {
+    /** Gas limit for the transaction */
+    gasLimit?: bigint;
+    /** Max fee per gas (EIP-1559) */
+    maxFeePerGas?: bigint;
+    /** Max priority fee per gas (EIP-1559) */
+    maxPriorityFeePerGas?: bigint;
+    /** Gas price (legacy transactions) */
+    gasPrice?: bigint;
+    /** Transaction value in wei */
+    value?: bigint;
+    /** Nonce for the transaction */
+    nonce?: number;
+}
+/**
+ * Represents an encoded EVM transaction ready to be sent
+ */
+export interface IEncodedTransaction {
+    /** The target contract address */
+    to: string;
+    /** The encoded function data */
+    data: string;
+    /** The value in wei (default: 0) */
+    value: bigint;
+    /** Optional gas limit */
+    gasLimit?: bigint;
+    /** Chain ID */
+    chainId: string;
+}
+/**
+ * Vault pause operation types for EVM
+ */
+export type VaultPauseOperation = "deposits" | "withdrawals" | "privilegedOperations";
+/**
+ * Represents a transaction call that can be encoded by ethers.js
+ */
+export interface ITransactionCall {
+    /** The target contract address */
+    to: string;
+    /** The function name to call */
+    functionName: string;
+    /** The arguments to pass to the function */
+    args: unknown[];
+    /** The ABI of the contract */
+    abi: unknown[];
+    /** The value in wei (default: 0n) */
+    value: bigint;
+    /** Chain ID from deployment */
+    chainId: string;
+}
+/**
+ * Optional parameters for EVM on-chain calls
+ */
+export interface IEvmCallOptions {
+    /** If true, simulates the transaction without sending */
+    dryRun?: boolean;
+    /** If true, returns the transaction call object without executing */
+    returnTxCall?: boolean;
+    /** If true, waits for the transaction to be mined and returns receipt with events */
+    waitForReceipt?: boolean;
+    /** Number of confirmations to wait for (default: 1) */
+    confirmations?: number;
+    /** Gas limit override */
+    gasLimit?: bigint;
+}
+/**
+ * Optional parameters for user deposit/mint/redeem calls
+ */
+export interface IUserCallOptions extends IEvmCallOptions {
+    /** Receiver address for shares/funds. Defaults to the caller's address if not provided */
+    receiver?: string;
+}
+/**
+ * Parsed event from a transaction
+ */
+export interface IParsedEvent {
+    /** Event name */
+    name: string;
+    /** Event signature */
+    signature: string;
+    /** Decoded event arguments */
+    args: Record<string, unknown>;
+    /** Raw log */
+    log: Log;
+}
+/**
+ * Response for dry run calls
+ */
+export interface IDryRunResponse {
+    success: boolean;
+    /** Error message if the call failed */
+    error?: string;
+    /** Decoded return value from the call (if successful) */
+    result?: unknown;
+}
+/**
+ * Response for executed transactions with receipt
+ */
+export interface ITransactionReceiptResponse {
+    /** Transaction response */
+    response: TransactionResponse;
+    /** Transaction receipt */
+    receipt: TransactionReceipt;
+    /** Parsed events from the transaction */
+    events: IParsedEvent[];
+}
+/**
+ * Response type for EVM on-chain calls
+ */
+export type EvmOnChainCallResponse = TransactionResponse | ITransactionReceiptResponse | ITransactionCall | IDryRunResponse;
+/**
+ * Re-export ethers types for convenience
+ */
+export type { Signer, Provider, TransactionResponse, TransactionReceipt, Log, LogDescription };