@upshiftfinance/sdk 0.0.0-stage → 0.2.0

package/lib/core/helpers/vaults.d.ts

@@ -0,0 +1,89 @@
+import type { IAddress, IContractRunner } from '../../types';
+/**
+ * Bad transactions that should be ignored
+ * these transactions are usually from tests and can skew data
+ */
+export declare const isBadTransaction: (hash: string, chainId: number) => boolean;
+export declare const isBadVault: (address?: string) => boolean;
+import { getAddressChainType, getVaultVersion, getVaultVersionV2 } from './vault-version';
+export { getAddressChainType, getVaultVersion, getVaultVersionV2 };
+export declare const REWARD_DISTRIBUTOR_ADDRESS: (chainId: number) => string[];
+export declare const AVAX_PRICE_FEED_ADDRESS: (chainId: number) => "0x" | "0xFF3EEb22B5E3dE6e705b44749C2559d704923FD7";
+export declare function getVaultSymbol(vault: IAddress, provider: IContractRunner): Promise<string | undefined>;
+/**
+ * @deprecated
+ * Replaced by SUBGRAPH_VAULT_URLS which are subgraphs deployed on Goldsky.
+ */
+export declare const SUBGRAPH_POOL_URLS: (apiKey: string, chainId?: number, pool?: IAddress) => {
+    1: string;
+    8453: string;
+    43114: string;
+    42161: string;
+    56: string;
+} | {
+    999: string;
+};
+/**
+ * Previously fabricated a Goldsky subgraph URL from the chain name and vault
+ * symbol. That guess is unreliable and produced dead endpoints:
+ * - The path segment `/v1/subgraphs/name/goldsky/` is legacy hosted-service
+ *   syntax, not Goldsky's current scheme (cf. {@link SUBGRAPH_VAULT_URLS}).
+ * - The chain name isn't the subgraph slug — ethers reports Citrea's network as
+ *   `unknown`, and mainnet as `mainnet` where the subgraph uses `eth`.
+ * - A vault's symbol isn't its subgraph name — e.g. on-chain `EctUSD` vs the
+ *   deployed `earn-ctusd`.
+ *
+ * A fabricated URL 404s silently, so a missing subgraph reads as "no data"
+ * rather than an error (this masked the Citrea Earn ctUSD outage). Subgraph URLs
+ * must now come from backend vault metadata (`fetchVaultMetadata → subgraph`).
+ * This returns `undefined` so callers hit their existing "Missing Subgraph"
+ * branch (warn + Slack alert) instead of querying a dead endpoint.
+ *
+ * @param _network - Unused. Kept for call-site compatibility.
+ * @param _symbol - Unused. Kept for call-site compatibility.
+ * @returns `undefined` — the SDK no longer guesses subgraph URLs.
+ * @deprecated Resolve subgraph URLs from `fetchVaultMetadata`; do not rely on a
+ *   generated fallback.
+ */
+export declare const getDefaultSubgraphUrl: (_network: string, _symbol: string) => string | undefined;
+/**
+ * Resolve whether a single fee (management or performance) is currently waived.
+ *
+ * Backend-driven. This centralizes logic that previously lived —
+ * and diverged — across two upshift-app components. The resolution is deliberately
+ * split between the backend and the SDK:
+ *
+ * - The backend `isFeeWaivedToggle` (`platform_fee_override.is_fee_waived`) is both
+ *   the master enable AND the TVL latch. Retool config takes precedence over live
+ *   TVL, and the backend flips this flag `false` once live TVL crosses the
+ *   configured threshold. That flip is one-way: if TVL later falls back below the
+ *   threshold the waiver does NOT re-apply. The SDK therefore does no TVL math and
+ *   never reads `latest_reported_tvl` here — trusting the flag preserves the latch.
+ * - The **date** window is time-dependent, so it cannot be a static DB flag; the SDK
+ *   evaluates it live against the clock.
+ *
+ * Resolution:
+ * - Toggle off  → never waived (also the only "hide" path once TVL trips the latch).
+ * - Toggle on, both date and TVL blank → indefinite manual waiver → waived.
+ * - Toggle on with a date window → waived while `now < waivedUntilDate`.
+ * - Toggle on with a TVL threshold configured → waived (the backend keeps the toggle
+ *   on only while live TVL is under the threshold).
+ *
+ * @param isFeeWaivedToggle - Backend master/TVL-latch flag. `false` ⇒ never waived.
+ * @param waivedUntilDate - ISO datetime string the waiver runs until, or `null` for
+ *   no date window. An unparseable string yields `NaN`, which is never `> now`, so
+ *   it correctly contributes no date-based waiver.
+ * @param waivedUntilTvl - Configured TVL threshold in whole USD, or `null`. Used only
+ *   to detect that a TVL-based waiver was set (values `<= 0` are treated as unset);
+ *   the threshold comparison itself is owned by the backend.
+ * @param now - Clock, injected for deterministic testing. Defaults to `new Date()`.
+ * @returns `true` if the UI should present this fee as "Fee Waived" right now.
+ * @example
+ * ```ts
+ * // Toggle on, 30-day window still open → waived.
+ * resolveFeeWaived(true, '2099-01-01T00:00:00Z', null); // true
+ * // Toggle off overrides everything → not waived.
+ * resolveFeeWaived(false, '2099-01-01T00:00:00Z', 10_000_000); // false
+ * ```
+ */
+export declare function resolveFeeWaived(isFeeWaivedToggle: boolean, waivedUntilDate: string | null, waivedUntilTvl: number | null, now?: Date): boolean;

