upshift-finance 1.0.0

package/lib/evm/methods/crossChainVaultRegistry.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Cross-Chain Vault Registry
+ *
+ * Address-keyed registry of August's LayerZero OVault deployments plus the
+ * resolver helpers that turn a vault address into the
+ * {@link ICrossChainVaultConfig} consumed by `buildCrossChainVaultTx`,
+ * `crossChainVaultDeposit`, and `quoteCrossChainDeposit`.
+ *
+ * This is the cross-chain analogue of the SwapRouter registry
+ * (`VAULTS_USING_SWAP_ROUTER` / `getSwapRouterAddress`): consumers resolve a
+ * full config by vault address instead of hand-assembling the per-chain
+ * contract maps and LayerZero EIDs. Without it, every consuming app would
+ * re-encode the same address book.
+ *
+ * Addresses are ported verbatim from upshift-app `src/config/ovault.ts` and
+ * cross-checked against the read-side `LAYERZERO_VAULTS` registry in
+ * `services/layerzero/deposits.ts`. Verify against the deployed contracts
+ * before adding or editing an entry — a wrong address silently routes funds
+ * to the wrong chain.
+ *
+ * Return convention (deliberate, mirrors the SwapRouter helpers): lookups that
+ * resolve a single optional value (`getCrossChainVaultConfig`,
+ * `getOVaultChains`) return `undefined` for an unregistered vault, while
+ * list-returning helpers (`getWithdrawDestinationChains`) return `[]` so
+ * callers can iterate without a null-check.
+ *
+ * @module evm/methods/crossChainVaultRegistry
+ */
+import type { IAddress } from '../../types';
+import type { ICrossChainVaultConfig } from '../types/crossChain';
+/**
+ * August's LayerZero OVault deployments, keyed by lowercase hub-chain vault
+ * address. Resolve entries with {@link getCrossChainVaultConfig} rather than
+ * indexing directly — the helper handles address-casing for you.
+ *
+ * @see {@link getCrossChainVaultConfig} for the typed, case-insensitive lookup.
+ */
+export declare const CROSS_CHAIN_VAULT_CONFIGS: Readonly<Record<string, ICrossChainVaultConfig>>;
+/**
+ * Resolve the full cross-chain config for a vault. Address comparison is
+ * case-insensitive.
+ *
+ * @param vault - Hub-chain vault contract address.
+ * @returns The {@link ICrossChainVaultConfig} to pass to
+ *   `crossChainVaultDeposit` / `quoteCrossChainDeposit`, or `undefined` when
+ *   the vault is not a registered OVault deployment.
+ * @example
+ * ```ts
+ * const config = getCrossChainVaultConfig('0xE9B725010A9E419412ed67d0fA5f3A5f40159D32');
+ * if (config) await quoteCrossChainDeposit({ config, ...rest });
+ * ```
+ */
+export declare function getCrossChainVaultConfig(vault: IAddress): ICrossChainVaultConfig | undefined;
+/**
+ * Whether a vault is a registered LayerZero OVault and should route deposits
+ * through the cross-chain flow. Address comparison is case-insensitive.
+ *
+ * @param vault - Vault contract address.
+ * @returns `true` when the vault has an entry in
+ *   {@link CROSS_CHAIN_VAULT_CONFIGS}.
+ */
+export declare function isCrossChainVault(vault: IAddress): boolean;
+/**
+ * Get the hub and spoke chain IDs a vault is deployed across — the set of
+ * chains a user can deposit from.
+ *
+ * @param vault - Vault contract address.
+ * @returns `{ hub, spokes }` chain IDs, or `undefined` when the vault is not a
+ *   registered OVault deployment.
+ */
+export declare function getOVaultChains(vault: IAddress): {
+    hub: number;
+    spokes: number[];
+} | undefined;
+/**
+ * Whether a vault's receipt token is hub-only (no cross-chain withdraw).
+ * The deposit UI must not offer a spoke share destination for these vaults.
+ *
+ * @param vault - Vault contract address.
+ * @returns `true` for vaults whose shares cannot leave the hub chain
+ *   (AUGUST-6300).
+ */
+export declare function isHubOnlyReceipt(vault: IAddress): boolean;
+/**
+ * Chains a user can receive the underlying asset on when withdrawing.
+ * Hub-only-receipt vaults redeem to the hub chain only (AUGUST-6300); all
+ * other OVault vaults can redeem to the hub or any spoke.
+ *
+ * @param vault - Vault contract address.
+ * @returns Destination chain IDs, or an empty array when the vault is not a
+ *   registered OVault deployment.
+ */
+export declare function getWithdrawDestinationChains(vault: IAddress): number[];

