upshift-finance 1.0.0

package/lib/types/index.js

@@ -0,0 +1,28 @@
+"use strict";
+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("./web3"), exports);
+__exportStar(require("./typed-contract"), exports);
+__exportStar(require("./user"), exports);
+__exportStar(require("./webserver"), exports);
+__exportStar(require("./pools"), exports);
+__exportStar(require("./staking"), exports);
+__exportStar(require("./subgraph"), exports);
+__exportStar(require("./vaults"), exports);
+__exportStar(require("./points"), exports);
+__exportStar(require("./sub-accounts"), exports);
+__exportStar(require("./api"), exports);
+//# sourceMappingURL=index.js.map

package/lib/types/points.d.ts

@@ -0,0 +1,28 @@
+export interface IUserPoints {
+    totalPoints?: number;
+    referralEarnings?: number;
+    pools?: Record<string, {
+        amountDepositedInUsd?: number;
+        nativeAmountDeposited?: number;
+        totalPoints?: number;
+        hasPendingRewards?: boolean;
+    }>;
+    external?: Record<string, {
+        protocol?: string;
+        externalName?: string;
+        amountDepositedInUsd?: number;
+        nativeAmountDeposited?: number;
+        totalPoints?: number;
+    }>;
+    referrals?: Record<string, {
+        totalPoints?: number;
+        amountDepositedInUsd?: number;
+        nativeAmountDeposited?: number;
+    }>;
+    topVault?: {
+        lifetimeDeposit?: number;
+        address?: string;
+    } | null;
+    streak?: number;
+    rank?: number | null;
+}

package/lib/types/points.js

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

package/lib/types/pools.d.ts

