@kasufinance/kasu-sdk 1.0.1

package/dist/services/DataService/directus-types.d.ts

@@ -0,0 +1,187 @@
+export interface DirectusSchema {
+    PoolOverview: PoolOverviewDirectus[];
+    PoolDelegateProfileAndHistory: PoolDelegateProfileAndHistoryDirectus[];
+    RiskManagement: RiskManagementDirectus[];
+    RiskManagementItems: RiskManagementItemDirectus[];
+    RiskManagementGroups: RiskManagementGroupDirectus[];
+    PoolCreditMetrics: PoolCreditMetricsDirectus[];
+    BadAndDoubtfulDebts: BadAndDoubtfulDebtsDirectus[];
+    FinancialReportingDocuments: FinancialReportingDocumentsDirectus[];
+    FinancialReportingDocumentsItems: FinancialReportingDocumentsItemsDirectus[];
+    PoolRepayments: PoolRepaymentDirectus[];
+    PoolRepaymentItems: PoolRepaymentItemsDirectus[];
+    KeyCreditMetrics: KeyCreditMetricsDirectus[];
+    BadAndDoubtfulDebtsItems: BadAndDoubtfulDebtsItems[];
+    PlatformOverview: PlatformOverviewDirectus;
+    NftBoost: NftBoostDirectus;
+}
+export interface PlatformOverviewDirectus {
+    id: string;
+    loanOriginationVolume: number;
+}
+export interface NftBoostDirectus {
+    id: string;
+    kappa: number;
+    kitsune: number;
+    tengu: number;
+    ryujin: number;
+    yurei: number;
+}
+export interface PoolOverviewDirectus {
+    id: string;
+    poolName?: string;
+    subheading?: string;
+    enabled: boolean;
+    oversubscribed: boolean;
+    security: string[];
+    apy: number;
+    description: string;
+    liteDescription: string;
+    thumbnailImage: string;
+    bannerImage: string;
+    strategyDeck: string;
+    assetClass: string;
+    industryExposure: string;
+    poolApyStructure: 'Variable' | 'Fixed';
+    apyExpiryDate: number | null;
+    poolInvestmentTerm: string;
+    loanStructure: string;
+    loansUnderManagement: string;
+    activeLoans: string;
+    loanFundsOriginated: string;
+    plumeStrategy: string | null;
+}
+export interface PoolDelegateProfileAndHistoryDirectus {
+    id: string;
+    delegateLendingHistory: number;
+    assetClasses: string;
+    otherPools: {
+        PoolDelegateProfileAndHistory_id: string;
+        PoolOverview_id: string;
+        id: number;
+    }[];
+    totalLoanFundsOriginated: number;
+    totalLoansOriginated: number;
+    loansUnderManagement: number;
+    historicLossRate: number;
+}
+export interface RiskManagementDirectus {
+    id: string;
+    poolIdFK: string;
+    firstLossCapital: number;
+    poolLossRate: number;
+    independentRiskScore: number;
+    communityRating: number;
+    riskManagementItems: {
+        riskManagementItem: {
+            key: string;
+            collection: string;
+        };
+        description: string;
+    }[];
+}
+export interface RiskManagementItemDirectus {
+    name: string;
+    group: {
+        key: string;
+        collection: string;
+    };
+    tooltip: string;
+}
+export interface RiskManagementGroupDirectus {
+    name: string;
+}
+export interface PoolCreditMetricsDirectus {
+    id: string;
+    poolIdFK: string;
+    keyCreditMetrics: {
+        keyCreditMetric: {
+            key: string;
+            collection: string;
+        };
+        mostRecentQuarter: number;
+        previousFiscalYear: number;
+        priorMonth: number;
+    }[];
+}
+export interface KeyCreditMetricsDirectus {
+    name: string;
+    tooltip?: string;
+    unit: string;
+}
+export interface BadAndDoubtfulDebtsItems {
+    id: string;
+    name: string;
+    tooltip?: string;
+    unit?: string;
+}
+export interface BadAndDoubtfulDebtsDirectus {
+    id: string;
+    poolIdFK: string;
+    items: {
+        item: {
+            key: string;
+            collection: string;
+        };
+        totalLifetimeAmount: number | null;
+        totalLifetimePercentage: number | null;
+        monthlyAverageAmount: number | null;
+        monthlyAveragePercentage: number | null;
+        currentAmount: number | null;
+        currentPercentage: number | null;
+    }[];
+}
+export interface FinancialReportingDocumentsItemsDirectus {
+    id: number;
+    date_created: string;
+    name: string;
+    description: string;
+    document: string;
+    version: number;
+    financialReportingDocumentsFK: string;
+}
+export interface FinancialReportingDocumentsDirectus {
+    id: string;
+    poolIdFK: string;
+    documents: number[] | null;
+}
+export interface PoolRepaymentItemsDirectus {
+    name: string;
+    tooltip: string;
+}
+export interface PoolRepaymentDirectus {
+    id: string;
+    poolIdFK: string;
+    repaymentsFile: string;
+    currentTotalEndBorrowers: number;
+    UpcomingLendingFundsFlow: {
+        repaymentItem: {
+            key: string;
+            collection: string;
+        };
+        value: number;
+    }[];
+    CumulativeLendingFundsFlow: {
+        repaymentItem: {
+            key: string;
+            collection: string;
+        };
+        value: number;
+    }[];
+    CumulativeLendingAndWithdrawals: {
+        repaymentItem: {
+            key: string;
+            collection: string;
+        };
+        value?: number;
+        key?: string;
+    }[];
+    LendingAndWithdrawalRequests: {
+        repaymentItem: {
+            key: string;
+            collection: string;
+        };
+        value?: number;
+        key?: string;
+    }[];
+}