package/lib/core/helpers/vaults.js

@@ -0,0 +1,241 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultSubgraphUrl = exports.SUBGRAPH_POOL_URLS = exports.AVAX_PRICE_FEED_ADDRESS = exports.REWARD_DISTRIBUTOR_ADDRESS = exports.getVaultVersionV2 = exports.getVaultVersion = exports.getAddressChainType = exports.isBadVault = exports.isBadTransaction = void 0;
+exports.getVaultSymbol = getVaultSymbol;
+exports.resolveFeeWaived = resolveFeeWaived;
+const ethers_1 = require("ethers");
+const vaults_1 = require("../constants/vaults");
+const web3_1 = require("./web3");
+const chain_address_1 = require("./chain-address");
+const vault_metadata_1 = require("../vault-metadata");
+const logger_1 = require("../logger");
+/** @internal */
+const VAULT_SYMBOLS_LOWERCASE = Object.fromEntries(Object.entries(vaults_1.VAULT_SYMBOLS).map(([k, v]) => [k.toLowerCase(), v]));
+/**
+ * Bad transactions that should be ignored
+ * these transactions are usually from tests and can skew data
+ */
+const isBadTransaction = (hash, chainId) => {
+    const badTxs = {
+        1: [
+            // farmBOLD deposit test tx due to a decimal error
+            '0xaba75b16e74a7a2457bfdcded853edd2bb4d3b305919baf84fb1f6b54b864889',
+            '0xc4c30185198672cbc91a95520d1bf91634ece37c199b2f1f15d29e8290c7ed4b',
+            '0x8e319576413897d1750f16bb93c7f59759b5bbafcb5bd9ef956f6bc0b0314aef',
+            '0x49057f8ea86b84a21808269558474686c9de02d31dc9e03a201b61104afbcdd3',
+            '0x7146dd528423705e225dd508f06cc6b4dab490c767400652ef82e7c96031359d',
+            '0x826340b2f376e71795177e9d68fee07e0c45263b45d22c36327db81db36d70a6',
+            '0xd79f4cf16dd4a794809448bf021bb64b6bfd22fb42094403baad4da5664b7519',
+        ],
+    };
+    if (chainId in badTxs) {
+        return badTxs[chainId].includes(hash);
+    }
+    return false;
+};
+exports.isBadTransaction = isBadTransaction;
+const isBadVault = (address) => {
+    if (!address)
+        return false;
+    if ((0, vault_version_1.getAddressChainType)(address) !== 'evm')
+        return false;
+    switch ((0, ethers_1.getAddress)(address)) {
+        case (0, ethers_1.getAddress)('0x706162790b601A8514c18718d0c63C9D1268e89C'):
+            return true;
+        case (0, ethers_1.getAddress)('0xd684AF965b1c17D628ee0d77cae94259c41260F4'):
+            return true; // ETH: sUSDe
+        case (0, ethers_1.getAddress)('0xB78dAf3fD674B81ebeaaa88d711506fa069E1C5E'):
+            return true; // ETH: ETH Optimizer
+        case (0, ethers_1.getAddress)('0x4e2D90f0307A93b54ACA31dc606F93FE6b9132d2'):
+            return true; // Base: LBTC
+        case (0, ethers_1.getAddress)('0x18a5a3D575F34e5eBa92ac99B0976dBe26f9F869'):
+            return true; // ETH: LBTC
+        case (0, ethers_1.getAddress)('0xD0b717ef23817b1a127139830Cf0FcD449ef74F0'):
+            return true; // BNB: Sienna USDT Tulipa
+        case (0, ethers_1.getAddress)('0xeb402fc96C7ed2f889d837C9976D6d821c1B5f01'):
+            return true; // ETH: Kelp TAC Vault
+        case (0, ethers_1.getAddress)('0xEBac5e50003d4B17Be422ff9775043cD61002f7f'):
+            return true; // ETH: Upshift BTC
+        case (0, ethers_1.getAddress)('0x419386E3Ef42368e602720CC458e00c0B28c47A7'):
+            return true; // ETH: Kelp TAC Vault
+        default:
+            return false;
+    }
+};
+exports.isBadVault = isBadVault;
+const vault_version_1 = require("./vault-version");
+Object.defineProperty(exports, "getAddressChainType", { enumerable: true, get: function () { return vault_version_1.getAddressChainType; } });
+Object.defineProperty(exports, "getVaultVersion", { enumerable: true, get: function () { return vault_version_1.getVaultVersion; } });
+Object.defineProperty(exports, "getVaultVersionV2", { enumerable: true, get: function () { return vault_version_1.getVaultVersionV2; } });
+// Used for Upshift
+const REWARD_DISTRIBUTOR_ADDRESS = (chainId) => {
+    switch (chainId) {
+        case 43114:
+            return [
+                '0xAeAc5f82B140c0f7309f7E9Ec43019062A5e5BE2',
+                '0xd3e653A9f6F3d96B26Dd4487a53D151140B697C4',
+            ];
+        default:
+            return ['0x0000000000000000000000000000000000000000'];
+    }
+};
+exports.REWARD_DISTRIBUTOR_ADDRESS = REWARD_DISTRIBUTOR_ADDRESS;
+// Used for Upshift
+const AVAX_PRICE_FEED_ADDRESS = (chainId) => {
+    switch (chainId) {
+        case 1:
+            return '0xFF3EEb22B5E3dE6e705b44749C2559d704923FD7';
+        default:
+            return '0x';
+    }
+};
+exports.AVAX_PRICE_FEED_ADDRESS = AVAX_PRICE_FEED_ADDRESS;
+async function getVaultSymbol(vault, provider) {
+    if ((0, chain_address_1.isStellarAddress)(vault)) {
+        logger_1.Logger.log.warn('getVaultSymbol', `Vault symbol lookup is not yet supported for Stellar vaults: ${vault}`);
+        return undefined;
+    }
+    // Sui object IDs are 64 hex digits, which ethers' `getAddress` rejects; they
+    // have no checksum form, so compare them lowercase as they are.
+    const address = (0, chain_address_1.isSuiAddress)(vault) ? vault.toLowerCase() : (0, ethers_1.getAddress)(vault);
+    let vaultsMetadata = {};
+    try {
+        vaultsMetadata = await (0, vault_metadata_1.fetchVaultMetadata)();
+    }
+    catch (e) {
+        logger_1.Logger.log.error('getVaultSymbol:fetchMetadata', e, { vault });
+    }
+    const entries = Object.entries(vaultsMetadata);
+    for (const [_, metadata] of entries) {
+        if (metadata.address.toLowerCase() === address.toLowerCase()) {
+            return metadata.symbol;
+        }
+    }
+    const hardcodedSymbol = vaults_1.VAULT_SYMBOLS[address] ??
+        VAULT_SYMBOLS_LOWERCASE[address.toLowerCase()];
+    if (hardcodedSymbol) {
+        return hardcodedSymbol;
+    }
+    // The on-chain fallback below is an EVM `symbol()` call; a Sui vault has no
+    // such contract, so a metadata miss is the end of the lookup.
+    if ((0, chain_address_1.isSuiAddress)(vault))
+        return undefined;
+    const symbol = await (0, web3_1.getSymbol)(provider, vault);
+    return symbol;
+}
+/**
+ * @deprecated
+ * Replaced by SUBGRAPH_VAULT_URLS which are subgraphs deployed on Goldsky.
+ */
+const SUBGRAPH_POOL_URLS = (apiKey, chainId, pool) => {
+    if (chainId === 999) {
+        if (!pool) {
+            throw new Error(`Pool address is required for chainId ${chainId}`);
+        }
+        switch (pool) {
+            // hbHYPE
+            case '0x96C6cBB6251Ee1c257b2162ca0f39AA5Fa44B1FB':
+                return {
+                    999: 'https://api.goldsky.com/api/public/project_cm9g0xy3o4j6v01vd34r3hvv9/subgraphs/august-hyperevm-hyperbeat/1.0.0/gn',
+                };
+            // hbBTC
+            case '0xc061d38903b99aC12713B550C2CB44B221674F94':
+                return {
+                    999: 'https://api.goldsky.com/api/public/project_cm9g0xy3o4j6v01vd34r3hvv9/subgraphs/august-hyperevm-hbBTC/1.0.0/gn',
+                };
+            default:
+                throw new Error(`Unsupported pool for chainId ${chainId}: ${pool}`);
+        }
+    }
+    const urls = {
+        1: `https://gateway.thegraph.com/api/${apiKey}/subgraphs/id/BtbHLe7XtX2x9Ude9PKv2uagNHj6JYhjjFcimxvk7NPD`,
+        8453: `https://gateway.thegraph.com/api/${apiKey}/subgraphs/id/E96gN4ZAmtCwLfsYccy3TqCTBbizGPWssFFeZfJ5QSQP`,
+        43114: `https://gateway.thegraph.com/api/${apiKey}/subgraphs/id/Ho15f2DBGndTMAYx9bPxJzasQRsAd5oLdci4oZvWs2u6`,
+        42161: `https://gateway.thegraph.com/api/${apiKey}/subgraphs/id/BrqNoj6FWm678yFRKdVWBncwt3zUnpbA3u4n9A9puUSg`,
+        56: `https://gateway.thegraph.com/api/${apiKey}/subgraphs/id/4BDCXZvSBuNGX3ck6C6nTGos7Dg5SxjfHMjrKnQz4YE2`,
+    };
+    if (chainId && !(chainId in urls)) {
+        throw new Error(`Unsupported chainId: ${chainId}. Supported chains: ${Object.keys(urls).join(', ')}`);
+    }
+    return urls;
+};
+exports.SUBGRAPH_POOL_URLS = SUBGRAPH_POOL_URLS;
+/**
+ * Previously fabricated a Goldsky subgraph URL from the chain name and vault
+ * symbol. That guess is unreliable and produced dead endpoints:
+ * - The path segment `/v1/subgraphs/name/goldsky/` is legacy hosted-service
+ *   syntax, not Goldsky's current scheme (cf. {@link SUBGRAPH_VAULT_URLS}).
+ * - The chain name isn't the subgraph slug — ethers reports Citrea's network as
+ *   `unknown`, and mainnet as `mainnet` where the subgraph uses `eth`.
+ * - A vault's symbol isn't its subgraph name — e.g. on-chain `EctUSD` vs the
+ *   deployed `earn-ctusd`.
+ *
+ * A fabricated URL 404s silently, so a missing subgraph reads as "no data"
+ * rather than an error (this masked the Citrea Earn ctUSD outage). Subgraph URLs
+ * must now come from backend vault metadata (`fetchVaultMetadata → subgraph`).
+ * This returns `undefined` so callers hit their existing "Missing Subgraph"
+ * branch (warn + Slack alert) instead of querying a dead endpoint.
+ *
+ * @param _network - Unused. Kept for call-site compatibility.
+ * @param _symbol - Unused. Kept for call-site compatibility.
+ * @returns `undefined` — the SDK no longer guesses subgraph URLs.
+ * @deprecated Resolve subgraph URLs from `fetchVaultMetadata`; do not rely on a
+ *   generated fallback.
+ */
+const getDefaultSubgraphUrl = (_network, _symbol) => {
+    return undefined;
+};
+exports.getDefaultSubgraphUrl = getDefaultSubgraphUrl;
+/**
+ * Resolve whether a single fee (management or performance) is currently waived.
+ *
+ * Backend-driven. This centralizes logic that previously lived —
+ * and diverged — across two upshift-app components. The resolution is deliberately
+ * split between the backend and the SDK:
+ *
+ * - The backend `isFeeWaivedToggle` (`platform_fee_override.is_fee_waived`) is both
+ *   the master enable AND the TVL latch. Retool config takes precedence over live
+ *   TVL, and the backend flips this flag `false` once live TVL crosses the
+ *   configured threshold. That flip is one-way: if TVL later falls back below the
+ *   threshold the waiver does NOT re-apply. The SDK therefore does no TVL math and
+ *   never reads `latest_reported_tvl` here — trusting the flag preserves the latch.
+ * - The **date** window is time-dependent, so it cannot be a static DB flag; the SDK
+ *   evaluates it live against the clock.
+ *
+ * Resolution:
+ * - Toggle off  → never waived (also the only "hide" path once TVL trips the latch).
+ * - Toggle on, both date and TVL blank → indefinite manual waiver → waived.
+ * - Toggle on with a date window → waived while `now < waivedUntilDate`.
+ * - Toggle on with a TVL threshold configured → waived (the backend keeps the toggle
+ *   on only while live TVL is under the threshold).
+ *
+ * @param isFeeWaivedToggle - Backend master/TVL-latch flag. `false` ⇒ never waived.
+ * @param waivedUntilDate - ISO datetime string the waiver runs until, or `null` for
+ *   no date window. An unparseable string yields `NaN`, which is never `> now`, so
+ *   it correctly contributes no date-based waiver.
+ * @param waivedUntilTvl - Configured TVL threshold in whole USD, or `null`. Used only
+ *   to detect that a TVL-based waiver was set (values `<= 0` are treated as unset);
+ *   the threshold comparison itself is owned by the backend.
+ * @param now - Clock, injected for deterministic testing. Defaults to `new Date()`.
+ * @returns `true` if the UI should present this fee as "Fee Waived" right now.
+ * @example
+ * ```ts
+ * // Toggle on, 30-day window still open → waived.
+ * resolveFeeWaived(true, '2099-01-01T00:00:00Z', null); // true
+ * // Toggle off overrides everything → not waived.
+ * resolveFeeWaived(false, '2099-01-01T00:00:00Z', 10_000_000); // false
+ * ```
+ */
+function resolveFeeWaived(isFeeWaivedToggle, waivedUntilDate, waivedUntilTvl, now = new Date()) {
+    // Master toggle off ⇒ never waived. Also satisfies the one-way TVL latch: the
+    // backend has already flipped this false when live TVL crossed the threshold.
+    if (!isFeeWaivedToggle)
+        return false;
+    const isDateActive = waivedUntilDate != null && new Date(waivedUntilDate) > now;
+    const isTvlConfigured = waivedUntilTvl != null && waivedUntilTvl > 0;
+    // Toggle on but neither trigger configured ⇒ indefinite manual waiver.
+    if (waivedUntilDate == null && !isTvlConfigured)
+        return true;
+    return isDateActive || isTvlConfigured;
+}
+//# sourceMappingURL=vaults.js.map