@@ -0,0 +1,144 @@
+/**
+ * @deprecated
+ */
+import type { IAddress, INormalizedNumber } from './web3';
+import type { IDebankProtocolExposure, IDebankTokenExposure, ITokenizedVaultStrategist, IWSSubaccountCefi } from './webserver';
+type ILabelValue = {
+    label: string;
+    value: string;
+    usd: number;
+};
+export type IPoolLoan = {
+    address: IAddress;
+    apr: number;
+    collateral: IAddress;
+    principal: INormalizedNumber;
+    allocation: number;
+    repaid: INormalizedNumber;
+    exposure?: ILabelValue[];
+    positions?: ILabelValue[];
+    idleCapital?: boolean;
+};
+export type IPoolRewards = {
+    upshift_points: string;
+    latestUpshiftPointMultiplier: number;
+    upshift_points_multipliers: {
+        multiplier: number;
+        timestamp: number;
+    }[];
+    additional_points: string[];
+};
+export type IPool = {
+    address: IAddress;
+    name: string;
+    logoUrl: string;
+    asset: IAddress;
+    loansOperator?: IAddress;
+    globalLoansAmount: INormalizedNumber;
+    symbol: string;
+    totalAssets?: INormalizedNumber;
+    totalSupply: INormalizedNumber;
+    maxSupply: INormalizedNumber;
+    decimals: number;
+    getTotalLoansDeployed: INormalizedNumber;
+    chainId: number;
+    withdrawalFee: INormalizedNumber;
+    loans?: IPoolLoan[];
+    collateral?: IAddress[];
+    apy?: number;
+    sUSDeAPY?: number;
+    leverageLoopAPR?: number;
+    leverage?: string;
+    managementFee?: number | undefined;
+    stakeAPY?: number;
+    idleAssets?: INormalizedNumber;
+    description?: string;
+    hardcodedStrategist?: string;
+    protocolExposure?: IDebankProtocolExposure[];
+    tokenExposure?: IDebankTokenExposure[];
+    cefiExposure?: IWSSubaccountCefi[];
+    vaultsSubAccWhitelist?: IAddress[];
+    internalType?: 'lendingPool' | 'tokenizedVault';
+    publicType?: 'Lending' | 'Defi Yield' | 'Pre-deposit';
+    strategist: ITokenizedVaultStrategist;
+    isFeatured?: boolean;
+    isVisible?: boolean;
+    rewards?: IPoolRewards;
+};
+export type IPoolWithUnderlying = IPool & {
+    underlying: {
+        address: IAddress;
+        symbol: string;
+        decimals: number;
+        chain: number;
+    };
+};
+export interface ISubgraphFormattedPool {
+    decimals: number;
+    symbol: string;
+    name: string;
+    asset: IAddress;
+    totalSupply: INormalizedNumber;
+    totalAssets: INormalizedNumber;
+    maxSupply: INormalizedNumber;
+    globalLoansAmount: INormalizedNumber;
+    getTotalLoansDeployed: INormalizedNumber;
+    withdrawalFee: INormalizedNumber;
+    chainId: number;
+    address: IAddress;
+    managementFee: number;
+    underlying: {
+        address: IAddress;
+        chain: number;
+    };
+    loansOperator: IAddress;
+    loans: ISubgraphFormattedLoan[];
+}
+export interface ISubgraphFormattedLoan {
+    amount: INormalizedNumber;
+    address: IAddress;
+    apr: number;
+    collateral: IAddress;
+    repaid: INormalizedNumber;
+    borrower: IAddress;
+}
+export type IPoolWithPositions = IPoolWithUnderlying & {
+    token: IAddress;
+    position: string;
+    apy: number;
+    status: string;
+    availableRedemptions: IPoolAvailableRedemption[];
+    redeemable: INormalizedNumber;
+    walletBalance: string;
+};
+export type IPoolFunctions = 'decimals' | 'symbol' | 'name' | 'asset' | 'totalSupply' | 'maxSupply' | 'totalAssets' | 'globalLoansAmount' | 'loansOperator' | 'getTotalLoansDeployed' | 'withdrawalFee' | 'lagDuration' | 'withdrawalsPaused' | 'assetsWhitelistAddress' | 'getWhitelistedAssets' | 'maxDepositAmount' | 'getTotalAssets' | 'lpTokenAddress' | 'depositCap';
+export type IPoolAction = 'deposit' | 'withdraw' | 'claim' | 'stake' | 'getReward' | 'unstake';
+export type IPoolModal = {
+    isOpen: boolean;
+    onClose: (e: any) => void;
+    type: IPoolAction;
+    mode?: 'light' | 'dark';
+} & IPoolWithUnderlying;
+export type IPoolAvailableRedemption = {
+    receiver: IAddress;
+    day: INormalizedNumber;
+    month: INormalizedNumber;
+    year: INormalizedNumber;
+    amount: INormalizedNumber;
+    date: Date;
+    pool: IAddress;
+};
+export type IPoolRedemptionHistoryItem = {
+    receiver: IAddress;
+    amount: INormalizedNumber;
+    processed: Date;
+    requested: Date;
+    pool: IAddress;
+};
+export type IPoolOrderParam = 'asc' | 'desc';
+export type IPoolHistoricalParams = {
+    order?: IPoolOrderParam;
+    start: Date;
+    interval?: 'years' | 'quarters' | 'months' | 'weeks' | 'days' | 'hours' | 'minutes';
+};
+export {};

package/lib/types/pools.js

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

package/lib/types/staking.d.ts

@@ -0,0 +1,28 @@
+import type { IAddress, INormalizedNumber } from './web3';
+export type IActiveStakingPosition = {
+    stakingToken: {
+        decimals: number;
+        symbol: string;
+        address: IAddress;
+        chain: number;
+        totalStaked: INormalizedNumber;
+        usd: INormalizedNumber;
+        totalSupply?: INormalizedNumber;
+        name: string;
+    };
+    rewardToken: {
+        decimals: number;
+        symbol: string;
+        address: IAddress;
+        chain: number;
+        redeemable: INormalizedNumber;
+        usd: INormalizedNumber;
+        name: string;
+    };
+    rewardDistributor: IAddress;
+    rewardPerSecond: INormalizedNumber;
+    apy?: number;
+    maxApy?: number;
+    chainId: number;
+    id: string;
+};

package/lib/types/staking.js

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

package/lib/types/sub-accounts.d.ts

