@kasufinance/kasu-sdk 1.0.1

package/dist/services/UserLending/subgraph-types.d.ts

@@ -0,0 +1,147 @@
+import { TrancheConfigurationSubgraph, TrancheInterestRateUpdateSubgraph } from '../DataService/subgraph-types';
+export interface UserRequestsSubgraph {
+    userRequests: {
+        id: string;
+        amountRequested: string;
+        amountAccepted: string;
+        amountRejected: string;
+        status: UserRequestStatus;
+        createdOn: string;
+        type: 'DepositRequest' | 'WithdrawalRequest';
+        updatedOn: string;
+        lendingPool: {
+            id: string;
+            name: string;
+            balance: string;
+            tranches: {
+                orderId: string;
+                shares: string;
+            }[];
+            configuration: {
+                tranchesConfig: {
+                    id: string;
+                    interestRate: string;
+                    lendingPoolTrancheInterestRateUpdates: TrancheInterestRateUpdateSubgraph[];
+                    lendingPoolTrancheFixedTermConfigs: TrancheConfigurationSubgraph['lendingPoolTrancheFixedTermConfigs'];
+                }[];
+            };
+        };
+        fixedTermConfigId: string;
+        tranche: {
+            orderId: string;
+            id: string;
+            shares: string;
+            balance: string;
+        };
+        user: {
+            id: string;
+        };
+        nftId: string;
+        userRequestEvents: {
+            assetAmount?: string;
+            createdOn: string;
+            id: string;
+            index: string;
+            type: UserRequestEventType;
+            transactionHash: string;
+            sharesAmount: string;
+            epochId: string;
+            tranche: {
+                id: string;
+                orderId: string;
+            };
+        }[];
+    }[];
+}
+export interface CurrentEpochDepositedAmountSubgraph {
+    lendingPoolUserDetails_collection: {
+        lendingPoolTrancheUserDetails: {
+            tranche: {
+                id: string;
+            };
+            totalPendingDepositAmount: string;
+        }[];
+    }[] | null;
+}
+export interface CurrentEpochFtdAmountSubgraph {
+    userRequests: {
+        fixedTermConfigId: string;
+        amountRequested: string;
+        tranche: {
+            id: string;
+            balance: string;
+            shares: string;
+        };
+    }[];
+}
+export declare enum UserRequestStatus {
+    REQUESTED = "Requested",
+    PROCESSING = "Processing",
+    PROCESSED = "Processed"
+}
+export type UserRequestEventType = 'ImmediateWithdrawalExecuted' | 'WithdrawalInitiated' | 'WithdrawalIncreased' | 'WithdrawalCancelled' | 'WithdrawalAccepted' | 'DepositReallocated' | 'DepositInitiated' | 'DepositIncreased' | 'DepositCancelled' | 'DepositAccepted' | 'DepositRejected';
+export interface LendingPoolUserDetailsSubgraph {
+    user: {
+        lendingPoolUserDetails: {
+            lendingPool: {
+                id: string;
+            };
+            totalAcceptedDeposits: string;
+            totalAcceptedWithdrawnAmount: string;
+        }[];
+    } | null;
+}
+export interface TrancheUserDetailsSubgraph {
+    lendingPoolTrancheUserDetails?: {
+        id: string;
+        totalAcceptedDeposits: string;
+        totalAcceptedWithdrawnAmount: string;
+        shares: string;
+        tranche: {
+            id: string;
+            shares: string;
+            balance: string;
+        };
+    };
+}
+export interface PortfolioTrancheUserDetailsSubgraph {
+    user: {
+        lendingPoolUserDetails: {
+            lendingPool: {
+                id: string;
+            };
+            lendingPoolTrancheUserDetails: TrancheUserDetailsSubgraph['lendingPoolTrancheUserDetails'][];
+        }[];
+    } | null;
+}
+export interface TotalUserLoyaltyRewardsSubgraph {
+    user?: {
+        totalUserLoyaltyRewards: string;
+    };
+}
+export interface LendingPoolsBalanceSubgraph {
+    lendingPools: {
+        id: string;
+        balance: string;
+        tranches: {
+            shares: string;
+        }[];
+    }[];
+}
+export interface CurrentFtdBalanceSubgraph {
+    userLendingPoolTrancheFixedTermDepositLocks: {
+        trancheShares: string;
+        lendingPoolTrancheFixedTermConfig: {
+            configId: string;
+            lendingPoolTranche: {
+                id: string;
+            };
+        };
+        lendingPool: {
+            balance: string;
+            tranches: {
+                shares: string;
+            }[];
+        };
+    }[];
+}

