upshift-config 0.5.14

package/lib/types/webserver.d.ts

@@ -0,0 +1,698 @@
+import type { IUserRoles } from './user';
+import type { IAddress, ChainType, IStellarNetwork } from './web3';
+/**
+ * Table of Contents
+ * 1) Subaccounts
+ * 2) Metrics
+ * 3) Tokens
+ * 4) Users
+ * 5) Statuses
+ * 6) Integrations
+ * 7) Lending Pools
+ */
+export type IHIstoricalSnapshot = {
+    total_assets: number;
+    total_shares: number;
+    asset_share_ratio: number;
+    underlying_price: number;
+    snapshot_datetime: string;
+    block_id: number;
+    id: string;
+    tvl: number;
+};
+export interface IWSMonitorHeaders {
+    'x-user-id'?: string;
+    'x-environment'?: string;
+}
+/**
+ * Subaccounts
+ */
+export type IWSSubaccountPermission = {
+    name: string;
+    chain: number;
+    account_address?: string;
+};
+export type IWSSubaccountTwap = {
+    source_token: string;
+    dest_token: string;
+    subaccount_chain: number;
+    time_interval: number;
+    amount: number;
+    start_time?: string;
+    limit_price?: number;
+    number_of_orders: number;
+    complete_all_orders?: boolean;
+    slippage_tolerance?: number;
+};
+export type IWSSubaccountTwapHistoryItem = {
+    start_time: string;
+    time_interval: number;
+    source_token: string;
+    destination_token: string;
+    amount: number | null;
+    limit_price: number;
+    active: boolean;
+    number_of_orders: number;
+    complete_all_orders: boolean;
+    id: string;
+    updated_at: string;
+    created_at: string;
+    subaccount_id: string;
+};
+export type IWSSubaccountTwapFill = {
+    transaction_hash: string | null;
+    source_token: string;
+    destination_token: string;
+    source_amount_in: number | null;
+    destination_amount_out: number | null;
+    implied_price: number | null;
+    fee_amount: number | null;
+    id: string;
+    updated_at: string;
+    created_at: string;
+    twap_id: string;
+    fireblocks_transaction_id: string;
+    status: IWSFireblocksTxStatus;
+    message: string;
+};
+export type IWSSubaccountToken = {
+    address: string;
+    chain: number;
+    decimals: number;
+    discount_factor: number;
+    img_url: string | null;
+    price: number;
+    symbol: string;
+    token_type: number;
+};
+interface IWSSubaccountCefiAsset {
+    type: string;
+    name: string;
+    underlying: string;
+    symbol: string;
+    asset_type: string;
+}
+interface IWSSubaccountCefiSpotToken {
+    asset: IWSSubaccountCefiAsset;
+    value: number;
+    balance: number;
+}
+interface IWSSubaccountCefiDerivative {
+    value: number;
+    asset_type: string;
+    asset: IWSSubaccountCefiAsset;
+    units: number;
+    avg_cost: number;
+    entry_cost: number;
+}
+export interface IWSSubaccountCefi {
+    value: number;
+    name: string;
+    spot_tokens: IWSSubaccountCefiSpotToken[];
+    derivative_positions: IWSSubaccountCefiDerivative[];
+}
+export interface IWSSubaccountLoan {
+    address: IAddress;
+    lender: IAddress;
+    borrower: IAddress;
+    state: string;
+    total_repaid: number;
+    principal_token: IWSTokenEntry;
+    principal_amount: number;
+    interest_amount: number;
+    upcoming_payment: {
+        amount: number;
+        due_date: string;
+    };
+    apr: number;
+    initial_principal_amount: number;
+    deployed_date: string;
+    payment_interval: number;
+    lender_apr: number;
+}
+/**
+ * Metrics
+ */
+export type IWSMetricsPnlAttributes = {
+    pnl: number;
+    percent_return: number;
+    realized_apr: number;
+} | null;
+export type IWSMetricsPnl = {
+    id: string;
+    datetime: string | Date;
+    pnl: number;
+    pnl_vs_spot: number;
+    swaps_pnl: number;
+    timestamp: number;
+    debt_interest_owed: number;
+    credit_interest_owed: number;
+    total_account_value: number;
+    net_deposits: number;
+    net_deposits_pv: number;
+    hedger_pnl: number;
+    lifetime: IWSMetricsPnlAttributes;
+    lifetime_vs_spot: IWSMetricsPnlAttributes;
+    three_day: IWSMetricsPnlAttributes;
+    three_day_vs_spot: IWSMetricsPnlAttributes;
+    seven_day: IWSMetricsPnlAttributes;
+    seven_day_vs_spot: IWSMetricsPnlAttributes;
+    thirty_day: IWSMetricsPnlAttributes;
+    thirty_day_vs_spot: IWSMetricsPnlAttributes;
+};
+export type IWSMetricsStrategy = {
+    subaccount: string;
+    strategy: string;
+    datetime: string | Date;
+    chain_id: number;
+    estimated_apr: number;
+    strategy_pnl: number;
+    pending_rewards: number;
+    strategy_notional: number;
+    pnl_vs_spot: number;
+    pnl_vs_spot_3d: number;
+    pnl_vs_spot_7d: number;
+    pnl_vs_spot_30d: number;
+    realized_apr: number;
+    realized_apr_3d: number;
+    realized_apr_7d: number;
+    realized_apr_30d: number;
+    pool_weights: Record<string, number>;
+    lp_price: number;
+    strategy_name: string;
+    net_deposits: number;
+};
+export type IWSMetricsToken = {
+    subaccount: string;
+    strategy: string;
+    datetime: string | Date;
+    chain_id: number;
+    symbol: string;
+    units_held: number;
+    value_held: number;
+    units_implied: number;
+    value_implied: number;
+    collateral_posted_amount: number;
+    margin_posted_amount: number;
+    collateral_posted_value: number;
+    margin_posted_value: number;
+    pool_weight: number;
+};
+export type IWSMetricsTRS = {
+    datetime: string | Date;
+    reciever: string;
+    payer: string;
+    trs_address: string;
+    chain_id: number;
+    initial_underyling_price: number;
+    reference_underlying_price: number;
+    current_underlying_price: number;
+    required_reciever_margin: number;
+    required_payer_margin: number;
+    mark_to_market_pnl: number;
+    initial_margin: number;
+    swap_contract_units: number;
+    state: string;
+    direction: string;
+    underlying_token: string;
+};
+export type IWSMetricsHealthFactor = {
+    id: string;
+    datetime: string;
+    health_factor: number;
+    total_account_value: number;
+    total_equity_value: number;
+    total_loan_value: number;
+    total_loan_interest_amount: number;
+    total_pnl: number;
+    aggregate_payer_margin: number;
+    aggregate_receiver_margin: number;
+    intrest_paid: number;
+    total_net_deposits: number;
+    net_account_value: number;
+    life_time_apr: number;
+    percent_return: number;
+    margin_fraction: number;
+    maintenance_margin_fraction: number;
+    total_collateral_value: number;
+    total_pnl_3d: number;
+    total_pnl_7d: number;
+    total_pnl_30d: number;
+    realized_apr_3d: number;
+    realized_apr_7d: number;
+    realized_apr_30d: number;
+};
+export type IWSMetricsHedgerPnl = {
+    subaccount: string;
+    strategy: string;
+    datetime: string | Date;
+    chain_id: number;
+    symbol: string;
+    funding_payments: number;
+    fees: number;
+    unrealized: number;
+    realized: number;
+    pnl: number;
+    implied_delta: number;
+    hedge_delta: number;
+    oi_biased_implied_delta: number;
+    oi_bias: number;
+};
+export type IWSMetricsHedger = {
+    subaccount: string;
+    strategy: string;
+    datetime: string | Date;
+    chain_id: number;
+    strategy_notional: number;
+    strategy_pnl: number;
+    hedger_pnl: number;
+    trs_pnl: number;
+    realized_pnl: number;
+    unrealized_pnl: number;
+    fees: number;
+    funding: number;
+    corrections: number;
+    total_hedge_delta: number;
+    total_implied_delta: number;
+    net_pnl: number;
+    realized_apr_3d: number;
+    realized_apr_7d: number;
+    realized_apr_30d: number;
+};
+export type IWSMetricsTimeseries = {
+    aggregate_payer_margin: number;
+    aggregate_receiver_margin: number;
+    datetime: string | Date;
+    health_factor: number;
+    id: string;
+    intrest_paid: number;
+    life_time_apr: number;
+    maintenance_margin_fraction: number;
+    margin_fraction: number;
+    net_account_value: number;
+    percent_return: number;
+    realized_apr_3d: number | null;
+    realized_apr_7d: number | null;
+    realized_apr_30d: number | null;
+    total_account_value: number;
+    total_collateral_value: number;
+    total_equity_value: number;
+    total_loan_interest_amount: number;
+    total_loan_value: number;
+    total_net_deposits: number;
+    total_pnl: number;
+    total_pnl_3d: number | null;
+    total_pnl_7d: number | null;
+    total_pnl_30d: number | null;
+};
+/**
+ * Tokens
+ */
+export type IWSTokenEntry = {
+    symbol: string;
+    address: `0x${string}`;
+    decimals: number;
+    img_url?: string;
+    price?: number;
+    chain?: number;
+    balance?: number;
+    value?: number;
+    label?: string;
+    discount_factor?: string;
+    type?: string;
+};
+export type IWSTokenPrice = {
+    price: number;
+    dt: string;
+};
+/**
+ * Users
+ */
+export type IWSUserSubaccount = {
+    internal_name: string;
+    friendly_name: string;
+    address: string;
+    chains: {
+        chain_id: number;
+        name: string;
+        id: string;
+    }[];
+    status: string;
+    subaccount_type: string;
+    min_health_factor: number;
+    estimated_apr: number;
+    id: string;
+    user_id: string;
+    implementation: string;
+    turnkey_address: string;
+};
+export type IWSUser = {
+    eoa: string;
+    full_name: string;
+    type_: IUserRoles;
+    nonce: string;
+    disabled: boolean;
+    id: string;
+};
+/**
+ * Statuses
+ */
+export type IWSFireblocksTxStatus = 'SUBMITTED' | 'PENDING_AML_SCREENING' | 'PENDING_AUTHORIZATION' | 'QUEUED' | 'PENDING_SIGNATURE' | 'PENDING_3RD_PARTY_MANUAL_APPROVAL' | 'PENDING_3RD_PARTY' | 'BROADCASTING' | 'CONFIRMING' | 'COMPLETED' | 'CANCELLING' | 'BLOCKED' | 'REJECTED' | 'FAILED';
+/**
+ * Integrations
+ */
+export interface IWSIntegrationMorphoApy {
+    apy: number;
+    vault_positions: any[];
+    token: IWSTokenEntry;
+}
+/**
+ * Lending Pools
+ */
+export interface IWSVaultLoan {
+    address: IAddress;
+    lender: IAddress;
+    borrower: IAddress;
+    state: string;
+    total_repaid: number;
+    principal_token: IWSTokenEntry;
+    principal_amount: number;
+    interest_amount: number;
+    upcoming_payment: {
+        amount: number;
+        due_date: string;
+    };
+    apr: number;
+    initial_principal_amount: number;
+    deployed_date: string;
+    payment_interval: number;
+}
+export interface IDebankTokenExposure {
+    amount: number;
+    chain: string;
+    decimals: number;
+    id: IAddress;
+    logoUrl: string;
+    name: string;
+    symbol: string;
+}
+export interface IDebankProtocolExposure {
+    assetUsdValue: number;
+    chain: string;
+    debtUsdValue: number;
+    id: string;
+    logoUrl: string;
+    netUsdValue: number;
+    protocol: string;
+    siteUrl: string;
+    address: string;
+    tokenExposure: Record<string, string[] | string>;
+    protocolExposure: Record<string, string[] | string>;
+}
+export interface ITokenizedVaultSubaccount {
+    address: string;
+    strategist: ITokenizedVaultStrategist;
+}
+export type IOperatorTypeEnum = 'eoa' | 'subaccount';
+export interface ITokenizedVaultOperator {
+    address: `0x${string}`;
+    operator_type: IOperatorTypeEnum;
+}
+export interface ITokenizedVaultEoaOperator {
+    address: string;
+    id: string;
+    name: string;
+}
+/**
+ * Controls how the vault's APY is displayed in the UI.
+ * When `is_show_target_apy` is true, the UI should show a target/projected APY.
+ * When `is_show_hardcoded_apy` is true, `hardcoded_apy` overrides the computed APY.
+ * When `is_show_compound_apy` is true, the UI should render the
+ * compound-annualized historical APY (`historical_compound_apy`) instead of
+ * the simple one.
+ */
+export interface IApyOverride {
+    /** Whether to display a target APY rather than historical performance. */
+    is_show_target_apy: boolean;
+    /** Whether to display `hardcoded_apy` in place of the computed APY. */
+    is_show_hardcoded_apy: boolean;
+    /** The fixed APY value to display when `is_show_hardcoded_apy` is true, or null. */
+    hardcoded_apy: number | null;
+    /**
+     * Whether to display the compound-annualized historical APY
+     * (`historical_compound_apy`) instead of the simple `historical_apy`.
+     * Absent (older/cached responses) or false means simple. Independent of the
+     * target/hardcoded flags above, which keep their existing precedence.
+     */
+    is_show_compound_apy?: boolean;
+}
+/**
+ * Per-vault provenance timestamps returned by the backend on every tokenized-vault
+ * read (list and single-vault, on both the `api.augustdigital.io/tokenized_vault`
+ * and `api.upshift.finance/tokenized_vaults` surfaces).
+ *
+ * The three stamps describe *different* pipelines and are independently nullable —
+ * one of them cannot stand in for another. Consumers use the ordering between them
+ * to detect that the vault's share price has moved ahead of its APY: a
+ * `share_ratio_snapshot_at` later than `apy_computed_at` means a share-price
+ * snapshot has landed that the APY has not yet been recomputed from.
+ *
+ * All values are RFC 3339 UTC strings with a trailing `Z` (e.g.
+ * `'2026-07-25T00:01:46Z'`). The trailing `Z` matters: `new Date()` parses an
+ * offset-less date-time as *local* time, which would silently shift the stamp by
+ * the viewer's UTC offset.
+ *
+ * @see ITokenizedVault.freshness
+ */
+export interface ITokenizedVaultFreshness {
+    /**
+     * When `historical_apy`, TVL and drawdown were last recomputed, or null if they
+     * have never been computed for this vault.
+     */
+    apy_computed_at: string | null;
+    /**
+     * `snapshot_datetime` of the newest persisted share-price snapshot, or null when
+     * the vault has no snapshot yet.
+     *
+     * The backend stamps this from a scalar `max(snapshot_datetime)`, so it is
+     * populated independently of `load_snapshots` — including on the basic and
+     * sub-accounts views (`load_snapshots=false`), which is what every app call site
+     * sends. Never substitute another timestamp for it.
+     */
+    share_ratio_snapshot_at: string | null;
+    /**
+     * When the backend assembled the response body, before it entered the backend's
+     * own response cache. Distinct from the top-level `cached_at` only in scope:
+     * this one travels with the vault object.
+     */
+    cached_at: string | null;
+}
+export interface ITokenizedVaultStrategist {
+    strategist_name: string;
+    strategist_logo: string;
+    /** URL of the strategist's website, or null if not provided. */
+    website_url: string | null;
+    id: string;
+}
+export interface IOTCTrade {
+    value: number;
+    payer: string;
+    receiver: string;
+    units: number;
+    price: number;
+    trade_name: string;
+    symbol: string;
+    strike: number;
+    expiry: string;
+    asset_type: string;
+    underlying: string;
+    average_cost: number;
+}
+export interface IOTCPosition {
+    value: number;
+    underlying: string;
+    settlement_type: string;
+    settlement_currency: string;
+    asset_type: string;
+    symbol: string;
+    trades: IOTCTrade[];
+}
+export interface ITokenizedVaultReward {
+    tokenizedvault_id: string;
+    id: string;
+    text: string;
+    img_url: string;
+    multiplier: number;
+    created_at: string;
+    start_datetime: string;
+}
+export interface ITokenizedVaultReportedAPY {
+    apy: number;
+    underlying_apy: number;
+    liquid_apy: number;
+    points_apy: number | null;
+    rewards_compounded: number;
+    rewards_claimable: number;
+    explainer: string;
+    id: string;
+    tokenized_vault_id: string;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface ITokenizedVaultReceiptTokenIntegration {
+    address: string;
+    chain: number;
+    token_class: string;
+    shorthand: string;
+    symbol: string;
+    tiingo_ticker: string;
+    img_url: string;
+    is_transferable: boolean;
+    id: string;
+    position_id: string;
+    stable_token_pair_id: string;
+}
+export interface IComposabilityIntegration {
+    name: string;
+    description: string;
+    earning_multiplier: number;
+    protocol_url: string;
+    logo_url: string;
+    tokenized_vault_id: string;
+    id: string;
+}
+export interface ISolanaVaultMetadata {
+    vault_state_pda: string;
+    share_mint: string;
+    deposit_mint: string;
+    deposit_token_symbol?: string;
+    deposit_token_decimals?: number;
+    program_id?: string;
+}
+export interface IStellarVaultMetadata {
+    deposit_token_address: string | null;
+    deposit_token_symbol?: string;
+    deposit_token_decimals?: number;
+    network_name: IStellarNetwork;
+    utila_vault_id?: string;
+    utila_wallet_id?: string;
+}
+export interface ITokenizedVault {
+    address: string;
+    yield_distributor: string;
+    chain: number;
+    enable_external_assets_update: boolean;
+    chain_type: ChainType;
+    default_apy_horizon: 7 | 30 | null;
+    enabled_historical_price_horizons: any[];
+    description: string;
+    internal_type: 'lendingPool' | 'tokenizedVault' | 'tokenizedVaultV2' | 'multiAssetVault';
+    public_type: 'Lending' | 'Defi Yield' | 'Pre-deposit';
+    is_featured: boolean;
+    is_spotlighted?: boolean;
+    withdrawal_only?: boolean | null;
+    is_visible: boolean;
+    weekly_performance_fee_bps: number;
+    platform_fee_override: {
+        management_fee: number;
+        is_fee_waived: boolean;
+    };
+    management_fee_waived_until_date: string | null;
+    management_fee_waived_until_tvl: number | null;
+    performance_fee_waived_until_date: string | null;
+    performance_fee_waived_until_tvl: number | null;
+    start_datetime: Date;
+    vault_name: string;
+    vault_logo_url: string;
+    reserve_target: number;
+    reserve_tolerance: number;
+    status: 'active' | 'closed';
+    is_charge_fees_manual: boolean;
+    id: string;
+    receipt_token_symbol: string;
+    rewards: ITokenizedVaultReward[];
+    subaccounts: ITokenizedVaultSubaccount[];
+    reported_apy: ITokenizedVaultReportedAPY | null;
+    campaign_apy: number | null;
+    receipt_token_integrations: ITokenizedVaultReceiptTokenIntegration[];
+    hardcoded_strategists: ITokenizedVaultStrategist[];
+    max_daily_drawdown: number | null;
+    risk: string;
+    operators: ITokenizedVaultOperator[];
+    eoa_operators: ITokenizedVaultEoaOperator[];
+    composability_integrations?: IComposabilityIntegration[];
+    solana_vault_metadata?: ISolanaVaultMetadata | null;
+    stellar_vault_metadata?: IStellarVaultMetadata | null;
+    lagDuration: number;
+    /**
+     * Display buffer in seconds added on top of the on-chain lag for the
+     * withdrawal period shown to users. Null when not configured.
+     */
+    withdrawal_margin_seconds?: number | null;
+    /**
+     * IAT trader wallet addresses for the vault. Address format follows the
+     * vault's chain (EVM hex / Solana base58 / Stellar). Null when not
+     * configured.
+     */
+    iat_traders?: string[] | null;
+    historical_apy: Record<number, number> | null;
+    /**
+     * Compound-annualized historical APY keyed by horizon in days (1/7/30), as
+     * decimal fractions (0.0795 = 7.95%). Same shape and per-horizon null
+     * semantics as `historical_apy`. Absent on older/cached responses.
+     */
+    historical_compound_apy?: Record<number, number> | null;
+    /** @deprecated Use getVaultHistoricalTimeseries instead */
+    historical_snapshots?: IHIstoricalSnapshot[];
+    max_drawdown: number | null;
+    daily_pnl_per_share: Record<string, number>;
+    latest_reported_tvl: number | null;
+    cached_at?: string | null;
+    /**
+     * Per-vault provenance timestamps (APY recompute, newest share-price snapshot,
+     * response assembly). Absent on older/cached responses predating the backend
+     * change that added it.
+     */
+    freshness?: ITokenizedVaultFreshness | null;
+    instant_redeem_config: null | {
+        subaccount_address: string;
+        output_asset_symbol: string;
+        is_paused: boolean;
+        available_liquidity: number;
+        redeemable_assets: Array<{
+            address: string;
+            symbol: string;
+            decimals: number;
+            spread_bps: number;
+        }>;
+    };
+    show_cap_filled: boolean | null;
+    /** Controls APY display behaviour in the UI; null when the server has not set an override. */
+    apy_override: IApyOverride | null;
+}
+/**
+ * @deprecated
+ */
+export interface IWSVaultHistoricalApy {
+    data: {
+        labels: string[];
+        values: number[];
+    };
+    average_apy: number;
+    status: number;
+    error: string | null;
+}
+export interface IHistoricalTimeseriesPoint {
+    tvl: number | null;
+    daily_apy: number | null;
+    daily_pnl: number | null;
+    share_price: number | null;
+    total_assets: number | null;
+    total_shares: number | null;
+    asset_share_ratio: number | null;
+    missing: boolean;
+}
+export interface IHistoricalTimeseriesResponse {
+    data: Record<string, IHistoricalTimeseriesPoint>;
+}
+export {};

package/lib/types/webserver.js

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