@upshiftfinance/sdk 0.1.0 → 0.2.0

package/lib/adapters/sui/getters.js

@@ -1,134 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEmberVaults = getEmberVaults;
-exports.getEmberTVL = getEmberTVL;
-const constants_1 = require("./constants");
-const core_1 = require("../../core");
-const cache_1 = require("../../core/cache");
-const logger_1 = require("../../core/logger");
-/**
- * Hard ceiling on the Ember (Bluefin) vaults request. The endpoint is a
- * third-party API awaited on the `getVaults` hot path; without a bound, a
- * hung connection stalls every vault-list consumer indefinitely (the fetch
- * options carry no signal and no timeout). Measured latency is 0.24–1.02s,
- * so 5s is ~5× the observed worst case while still failing fast enough for
- * callers racing `getVaults` against their own budgets.
- */
-const EMBER_FETCH_TIMEOUT_MS = 5_000;
-/**
- * TTL for the cached Ember vaults payload. The set of active Ember vaults
- * changes rarely (the SDK additionally filters it to a hardcoded allowlist),
- * so 5 minutes matches the freshness of the other list-shaped caches without
- * letting a stale payload outlive a delisting for long.
- */
-const EMBER_CACHE_TTL_MS = 5 * 60 * 1000;
-/**
- * GET an Ember endpoint as a JSON array, with the timeout + cache both Ember
- * getters share.
- *
- * Why: `getEmberVaults` and `getEmberTVL` hit the same third-party API from
- * the same hot paths, but only the former was bounded and cached — a hung TVL
- * request stalled callers indefinitely. Centralising the plumbing keeps the
- * two from drifting again.
- *
- * - Cached for {@link EMBER_CACHE_TTL_MS}, keyed by `cacheKey` (callers embed
- *   the full URL so different query options cache independently). Only
- *   successful array payloads are cached; failures are never cached.
- * - Aborted after {@link EMBER_FETCH_TIMEOUT_MS}. AbortController (not
- *   AbortSignal.timeout) for browser + older-Node parity. The timer stays armed
- *   through the body read: `fetch` resolves as soon as headers arrive, so
- *   clearing it there would leave a stalled `json()` unbounded — the exact
- *   hang the ceiling exists to prevent.
- *
- * @param cacheKey - Shared-LRU key for this request.
- * @param url - Fully-qualified Ember URL (query string included).
- * @returns The parsed array, or `[]` when the endpoint returns a non-array.
- * @throws On non-2xx responses, network failure, or timeout (AbortError) —
- *   callers own the fail-tolerant fallback.
- */
-async function fetchEmberArray(cacheKey, url) {
-    // The shared LRU is constructed with `allowStale: true`; opt out here so a
-    // payload past its TTL is refetched rather than served one last time —
-    // keeping the 5-minute bound above an exact contract.
-    const cached = cache_1.CACHE.get(cacheKey, { allowStale: false });
-    if (cached)
-        return cached;
-    const controller = new AbortController();
-    const timer = setTimeout(() => controller.abort(), EMBER_FETCH_TIMEOUT_MS);
-    let data;
-    try {
-        const response = await fetch(url, {
-            ...core_1.DEFAULT_FETCH_OPTIONS,
-            signal: controller.signal,
-        });
-        if (!response.ok) {
-            throw new Error(`HTTP error! status: ${response.status}`);
-        }
-        data = await response.json();
-    }
-    finally {
-        clearTimeout(timer);
-    }
-    const rows = Array.isArray(data) ? data : [];
-    cache_1.CACHE.set(cacheKey, rows, { ttl: EMBER_CACHE_TTL_MS });
-    return rows;
-}
-/**
- * Fetch Ember vaults from API.
- *
- * Results are cached for {@link EMBER_CACHE_TTL_MS} (keyed by the full request
- * URL, so different query options cache independently) and the request is
- * aborted after {@link EMBER_FETCH_TIMEOUT_MS}. Failures — including timeouts —
- * are never cached and resolve to `[]`, preserving the long-standing
- * fail-tolerant contract of this getter.
- */
-async function getEmberVaults(options) {
-    try {
-        const params = new URLSearchParams();
-        if (options?.limit)
-            params.append('limit', options.limit.toString());
-        if (options?.offset)
-            params.append('offset', options.offset.toString());
-        if (options?.status)
-            params.append('status', options.status);
-        const queryString = params.toString();
-        const url = `${constants_1.EMBER_API_BASE_URL}${queryString ? `?${queryString}` : ''}`;
-        return await fetchEmberArray(`ember-vaults-${url}`, url);
-    }
-    catch (error) {
-        logger_1.Logger.log.error('getEmberVaults', error);
-        return [];
-    }
-}
-/**
- * Fetch the latest Ember TVL (in whole units, i.e. `tvlE9 / 1e9`).
- *
- * Shares the timeout and cache of {@link getEmberVaults} via
- * {@link fetchEmberArray}: the TVL history payload is cached for
- * {@link EMBER_CACHE_TTL_MS} per `limit`, and a hung request is aborted after
- * {@link EMBER_FETCH_TIMEOUT_MS}. Failures — including timeouts — are never
- * cached and resolve to `0`.
- *
- * @param limit - Number of history rows to request; only the newest is read.
- * @returns The latest TVL, or `0` when unavailable.
- */
-async function getEmberTVL(limit = 1) {
-    try {
-        const params = new URLSearchParams();
-        if (limit)
-            params.append('limit', limit.toString());
-        const queryString = params.toString();
-        const url = `${constants_1.EMBER_API_BASE_URL}${constants_1.EMBER_ENDPOINTS.TVL}${queryString ? `?${queryString}` : ''}`;
-        const result = await fetchEmberArray(`ember-tvl-${url}`, url);
-        if (result.length > 0) {
-            const latestEntry = result[0];
-            return Number(latestEntry.tvlE9) / constants_1.EMBER_DEFAULTS.E9_DIVISOR;
-        }
-        return 0;
-    }
-    catch (error) {
-        logger_1.Logger.log.error('getEmberTVL', error);
-        return 0;
-    }
-}
-//# sourceMappingURL=getters.js.map