@@ -0,0 +1,140 @@
+import type { IAddress } from './web3';
+/**
+ * Chain record attached to a subaccount directory entry, as serialized by the
+ * backend `IChainRead` schema.
+ */
+export interface IWSSubaccountListChain {
+    id: string;
+    chain_id: number;
+    name: string;
+}
+/**
+ * One subaccount record from the admin-only `GET /subaccount` directory
+ * endpoint (backend `ISubaccountRead` schema). Nullable fields are optional
+ * metadata the operations team may not have filled in.
+ */
+export interface IWSSubaccountListItem {
+    id: string;
+    user_id: string | null;
+    internal_name: string;
+    friendly_name: string | null;
+    address: IAddress;
+    status: string | null;
+    subaccount_type: string | null;
+    min_health_factor: number | null;
+    estimated_apr: number | null;
+    notes: string | null;
+    proxy_salt: string | null;
+    admin_salt: string | null;
+    disable_discount_factor: boolean | null;
+    turnkey_address: IAddress | null;
+    autopay_frequency: string | null;
+    implementation: string | null;
+    variant: string | null;
+    default_fee_rate_in_bips: number | null;
+    wallet_role: string | null;
+    chains: IWSSubaccountListChain[];
+}
+export interface IWSSubAccountHealthFactor {
+    id: IAddress;
+    datetime: string;
+    health_factor: number;
+    total_collateral_value: number;
+    total_loan_value: number;
+}
+export interface IWSSubaccountSummaryToken {
+    type: string;
+    name: string;
+    address: string;
+    chain: number;
+    symbol: string;
+    decimals: number;
+    img_url: string;
+}
+export interface IWSSubaccountSummaryPortfolioToken {
+    value: number;
+    balance: number;
+    token: IWSSubaccountSummaryToken;
+}
+export interface IWSSubaccountSummaryFullToken extends IWSSubaccountSummaryToken {
+    price: number;
+    raw_balance: number;
+    balance: number;
+    value: number;
+}
+export interface IWSSubaccountSummaryChain {
+    name: string;
+    chain_id: number;
+}
+export interface IWSSubaccountSummaryLoanBook {
+    address: IAddress;
+    lender: IAddress;
+    borrower: IAddress;
+    state: string;
+    total_repaid: number;
+    principal_token: IWSSubaccountSummaryToken & {
+        token_type: number;
+        discount_factor: number;
+        price: number;
+    };
+    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;
+    total_interest_payment_fees: number;
+}
+export interface IWSSubaccountSummaryLoan {
+    subaccount_address: IAddress;
+    book: IWSSubaccountSummaryLoanBook;
+    is_borrow: boolean;
+    debt_info: {
+        interest_owed: number;
+        principal_debt_owed: number;
+        interest_repaid: number;
+    };
+    credit_info: {
+        net_interest_owed: number;
+        principal_debt_owed: number;
+        net_interest_repaid: number;
+    };
+}
+export interface IWSSubaccountSummaryLoanbook {
+    loans: IWSSubaccountSummaryLoan[];
+    total_debt: number;
+    total_credit: number;
+    aggregates_by_token: unknown[];
+}
+export interface IWSSubaccountSummaryPortfolio {
+    tokens: IWSSubaccountSummaryPortfolioToken[];
+    margin_balances: unknown[];
+    collateral_balances: unknown[];
+    cefi_positions: unknown[];
+    defi_positions: unknown[];
+    trs_positions: unknown[];
+    strategy_contract_positions: unknown[];
+    legacy_hedger_positions: unknown[];
+    otc_positions: unknown[];
+    total_value: number;
+    discounted_value: number;
+}
+export interface IWSSubaccountSummary {
+    address: IAddress;
+    name: string;
+    type: 'subaccount' | 'eoa';
+    portfolio: IWSSubaccountSummaryPortfolio;
+    loanbook: IWSSubaccountSummaryLoanbook;
+    chains: IWSSubaccountSummaryChain[];
+    tokens: IWSSubaccountSummaryFullToken[];
+    total_account_value: number;
+    total_collateral_value: number;
+    total_loan_value: number;
+    health_factor: number | null;
+    net_account_value: number;
+    total_equity_value: number;
+}

package/lib/types/sub-accounts.js

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

package/lib/types/subgraph.d.ts

