@augustdigital/pools
Version:
JS SDK for web3 interactions with the August Digital Lending Pools
56 lines (55 loc) • 2.83 kB
TypeScript
import { AugustBase, IAugustBase } from '@augustdigital/utils';
import type { IAddress, IChainId, IPoolHistoricalParams, IPoolWithUnderlying } from '@augustdigital/types';
import { Signer } from 'ethers';
interface IPoolOptions {
loans: boolean;
allocations: boolean;
}
export declare class AugustPools extends AugustBase {
constructor(baseConfig: IAugustBase);
getPools(options?: IPoolOptions, initialData?: IPoolWithUnderlying[]): Promise<IPoolWithUnderlying[]>;
getPool(pool: IAddress | IPoolWithUnderlying, chainId?: IChainId, options?: IPoolOptions): Promise<IPoolWithUnderlying>;
getPoolApr(pool: IAddress, chainId?: IChainId, optionalParams?: IPoolHistoricalParams): Promise<any[] | {
timestamp: number;
value: number;
}>;
getPoolTvl(pool: IAddress, chainId?: IChainId, optionalParams?: IPoolHistoricalParams): Promise<{
value: import("@augustdigital/types").INormalizedNumber;
timestamp: number;
}[]>;
getAvailableRedemptions(pool: IAddress, options?: {
address?: IAddress;
chainId?: IChainId;
}): Promise<void>;
getAllPositions(address: IAddress, chainId?: IChainId, pools?: IPoolWithUnderlying[]): Promise<import("@augustdigital/types").IPoolWithPositions[]>;
getPoolLoans(pool: IPoolWithUnderlying | IAddress, chainId?: IChainId): Promise<{
apy: number;
collateral: IAddress[];
loans: import("@augustdigital/types").IPoolLoan[];
protocolExposure: import("@augustdigital/types").IDebankProtocolExposure[];
tokenExposure: import("@augustdigital/types").IDebankTokenExposure[];
cefiExposure: import("@augustdigital/types").IWSSubaccountCefi[];
debankBorrowerResponses?: Record<string, any>;
otcPositions?: Record<string, import("@augustdigital/types").IOTCPosition>;
vaultsSubAccWhitelist?: IAddress[];
}>;
getManagementFee(pool: IAddress, chainId: number): Promise<number>;
getStakingPositions(wallet?: IAddress, chainId?: IChainId): Promise<import("@augustdigital/types").IActiveStakingPosition[]>;
getPoolsBorrowerHealthFactor(chainId?: IChainId): Promise<{}>;
allowance(pool: IAddress, signer: Signer): Promise<import("@augustdigital/types").INormalizedNumber>;
approve(pool: IAddress, signer: Signer, inputParams: {
amount: string | number | bigint;
}): Promise<string>;
deposit(pool: IAddress, signer: Signer, inputParams: {
amount: string | number | bigint;
}): Promise<string>;
requestWithdrawal(pool: IAddress, signer: Signer): Promise<string>;
withdraw(pool: IAddress, signer: Signer, inputParams: {
amount: string | bigint | number;
day: string;
month: string;
year: string;
receiverIndex: string;
}): Promise<string>;
}
export {};