package/lib/adapters/sui/transformer.d.ts

@@ -1,10 +0,0 @@
-import type { IVault } from '../../types';
-import type { IEmberVault } from './types';
-/**
- * Transform Ember vault to IVault format
- */
-export declare function transformEmberVaultToIVault(emberVault: IEmberVault): IVault;
-/**
- * Transform multiple Ember vaults
- */
-export declare function transformEmberVaultsToIVaults(emberVaults: IEmberVault[]): IVault[];

package/lib/adapters/sui/transformer.js

@@ -1,115 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformEmberVaultToIVault = transformEmberVaultToIVault;
-exports.transformEmberVaultsToIVaults = transformEmberVaultsToIVaults;
-const core_1 = require("../../core");
-const constants_1 = require("./constants");
-const utils_1 = require("./utils");
-/**
- * Transform Ember vault to IVault format
- */
-function transformEmberVaultToIVault(emberVault) {
-    const depositTokenDecimals = emberVault.depositCoin?.decimals || constants_1.EMBER_DEFAULTS.DECIMALS;
-    const receiptTokenDecimals = emberVault.receiptCoin?.decimals || constants_1.EMBER_DEFAULTS.DECIMALS;
-    const returnObj = {
-        chainId: constants_1.SUI_CHAIN_ID,
-        maxDailyDrawdown: 0,
-        risk: 'medium',
-        lagDuration: 0,
-        address: emberVault.address,
-        name: emberVault.name,
-        logoUrl: emberVault.logoUrl || '',
-        apy: {
-            apy: (0, utils_1.convertFromE9)(emberVault.reportedApy?.reportedApyE9 || 0) * 100,
-            pointsApy: null,
-            campaignApy: null,
-            explainer: '',
-            liquidApy: 0,
-            rewardsClaimable: 0,
-            rewardsCompounded: 0,
-            underlyingApy: (0, utils_1.convertFromE9)(emberVault.reportedApy?.reportedApyE9 || 0) * 100,
-        },
-        historical_apy: {
-            7: (0, utils_1.convertFromE9)(emberVault.reportedApy?.reportedApyE9 || 0),
-        },
-        strategists: (emberVault.managers ||
-            emberVault.subAccounts?.map((s) => s.manager) ||
-            []).map((manager) => ({
-            address: manager?.id || '',
-            logo: manager?.logoUrl || '',
-            name: manager?.name?.toLowerCase() === 'gamma'
-                ? 'Gamma Research'
-                : manager?.name || 'Unknown',
-            type: 'subaccount',
-            website_url: null,
-        })),
-        fees: {
-            performance: (0, utils_1.convertFromE9)(emberVault.weeklyPerformanceFeeBpsE9 || 0) /
-                constants_1.EMBER_DEFAULTS.BPS_TO_PERCENT,
-            management: (0, utils_1.convertFromE9)(emberVault.managementFeePercentE9 || 0) * 100,
-            isManagementWaived: false,
-            managementFeeWaivedUntilDate: null,
-            managementFeeWaivedUntilTvl: null,
-            isPerformanceWaived: false,
-            performanceFeeWaivedUntilDate: null,
-            performanceFeeWaivedUntilTvl: null,
-        },
-        rewards: {
-            points: '0',
-            multiplier: 0,
-            multipliers: [],
-            additionalPoints: [],
-            additionalPointsDetailed: [],
-        },
-        version: constants_1.EMBER_DEFAULTS.VERSION,
-        description: emberVault.description || '',
-        startDatetime: new Date(emberVault.createdAt || Date.now()).toISOString(),
-        status: emberVault.status === 'deprecated' ? 'closed' : 'active',
-        tags: ['Sui DeFi', emberVault.publicType].filter(Boolean),
-        isFeatured: false,
-        isSpotlighted: false,
-        withdrawalOnly: undefined,
-        isVisible: emberVault.status === 'active' || emberVault.status === 'beta',
-        reserveTarget: 0,
-        reserveTolerance: 0,
-        isDepositPaused: emberVault.status === 'deprecated',
-        decimals: receiptTokenDecimals,
-        isWithdrawalPaused: emberVault.status === 'deprecated',
-        operator: '',
-        idleAssets: (0, core_1.toNormalizedBn)(0, receiptTokenDecimals),
-        depositAssets: [
-            {
-                address: emberVault.depositCoin?.address,
-                symbol: emberVault.depositCoin?.symbol || '',
-                decimals: depositTokenDecimals,
-            },
-        ],
-        totalAssets: (0, core_1.toNormalizedBn)(BigInt(emberVault.totalDeposits || '0'), depositTokenDecimals),
-        /**
-         * PLACEHOLDER: `totalSupply` mirrors `totalDeposits`, so any share price
-         * derived as totalAssets / totalSupply is always 1.0 for Ember vaults and
-         * is NOT the real receipt-token price. Ember's `rateE9` is not read: its
-         * exact semantics (and whether `totalDeposits` is current TVL or a
-         * cumulative figure) are not documented by the Ember API, so it is not
-         * used to derive supply until that is confirmed.
-         */
-        totalSupply: (0, core_1.toNormalizedBn)(BigInt(emberVault.totalDeposits || '0'), receiptTokenDecimals),
-        maxSupply: (0, core_1.toNormalizedBn)(BigInt(emberVault.maxDepositsAllowed || '0'), depositTokenDecimals),
-        receipt: {
-            symbol: emberVault.receiptCoin?.symbol || '',
-            address: emberVault.receiptCoin?.address,
-            decimals: receiptTokenDecimals,
-        },
-        composabilityIntegrations: [],
-        eoa_operators: [],
-        operators: [],
-    };
-    return returnObj;
-}
-/**
- * Transform multiple Ember vaults
- */
-function transformEmberVaultsToIVaults(emberVaults) {
-    return emberVaults.map(transformEmberVaultToIVault);
-}
-//# sourceMappingURL=transformer.js.map

