@defisaver/positions-sdk 0.0.3 → 0.0.5

package/src/config/contracts.js

@@ -584,12 +584,18 @@ module.exports = {
     }
   },
   "ChickenBondsView": {
-    "abi": [{"inputs":[{"internalType":"uint256","name":"_bondID","type":"uint256"}],"name":"getBondFullInfo","outputs":[{"components":[{"internalType":"uint256","name":"bondID","type":"uint256"},{"internalType":"uint256","name":"lusdAmount","type":"uint256"},{"internalType":"uint64","name":"claimedBLUSD","type":"uint64"},{"internalType":"uint256","name":"accruedBLUSD","type":"uint256"},{"internalType":"uint256","name":"maxAmountBLUSD","type":"uint256"},{"internalType":"uint64","name":"startTime","type":"uint64"},{"internalType":"uint64","name":"endTime","type":"uint64"},{"internalType":"enum IChickenBondManager.BondStatus","name":"status","type":"uint8"},{"internalType":"string","name":"tokenURI","type":"string"}],"internalType":"struct ChickenBondsView.BondDataFull","name":"bond","type":"tuple"}],"stateMutability":"view","type":"function"}],
+    "abi": [{"inputs":[],"name":"BorrowerOperations","outputs":[{"internalType":"contract IBorrowerOperations","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"CBManager","outputs":[{"internalType":"contract IChickenBondManager","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"CollSurplusPool","outputs":[{"internalType":"contract ICollSurplusPool","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"HintHelpers","outputs":[{"internalType":"contract IHintHelpers","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"LQTYStaking","outputs":[{"internalType":"contract ILQTYStaking","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"LUSD_GAS_COMPENSATION","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"PriceFeed","outputs":[{"internalType":"contract IPriceFeed","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"SortedTroves","outputs":[{"internalType":"contract ISortedTroves","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"StabilityPool","outputs":[{"internalType":"contract IStabilityPool","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"TroveManager","outputs":[{"internalType":"contract ITroveManager","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_bondID","type":"uint256"}],"name":"getBondFullInfo","outputs":[{"components":[{"internalType":"uint256","name":"bondID","type":"uint256"},{"internalType":"uint256","name":"lusdAmount","type":"uint256"},{"internalType":"uint64","name":"claimedBLUSD","type":"uint64"},{"internalType":"uint256","name":"accruedBLUSD","type":"uint256"},{"internalType":"uint256","name":"maxAmountBLUSD","type":"uint256"},{"internalType":"uint64","name":"startTime","type":"uint64"},{"internalType":"uint64","name":"endTime","type":"uint64"},{"internalType":"enum IChickenBondManager.BondStatus","name":"status","type":"uint8"},{"internalType":"string","name":"tokenURI","type":"string"}],"internalType":"struct ChickenBondsView.BondDataFull","name":"bond","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getSystemInfo","outputs":[{"components":[{"internalType":"uint256","name":"totalPendingLUSD","type":"uint256"},{"internalType":"uint256","name":"totalReserveLUSD","type":"uint256"},{"internalType":"uint256","name":"totalPermanentLUSD","type":"uint256"},{"internalType":"uint256","name":"ownedLUSDInSP","type":"uint256"},{"internalType":"uint256","name":"ownedLUSDInCurve","type":"uint256"},{"internalType":"uint256","name":"systemBackingRatio","type":"uint256"},{"internalType":"uint256","name":"accrualParameter","type":"uint256"},{"internalType":"uint256","name":"chickenInAMMFee","type":"uint256"},{"internalType":"uint256","name":"numPendingBonds","type":"uint256"},{"internalType":"uint256","name":"numChickenInBonds","type":"uint256"},{"internalType":"uint256","name":"numChickenOutBonds","type":"uint256"},{"internalType":"uint256","name":"bLUSDSupply","type":"uint256"}],"internalType":"struct ChickenBondsView.ChickenBondsSystemInfo","name":"systemInfo","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_userAddr","type":"address"}],"name":"getUsersBonds","outputs":[{"components":[{"internalType":"uint256","name":"bondID","type":"uint256"},{"internalType":"uint256","name":"lusdAmount","type":"uint256"},{"internalType":"uint64","name":"claimedBLUSD","type":"uint64"},{"internalType":"uint256","name":"accruedBLUSD","type":"uint256"},{"internalType":"uint256","name":"maxAmountBLUSD","type":"uint256"},{"internalType":"uint64","name":"startTime","type":"uint64"},{"internalType":"uint64","name":"endTime","type":"uint64"},{"internalType":"enum IChickenBondManager.BondStatus","name":"status","type":"uint8"},{"internalType":"string","name":"tokenURI","type":"string"}],"internalType":"struct ChickenBondsView.BondDataFull[]","name":"bonds","type":"tuple[]"}],"stateMutability":"view","type":"function"}],
     "networks": {
-      "1": {
+      "1": { 
         "address": "0x809a93fd4a0d7d7906Ef6176f0b5518b418Da08f",
         "createdBlock": 15739450
       }
     }
+  },
+  "ChickenBondsManager": {
+    "abi": [{"inputs":[{"internalType":"uint256","name":"_bondID","type":"uint256"}],"name":"chickenIn","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_bondID","type":"uint256"},{"internalType":"uint256","name":"_minLUSD","type":"uint256"}],"name":"chickenOut","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_lusdAmount","type":"uint256"}],"name":"createBond","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"getAcquiredLUSDInCurve","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"getAcquiredLUSDInSP","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_bLUSDToRedeem","type":"uint256"},{"internalType":"uint256","name":"_minLUSDFromBAMMSPVault","type":"uint256"}],"name":"redeem","outputs":[{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"totalWeightedStartTimes","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"yTokensHeldByCBM","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}],
+    "networks": {
+      "1": { "address": "0x57619FE9C539f890b19c61812226F9703ce37137" }
+    }
   }
 }

package/src/contracts.ts

@@ -92,4 +92,6 @@ export const McdSpotterContract = createContractFromConfigFunc<ContractTypes.Mcd
 export const McdDogContract = createContractFromConfigFunc<ContractTypes.McdDog>('McdDog');
 export const McdJugContract = createContractFromConfigFunc<ContractTypes.McdJug>('McdJug');
 export const McdVatContract = createContractFromConfigFunc<ContractTypes.McdVat>('McdVat');
-export const ChickenBondsViewContract = createContractFromConfigFunc<ContractTypes.ChickenBondsView>('ChickenBondsView');
+
+export const ChickenBondsViewContract = createContractFromConfigFunc<ContractTypes.ChickenBondsView>('ChickenBondsView');
+export const ChickenBondsManagerContract = createContractFromConfigFunc<ContractTypes.ChickenBondsManager>('ChickenBondsManager');

package/src/helpers/chickenBondsHelpers/index.ts

@@ -0,0 +1,13 @@
+import Dec from 'decimal.js';
+
+export const calcCBondsBLUSDFloorPrice = (bLUSDSupply: string, totalReserveLUSD: string) => {
+  if (new Dec(bLUSDSupply).eq(0)) return '1';
+  return new Dec(totalReserveLUSD).div(bLUSDSupply).toString();
+};
+
+export const calcAverageBondAgeMs = (totalWeightedStartTimes: string, totalPendingLusd: string) => {
+  const averageStartTimeMs = new Dec(totalWeightedStartTimes).div(totalPendingLusd).round().mul(1000)
+    .toNumber();
+
+  return Date.now() - averageStartTimeMs;
+};

package/src/helpers/index.ts

@@ -2,4 +2,5 @@ export * as aaveHelpers from './aaveHelpers';
 export * as compoundHelpers from './compoundHelpers';
 export * as sparkHelpers from './sparkHelpers';
 export * as curveUsdHelpers from './curveUsdHelpers';
-export * as makerHelpers from './makerHelpers';
+export * as makerHelpers from './makerHelpers';
+export * as chickenBondsHelpers from './chickenBondsHelpers';

package/src/staking/staking.ts

@@ -1,7 +1,7 @@
 import Dec from 'decimal.js';
 import Web3 from 'web3';
 import {
-  CbEthContract, LidoContract, REthContract, wstETHContract,
+  CbEthContract, LidoContract, PotContract, REthContract, wstETHContract,
 } from '../contracts';
 import { MMAssetsData, MMUsedAssets, NetworkNumber } from '../types/common';
 import { ContractEventLog } from '../types/contracts/generated/types';
@@ -66,10 +66,21 @@ export const getREthApr = async (web3: Web3, blockNumber: 'latest' | number = 'l
   return apr;
 };
 
+export const getDsrApy = async (web3: Web3, blockNumber: 'latest' | number = 'latest') => {
+  const potContract = PotContract(web3, NetworkNumber.Eth);
+  return new Dec(await potContract.methods.dsr().call())
+      .div(new Dec(1e27))
+      .pow(SECONDS_PER_YEAR)
+      .sub(1)
+      .mul(100)
+      .toString();
+};
+
 export const getStakingApy = (asset: string, web3: Web3, blockNumber: 'latest' | number = 'latest', fromBlock: number | undefined = undefined) => {
   if (asset === 'stETH' || asset === 'wstETH') return getStETHApr(web3, fromBlock, blockNumber);
   if (asset === 'cbETH') return getCbETHApr(web3, blockNumber);
   if (asset === 'rETH') return getREthApr(web3, blockNumber);
+  if (asset === 'sDAI') return getDsrApy(web3);
 };
 
 export const calculateInterestEarned = (principal: string, interest: string, type: string, apy = false) => {

package/src/types/chickenBonds.ts

@@ -0,0 +1,45 @@
+export type ChickenBondsSystemInfoStructOutputStruct = {
+  totalPendingLUSD: string;
+  totalReserveLUSD: string;
+  totalPermanentLUSD: string;
+  ownedLUSDInSP: string;
+  ownedLUSDInCurve: string;
+  systemBackingRatio: string;
+  accrualParameter: string;
+  chickenInAMMFee: string;
+  numPendingBonds: string;
+  numChickenInBonds: string;
+  numChickenOutBonds: string;
+  bLUSDSupply: string;
+};
+
+export interface ChickenBondsSystemInfoBasic extends ChickenBondsSystemInfoStructOutputStruct {
+  totalWeightedStartTimes: string
+  targetAverageAgeMs: number
+  acquiredLUSDInSP: string
+  acquiredLUSDInCurve: string
+  yTokensHeldByCBM: string
+  floorPrice: string
+  averageBondAgeMs: number
+}
+
+export interface BondInfoBasic {
+  bondId: string,
+  status: string,
+  startTime: Date,
+  endTime: Date,
+  accruedBLUSD: string,
+  claimedBLUSD: string,
+  lusdAmount: string,
+  maxAmountBLUSD: string,
+}
+
+export enum BondStatus {
+  // Order [0, 3] is set on contract
+  Nonexistent = '0',
+  Active = '1',
+  ChickenedOut = '2',
+  ChickenedIn = '3',
+  BrokeEven = '4',
+  Rebondable = '5',
+}

package/src/types/contracts/generated/ChickenBondsManager.ts

@@ -0,0 +1,59 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+
+import type BN from "bn.js";
+import type { ContractOptions } from "web3-eth-contract";
+import type { EventLog } from "web3-core";
+import type { EventEmitter } from "events";
+import type {
+  Callback,
+  PayableTransactionObject,
+  NonPayableTransactionObject,
+  BlockType,
+  ContractEventLog,
+  BaseContract,
+} from "./types";
+
+export interface EventOptions {
+  filter?: object;
+  fromBlock?: BlockType;
+  topics?: string[];
+}
+
+export interface ChickenBondsManager extends BaseContract {
+  constructor(
+    jsonInterface: any[],
+    address?: string,
+    options?: ContractOptions
+  ): ChickenBondsManager;
+  clone(): ChickenBondsManager;
+  methods: {
+    chickenIn(_bondID: number | string | BN): NonPayableTransactionObject<void>;
+
+    chickenOut(
+      _bondID: number | string | BN,
+      _minLUSD: number | string | BN
+    ): NonPayableTransactionObject<void>;
+
+    createBond(
+      _lusdAmount: number | string | BN
+    ): NonPayableTransactionObject<string>;
+
+    getAcquiredLUSDInCurve(): NonPayableTransactionObject<string>;
+
+    getAcquiredLUSDInSP(): NonPayableTransactionObject<string>;
+
+    redeem(
+      _bLUSDToRedeem: number | string | BN,
+      _minLUSDFromBAMMSPVault: number | string | BN
+    ): NonPayableTransactionObject<[string, string]>;
+
+    totalWeightedStartTimes(): NonPayableTransactionObject<string>;
+
+    yTokensHeldByCBM(): NonPayableTransactionObject<string>;
+  };
+  events: {
+    allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
+  };
+}

package/src/types/contracts/generated/ChickenBondsView.ts

@@ -70,6 +70,68 @@ export declare namespace ChickenBondsView {
   };
   export type BondDataFullStructOutput = BondDataFullStructOutputArray &
     BondDataFullStructOutputStruct;
+
+  export type ChickenBondsSystemInfoStruct =
+    | [
+        number | string | BN,
+        number | string | BN,
+        number | string | BN,
+        number | string | BN,
+        number | string | BN,
+        number | string | BN,
+        number | string | BN,
+        number | string | BN,
+        number | string | BN,
+        number | string | BN,
+        number | string | BN,
+        number | string | BN
+      ]
+    | {
+        totalPendingLUSD: number | string | BN;
+        totalReserveLUSD: number | string | BN;
+        totalPermanentLUSD: number | string | BN;
+        ownedLUSDInSP: number | string | BN;
+        ownedLUSDInCurve: number | string | BN;
+        systemBackingRatio: number | string | BN;
+        accrualParameter: number | string | BN;
+        chickenInAMMFee: number | string | BN;
+        numPendingBonds: number | string | BN;
+        numChickenInBonds: number | string | BN;
+        numChickenOutBonds: number | string | BN;
+        bLUSDSupply: number | string | BN;
+      };
+
+  export type ChickenBondsSystemInfoStructOutputArray = [
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    string,
+    string
+  ];
+  export type ChickenBondsSystemInfoStructOutputStruct = {
+    totalPendingLUSD: string;
+    totalReserveLUSD: string;
+    totalPermanentLUSD: string;
+    ownedLUSDInSP: string;
+    ownedLUSDInCurve: string;
+    systemBackingRatio: string;
+    accrualParameter: string;
+    chickenInAMMFee: string;
+    numPendingBonds: string;
+    numChickenInBonds: string;
+    numChickenOutBonds: string;
+    bLUSDSupply: string;
+  };
+  export type ChickenBondsSystemInfoStructOutput =
+    ChickenBondsSystemInfoStructOutputArray &
+      ChickenBondsSystemInfoStructOutputStruct;
 }
 
 export interface ChickenBondsView extends BaseContract {
@@ -80,9 +142,35 @@ export interface ChickenBondsView extends BaseContract {
   ): ChickenBondsView;
   clone(): ChickenBondsView;
   methods: {
+    BorrowerOperations(): NonPayableTransactionObject<string>;
+
+    CBManager(): NonPayableTransactionObject<string>;
+
+    CollSurplusPool(): NonPayableTransactionObject<string>;
+
+    HintHelpers(): NonPayableTransactionObject<string>;
+
+    LQTYStaking(): NonPayableTransactionObject<string>;
+
+    LUSD_GAS_COMPENSATION(): NonPayableTransactionObject<string>;
+
+    PriceFeed(): NonPayableTransactionObject<string>;
+
+    SortedTroves(): NonPayableTransactionObject<string>;
+
+    StabilityPool(): NonPayableTransactionObject<string>;
+
+    TroveManager(): NonPayableTransactionObject<string>;
+
     getBondFullInfo(
       _bondID: number | string | BN
     ): NonPayableTransactionObject<ChickenBondsView.BondDataFullStructOutput>;
+
+    getSystemInfo(): NonPayableTransactionObject<ChickenBondsView.ChickenBondsSystemInfoStructOutput>;
+
+    getUsersBonds(
+      _userAddr: string
+    ): NonPayableTransactionObject<ChickenBondsView.BondDataFullStructOutput[]>;
   };
   events: {
     allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;

package/src/types/contracts/generated/index.ts

@@ -11,6 +11,7 @@ export type { AaveV3ProtocolDataProvider } from "./AaveV3ProtocolDataProvider";
 export type { AaveV3View } from "./AaveV3View";
 export type { BalanceScanner } from "./BalanceScanner";
 export type { CbEth } from "./CbEth";
+export type { ChickenBondsManager } from "./ChickenBondsManager";
 export type { ChickenBondsView } from "./ChickenBondsView";
 export type { CollSurplusPool } from "./CollSurplusPool";
 export type { CompV3ETHBulker } from "./CompV3ETHBulker";

package/src/types/index.ts

@@ -3,4 +3,5 @@ export * from './compound';
 export * from './spark';
 export * from './curveUsd';
 export * from './liquity';
-export * from './maker';
+export * from './maker';
+export * from './chickenBonds';