package/dist/services/UserLending/subgraph-types.js

@@ -0,0 +1,6 @@
+export var UserRequestStatus;
+(function (UserRequestStatus) {
+    UserRequestStatus["REQUESTED"] = "Requested";
+    UserRequestStatus["PROCESSING"] = "Processing";
+    UserRequestStatus["PROCESSED"] = "Processed";
+})(UserRequestStatus || (UserRequestStatus = {}));

package/dist/services/UserLending/types.d.ts

@@ -0,0 +1,102 @@
+import { BigNumber } from 'ethers';
+import { UserRequestStatus } from './subgraph-types';
+export interface UserInvestment {
+    id: string;
+    totalAmountInvested: number;
+    weightedAverageAPY: number;
+    totalYieldEarned: number;
+    userTrancheData: UserTrancheData[];
+}
+export interface UserTrancheData {
+    id: string;
+    totalAmountInvested: number;
+    trancheAPY: number;
+    yieldEarned: number;
+}
+export interface UserTransactions {
+    id: string;
+    request: string;
+    tranche: string;
+    requested: number;
+    accepted: number;
+    rejected: number;
+    timestamp: number;
+    status: string;
+}
+export interface UserRequest {
+    id: string;
+    userId: string;
+    lendingPool: {
+        id: string;
+        name: string;
+        tranches: {
+            orderId: string;
+        }[];
+    };
+    requestType: 'Deposit' | 'Withdrawal';
+    trancheId: string;
+    trancheName: string;
+    requestedAmount: string;
+    acceptedAmount: string;
+    rejectedAmount: string;
+    timestamp: EpochTimeStamp;
+    status: UserRequestStatus;
+    canCancel: boolean;
+    events: UserRequestEvent[];
+    nftId: string;
+    apy: string;
+    fixedTermConfig: {
+        configId: string;
+        apy: string;
+        epochLockDuration: string;
+        epochInterestRate: string;
+    } | undefined;
+}
+export interface UserRequestEvent {
+    id: string;
+    requestType: 'Initiated' | 'Increased' | 'Cancelled' | 'Accepted' | 'Rejected' | 'Reallocated' | 'Forced';
+    assetAmount: string;
+    totalRequested: string;
+    totalAccepted: string;
+    totalRejected: string;
+    index: number;
+    timestamp: EpochTimeStamp;
+    transactionHash: string;
+    trancheName: string;
+    trancheId: string;
+    apy: string;
+    epochId: string;
+}
+export interface UserTrancheBalance {
+    userId: string;
+    address: string;
+    yieldEarned: number;
+    balance: string;
+    availableToWithdraw: BigNumber;
+    trancheId: string;
+}
+export type PortfolioUserTrancheBalance = Map<string, {
+    trancheId: string;
+    yieldEarned: number;
+    userBalance: string;
+}[]>;
+export interface UserPoolBalance {
+    poolId: string;
+    yieldEarned: number;
+    balance: BigNumber;
+}
+export declare enum UserRequestType {
+    DEPOSIT = "DepositRequest",
+    WITHDRAW = "WithdrawRequest"
+}
+export declare enum UserRequestEventType {
+    DEPOSIT_INITIATED = "DepositInitiated",
+    ACCEPTED = "DepositAccepted",
+    REJECTED = "DepositRejected",
+    CANCELLED = "DepositCancelled",
+    WITHDRAWAL_INITIATED = "WithdrawalInitiated"
+}
+export interface UserApyBonus {
+    balance: BigNumber;
+    lifetime: number;
+}

package/dist/services/UserLending/types.js

@@ -0,0 +1,13 @@
+export var UserRequestType;
+(function (UserRequestType) {
+    UserRequestType["DEPOSIT"] = "DepositRequest";
+    UserRequestType["WITHDRAW"] = "WithdrawRequest";
+})(UserRequestType || (UserRequestType = {}));
+export var UserRequestEventType;
+(function (UserRequestEventType) {
+    UserRequestEventType["DEPOSIT_INITIATED"] = "DepositInitiated";
+    UserRequestEventType["ACCEPTED"] = "DepositAccepted";
+    UserRequestEventType["REJECTED"] = "DepositRejected";
+    UserRequestEventType["CANCELLED"] = "DepositCancelled";
+    UserRequestEventType["WITHDRAWAL_INITIATED"] = "WithdrawalInitiated";
+})(UserRequestEventType || (UserRequestEventType = {}));

package/dist/services/UserLending/user-lending.d.ts

