@defisaver/sdk 1.2.15-dev-allocator-2 → 1.2.16-dev-liquity-v2-1

package/src/actions/liquityV2/LiquityV2AdjustAction.ts

@@ -0,0 +1,73 @@
+import { getAssetInfo } from '@defisaver/tokens';
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress, uint256, uint8 } from '../../types';
+
+/**
+ * LiquityV2AdjustAction - Adjusts a trove's collateral and/or debt
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2AdjustAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param from address from which to take the collateral or pay debt
+   * @param to address to which to send the collateral or borrowed debt
+   * @param troveId id of the trove being adjusted
+   * @param collAmount collateral amount to supply/withdraw
+   * @param debtAmount debt amount to borrow/payback
+   * @param maxUpfrontFee maximum upfront fee user is willing to pay
+   * @param collAction specify if collateral is supplied or withdrawn
+   * @param debtAction specify if debt is borrowed or paid back
+   */
+  constructor(
+    market: EthAddress,
+    from: EthAddress,
+    to: EthAddress,
+    troveId: uint256,
+    collAmount: uint256,
+    debtAmount: uint256,
+    maxUpfrontFee: uint256,
+    collAction: uint8,
+    debtAction: uint8,
+  ) {
+    super(
+      'LiquityV2Adjust',
+      getAddr('LiquityV2Adjust'),
+      [
+        'address',
+        'address',
+        'address',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint8',
+        'uint8',
+      ],
+      [
+        market,
+        from,
+        to,
+        troveId,
+        collAmount,
+        debtAmount,
+        maxUpfrontFee,
+        collAction,
+        debtAction,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+      this.args[2],
+      this.args[3],
+      this.args[4],
+      this.args[5],
+      this.args[6],
+      this.args[7],
+      this.args[8],
+    ];
+  }
+}

package/src/actions/liquityV2/LiquityV2AdjustInterestRateAction.ts

@@ -0,0 +1,57 @@
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress, uint256 } from '../../types';
+
+/**
+ * LiquityV2AdjustInterestRateAction - Adjusts the interest rate for a specific trove
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2AdjustInterestRateAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param troveId id of the trove to adjust the interest rate for
+   * @param newAnnualInterestRate the new annual interest rate
+   * @param upperHint upper hint for trove positioning
+   * @param lowerHint lower hint for trove positioning
+   * @param maxUpfrontFee maximum upfront fee the user is willing to pay
+   */
+  constructor(
+    market: EthAddress,
+    troveId: uint256,
+    newAnnualInterestRate: uint256,
+    upperHint: uint256,
+    lowerHint: uint256,
+    maxUpfrontFee: uint256,
+  ) {
+    super(
+      'LiquityV2AdjustInterestRate',
+      getAddr('LiquityV2AdjustInterestRate'),
+      [
+        'address',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+      ],
+      [
+        market,
+        troveId,
+        newAnnualInterestRate,
+        upperHint,
+        lowerHint,
+        maxUpfrontFee,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+      this.args[2],
+      this.args[3],
+      this.args[4],
+      this.args[5],
+    ];
+  }
+}

package/src/actions/liquityV2/LiquityV2AdjustZombieTroveAction.ts

@@ -0,0 +1,82 @@
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress, uint256, uint8 } from '../../types';
+
+/**
+ * LiquityV2AdjustZombieTroveAction - Adjusts a trove's collateral and/or debt for a zombie trove
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2AdjustZombieTroveAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param from address from which to take the collateral or pay debt
+   * @param to address to which to send the collateral or borrowed debt
+   * @param troveId id of the trove being adjusted
+   * @param collAmount collateral amount to supply/withdraw
+   * @param debtAmount debt amount to borrow/payback
+   * @param upperHint upper hint for the trove insertion
+   * @param lowerHint lower hint for the trove insertion
+   * @param maxUpfrontFee maximum upfront fee user is willing to pay
+   * @param collAction specify if collateral is supplied or withdrawn
+   * @param debtAction specify if debt is borrowed or paid back
+   */
+  constructor(
+    market: EthAddress,
+    from: EthAddress,
+    to: EthAddress,
+    troveId: uint256,
+    collAmount: uint256,
+    debtAmount: uint256,
+    upperHint: uint256,
+    lowerHint: uint256,
+    maxUpfrontFee: uint256,
+    collAction: uint8,
+    debtAction: uint8,
+  ) {
+    super(
+      'LiquityV2AdjustZombieTrove',
+      getAddr('LiquityV2AdjustZombieTrove'),
+      [
+        'address',
+        'address',
+        'address',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint8',
+        'uint8',
+      ],
+      [
+        market,
+        from,
+        to,
+        troveId,
+        collAmount,
+        debtAmount,
+        upperHint,
+        lowerHint,
+        maxUpfrontFee,
+        collAction,
+        debtAction,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+      this.args[2],
+      this.args[3],
+      this.args[4],
+      this.args[5],
+      this.args[6],
+      this.args[7],
+      this.args[8],
+      this.args[9],
+      this.args[10],
+    ];
+  }
+}

package/src/actions/liquityV2/LiquityV2BorrowAction.ts