package/lib/adapters/sui/types.d.ts

@@ -1,70 +0,0 @@
-import type { IHIstoricalSnapshot } from '../../types';
-export interface IEmberVault {
-    address: string;
-    id: string;
-    name: string;
-    description: string;
-    logoUrl: string;
-    status: 'active' | 'beta' | 'deprecated';
-    publicType: string;
-    strategy: string;
-    createdAt: number;
-    totalDeposits: string;
-    totalDepositsInUsdE9: string;
-    maxDepositsAllowed: string;
-    rateE9: string;
-    managementFeePercentE9: string;
-    weeklyPerformanceFeeBpsE9: string;
-    withdrawalPeriodDays: number;
-    minWithdrawalSharesE9: string;
-    historicalSnapshots?: IHIstoricalSnapshot[];
-    max_drawdown?: number | null;
-    depositCoin: {
-        address: string;
-        symbol: string;
-        name: string;
-        decimals: number;
-        logoUrl: string;
-        priceE9: string;
-        type: string;
-    };
-    receiptCoin: {
-        address: string;
-        symbol: string;
-        name: string;
-        decimals: number;
-        logoUrl: string;
-        priceE9: string;
-        type: string;
-    };
-    reportedApy: {
-        apyE9: string;
-        reportedApyE9: string;
-        updatedAt: string;
-    };
-    managers: Array<{
-        id: string;
-        name: string;
-        logoUrl: string;
-        websiteUrl: string;
-    }>;
-    subAccounts: Array<{
-        address: string;
-        manager: {
-            id: string;
-            name: string;
-            logoUrl: string;
-            websiteUrl: string;
-        };
-    }>;
-    /**
-     * Ember reward entries. Their shape is not documented by the Ember API and
-     * the SDK does not read them, so they are typed `unknown` — narrow before use.
-     */
-    rewards: unknown[];
-}
-export interface IFetchEmberVaultsOptions {
-    limit?: number;
-    offset?: number;
-    status?: string;
-}

package/lib/adapters/sui/types.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map