@aurigami/sdk 1.6.0-no-src → 1.6.1

package/src/types/index.ts

@@ -0,0 +1,106 @@
+import type { BigNumber, providers, Signer } from 'ethers';
+import { TokenAmount } from '../entities/tokenAmount';
+
+export enum ComptrollerRewardType {
+  PLY = 0,
+  AURORA,
+}
+export type NetworkConnection = {
+  provider: providers.Provider;
+  signer?: Signer;
+};
+
+export type Address = string;
+
+export type CurrencyAmount = {
+  currency: string;
+  amount: string;
+};
+
+export type TokenValuation = {
+  tokenAmount: TokenAmount;
+  currencyAmount: CurrencyAmount;
+};
+
+export type MoneyMarketDetails = {
+  auTokenAddress: string;
+  totalTokenDeposited: TokenAmount;
+  totalTokenBorrowed: TokenAmount;
+  depositApy: number;
+  depositPlyApy: number;
+  borrowApy: number;
+  borrowPlyApy: number;
+  collateralRatio: number;
+  depositPlyPerWeek: TokenAmount;
+  borrowPlyPerWeek: TokenAmount;
+  depositMETAApy: number;
+  depositNEARApy: number;
+  borrowNEARApy: number;
+};
+
+export type UserDetails = {
+  markets: UserMarketDetails[];
+  borrowLimit: CurrencyAmount;
+  userLockingDetails: UserLockingDetails;
+  borrowableAmount: CurrencyAmount;
+};
+
+export type UserLockingDetails = {
+  vestingStart: number;
+  /** % of reward they will receive in PLY, if they claim this week */
+  currentUnlockPortion: number;
+  //** Amount of PLY rewards that a user has. Equal to currentPly + currentPulp */
+  accruedPly: TokenAmount;
+  /** Amount of PLY they will receive, if they claim this week */
+  currentPly: TokenAmount;
+  /** Amount of PULP they will receive, if they claim this week */
+  currentPulp: TokenAmount;
+  /** % of reward they will receive in PLY, if they claim next week */
+  nextUnlockPortion: number;
+  /**
+   * Amount of PLY they will receive, if they claim next week.
+   * This doesn't include the additional reward that they will earn
+   * in the next week.
+   */
+  nextPly: TokenAmount;
+  /**
+   * Amount of PULP they will receive, if they claim next week.
+   * This doesn't include the additional reward that they will earn
+   * in the next week.
+   */
+  nextPulp: TokenAmount;
+};
+
+export type UserMarketDetails = {
+  market: string;
+  depositBalance: TokenAmount;
+  borrowBalance: TokenAmount;
+  isCollateral: boolean;
+  maxWithdrawableAmount: TokenAmount;
+  collateralRatio: number;
+  underlyingPrice: string;
+};
+
+export type TokenAPY = {
+  address: string;
+  apy: string;
+};
+
+export type PLYWNEARPoolDetails = {
+  totalStakedLiquidity: TokenAmount;
+  APYs: TokenAPY[];
+};
+
+export enum MarketAction {
+  Deposit = 0,
+  Borrow,
+  Withdraw,
+  Repay,
+  EnableCollateral,
+  DisableCollateral,
+}
+
+export type HypotheticalStats = {
+  newBorrowLimit: CurrencyAmount;
+  newBorrowUtilization: number;
+};