@@ -0,0 +1,52 @@
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress, uint256 } from '../../types';
+
+/**
+ * LiquityV2BorrowAction - Borrows BOLD from a trove
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2BorrowAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param to address to which to send the borrowed BOLD
+   * @param troveId id of the trove to borrow from
+   * @param amount BOLD amount to borrow
+   * @param maxUpfrontFee maximum upfront fee user is willing to pay
+   */
+  constructor(
+    market: EthAddress,
+    to: EthAddress,
+    troveId: uint256,
+    amount: uint256,
+    maxUpfrontFee: uint256,
+  ) {
+    super(
+      'LiquityV2Borrow',
+      getAddr('LiquityV2Borrow'),
+      [
+        'address',
+        'address',
+        'uint256',
+        'uint256',
+        'uint256',
+      ],
+      [
+        market,
+        to,
+        troveId,
+        amount,
+        maxUpfrontFee,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+      this.args[2],
+      this.args[3],
+      this.args[4],
+    ];
+  }
+}

package/src/actions/liquityV2/LiquityV2ClaimAction.ts

@@ -0,0 +1,37 @@
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress } from '../../types';
+
+/**
+ * LiquityV2ClaimAction - Claims collateral left from liquidation from a trove
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2ClaimAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param to address to which to send the claimed collateral
+   */
+  constructor(
+    market: EthAddress,
+    to: EthAddress,
+  ) {
+    super(
+      'LiquityV2Claim',
+      getAddr('LiquityV2Claim'),
+      [
+        'address',
+        'address',
+      ],
+      [
+        market,
+        to,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+    ];
+  }
+}

package/src/actions/liquityV2/LiquityV2CloseAction.ts

@@ -0,0 +1,53 @@
+import { getAssetInfo } from '@defisaver/tokens';
+import { Action } from '../../Action';
+import { requireAddress } from '../../utils/general';
+import { getAddr } from '../../addresses';
+import { EthAddress } from '../../types';
+
+/**
+ * LiquityV2CloseAction - Closes trove
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2CloseAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param from address from which to take the BOLD
+   * @param to address to which to send the collateralToken and WETH gas compensation
+   * @param troveId id of the trove to close
+   */
+  constructor(
+    market: EthAddress,
+    from: EthAddress,
+    to: EthAddress,
+    troveId: string,
+  ) {
+    super(
+      'LiquityV2Close',
+      getAddr('LiquityV2Close'),
+      [
+        'address',
+        'address',
+        'address',
+        'uint256',
+      ],
+      [
+        market,
+        from,
+        to,
+        troveId,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+      this.args[2],
+      this.args[3],
+    ];
+  }
+
+  async getAssetsToApprove() {
+    return [{ asset: getAssetInfo('BOLD').address, owner: this.args[1] }];
+  }
+}

package/src/actions/liquityV2/LiquityV2OpenAction.ts

@@ -0,0 +1,101 @@
+import { getAssetInfo } from '@defisaver/tokens';
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress, uint256 } from '../../types';
+
+
+/**
+ * LiquityV2OpenAction - Opens up a trove
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2OpenAction extends Action {
+  tokenForApproval: EthAddress;
+
+  /**
+   * @param market liquity address registry for the market
+   * @param from address from which to take the collateralToken and WETH gas compensation
+   * @param to address to which to send the borrowed BOLD
+   * @param collToken address of the collateral token
+   * @param interestBatchManager address of the interest batch manager, or address(0) if this trove will not be part of a batch
+   * @param ownerIndex owner index of the trove
+   * @param collAmount collateral amount
+   * @param boldAmount borrowed BOLD amount
+   * @param upperHint upper hint for the trove insertion
+   * @param lowerHint lower hint for the trove insertion
+   * @param annualInterestRate annual interest rate for the trove or 0 if trove will be part of a batch
+   * @param maxUpfrontFee maximum upfront fee user is willing to pay
+   */
+  constructor(
+    market: EthAddress,
+    from: EthAddress,
+    to: EthAddress,
+    collToken: EthAddress,
+    interestBatchManager: EthAddress,
+    ownerIndex: uint256,
+    collAmount: uint256,
+    boldAmount: uint256,
+    upperHint: uint256,
+    lowerHint: uint256,
+    annualInterestRate: uint256,
+    maxUpfrontFee: uint256,
+  ) {
+    super(
+      'LiquityV2Open',
+      getAddr('LiquityV2Open'),
+      [
+        'address',
+        'address',
+        'address',
+        'address',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+        'uint256',
+      ],
+      [
+        market,
+        from,
+        to,
+        interestBatchManager,
+        ownerIndex,
+        collAmount,
+        boldAmount,
+        upperHint,
+        lowerHint,
+        annualInterestRate,
+        maxUpfrontFee,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+      this.args[2],
+      this.args[3],
+      this.args[4],
+      this.args[5],
+      this.args[6],
+      this.args[7],
+      this.args[8],
+      this.args[9],
+      this.args[10],
+    ];
+
+    this.tokenForApproval = collToken;
+  }
+
+  async getAssetsToApprove() {
+    const wethToken = getAssetInfo('WETH').address;
+    if (this.tokenForApproval.toLocaleLowerCase() === wethToken.toLocaleLowerCase()) {
+      return [{ asset: wethToken, owner: this.args[1] }];
+    }
+    return [
+      { asset: wethToken, owner: this.args[1] },
+      { asset: this.tokenForApproval, owner: this.args[1] },
+    ];
+  }
+}

