@upshiftfinance/sdk 0.0.0-stage → 0.2.0

package/lib/abis/WrapperAdapter.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ABI_WRAPPER_ADAPTER = void 0;
+exports.ABI_WRAPPER_ADAPTER = [
+    {
+        inputs: [{ internalType: 'address', name: 'referralId', type: 'address' }],
+        name: 'depositETH',
+        outputs: [],
+        stateMutability: 'payable',
+        type: 'function',
+    },
+    {
+        inputs: [
+            { internalType: 'uint256', name: 'amount', type: 'uint256' },
+            { internalType: 'address', name: 'referralId', type: 'address' },
+        ],
+        name: 'depositWETH',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+    },
+    {
+        inputs: [{ internalType: 'address', name: 'referralId', type: 'address' }],
+        name: 'getRSETHWithETH',
+        outputs: [],
+        stateMutability: 'payable',
+        type: 'function',
+    },
+    {
+        inputs: [
+            {
+                internalType: 'address',
+                name: 'asset',
+                type: 'address',
+            },
+            {
+                internalType: 'uint256',
+                name: 'depositAmount',
+                type: 'uint256',
+            },
+            {
+                internalType: 'string',
+                name: 'referralId',
+                type: 'string',
+            },
+        ],
+        name: 'getRSETHWithERC20',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+    },
+    {
+        inputs: [
+            {
+                internalType: 'address',
+                name: 'asset',
+                type: 'address',
+            },
+            {
+                internalType: 'uint256',
+                name: 'depositAmount',
+                type: 'uint256',
+            },
+        ],
+        name: 'getRsETHAmountToMint',
+        outputs: [
+            {
+                internalType: 'uint256',
+                name: 'rsETHAmount',
+                type: 'uint256',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+    },
+];
+//# sourceMappingURL=WrapperAdapter.js.map

package/lib/abis/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Contract ABI definitions for interacting with Upshift smart contracts.
+ *
+ * @module ABIs
+ */
+export * from './LendingPool';
+export * from './ERC20';
+export * from './Loan';
+export * from './FeeOracle';
+export * from './AddressResolver';
+export * from './ERC20_Bytes32';
+export * from './ERC4626';
+export * from './ERC721';
+export * from './LendingPoolV2';
+export * from './Multicall3';
+export * from './SmartAccount';
+export * from './TextResolver';
+export * from './UniversalResolverResolve';
+export * from './UniversalSignatureValidator';
+export * from './ChainlinkV3';
+export * from './RewardDistributor';
+export * from './WrapperAdapter';
+export * from './PoolAdapter';
+export * from './LendingPoolV3';
+export * from './TokenizedVaultV2WhitelistedAssets';
+export * from './TokenizedVaultV2';
+export * from './TokenizedVaultV2Receipt';
+export * from './TokenizedVaultV2DepositWithPermit';
+export * from './TokenizedVaultV2WhitelistedAllocation';
+export * from './MultiAssetNativeDepositWrapper';
+export * from './TokenizedVaultV2SenderAllocationWhitelist';
+export * from './RwaRedeemSubaccount';
+export * from './OFT';
+export * from './SwapRouter';

package/lib/abis/index.js

@@ -0,0 +1,51 @@
+"use strict";
+/**
+ * Contract ABI definitions for interacting with Upshift smart contracts.
+ *
+ * @module ABIs
+ */
+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("./LendingPool"), exports);
+__exportStar(require("./ERC20"), exports);
+__exportStar(require("./Loan"), exports);
+__exportStar(require("./FeeOracle"), exports);
+__exportStar(require("./AddressResolver"), exports);
+__exportStar(require("./ERC20_Bytes32"), exports);
+__exportStar(require("./ERC4626"), exports);
+__exportStar(require("./ERC721"), exports);
+__exportStar(require("./LendingPoolV2"), exports);
+__exportStar(require("./Multicall3"), exports);
+__exportStar(require("./SmartAccount"), exports);
+__exportStar(require("./TextResolver"), exports);
+__exportStar(require("./UniversalResolverResolve"), exports);
+__exportStar(require("./UniversalSignatureValidator"), exports);
+__exportStar(require("./ChainlinkV3"), exports);
+__exportStar(require("./RewardDistributor"), exports);
+__exportStar(require("./WrapperAdapter"), exports);
+__exportStar(require("./PoolAdapter"), exports);
+__exportStar(require("./LendingPoolV3"), exports);
+__exportStar(require("./TokenizedVaultV2WhitelistedAssets"), exports);
+__exportStar(require("./TokenizedVaultV2"), exports);
+__exportStar(require("./TokenizedVaultV2Receipt"), exports);
+__exportStar(require("./TokenizedVaultV2DepositWithPermit"), exports);
+__exportStar(require("./TokenizedVaultV2WhitelistedAllocation"), exports);
+__exportStar(require("./MultiAssetNativeDepositWrapper"), exports);
+__exportStar(require("./TokenizedVaultV2SenderAllocationWhitelist"), exports);
+__exportStar(require("./RwaRedeemSubaccount"), exports);
+__exportStar(require("./OFT"), exports);
+__exportStar(require("./SwapRouter"), exports);
+//# sourceMappingURL=index.js.map

package/lib/adapters/evm/getters.d.ts

@@ -0,0 +1,19 @@
+import type { ITokenizedVault } from '../../types';
+import type { IVaultBaseOptions } from '../../modules/vaults/types';
+/**
+ * Fetch EVM vault data for v1 vault contracts (legacy format).
+ * Queries on-chain state and combines with backend metadata.
+ * @param tokenizedVault Vault metadata from backend
+ * @param options RPC configuration and chain details
+ * @returns Formatted vault object or null if closed/invisible
+ */
+export declare const getEvmVaultV1: (tokenizedVault: ITokenizedVault, options: IVaultBaseOptions) => Promise<import("../../types").IVault>;
+/**
+ * Fetch EVM vault data for v2 vault contracts (current format).
+ * V2 vaults use separate contracts for vault, receipt token, and whitelist.
+ * Queries all three contracts and combines results.
+ * @param tokenizedVault Vault metadata from backend
+ * @param options RPC configuration and chain details
+ * @returns Formatted vault object or null if closed/invisible
+ */
+export declare const getEvmVaultV2: (tokenizedVault: ITokenizedVault, options: IVaultBaseOptions) => Promise<import("../../types").IVault>;

package/lib/adapters/evm/getters.js

@@ -0,0 +1,249 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEvmVaultV2 = exports.getEvmVaultV1 = void 0;
+const abis_1 = require("../../abis");
+const core_1 = require("../../core");
+const utils_1 = require("../../modules/vaults/utils");
+const TokenizedVaultV2_1 = require("../../abis/TokenizedVaultV2");
+const TokenizedVaultV2Receipt_1 = require("../../abis/TokenizedVaultV2Receipt");
+/**
+ * Read the vault's on-chain deposit-pause switch.
+ *
+ * A curator pausing deposits is the only signal that the deposit CTA must be
+ * disabled — without this read the UI offers a deposit that always reverts with
+ * `DepositsPaused` at estimateGas.
+ *
+ * Only a contract **revert** is treated as "getter absent". Transport failures
+ * (rate limit, timeout, network blip) are re-thrown: swallowing them would
+ * render a paused vault as open and send the user into a deposit that reverts
+ * at estimateGas — exactly the failure this read exists to prevent.
+ * @param vaultContract Vault contract instance (v1 lending pool or v2 tokenized vault).
+ * @returns `true` when deposits are paused on-chain; `false` when they are open
+ * OR when the deployment predates the getter — an older vault without
+ * `depositsPaused()` reverts the call, and a reverting read must not drop the
+ * whole vault from the marketplace.
+ * @throws The underlying RPC error when the read fails for a transport reason
+ * rather than a contract revert, so a flaky node cannot masquerade as
+ * "deposits open".
+ */
+const readDepositsPaused = async (vaultContract) => {
+    try {
+        return await vaultContract.depositsPaused();
+    }
+    catch (error) {
+        // Old deployments without `depositsPaused()` revert — treat as open.
+        // Anything else is a transport fault and must surface.
+        const isMissingGetter = (0, core_1.isExpectedRevertError)(error);
+        (0, core_1.logChainError)('readDepositsPaused', error, isMissingGetter);
+        if (isMissingGetter)
+            return false;
+        throw error;
+    }
+};
+/**
+ * Fetch EVM vault data for v1 vault contracts (legacy format).
+ * Queries on-chain state and combines with backend metadata.
+ * @param tokenizedVault Vault metadata from backend
+ * @param options RPC configuration and chain details
+ * @returns Formatted vault object or null if closed/invisible
+ */
+const getEvmVaultV1 = async (tokenizedVault, options) => {
+    const vault = tokenizedVault.address;
+    if (!vault) {
+        throw new Error('Vault address is undefined');
+    }
+    // Skip closed staging vaults that shouldn't be displayed — unless the caller
+    // explicitly opts in (portfolio mode), where a user's position in a closed,
+    // invisible vault must still resolve its metadata.
+    if (tokenizedVault.status === 'closed' &&
+        tokenizedVault.is_visible === false &&
+        !options?.includeClosed) {
+        core_1.Logger.log.warn('getEvmVaultV1', `closed: ${tokenizedVault.vault_name}`);
+        return null;
+    }
+    const provider = (0, core_1.createProvider)(options.rpcUrl);
+    // Batch fetch all vault contract data
+    const vaultContract = (0, core_1.createContract)({
+        address: vault,
+        abi: abis_1.ABI_LENDING_POOL_V2,
+        provider,
+    });
+    const vaultContractCalls = await Promise.all(core_1.VAULT_FUNCTIONS_V1.map(async (f) => {
+        if (f === 'totalSupply' || f === 'totalAssets') {
+            if ((0, core_1.getVaultVersionV2)(tokenizedVault) === 'evm-2' ||
+                core_1.MULTI_ASSET_VAULTS.includes(vault)) {
+                return 0;
+            }
+        }
+        if (f === 'maxDepositAmount') {
+            try {
+                return await vaultContract[f]();
+            }
+            catch (error) {
+                return null;
+            }
+        }
+        if (f === 'depositsPaused') {
+            return readDepositsPaused(vaultContract);
+        }
+        if (f === 'symbol') {
+            return (0, core_1.getSymbol)(provider, vault);
+        }
+        if (f === 'decimals') {
+            return (0, core_1.getDecimalsOrThrow)(provider, vault, 'getEvmVaultV1');
+        }
+        return vaultContract[f]();
+    }));
+    // Normalize contract call results into typed object
+    const formattedContractCalls = vaultContractCalls.reduce((acc, curr, i) => {
+        let val;
+        if (core_1.VAULT_FUNCTIONS_V1[i] === 'maxDepositAmount') {
+            if (curr === null) {
+                return acc;
+            }
+            val = (0, core_1.toNormalizedBn)(curr, vaultContractCalls[0]);
+        }
+        else if (core_1.VAULT_FUNCTIONS_V1[i] === 'totalSupply' ||
+            core_1.VAULT_FUNCTIONS_V1[i] === 'totalAssets' ||
+            core_1.VAULT_FUNCTIONS_V1[i] === 'globalLoansAmount' ||
+            core_1.VAULT_FUNCTIONS_V1[i] === 'maxSupply') {
+            val = (0, core_1.toNormalizedBn)(curr, vaultContractCalls[0]);
+        }
+        else if (core_1.VAULT_FUNCTIONS_V1[i] === 'getTotalLoansDeployed') {
+            val = (0, core_1.toNormalizedBn)(curr, 0);
+        }
+        else if (core_1.VAULT_FUNCTIONS_V1[i] === 'withdrawalFee') {
+            val = (0, core_1.toNormalizedBn)(curr, 2);
+        }
+        else if (core_1.VAULT_FUNCTIONS_V1[i] === 'decimals') {
+            val = Number(curr.toString());
+        }
+        else if (core_1.VAULT_FUNCTIONS_V1[i] === 'loansOperator') {
+            // TODO: hardcoded as we cannot pull the real strategist
+            val = '0x4DCb388488622e47683EAd1a147947140a31e485';
+        }
+        else {
+            val = curr;
+        }
+        return { ...acc, [core_1.VAULT_FUNCTIONS_V1[i]]: val };
+    }, {});
+    // Combine on-chain and backend data into unified vault object
+    const returnObj = await (0, utils_1.buildFormattedVault)(provider, tokenizedVault, formattedContractCalls);
+    return returnObj;
+};
+exports.getEvmVaultV1 = getEvmVaultV1;
+/**
+ * Fetch EVM vault data for v2 vault contracts (current format).
+ * V2 vaults use separate contracts for vault, receipt token, and whitelist.
+ * Queries all three contracts and combines results.
+ * @param tokenizedVault Vault metadata from backend
+ * @param options RPC configuration and chain details
+ * @returns Formatted vault object or null if closed/invisible
+ */
+const getEvmVaultV2 = async (tokenizedVault, options) => {
+    const provider = (0, core_1.createProvider)(options.rpcUrl);
+    const vault = tokenizedVault.address;
+    if (!vault) {
+        throw new Error('Vault address is undefined');
+    }
+    // Skip closed staging vaults that shouldn't be displayed — unless the caller
+    // explicitly opts in (portfolio mode), where a user's position in a closed,
+    // invisible vault must still resolve its metadata.
+    if (tokenizedVault.status === 'closed' &&
+        tokenizedVault.is_visible === false &&
+        !options?.includeClosed) {
+        core_1.Logger.log.warn('getEvmVaultV2', `closed: ${tokenizedVault.vault_name}`);
+        return null;
+    }
+    // Fetch vault contract state
+    const vaultContract = (0, core_1.createContract)({
+        address: vault,
+        abi: TokenizedVaultV2_1.ABI_TOKENIZED_VAULT_V2,
+        provider,
+    });
+    const vaultContractCalls = await Promise.all(core_1.VAULT_FUNCTIONS_V2.map(async (f) => {
+        if (f === 'depositCap') {
+            try {
+                return await vaultContract[f]();
+            }
+            catch (error) {
+                return null;
+            }
+        }
+        if (f === 'depositsPaused') {
+            return readDepositsPaused(vaultContract);
+        }
+        return vaultContract[f]();
+    }));
+    const receiptAddress = vaultContractCalls[core_1.VAULT_FUNCTIONS_V2.length - 1];
+    const whitelistedAssetsAddress = vaultContractCalls[0];
+    const reciptContract = (0, core_1.createContract)({
+        address: receiptAddress, // lpTokenAddress
+        abi: TokenizedVaultV2Receipt_1.ABI_TOKENIZED_VAULT_V2_RECEIPT,
+        provider,
+    });
+    const [receiptContractCalls, whitelistedList] = await Promise.all([
+        Promise.all(core_1.VAULT_FUNCTIONS_V2_RECEIPT.map((f) => {
+            if (f === 'symbol') {
+                return (0, core_1.getSymbol)(provider, receiptAddress, false);
+            }
+            if (f === 'decimals') {
+                return (0, core_1.getDecimalsOrThrow)(provider, receiptAddress, 'getEvmVaultV2');
+            }
+            return reciptContract[f]();
+        })),
+        (0, core_1.getWhitelistedAssets)(provider, whitelistedAssetsAddress),
+    ]);
+    const whitelistedAssetsContractCalls = [whitelistedList];
+    // Merge all contract call results
+    const combinedCalls = [
+        ...vaultContractCalls,
+        ...receiptContractCalls,
+        ...whitelistedAssetsContractCalls,
+    ];
+    const combinedFunctions = [
+        ...core_1.VAULT_FUNCTIONS_V2,
+        ...core_1.VAULT_FUNCTIONS_V2_RECEIPT,
+        ...core_1.VAULT_FUNCTIONS_V2_WHITELISTED_ASSETS,
+    ];
+    // Normalize all contract results with proper decimal handling
+    const formattedContractCalls = combinedCalls.reduce((acc, curr, i) => {
+        let val;
+        if (combinedFunctions[i] === 'depositCap') {
+            if (curr === null) {
+                return acc;
+            }
+            val = (0, core_1.toNormalizedBn)(curr, receiptContractCalls[0]);
+        }
+        else if (combinedFunctions[i] === 'totalSupply' ||
+            combinedFunctions[i] === 'totalAssets' ||
+            combinedFunctions[i] === 'globalLoansAmount' ||
+            combinedFunctions[i] === 'maxSupply' ||
+            combinedFunctions[i] === 'getTotalAssets' ||
+            combinedFunctions[i] === 'maxDepositAmount') {
+            val = (0, core_1.toNormalizedBn)(curr, receiptContractCalls[0]);
+        }
+        else if (combinedFunctions[i] === 'getTotalLoansDeployed') {
+            val = (0, core_1.toNormalizedBn)(curr, 0);
+        }
+        else if (combinedFunctions[i] === 'withdrawalFee') {
+            val = (0, core_1.toNormalizedBn)(curr, 2);
+        }
+        else if (combinedFunctions[i] === 'decimals') {
+            val = Number(curr.toString());
+        }
+        else if (combinedFunctions[i] === 'loansOperator') {
+            // @hardcoded: we cannot pull the real strategist
+            val = '0x4DCb388488622e47683EAd1a147947140a31e485';
+        }
+        else {
+            val = curr;
+        }
+        return { ...acc, [combinedFunctions[i]]: val };
+    }, {});
+    // Combine on-chain and backend data into unified vault object
+    const returnObj = await (0, utils_1.buildFormattedVault)(provider, tokenizedVault, formattedContractCalls);
+    return returnObj;
+};
+exports.getEvmVaultV2 = getEvmVaultV2;
+//# sourceMappingURL=getters.js.map