package/dist/services/DataService/directus-types.js

@@ -0,0 +1 @@
+export {};

package/dist/services/DataService/queries.d.ts

@@ -0,0 +1,7 @@
+export declare const getPlumeTvl: string;
+export declare const getPoolOverviewQuery: (ids?: string[]) => string;
+export declare const getAllLendingPoolsQuery: string;
+export declare const getAllTranchesQuery: string;
+export declare const getAllTrancheConfigurationsQuery: string;
+export declare const getPoolNameQuery: string;
+export declare const getLendingPoolWithdrawalAndDepositsQuery: string;

package/dist/services/DataService/queries.js

@@ -0,0 +1,158 @@
+import { gql } from 'graphql-request';
+export const getPlumeTvl = gql `
+    {
+        lendingPools {
+            id
+            balance
+        }
+    }
+`;
+export const getPoolOverviewQuery = (ids) => gql `
+    query getAllPoolOverview($epochId: String!, $unusedPools: [String]!) {
+        lendingPools(
+            where: { 
+                id_not_in: $unusedPools
+                ${(ids === null || ids === void 0 ? void 0 : ids.length) ? `, id_in: [${ids.map((id) => `"${id}"`).join(',')}]` : ''} 
+            }
+        ) {
+            pendingPool {
+                id
+                totalPendingDepositAmounts
+                totalPendingDepositsAmount
+                totalPendingWithdrawalShares
+            }
+            id
+            totalUserInterestAmount
+            totalLossAmount
+            name
+            balance
+            firstLostCapital
+            isStopped
+            tranches(orderBy: orderId, orderDirection: asc) {
+                balance
+                id
+                totalInterestAmount
+                orderId
+            }
+            configuration {
+                desiredDrawAmount
+                lendingPoolWithdrawalConfig{
+                    requestEpochsInAdvance
+                }
+                tranchesConfig(orderBy: orderId, orderDirection: asc) {
+                    id
+                    desiredRatio
+                    interestRate
+                    minDepositAmount
+                    maxDepositAmount
+                    lendingPoolTrancheInterestRateUpdates(
+                        orderDirection: desc
+                        orderBy: epochId
+                        first: 1
+                        where:{ epochId_lte: $epochId }
+                    ) {
+                        epochInterestRate
+                    }
+                    lendingPoolTrancheFixedTermConfigs{
+                        configId
+                        epochLockDuration
+                        epochInterestRate
+                        fixedTermDepositStatus
+                        fixedTermDepositAllowlist{
+                            id
+                            user{
+                                id
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+`;
+export const getAllLendingPoolsQuery = gql `
+    query getAllLendingPools($unusedPools: [String]!) {
+        lendingPools(where: { id_not_in: $unusedPools }) {
+            pendingPool {
+                id
+                totalPendingDepositAmounts
+                totalPendingDepositsAmount
+                totalPendingWithdrawalShares
+            }
+            id
+            totalUserInterestAmount
+            totalLossAmount
+            name
+            balance
+            firstLostCapital
+            isStopped
+            tranches(orderBy: orderId, orderDirection: asc) {
+                balance
+                id
+                totalInterestAmount
+                orderId
+            }
+        }
+    }
+`;
+export const getAllTranchesQuery = gql `
+    query getAllTranches($unusedPools: [String]!) {
+        lendingPoolTranches(where: { lendingPool_not_in: $unusedPools }) {
+            id
+            orderId
+            totalInterestAmount
+            balance
+            lendingPool {
+                id
+            }
+        }
+    }
+`;
+export const getAllTrancheConfigurationsQuery = gql `
+    query getAllTrancheConfigurations(
+        $epochId: String!
+        $unusedPools: [String]!
+    ) {
+        lendingPoolTrancheConfigurations(
+            where: { lendingPoolConfiguration_not_in: $unusedPools }
+        ) {
+            id
+            orderId
+            maxDepositAmount
+            minDepositAmount
+            interestRate
+            desiredRatio
+            lendingPoolTrancheInterestRateUpdates(
+                orderDirection: desc
+                orderBy: epochId
+                first: 1
+                where: { epochId_lte: $epochId }
+            ) {
+                epochInterestRate
+            }
+        }
+    }
+`;
+export const getPoolNameQuery = gql `
+    query getPoolName($ids: [String], $unusedPools: [String]!) {
+        lendingPools(where: { id_in: $ids, id_not_in: $unusedPools }) {
+            id
+            name
+            isStopped
+        }
+    }
+`;
+export const getLendingPoolWithdrawalAndDepositsQuery = gql `
+    query getLendingPoolWithdrawalAndDeposits($unusedPools: [String]!) {
+        lendingPools(where: { id_not_in: $unusedPools }) {
+            id
+            pendingPool {
+                totalPendingDepositAmounts
+                totalPendingDepositsAmount
+                totalPendingWithdrawalShares
+            }
+            totalDepositsAccepted
+            totalWithdrawalsAccepted
+        }
+    }
+`;

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