@@ -0,0 +1,74 @@
+import type { IAddress } from './web3';
+export interface ISubgraphBase {
+    id: string;
+    contractId_: IAddress;
+    timestamp_: string;
+    transactionHash_: IAddress;
+    block_number: string;
+}
+export interface ISubgraphUserHistoryItem extends ISubgraphBase {
+    address: IAddress;
+    amount: string;
+    type: 'withdraw-request' | 'deposit' | 'withdraw-processed';
+    decimals?: number;
+    isInstant?: boolean;
+    /**
+     * Receipt-token (vault share) amount burned, raw base units. Present on
+     * withdraw-request rows: an async withdrawal burns shares up front, but the
+     * assets ultimately received are only known once the request settles (share
+     * price can move). Consumers showing a pending request should surface these
+     * shares (the concrete on-chain fact) rather than the request's `assets`
+     * preview. Absent on deposits and settled withdraws.
+     */
+    shares?: string;
+    /**
+     * Deposit asset token address, when known. Pre-deposit vaults accept
+     * multiple deposit assets with differing decimals (e.g. USDS at 18,
+     * USDC at 6), so `amount` cannot be normalized with the vault's own
+     * decimals alone — consumers (notably lifetime PnL) key off this address
+     * to resolve the correct per-asset decimals and USD price. Absent for
+     * single-asset vaults, where the vault `decimals` is correct.
+     */
+    assetIn?: IAddress;
+}
+export interface ISubgraphWithdrawProccessed extends ISubgraphBase {
+    processedOn: string;
+    requestedOn: string;
+    receiverAddr: IAddress;
+    assetsAmount: string;
+}
+export interface ISubgraphDeposit extends ISubgraphBase {
+    assets: string;
+    sender: IAddress;
+    shares: string;
+    owner: IAddress;
+    senderAddr?: IAddress;
+    amountIn?: string;
+    /**
+     * Deposit asset token address (evm-2 / pre-deposit vaults). The deposited
+     * asset can differ from the vault's underlying and carry different decimals
+     * (e.g. RLUSD at 18 into a 6-decimal sentUSD vault), so `amountIn` must be
+     * normalized against this token's decimals, not the vault's. Absent for
+     * single-asset vaults.
+     */
+    assetIn?: IAddress;
+}
+export interface ISubgraphWithdrawRequest extends ISubgraphBase {
+    day: string;
+    month: string;
+    year: string;
+    shares: string;
+    assets: string;
+    receiverAddr: IAddress;
+    ownerAddr: IAddress;
+}
+export interface ISubgraphWithdraw extends ISubgraphBase {
+    receiver: IAddress;
+    sender: string;
+    assets: string;
+}
+export interface ISubgraphTransfer extends ISubgraphBase {
+    from: IAddress;
+    to: IAddress;
+    value: string;
+}

package/lib/types/subgraph.js

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

package/lib/types/typed-contract.d.ts