@@ -0,0 +1,55 @@
+import { Provider } from '@ethersproject/providers';
+import { BigNumber, BigNumberish, BytesLike, ContractTransaction, Signer } from 'ethers';
+import { IKasuAllowListAbi__factory } from '../../contracts';
+import { SdkConfig } from '../../sdk-config';
+import { PortfolioUserTrancheBalance, UserApyBonus, UserPoolBalance, UserRequest, UserTrancheBalance } from './types';
+export declare class UserLending {
+    private _kasuConfig;
+    private readonly _graph;
+    private readonly _directus;
+    private _dataService;
+    private readonly _userManagerAbi;
+    private readonly _lendingPoolManagerAbi;
+    private readonly _userLoyaltyRewardsAbi;
+    private readonly _clearingCoordinatorAbi;
+    private readonly _systemVariablesAbi;
+    readonly _signerOrProvider: Signer | Provider;
+    constructor(_kasuConfig: SdkConfig, signerOrProvider: Signer | Provider);
+    getUserTotalPendingAndActiveDepositedAmount(user: string): Promise<[BigNumber, BigNumber]>;
+    getUserTotalPendingAndActiveDepositedAmountForCurrentEpoch(user: string): Promise<[BigNumber, BigNumber]>;
+    hasUserRKSU(user: string): Promise<boolean>;
+    buildKycSignatureParams(userAddress: `0x${string}`, chainId: string): {
+        contractAbi: IKasuAllowListAbi__factory;
+        contractAddress: string;
+        functionName: string;
+        args: BytesLike[];
+        userAddress: string;
+        chainId: string;
+    };
+    buildDepositSwapData(fromToken: string, fromAmount: string, routerAddress: string, swapCallData: string, minAmountOut: string): BytesLike;
+    requestDepositWithKyc(lendingPool: string, tranche: string, maxAmount: BigNumberish, swapData: BytesLike, fixedTermConfigId: BigNumberish, depositData: BytesLike, kycData: {
+        blockExpiration: BigNumberish;
+        signature: BytesLike;
+    }, ethValue: string): Promise<ContractTransaction>;
+    requestDeposit(lendingPool: string, tranche: string, amount: BigNumberish, swapData: BytesLike, fixedTermConfigId: BigNumberish, depositData: BytesLike): Promise<ContractTransaction>;
+    withdrawAtExpiry(lendingPool: string, fixedTermDepositId: string): Promise<ContractTransaction>;
+    lockDepositForFixedTerm(lendingPool: string, tranche: string, amount: BigNumberish, fixedTermConfigId: BigNumberish): Promise<ContractTransaction>;
+    cancelDepositRequest(lendingPool: string, dNftID: BigNumberish): Promise<ContractTransaction>;
+    requestWithdrawal(lendingPool: string, tranche: string, amount: BigNumberish): Promise<ContractTransaction>;
+    requestWithdrawalInUSDC(lendingPool: string, tranche: string, usdcAmount: BigNumberish): Promise<ContractTransaction>;
+    requestWithdrawalMax(lendingPool: string, tranche: string, user: string): Promise<ContractTransaction>;
+    cancelWithdrawalRequest(lendingPool: string, dNftID: BigNumberish): Promise<ContractTransaction>;
+    claimRepaidLoss(lendingPool: string, tranche: string, lossId: BigNumberish): Promise<ContractTransaction>;
+    getUserRequests(userAddress: `0x${string}`, epochId: string): Promise<UserRequest[]>;
+    getCurrentEpoch(): Promise<string>;
+    getCurrentFtdBalance(poolId: string, userId: string): Promise<Map<string, number[]>>;
+    getCurrentEpochFtdAmount(poolIds: string[], userId: string, currentEpoch: string): Promise<Map<string, string[]>>;
+    getCurrentEpochDepositedAmount(lendingPoolIds: string[], userId: string): Promise<Map<string, string>>;
+    convertSharesToAssets(sharesAmount: string, totalAssets: string, totalSupply: string): string;
+    isClearingPending(poolId: string): Promise<boolean>;
+    isCancelable(status: string, lendingPoolId: string): Promise<boolean>;
+    getUserPoolBalance(user: string, poolIds: string[], provider?: Provider): Promise<UserPoolBalance[]>;
+    getPortfolioUserTrancheBalances(user: string): Promise<PortfolioUserTrancheBalance>;
+    getUserTrancheBalance(user: string, poolId: string, trancheId: string): Promise<UserTrancheBalance>;
+    getUserApyBonus(user: string): Promise<UserApyBonus>;
+}