package/src/actions/liquityV2/LiquityV2PaybackAction.ts

@@ -0,0 +1,52 @@
+import { getAssetInfo } from '@defisaver/tokens';
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress, uint256 } from '../../types';
+
+/**
+ * LiquityV2PaybackAction - Pays back BOLD to a trove
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2PaybackAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param from address from which to take the BOLD for payback
+   * @param troveId id of the trove to pay back to
+   * @param amount BOLD amount to pay back
+   */
+  constructor(
+    market: EthAddress,
+    from: EthAddress,
+    troveId: uint256,
+    amount: uint256,
+  ) {
+    super(
+      'LiquityV2Payback',
+      getAddr('LiquityV2Payback'),
+      [
+        'address',
+        'address',
+        'uint256',
+        'uint256',
+      ],
+      [
+        market,
+        from,
+        troveId,
+        amount,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+      this.args[2],
+      this.args[3],
+    ];
+  }
+
+  async getAssetsToApprove() {
+    return [{ asset: getAssetInfo('BOLD').address, owner: this.args[1] }];
+  }
+}

package/src/actions/liquityV2/LiquityV2SPClaimCollAction.ts

@@ -0,0 +1,37 @@
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress } from '../../types';
+
+/**
+ * LiquityV2SPClaimCollAction - Claims remaining collateral gains for a user with no deposit
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2SPClaimCollAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param to address to which to send the claimed collateral gains
+   */
+  constructor(
+    market: EthAddress,
+    to: EthAddress,
+  ) {
+    super(
+      'LiquityV2SPClaimColl',
+      getAddr('LiquityV2SPClaimColl'),
+      [
+        'address',
+        'address',
+      ],
+      [
+        market,
+        to,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+    ];
+  }
+}

package/src/actions/liquityV2/LiquityV2SPDepositAction.ts

@@ -0,0 +1,62 @@
+import { getAssetInfo } from '@defisaver/tokens';
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress, uint256 } from '../../types';
+
+/**
+ * LiquityV2SPDepositAction - Deposits into the Stability Pool (SP) and optionally claims gains
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2SPDepositAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param from address from which to take the deposited BOLD
+   * @param boldGainTo address to send any claimed BOLD gains
+   * @param collGainTo address to send any claimed collateral gains
+   * @param amount BOLD amount to deposit into the Stability Pool
+   * @param doClaim whether to claim BOLD and collateral gains before depositing
+   */
+  constructor(
+    market: EthAddress,
+    from: EthAddress,
+    boldGainTo: EthAddress,
+    collGainTo: EthAddress,
+    amount: uint256,
+    doClaim: boolean,
+  ) {
+    super(
+      'LiquityV2SPDeposit',
+      getAddr('LiquityV2SPDeposit'),
+      [
+        'address',
+        'address',
+        'address',
+        'address',
+        'uint256',
+        'bool',
+      ],
+      [
+        market,
+        from,
+        boldGainTo,
+        collGainTo,
+        amount,
+        doClaim,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+      this.args[2],
+      this.args[3],
+      this.args[4],
+      this.args[5],
+    ];
+  }
+
+  async getAssetsToApprove() {
+    return [{ asset: getAssetInfo('BOLD').address, owner: this.args[1] }];
+  }
+}

package/src/actions/liquityV2/LiquityV2SPWithdrawAction.ts

@@ -0,0 +1,52 @@
+import { Action } from '../../Action';
+import { getAddr } from '../../addresses';
+import { EthAddress, uint256 } from '../../types';
+
+/**
+ * LiquityV2SPWithdrawAction - Withdraws from the Stability Pool (SP) and optionally claims gains
+ *
+ * @category LiquityV2
+ */
+export class LiquityV2SPWithdrawAction extends Action {
+  /**
+   * @param market liquity address registry for the market
+   * @param boldTo address to send any withdrawn BOLD
+   * @param collGainTo address to send any claimed collateral gains
+   * @param amount BOLD amount to withdraw from the Stability Pool
+   * @param doClaim whether to claim BOLD and collateral gains before withdrawing
+   */
+  constructor(
+    market: EthAddress,
+    boldTo: EthAddress,
+    collGainTo: EthAddress,
+    amount: uint256,
+    doClaim: boolean,
+  ) {
+    super(
+      'LiquityV2SPWithdraw',
+      getAddr('LiquityV2SPWithdraw'),
+      [
+        'address',
+        'address',
+        'address',
+        'uint256',
+        'bool',
+      ],
+      [
+        market,
+        boldTo,
+        collGainTo,
+        amount,
+        doClaim,
+      ],
+    );
+
+    this.mappableArgs = [
+      this.args[0],
+      this.args[1],
+      this.args[2],
+      this.args[3],
+      this.args[4],
+    ];
+  }
+}