@@ -0,0 +1,95 @@
+export interface LendingPoolSubgraph {
+    id: string;
+    totalUserInterestAmount: string;
+    totalLossAmount: string;
+    name: string;
+    balance: string;
+    firstLostCapital: string;
+    isStopped: boolean;
+    pendingPool: {
+        id: string;
+        totalPendingDepositAmounts: string[];
+        totalPendingDepositsAmount: string;
+        totalPendingWithdrawalShares: string[];
+    };
+    tranches: TrancheSubgraph[];
+    configuration: LendingPoolConfigurationSubgraph;
+}
+export interface PlumeSubgraphReturn {
+    lendingPools: {
+        id: string;
+        balance: string;
+    }[];
+}
+export interface LendingPoolSubgraphReturn {
+    lendingPools: LendingPoolSubgraph[];
+}
+export interface TrancheSubgraph {
+    balance: string;
+    id: string;
+    totalInterestAmount: string;
+    orderId: string;
+    lendingPool: {
+        id: string;
+    };
+}
+export interface TrancheSubgraphResult {
+    lendingPoolTranches: TrancheSubgraph[];
+}
+export interface TrancheInterestRateUpdateSubgraph {
+    id: string;
+    lendingPoolTrancheConfiguration: TrancheConfigurationSubgraph[];
+    epochId: number;
+    epochInterestRate: string;
+}
+export interface TrancheConfigurationSubgraph {
+    maxDepositAmount: string;
+    minDepositAmount: string;
+    interestRate: string;
+    id: string;
+    desiredRatio: string;
+    orderId: string;
+    lendingPoolTrancheInterestRateUpdates: TrancheInterestRateUpdateSubgraph[];
+    lendingPoolTrancheFixedTermConfigs: {
+        configId: string;
+        epochLockDuration: string;
+        epochInterestRate: string;
+        fixedTermDepositStatus: 'Everyone' | 'AllowlistedOnly';
+        fixedTermDepositAllowlist: {
+            isAllowlisted: boolean;
+            user: {
+                id: string;
+            };
+        }[];
+    }[];
+}
+export interface TrancheConfigurationSubgraphResult {
+    lendingPoolTrancheConfigurations: TrancheConfigurationSubgraph[];
+}
+export interface LendingPoolConfigurationSubgraph {
+    desiredDrawAmount: string;
+    drawRecipient: string;
+    id: string;
+    minimumExcessLiquidityPercentage: string;
+    targetExcessLiquidityPercentage: string;
+    trancheInterestChangeEpochDelay: string;
+    tranchesConfig: TrancheConfigurationSubgraph[];
+    lendingPoolWithdrawalConfig: {
+        requestEpochsInAdvance: string;
+    };
+}
+export interface LendingPoolConfigurationSubgraphReturn {
+    lendingPoolConfigurations: LendingPoolConfigurationSubgraph[];
+}
+export interface LendingPoolWithdrawalAndDepositSubgraph {
+    lendingPools: {
+        id: string;
+        pendingPool: {
+            totalPendingDepositAmounts: string[];
+            totalPendingDepositsAmount: string;
+            totalPendingWithdrawalShares: string[];
+        };
+        totalDepositsAccepted: string;
+        totalWithdrawalsAccepted: string;
+    }[];
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,169 @@
+import { BadAndDoubtfulDebtsItems, KeyCreditMetricsDirectus } from './directus-types';
+export interface PoolOverview {
+    poolName: string;
+    subheading?: string;
+    id: string;
+    enabled: boolean;
+    isOversubscribed: boolean;
+    apy: number;
+    description: string;
+    liteDescription: string;
+    thumbnailImageUrl: string;
+    bannerImageUrl: string;
+    strategyDeckUrl: string;
+    tranches: TrancheData[];
+    totalValueLocked: {
+        total: string;
+        offchain: string;
+        plume: string;
+    };
+    loansUnderManagement: string;
+    yieldEarned: string;
+    poolCapacity: string;
+    poolCapacityPercentage: string;
+    activeLoans: string;
+    assetClass: string;
+    security: string[];
+    industryExposure: string;
+    poolApyStructure: 'Variable' | 'Fixed';
+    apyExpiryDate: number | null;
+    poolInvestmentTerm: string;
+    loanStructure: string;
+    loanFundsOriginated: string;
+    requestEpochsInAdvance: string;
+    isActive: boolean;
+}
+export interface PoolDelegateProfileAndHistory {
+    id: string;
+    delegateLendingHistory: number;
+    assetClasses: string;
+    otherKASUPools: {
+        id: string;
+        name: string;
+        isActive: boolean;
+        isOversubscribed: boolean;
+    }[];
+    totalLoanFundsOriginated: number;
+    totalLoansOriginated: number;
+    loansUnderManagement: number;
+    historicLossRate: number;
+}
+export interface PoolTranche {
+    id: string;
+    poolIdFK: string;
+    apy: string;
+    minimalDepositThreshold: string;
+    maximalDepositThreshold: string;
+}
+export interface RiskManagement {
+    id: string;
+    poolIdFK: string;
+    items: RiskManagementItem[];
+    riskPerformance: RiskPerformance;
+}
+export interface RiskManagementItem {
+    description: string;
+    name: string;
+    group: string;
+    tooltip: string;
+}
+export interface RiskPerformance {
+    id: string;
+    firstLossCapital: number;
+    poolLossRate: number;
+    independentRiskScore: number;
+    communityRating: number;
+}
+export interface TrancheData {
+    id: string;
+    minApy: string;
+    maxApy: string;
+    apy: string;
+    averageApy: string;
+    maximumDeposit: string;
+    minimumDeposit: string;
+    poolCapacity: string;
+    poolCapacityPercentage: string;
+    name: string;
+    interestRate: string;
+    fixedTermConfig: {
+        configId: string;
+        apy: string;
+        epochLockDuration: string;
+        epochInterestRate: string;
+        fixedTermDepositStatus: 'Everyone' | 'AllowlistedOnly';
+        fixedTermDepositAllowlist: {
+            isAllowlisted: boolean;
+            userId: string;
+        }[];
+    }[];
+}
+export interface FinancialReportingDocuments {
+    id: string;
+    poolIdFK: string;
+    documents: {
+        id: number;
+        date_created: string;
+        name: string;
+        description: string;
+        document: string;
+        version: number;
+        financialReportingDocumentsFK: string;
+    }[];
+}
+export interface PoolCreditMetrics {
+    id: string;
+    poolIdFK: string;
+    keyCreditMetrics: {
+        keyCreditMetric: KeyCreditMetricsDirectus;
+        mostRecentQuarter: number;
+        previousFiscalYear: number;
+        priorMonth: number;
+    }[];
+}
+export interface BadAndDoubtfulDebts {
+    id: string;
+    poolIdFK: string;
+    items: {
+        totalLifetimeAmount: number | null;
+        totalLifetimePercentage: number | null;
+        monthlyAverageAmount: number | null;
+        monthlyAveragePercentage: number | null;
+        currentAmount: number | null;
+        currentPercentage: number | null;
+        item: BadAndDoubtfulDebtsItems;
+    }[];
+}
+export interface PoolRepayment {
+    id: string;
+    poolIdFK: string;
+    currentTotalEndBorrowers: number;
+    repaymentsFileUrl: string;
+    upcomingLendingFundsFlow: {
+        tooltip: string;
+        name: string;
+        value: number;
+    }[];
+    cumulativeLendingFundsFlow: {
+        tooltip: string;
+        name: string;
+        value: number;
+    }[];
+    cumulativeLendingAndWithdrawals: {
+        tooltip: string;
+        name: string;
+        value: number;
+    }[];
+    lendingAndWithdrawalRequests: {
+        tooltip: string;
+        name: string;
+        value: number;
+    }[];
+}
+export interface LendingTotals {
+    totalValueLocked: number;
+    loansUnderManagement: number;
+    totalLoanFundsOriginated: number;
+    totalYieldEarned: number;
+    totalLossRate: number;
+}

package/dist/services/DataService/types.js

@@ -0,0 +1 @@
+export {};

package/dist/services/Locking/locking.d.ts

@@ -0,0 +1,61 @@
+import { Provider } from '@ethersproject/providers';
+import { BigNumber, ContractTransaction, Signer } from 'ethers';
+import { SdkConfig } from '../../sdk-config';
+import { LockPeriod, LockPeriodInterface, RSVDeadlineValue, UserBonusData, UserLock } from './types';
+export declare class KSULocking {
+    private _kasuConfig;
+    private readonly _contractAbi;
+    private readonly _kasuToken;
+    private readonly _kasuBonusAddress;
+    private readonly _graph;
+    private readonly _userManagerAbi;
+    private readonly _systemVariablesAbi;
+    private readonly _ksuPriceAbi;
+    private readonly _userLoyaltyRewardsAbi;
+    private readonly apyBonuses;
+    /**
+     *
+     */
+    constructor(_kasuConfig: SdkConfig, signerOrProvider: Signer | Provider);
+    lockKSUTokens(amount: BigNumber, lockPeriod: BigNumber): Promise<ContractTransaction>;
+    lockKSUWithPermit(amount: number, lockPeriod: number, permit: RSVDeadlineValue): Promise<ContractTransaction>;
+    unlockKSU(amount: BigNumber, userLockId: BigNumber): Promise<ContractTransaction>;
+    claimFees(): Promise<ContractTransaction>;
+    lockDetails(lockPeriod: BigNumber): Promise<LockPeriodInterface>;
+    userTotalDeposits(userAddress: string): Promise<BigNumber>;
+    calculateUserLockProjectedProtocolFeeRewards(epochId: string, KSULocked: number, lockPeriod: BigNumber): Promise<number>;
+    calculateApy(epochInterestRate: number): number;
+    getUserLocks(userAddress: string): Promise<UserLock[]>;
+    getUserBonusData(userAddress: string): Promise<UserBonusData>;
+    getLoyaltyLevelAndApyBonusFromRatio(rKSUtoUSDCRatio: number): {
+        loyaltyLevel: number;
+        apyBonus: number;
+    };
+    getRKSUvsUSDCRatio(rKSUAmount: string, userAddress: string): Promise<number>;
+    getClaimableRewards(userAddress: string): Promise<BigNumber>;
+    getKasuTokenPrice(): Promise<{
+        price: BigNumber;
+        decimals: number;
+    }>;
+    getKasuEpochTokenPrice(): Promise<{
+        price: BigNumber;
+        decimals: number;
+    }>;
+    getLifetimeRewards(userAddress: string, rewardDecimals: number, claimableRewards?: BigNumber): Promise<BigNumber>;
+    getLaunchBonusAmount(lockAmount: BigNumber, bonusMultiplier: number, bonusTokensLeft: BigNumber): BigNumber;
+    getUserStakedKsu(userAddress: string): Promise<string>;
+    getUserEarnedrKsu(userAddress: string): Promise<string>;
+    getUserTotalBonusAmount(userAddress: string): Promise<string>;
+    getLockingRewards(userAddress: string): Promise<{
+        claimableRewards: string;
+        lifeTimeRewards: string;
+    }>;
+    getTotalKsuStaked(): Promise<string>;
+    getAvailableKsuBonus(): Promise<string>;
+    getUserKsuBalance(userAddress: string): Promise<string>;
+    getNextEpochDate(): Promise<EpochTimeStamp>;
+    getNextClearingPeriodDate(): Promise<EpochTimeStamp>;
+    getActiveLockPeriods(): Promise<LockPeriod[]>;
+    getProjectedApy(): string;
+    getProjectedUSDC(): string;
+}