package/lib/evm/methods/crossChainVaultRegistry.js

@@ -0,0 +1,240 @@
+"use strict";
+/**
+ * Cross-Chain Vault Registry
+ *
+ * Address-keyed registry of August's LayerZero OVault deployments plus the
+ * resolver helpers that turn a vault address into the
+ * {@link ICrossChainVaultConfig} consumed by `buildCrossChainVaultTx`,
+ * `crossChainVaultDeposit`, and `quoteCrossChainDeposit`.
+ *
+ * This is the cross-chain analogue of the SwapRouter registry
+ * (`VAULTS_USING_SWAP_ROUTER` / `getSwapRouterAddress`): consumers resolve a
+ * full config by vault address instead of hand-assembling the per-chain
+ * contract maps and LayerZero EIDs. Without it, every consuming app would
+ * re-encode the same address book.
+ *
+ * Addresses are ported verbatim from upshift-app `src/config/ovault.ts` and
+ * cross-checked against the read-side `LAYERZERO_VAULTS` registry in
+ * `services/layerzero/deposits.ts`. Verify against the deployed contracts
+ * before adding or editing an entry — a wrong address silently routes funds
+ * to the wrong chain.
+ *
+ * Return convention (deliberate, mirrors the SwapRouter helpers): lookups that
+ * resolve a single optional value (`getCrossChainVaultConfig`,
+ * `getOVaultChains`) return `undefined` for an unregistered vault, while
+ * list-returning helpers (`getWithdrawDestinationChains`) return `[]` so
+ * callers can iterate without a null-check.
+ *
+ * @module evm/methods/crossChainVaultRegistry
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CROSS_CHAIN_VAULT_CONFIGS = void 0;
+exports.getCrossChainVaultConfig = getCrossChainVaultConfig;
+exports.isCrossChainVault = isCrossChainVault;
+exports.getOVaultChains = getOVaultChains;
+exports.isHubOnlyReceipt = isHubOnlyReceipt;
+exports.getWithdrawDestinationChains = getWithdrawDestinationChains;
+const crossChainVault_1 = require("./crossChainVault");
+// EVM chain IDs for the chains carrying OVault deployments. Plain literals
+// (not `viem/chains`) keep viem an optional peer dependency — importing viem
+// at module load would break SDK consumers that do not install it.
+const ETHEREUM = 1;
+const ARBITRUM = 42161;
+const AVALANCHE = 43114;
+const BASE = 8453;
+const SONIC = 146;
+const MONAD = 143;
+const CONFIGS = [
+    {
+        vaultName: 'Upshift Core USDC',
+        vaultSymbol: 'coreUSDC',
+        hubChainId: ETHEREUM,
+        vaultAddress: '0xE9B725010A9E419412ed67d0fA5f3A5f40159D32',
+        spokeChainIds: [ARBITRUM, AVALANCHE, BASE, SONIC],
+        contracts: {
+            assetToken: {
+                [ETHEREUM]: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+                [ARBITRUM]: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831',
+                [AVALANCHE]: '0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E',
+                [BASE]: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
+                [SONIC]: '0x29219dd400f2Bf60E5a23d13Be72B486D4038894',
+            },
+            assetOFT: {
+                [ETHEREUM]: '0xc026395860Db2d07ee33e05fE50ed7bD583189C7',
+                [ARBITRUM]: '0xe8CDF27AcD73a434D661C84887215F7598e7d0d3',
+                [AVALANCHE]: '0x5634c4a5FEd09819E3c46D86A965Dd9447d86e47',
+                [BASE]: '0x27a16dc786820B16E5c9028b75B99F6f604b5d26',
+                [SONIC]: '0xA272fFe20cFfe769CdFc4b63088DCD2C82a2D8F9',
+            },
+            shareOFTAdapter: '0x4a21dcba38c3816c78144f33bb42d8fa17f38067',
+            composerSync: '0xc2637d7721791cc9cb196628d1e5e06887b1d4b9',
+            shareOFT: {
+                [ARBITRUM]: '0x50a31ff4d57841681011837c17aa201c6a34203c',
+                [AVALANCHE]: '0x1FA931Bf85248aD2eDf0004DD9A284698358e708',
+                [BASE]: '0x1fa931bf85248ad2edf0004dd9a284698358e708',
+                [SONIC]: '0x4bdd224fe59a3ae0b249125ad4c5b3126074c71b',
+            },
+        },
+        layerZeroEids: {
+            hub: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.ETHEREUM,
+            spokes: {
+                [ARBITRUM]: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.ARBITRUM,
+                [AVALANCHE]: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.AVALANCHE,
+                [BASE]: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.BASE,
+                [SONIC]: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.SONIC,
+            },
+        },
+        hubOnlyReceipt: true,
+    },
+    {
+        vaultName: 'Upshift USDC',
+        vaultSymbol: 'upUSDC',
+        hubChainId: ETHEREUM,
+        vaultAddress: '0x80E1048eDE66ec4c364b4F22C8768fc657FF6A42',
+        spokeChainIds: [ARBITRUM, AVALANCHE, BASE, SONIC],
+        contracts: {
+            assetToken: {
+                [ETHEREUM]: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+                [ARBITRUM]: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831',
+                [AVALANCHE]: '0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E',
+                [BASE]: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
+                [SONIC]: '0x29219dd400f2Bf60E5a23d13Be72B486D4038894',
+            },
+            assetOFT: {
+                [ETHEREUM]: '0xc026395860Db2d07ee33e05fE50ed7bD583189C7',
+                [ARBITRUM]: '0xe8CDF27AcD73a434D661C84887215F7598e7d0d3',
+                [AVALANCHE]: '0x5634c4a5FEd09819E3c46D86A965Dd9447d86e47',
+                [BASE]: '0x27a16dc786820B16E5c9028b75B99F6f604b5d26',
+                [SONIC]: '0xA272fFe20cFfe769CdFc4b63088DCD2C82a2D8F9',
+            },
+            shareOFTAdapter: '0x81971a3c359cfe74259cff1b46fb5f2112ddde34',
+            composerSync: '0xbe82134b95a8e9370e6759f3c8f44087cd9a52be',
+            shareOFT: {
+                [ARBITRUM]: '0x81971a3c359cfe74259cff1b46fb5f2112ddde34',
+                [AVALANCHE]: '0x81971A3C359cFE74259CfF1b46FB5f2112ddDE34',
+                [BASE]: '0x81971a3c359cfe74259cff1b46fb5f2112ddde34',
+                [SONIC]: '0x81971a3c359cfe74259cff1b46fb5f2112ddde34',
+            },
+        },
+        layerZeroEids: {
+            hub: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.ETHEREUM,
+            spokes: {
+                [ARBITRUM]: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.ARBITRUM,
+                [AVALANCHE]: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.AVALANCHE,
+                [BASE]: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.BASE,
+                [SONIC]: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.SONIC,
+            },
+        },
+        hubOnlyReceipt: true,
+    },
+    {
+        vaultName: 'earnAUSD',
+        vaultSymbol: 'earnAUSD',
+        hubChainId: MONAD,
+        vaultAddress: '0x36eDbF0C834591BFdfCaC0Ef9605528c75c406aA',
+        spokeChainIds: [ETHEREUM],
+        contracts: {
+            assetToken: {
+                [MONAD]: '0x00000000eFE302BEAA2b3e6e1b18d08D69a9012a',
+                [ETHEREUM]: '0x00000000eFE302BEAA2b3e6e1b18d08D69a9012a',
+            },
+            assetOFT: {
+                [MONAD]: '0x9CaB7Ede13dc56652E44D2404E969C212f22689b',
+                [ETHEREUM]: '0x9CaB7Ede13dc56652E44D2404E969C212f22689b',
+            },
+            shareOFTAdapter: '0x9549Fa3DF579Cca9F3e328695382675F7f1f0F34',
+            composerSync: '0xd1B1b12533E12BADB8ea6D63AeDd11922cAE5580',
+            shareOFT: {
+                [ETHEREUM]: '0xa6916b65c5e3fEdf46c0a2F59bff776e872C8992',
+            },
+        },
+        layerZeroEids: {
+            hub: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.MONAD,
+            spokes: {
+                [ETHEREUM]: crossChainVault_1.LAYERZERO_ENDPOINT_IDS.ETHEREUM,
+            },
+        },
+        multiAsset: {
+            hubAssetAddress: '0x00000000eFE302BEAA2b3e6e1b18d08D69a9012a',
+        },
+    },
+];
+/**
+ * August's LayerZero OVault deployments, keyed by lowercase hub-chain vault
+ * address. Resolve entries with {@link getCrossChainVaultConfig} rather than
+ * indexing directly — the helper handles address-casing for you.
+ *
+ * @see {@link getCrossChainVaultConfig} for the typed, case-insensitive lookup.
+ */
+exports.CROSS_CHAIN_VAULT_CONFIGS = Object.freeze(Object.fromEntries(CONFIGS.map((config) => [config.vaultAddress.toLowerCase(), config])));
+/**
+ * Resolve the full cross-chain config for a vault. Address comparison is
+ * case-insensitive.
+ *
+ * @param vault - Hub-chain vault contract address.
+ * @returns The {@link ICrossChainVaultConfig} to pass to
+ *   `crossChainVaultDeposit` / `quoteCrossChainDeposit`, or `undefined` when
+ *   the vault is not a registered OVault deployment.
+ * @example
+ * ```ts
+ * const config = getCrossChainVaultConfig('0xE9B725010A9E419412ed67d0fA5f3A5f40159D32');
+ * if (config) await quoteCrossChainDeposit({ config, ...rest });
+ * ```
+ */
+function getCrossChainVaultConfig(vault) {
+    return exports.CROSS_CHAIN_VAULT_CONFIGS[vault.toLowerCase()];
+}
+/**
+ * Whether a vault is a registered LayerZero OVault and should route deposits
+ * through the cross-chain flow. Address comparison is case-insensitive.
+ *
+ * @param vault - Vault contract address.
+ * @returns `true` when the vault has an entry in
+ *   {@link CROSS_CHAIN_VAULT_CONFIGS}.
+ */
+function isCrossChainVault(vault) {
+    return getCrossChainVaultConfig(vault) !== undefined;
+}
+/**
+ * Get the hub and spoke chain IDs a vault is deployed across — the set of
+ * chains a user can deposit from.
+ *
+ * @param vault - Vault contract address.
+ * @returns `{ hub, spokes }` chain IDs, or `undefined` when the vault is not a
+ *   registered OVault deployment.
+ */
+function getOVaultChains(vault) {
+    const config = getCrossChainVaultConfig(vault);
+    if (!config)
+        return undefined;
+    return { hub: config.hubChainId, spokes: config.spokeChainIds };
+}
+/**
+ * Whether a vault's receipt token is hub-only (no cross-chain withdraw).
+ * The deposit UI must not offer a spoke share destination for these vaults.
+ *
+ * @param vault - Vault contract address.
+ * @returns `true` for vaults whose shares cannot leave the hub chain
+ *   (AUGUST-6300).
+ */
+function isHubOnlyReceipt(vault) {
+    return getCrossChainVaultConfig(vault)?.hubOnlyReceipt === true;
+}
+/**
+ * Chains a user can receive the underlying asset on when withdrawing.
+ * Hub-only-receipt vaults redeem to the hub chain only (AUGUST-6300); all
+ * other OVault vaults can redeem to the hub or any spoke.
+ *
+ * @param vault - Vault contract address.
+ * @returns Destination chain IDs, or an empty array when the vault is not a
+ *   registered OVault deployment.
+ */
+function getWithdrawDestinationChains(vault) {
+    const config = getCrossChainVaultConfig(vault);
+    if (!config)
+        return [];
+    if (isHubOnlyReceipt(vault))
+        return [config.hubChainId];
+    return [config.hubChainId, ...config.spokeChainIds];
+}
+//# sourceMappingURL=crossChainVaultRegistry.js.map

package/lib/evm/methods/index.d.ts

@@ -0,0 +1,2 @@
+export * from './crossChainVault';
+export * from './crossChainVaultRegistry';

package/lib/evm/methods/index.js

@@ -0,0 +1,19 @@
+"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("./crossChainVault"), exports);
+__exportStar(require("./crossChainVaultRegistry"), exports);
+//# sourceMappingURL=index.js.map