@@ -0,0 +1,102 @@
+/**
+ * TypedContract type definitions for ethers v6 with abitype.
+ *
+ * This is a local copy of types from ethers-abitype to avoid the global
+ * abitype module augmentation that pollutes AddressType with `string | Addressable`,
+ * which breaks viem type compatibility.
+ *
+ * @see https://github.com/ethers-io/ethers.js/issues/4475
+ */
+import type { BaseContract, ContractTransaction, ContractTransactionResponse, DeferredTopicFilter, EventFragment, FunctionFragment, Result, Overrides } from 'ethers';
+import type { Abi, AbiParametersToPrimitiveTypes, ExtractAbiEvent, ExtractAbiEventNames, ExtractAbiEvents, ExtractAbiFunction, ExtractAbiFunctionNames, ExtractAbiFunctions } from 'abitype';
+type AsArray<T> = T extends readonly unknown[] ? T : never;
+export type TypedContractFunctionResult<TAbi extends Abi, TFunctionName extends string, TOutputArgs = AbiParametersToPrimitiveTypes<ExtractAbiFunction<TAbi, TFunctionName>['outputs']>> = TOutputArgs extends readonly [] ? void : TOutputArgs extends readonly [infer Arg] ? Arg : TOutputArgs;
+export type TypedFragment<TAbi extends Abi, TFunctionName extends string, TFunction extends ExtractAbiFunctions<TAbi> = ExtractAbiFunction<TAbi, TFunctionName>> = Omit<FunctionFragment, 'inputs' | 'outputs' | 'stateMutability' | 'name' | 'type'> & {
+    name: TFunction['name'];
+    type: TFunction['type'];
+    inputs: TFunction['inputs'];
+    outputs: TFunction['outputs'];
+    stateMutability: TFunction['stateMutability'];
+};
+export interface TypedContractFunction<TAbi extends Abi, TFunctionName extends string, TFunction extends ExtractAbiFunctions<TAbi> = ExtractAbiFunction<TAbi, TFunctionName>, TInputArgs extends readonly unknown[] = AsArray<AbiParametersToPrimitiveTypes<TFunction['inputs']>>, TResult = TypedContractFunctionResult<TAbi, TFunctionName>, TFragment = TypedFragment<TAbi, TFunctionName>> {
+    (...args: [...TInputArgs, overrides?: Overrides]): Promise<TFunction['stateMutability'] extends 'view' | 'pure' ? TResult : ContractTransactionResponse>;
+    /**
+     * The name of the Contract method.
+     */
+    name: TFunctionName;
+    /**
+     * The fragment of the Contract method. This will throw on ambiguous
+     * method names.
+     */
+    fragment: TFragment;
+    /**
+     * Returns the fragment constrained by %%args%%. This can be used to
+     * resolve ambiguous method names.
+     */
+    getFragment(...args: [...TInputArgs]): TFragment;
+    /**
+     * Returns a populated transaction that can be used to perform the
+     * contract method with %%args%%.
+     */
+    populateTransaction(...args: [...TInputArgs, overrides?: Overrides]): Promise<ContractTransaction>;
+    /**
+     * Call the contract method with %%args%% and return the value.
+     *
+     * If the return value is a single type, it will be dereferenced and
+     * returned directly, otherwise the full Result will be returned.
+     */
+    staticCall(...args: [...TInputArgs, overrides?: Overrides]): Promise<TResult>;
+    /**
+     * Send a transaction for the contract method with %%args%%.
+     */
+    send(...args: [...TInputArgs, overrides?: Overrides]): Promise<ContractTransactionResponse>;
+    /**
+     * Estimate the gas to send the contract method with %%args%%.
+     */
+    estimateGas(...args: [...TInputArgs, overrides?: Overrides]): Promise<bigint>;
+    /**
+     * Call the contract method with %%args%% and return the Result
+     * without any dereferencing.
+     */
+    staticCallResult(...args: [...TInputArgs, overrides?: Overrides]): Promise<Result>;
+}
+export interface TypedContractEvent<TAbi extends Abi, TEventName extends string, TEvent extends ExtractAbiEvents<TAbi> = ExtractAbiEvent<TAbi, TEventName>, TEventArgs extends readonly unknown[] = AsArray<Partial<AbiParametersToPrimitiveTypes<TEvent['inputs']>>>> {
+    (...args: [...TEventArgs]): DeferredTopicFilter;
+    /**
+     * The name of the Contract event.
+     */
+    name: TEventName;
+    /**
+     * The fragment of the Contract event. This will throw on ambiguous
+     * method names.
+     */
+    fragment: EventFragment;
+    /**
+     * Returns the fragment constrained by %%args%%. This can be used to
+     * resolve ambiguous event names.
+     */
+    getFragment(...args: [...TEventArgs]): EventFragment;
+}
+export type TypedContract<TAbi extends Abi> = Omit<BaseContract, 'getFunction' | 'getEvent'> & {
+    [Method in ExtractAbiFunctionNames<TAbi>]: TypedContractFunction<TAbi, Method>;
+} & {
+    /**
+     * Return the function for a given name. This is useful when a contract
+     * method name conflicts with a JavaScript name such as ``prototype`` or
+     * when using a Contract programatically.
+     */
+    getFunction<T extends ExtractAbiFunctionNames<TAbi>>(key: T | TypedFragment<TAbi, T>): TypedContractFunction<TAbi, T>;
+    /**
+     * Return the event for a given name. This is useful when a contract
+     * event name conflicts with a JavaScript name such as ``prototype`` or
+     * when using a Contract programatically.
+     */
+    getEvent<T extends ExtractAbiEventNames<TAbi>>(key: T | EventFragment): TypedContractEvent<TAbi, T>;
+    /**
+     * All the Events available on this contract.
+     */
+    filters: {
+        [EventName in ExtractAbiEventNames<TAbi>]: TypedContractEvent<TAbi, EventName>;
+    };
+};
+export {};

package/lib/types/typed-contract.js

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

package/lib/types/user.d.ts

@@ -0,0 +1 @@
+export type IUserRoles = 'client' | 'admin' | 'dev' | 'internal';

package/lib/types/user.js

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