@upshiftfinance/sdk 0.0.0-stage → 0.1.0

package/lib/modules/api/fetcher.d.ts

@@ -0,0 +1,108 @@
+import { type IFetchUpshiftOptions } from '../../core';
+import type { ICollateralExcessOrDeficit, ICollateralSimulationInput, ICollateralSimulationResults, ICuratorWhitelistStatus, IDiscountFactorLadder, ILoanBookInfo, IOracleClassification, IOtcMarginRequirement, IOtcPositionRead, IRevertReason, ITimelockRequest, ITransparencyAuditLog, ITransparencyFees, ITransparencyGovernancePermissions, ITransparencyGovernanceRoles, ITransparencyHistoricalAllocations, ITransparencyPositions, ITransparencyRatioPoint, ITransparencyTimelocks, IVaultPerformanceFees, IWSSubaccountListItem } from '../../types';
+/**
+ * Fetch the global loan-book aggregate (admin-only `GET /dashboard/loans`).
+ */
+export declare const fetchDashboardLoans: (upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<ILoanBookInfo[]>;
+/**
+ * Fetch every token discount-factor ladder (`GET /risk/discount_factors`).
+ */
+export declare const fetchDiscountFactors: (upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<IDiscountFactorLadder[]>;
+/**
+ * Fetch a subaccount's collateral excess/deficit for one token
+ * (`GET /risk/collateral_excess_or_deficit`).
+ */
+export declare const fetchCollateralExcessOrDeficit: (params: {
+    subaccount: string;
+    tokenAddress: string;
+    tokenChain: number;
+    targetHealthFactor?: number;
+}, upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<ICollateralExcessOrDeficit>;
+/**
+ * Run a collateral simulation (`POST /risk/collateral_simulation`). This is a
+ * pure, read-only simulation — the backend computes required collateral for a
+ * hypothetical loan and changes no state.
+ */
+export declare const fetchCollateralSimulation: (body: ICollateralSimulationInput, upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<ICollateralSimulationResults>;
+/**
+ * Fetch the decoded revert reason(s) for a transaction from the public
+ * `GET /revert_reason` endpoint. No API key required.
+ */
+export declare const fetchRevertReason: (txHash: string, chain: number, headers?: IFetchUpshiftOptions["headers"]) => Promise<IRevertReason>;
+/**
+ * Fetch all OTC positions (admin-only `GET /otc/position`).
+ */
+export declare const fetchOtcPositions: (upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<IOtcPositionRead[]>;
+/**
+ * Fetch OTC margin requirements (admin-only `GET /otc/margin_requirement`),
+ * optionally filtered by counterparty id and/or payer.
+ */
+export declare const fetchOtcMarginRequirements: (filters: {
+    otcCounterpartyId?: string;
+    payer?: string;
+}, upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<IOtcMarginRequirement[]>;
+/**
+ * Fetch the subaccounts linked to a vault (curator-or-admin
+ * `GET /curator/vaults/{vault_address}/subaccounts`).
+ */
+export declare const fetchCuratorVaultSubaccounts: (vaultAddress: string, upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<IWSSubaccountListItem[]>;
+/**
+ * Fetch on-chain whitelist status for a vault's subaccounts (curator-or-admin
+ * `GET /curator/vaults/{vault_address}/whitelist`). EVM vaults only — the
+ * backend 400s for non-EVM vaults.
+ */
+export declare const fetchCuratorVaultWhitelist: (vaultAddress: string, upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<ICuratorWhitelistStatus[]>;
+/**
+ * Fetch timelock requests for a vault on a chain (`GET /timelock-requests`),
+ * optionally filtered by status.
+ */
+export declare const fetchTimelockRequests: (params: {
+    vaultAddress: string;
+    chainId: number;
+    status?: string;
+}, upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<ITimelockRequest[]>;
+/**
+ * Fetch a vault's performance-fee computation
+ * (`GET /metrics/vault_performance_fees`). Slow first call (pandas over full
+ * snapshot history); 20-minute server-side cache.
+ */
+export declare const fetchVaultPerformanceFees: (params: {
+    vaultAddress: string;
+    annualizedFeesPct: number;
+    nativeDenominated: boolean;
+    calculationPeriod: string;
+    startDate?: string;
+    endDate?: string;
+}, upshiftKey: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<IVaultPerformanceFees>;
+/**
+ * Fetch a vault's NAV-oracle classification table from the public
+ * `GET /upshift/oracle_classification/{vault_address}` endpoint. No API key
+ * required.
+ */
+export declare const fetchVaultOracleClassification: (vaultAddress: string, chainId: number, headers?: IFetchUpshiftOptions["headers"]) => Promise<IOracleClassification>;
+/** Public `GET /upshift/positions/{vault}` — latest per-wallet position snapshot. */
+export declare const fetchTransparencyPositions: (vaultAddress: string, chainId: number, headers?: IFetchUpshiftOptions["headers"]) => Promise<ITransparencyPositions>;
+/** Public `GET /upshift/historical_allocations/{vault}` — daily per-protocol allocation history. */
+export declare const fetchTransparencyHistoricalAllocations: (vaultAddress: string, chainId: number, startDate?: string, endDate?: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<ITransparencyHistoricalAllocations>;
+/** Public `GET /upshift/fees/{vault}` — vault fee configuration. */
+export declare const fetchTransparencyFees: (vaultAddress: string, chainId: number, headers?: IFetchUpshiftOptions["headers"]) => Promise<ITransparencyFees>;
+/** Public `GET /upshift/unrealized_pnl?fields=ratio` — hourly backing / supply / collateral-ratio series. */
+export declare const fetchTransparencyRatioSeries: (vaultAddress: string, startDate?: string, endDate?: string, limit?: number, headers?: IFetchUpshiftOptions["headers"]) => Promise<ITransparencyRatioPoint[]>;
+/** Public `GET /upshift/historical_apy/chart` — smoothed rolling-APY series; returns the raw backend envelope. */
+export declare const fetchTransparencySmoothedApy: (vaultAddress: string, daysAgo: number, averagingPeriodDays: number, applySmoothing: boolean, headers?: IFetchUpshiftOptions["headers"]) => Promise<{
+    data: {
+        labels: string[];
+        values: number[];
+    };
+    average_apy?: number | null;
+    status: number;
+    error?: string | null;
+}>;
+/** Public `GET /upshift/governance/{vault}/roles` — owner/operator addresses with custody enrichment. */
+export declare const fetchTransparencyGovernanceRoles: (vaultAddress: string, chainId: number, headers?: IFetchUpshiftOptions["headers"]) => Promise<ITransparencyGovernanceRoles>;
+/** Public `GET /upshift/governance/{vault}/permissions` — whitelisted integrations per vault wallet. */
+export declare const fetchTransparencyGovernancePermissions: (vaultAddress: string, chainId: number, headers?: IFetchUpshiftOptions["headers"]) => Promise<ITransparencyGovernancePermissions>;
+/** Public `GET /upshift/governance/{vault}/timelocks` — timelock queue, default pending only. */
+export declare const fetchTransparencyGovernanceTimelocks: (vaultAddress: string, chainId: number, status?: string, headers?: IFetchUpshiftOptions["headers"]) => Promise<ITransparencyTimelocks>;
+/** Public `GET /upshift/governance/{vault}/audit_log` — one page of the governance audit log. */
+export declare const fetchTransparencyGovernanceAuditLog: (vaultAddress: string, chainId: number, category?: string, before?: string, limit?: number, headers?: IFetchUpshiftOptions["headers"]) => Promise<ITransparencyAuditLog>;

package/lib/modules/api/fetcher.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchTransparencyGovernanceAuditLog = exports.fetchTransparencyGovernanceTimelocks = exports.fetchTransparencyGovernancePermissions = exports.fetchTransparencyGovernanceRoles = exports.fetchTransparencySmoothedApy = exports.fetchTransparencyRatioSeries = exports.fetchTransparencyFees = exports.fetchTransparencyHistoricalAllocations = exports.fetchTransparencyPositions = exports.fetchVaultOracleClassification = exports.fetchVaultPerformanceFees = exports.fetchTimelockRequests = exports.fetchCuratorVaultWhitelist = exports.fetchCuratorVaultSubaccounts = exports.fetchOtcMarginRequirements = exports.fetchOtcPositions = exports.fetchRevertReason = exports.fetchCollateralSimulation = exports.fetchCollateralExcessOrDeficit = exports.fetchDiscountFactors = exports.fetchDashboardLoans = void 0;
+const core_1 = require("../../core");
+/**
+ * Fetch the global loan-book aggregate (admin-only `GET /dashboard/loans`).
+ */
+const fetchDashboardLoans = async (upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.dashboard.loans, { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch dashboard loans: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchDashboardLoans = fetchDashboardLoans;
+/**
+ * Fetch every token discount-factor ladder (`GET /risk/discount_factors`).
+ */
+const fetchDiscountFactors = async (upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.risk.discountFactors, { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch discount factors: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchDiscountFactors = fetchDiscountFactors;
+/**
+ * Fetch a subaccount's collateral excess/deficit for one token
+ * (`GET /risk/collateral_excess_or_deficit`).
+ */
+const fetchCollateralExcessOrDeficit = async (params, upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.risk.collateralExcessOrDeficit(params.subaccount, params.tokenAddress, params.tokenChain, params.targetHealthFactor), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch collateral excess or deficit: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchCollateralExcessOrDeficit = fetchCollateralExcessOrDeficit;
+/**
+ * Run a collateral simulation (`POST /risk/collateral_simulation`). This is a
+ * pure, read-only simulation — the backend computes required collateral for a
+ * hypothetical loan and changes no state.
+ */
+const fetchCollateralSimulation = async (body, upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.risk.collateralSimulation, { method: 'post', data: body, headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to run collateral simulation: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchCollateralSimulation = fetchCollateralSimulation;
+/**
+ * Fetch the decoded revert reason(s) for a transaction from the public
+ * `GET /revert_reason` endpoint. No API key required.
+ */
+const fetchRevertReason = async (txHash, chain, headers) => {
+    const response = await (0, core_1.fetchUpshiftPublic)(core_1.WEBSERVER_ENDPOINTS.public.revertReason(txHash, chain), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch revert reason: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchRevertReason = fetchRevertReason;
+/**
+ * Fetch all OTC positions (admin-only `GET /otc/position`).
+ */
+const fetchOtcPositions = async (upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.otc.positions, { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch OTC positions: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchOtcPositions = fetchOtcPositions;
+/**
+ * Fetch OTC margin requirements (admin-only `GET /otc/margin_requirement`),
+ * optionally filtered by counterparty id and/or payer.
+ */
+const fetchOtcMarginRequirements = async (filters, upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.otc.marginRequirements(filters.otcCounterpartyId, filters.payer), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch OTC margin requirements: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchOtcMarginRequirements = fetchOtcMarginRequirements;
+/**
+ * Fetch the subaccounts linked to a vault (curator-or-admin
+ * `GET /curator/vaults/{vault_address}/subaccounts`).
+ */
+const fetchCuratorVaultSubaccounts = async (vaultAddress, upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.curator.vaultSubaccounts(vaultAddress), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch curator vault subaccounts: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchCuratorVaultSubaccounts = fetchCuratorVaultSubaccounts;
+/**
+ * Fetch on-chain whitelist status for a vault's subaccounts (curator-or-admin
+ * `GET /curator/vaults/{vault_address}/whitelist`). EVM vaults only — the
+ * backend 400s for non-EVM vaults.
+ */
+const fetchCuratorVaultWhitelist = async (vaultAddress, upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.curator.vaultWhitelist(vaultAddress), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch curator vault whitelist: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchCuratorVaultWhitelist = fetchCuratorVaultWhitelist;
+/**
+ * Fetch timelock requests for a vault on a chain (`GET /timelock-requests`),
+ * optionally filtered by status.
+ */
+const fetchTimelockRequests = async (params, upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.timelockRequests(params.vaultAddress, params.chainId, params.status), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch timelock requests: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchTimelockRequests = fetchTimelockRequests;
+/**
+ * Fetch a vault's performance-fee computation
+ * (`GET /metrics/vault_performance_fees`). Slow first call (pandas over full
+ * snapshot history); 20-minute server-side cache.
+ */
+const fetchVaultPerformanceFees = async (params, upshiftKey, headers) => {
+    const response = await (0, core_1.fetchUpshiftWithKey)(upshiftKey, core_1.WEBSERVER_ENDPOINTS.metrics.vaultPerformanceFees(params), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch vault performance fees: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchVaultPerformanceFees = fetchVaultPerformanceFees;
+/**
+ * Fetch a vault's NAV-oracle classification table from the public
+ * `GET /upshift/oracle_classification/{vault_address}` endpoint. No API key
+ * required.
+ */
+const fetchVaultOracleClassification = async (vaultAddress, chainId, headers) => {
+    const response = await (0, core_1.fetchUpshiftPublic)(core_1.WEBSERVER_ENDPOINTS.public.oracleClassification(vaultAddress, chainId), { headers });
+    if (!response.ok || typeof response.json !== 'function') {
+        throw new Error(`Failed to fetch vault oracle classification: ${response.statusText || 'Unknown error'}`);
+    }
+    return response.json();
+};
+exports.fetchVaultOracleClassification = fetchVaultOracleClassification;
+/**
+ * Shared GET for the public transparency-dashboard endpoints. One HTTPS
+ * request, no RPC. `fetchUpshiftPublic` already maps non-2xx to typed
+ * `UpshiftServerError` / `UpshiftRateLimitError` / `UpshiftTimeoutError`, so
+ * this only parses the body; validation happens in the module layer.
+ */
+const fetchTransparency = async (endpoint, headers) => {
+    const response = await (0, core_1.fetchUpshiftPublic)(endpoint, { headers });
+    return response.json();
+};
+/** Public `GET /upshift/positions/{vault}` — latest per-wallet position snapshot. */
+const fetchTransparencyPositions = (vaultAddress, chainId, headers) => fetchTransparency(core_1.WEBSERVER_ENDPOINTS.public.transparency.positions(vaultAddress, chainId), headers);
+exports.fetchTransparencyPositions = fetchTransparencyPositions;
+/** Public `GET /upshift/historical_allocations/{vault}` — daily per-protocol allocation history. */
+const fetchTransparencyHistoricalAllocations = (vaultAddress, chainId, startDate, endDate, headers) => fetchTransparency(core_1.WEBSERVER_ENDPOINTS.public.transparency.historicalAllocations(vaultAddress, chainId, startDate, endDate), headers);
+exports.fetchTransparencyHistoricalAllocations = fetchTransparencyHistoricalAllocations;
+/** Public `GET /upshift/fees/{vault}` — vault fee configuration. */
+const fetchTransparencyFees = (vaultAddress, chainId, headers) => fetchTransparency(core_1.WEBSERVER_ENDPOINTS.public.transparency.fees(vaultAddress, chainId), headers);
+exports.fetchTransparencyFees = fetchTransparencyFees;
+/** Public `GET /upshift/unrealized_pnl?fields=ratio` — hourly backing / supply / collateral-ratio series. */
+const fetchTransparencyRatioSeries = (vaultAddress, startDate, endDate, limit, headers) => fetchTransparency(core_1.WEBSERVER_ENDPOINTS.public.transparency.ratioSeries(vaultAddress, startDate, endDate, limit), headers);
+exports.fetchTransparencyRatioSeries = fetchTransparencyRatioSeries;
+/** Public `GET /upshift/historical_apy/chart` — smoothed rolling-APY series; returns the raw backend envelope. */
+const fetchTransparencySmoothedApy = (vaultAddress, daysAgo, averagingPeriodDays, applySmoothing, headers) => fetchTransparency(core_1.WEBSERVER_ENDPOINTS.public.transparency.smoothedApy(vaultAddress, daysAgo, averagingPeriodDays, applySmoothing), headers);
+exports.fetchTransparencySmoothedApy = fetchTransparencySmoothedApy;
+/** Public `GET /upshift/governance/{vault}/roles` — owner/operator addresses with custody enrichment. */
+const fetchTransparencyGovernanceRoles = (vaultAddress, chainId, headers) => fetchTransparency(core_1.WEBSERVER_ENDPOINTS.public.transparency.governanceRoles(vaultAddress, chainId), headers);
+exports.fetchTransparencyGovernanceRoles = fetchTransparencyGovernanceRoles;
+/** Public `GET /upshift/governance/{vault}/permissions` — whitelisted integrations per vault wallet. */
+const fetchTransparencyGovernancePermissions = (vaultAddress, chainId, headers) => fetchTransparency(core_1.WEBSERVER_ENDPOINTS.public.transparency.governancePermissions(vaultAddress, chainId), headers);
+exports.fetchTransparencyGovernancePermissions = fetchTransparencyGovernancePermissions;
+/** Public `GET /upshift/governance/{vault}/timelocks` — timelock queue, default pending only. */
+const fetchTransparencyGovernanceTimelocks = (vaultAddress, chainId, status, headers) => fetchTransparency(core_1.WEBSERVER_ENDPOINTS.public.transparency.governanceTimelocks(vaultAddress, chainId, status), headers);
+exports.fetchTransparencyGovernanceTimelocks = fetchTransparencyGovernanceTimelocks;
+/** Public `GET /upshift/governance/{vault}/audit_log` — one page of the governance audit log. */
+const fetchTransparencyGovernanceAuditLog = (vaultAddress, chainId, category, before, limit, headers) => fetchTransparency(core_1.WEBSERVER_ENDPOINTS.public.transparency.governanceAuditLog(vaultAddress, chainId, category, before, limit), headers);
+exports.fetchTransparencyGovernanceAuditLog = fetchTransparencyGovernanceAuditLog;
+//# sourceMappingURL=fetcher.js.map

package/lib/modules/api/index.d.ts

@@ -0,0 +1 @@
+export { UpshiftApi } from './main';

package/lib/modules/api/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpshiftApi = void 0;
+var main_1 = require("./main");
+Object.defineProperty(exports, "UpshiftApi", { enumerable: true, get: function () { return main_1.UpshiftApi; } });
+//# sourceMappingURL=index.js.map