hedge-web3 0.2.3 → 0.2.9

package/src/state/VaultAccount.ts

@@ -20,13 +20,13 @@ export class VaultAccount {
   pdaSalt: string
 
   /** The deposited collateral of the vault (in SOL Lamports). */
-  deposited: number
+  deposited = new BN(0)
 
   /** The outstanding debt of the vault (in USH Lamports). Denormalized to time 0. */
-  denormalizedDebt: number
+  denormalizedDebt = new BN(0)
 
   /** The ordered number of when this vault was created. */
-  vaultNumber: number
+  vaultNumber = 0
 
   /** Debt redistribution snapshot */
   debtProductSnapshotBytes = new Decimal(0)
@@ -49,10 +49,14 @@ export class VaultAccount {
   constructor(vault: any, publicKey: PublicKey) {
     this.publicKey = publicKey
     this.vaultOwner = vault.vaultOwner
-    this.vaultNumber = vault.vaultNumber?.toNumber()
     this.pdaSalt = vault.pdaSalt
-    this.deposited = vault.deposited?.toNumber()
-    this.denormalizedDebt = vault.denormalizedDebt?.toNumber()
+    
+    this.deposited = vault.deposited
+    this.denormalizedDebt = vault.denormalizedDebt
+
+    if (vault.vaultNumber) {
+      this.vaultNumber = vault.vaultNumber.toNumber()
+    }
     if (vault.debtProductSnapshotBytes) {
       this.debtProductSnapshotBytes = DecimalFromU128(vault.debtProductSnapshotBytes.toString())
     }
@@ -78,14 +82,15 @@ export class VaultAccount {
     return publicKey && publicKey.toString() === this.vaultOwner.toString()
   }
 
-  /**
-   * Get the collateral value in SOL
-   *
-   * @returns collateral value in SOL
-   */
-  public inSol(): number {
-    return this.deposited / LAMPORTS_PER_SOL
-  }
+  // /**
+  //  * Get the collateral value in SOL
+  //  *
+  //  * @returns collateral value in SOL
+  //  */
+  // public inSol(): number {
+  // This should not be LAMPORTS_PER_SOL. Should be collateral units like Ray
+  //   return new Decimal(this.deposited.toString()).div(LAMPORTS_PER_SOL).toNumber()
+  // }
 
   /**
    * Get the debt value in USH
@@ -93,7 +98,7 @@ export class VaultAccount {
    * @returns debt value in USH
    */
   public inUsd(): number {
-    return this.denormalizedDebt / LAMPORTS_PER_SOL
+    return new Decimal(this.denormalizedDebt.toString()).div(LAMPORTS_PER_SOL).toNumber()
   }
 
   /**
@@ -107,42 +112,82 @@ export class VaultAccount {
       .substring(this.publicKey.toString().length - 6)}`
   }
 
-  public addDebt(additionalDebt: Decimal, vaultTypeAccount: VaultType) {
-    let loanFee = new Decimal(0)
-    if (additionalDebt.isPositive()){
-      loanFee = vaultTypeAccount.loanInitFee.mul(additionalDebt)
-    }
+  /**
+   * Add additional debt to the vault.
+   *
+   * @param {BN} additionalDebt - Additional normalized debt to add in (USH) lamports.
+   * @param {VaultType} vaultTypeAccount - Vault's vaultType
+   *
+   */
+  public addDebt(additionalDebt: BN, vaultTypeAccount: VaultType) {
+    const additionalDebtAsDecimal = new Decimal(additionalDebt.toString())
+    // Calculate the fee on the loan
+    const loanFee = vaultTypeAccount.loanInitFee.mul(additionalDebtAsDecimal)
+
+    // TODO: There's a chance this needs to be .Floor()
+    const totalNormalizedLoan = additionalDebtAsDecimal.add(loanFee)
+
+    const denormalizedNewDebt = new BN(totalNormalizedLoan.div(vaultTypeAccount.cumulativeRate).floor().toString())
+    this.denormalizedDebt = this.denormalizedDebt.add(denormalizedNewDebt)
+  }
+
+  /**
+   * Repay debt on a vault
+   *
+   * @param {BN} repayAmount - Normalized debt to repay in (USH) lamports.
+   * @param {VaultType} vaultTypeAccount - Vault's vaultType
+   *
+   */
+  public repayDebt(repayAmount: BN, vaultTypeAccount: VaultType) {
+    const denormalizedRepayment = new Decimal(repayAmount.toString()).div(vaultTypeAccount.cumulativeRate).floor()
 
-    const totalNormalizedLoan = additionalDebt.add(loanFee)
-    const denormalizedNewDebt = totalNormalizedLoan.div(new Decimal(vaultTypeAccount.cumulativeRate.toString()))
-    this.denormalizedDebt = denormalizedNewDebt.add(new Decimal(this.denormalizedDebt)).floor().toNumber()
+    this.denormalizedDebt = this.denormalizedDebt.sub(new BN(denormalizedRepayment.toString()))
   }
 
-  public addDeposit(depositAmount: number) {
-    this.deposited += depositAmount
+  /**
+   * Deposit Collateral
+   *
+   * @param {BN} depositAmount - Amount to deposit in (CollateralMint) lamports
+   *
+   */
+  public depositCollateral(depositAmount: BN) {
+    this.deposited = this.deposited.add(depositAmount)
+  }
+  /**
+   * Withdraw Collateral
+   *
+   * @param {BN} withdrawAmount - Amount to withdraw in (CollateralMint) lamports
+   *
+   */
+  public withdrawCollateral(withdrawAmount: BN) {
+    this.deposited = this.deposited.sub(withdrawAmount)
   }
 
   public redeem() {
     // TODO - Calculate actual redeem amount and adust correctly
-    this.denormalizedDebt = 0
+    this.denormalizedDebt = new BN(0)
     this.vaultStatus = 'initialized'
   }
   public liquidate() {
     // TODO - Calculate actual liquidate amount and adust correctly
-    this.denormalizedDebt = 0
+    this.denormalizedDebt = new BN(0)
     this.vaultStatus = 'liquidated'
   }
 
   public updateDebtAndCollateral(vaultTypeAccountData: VaultType) {
-
-    this.denormalizedDebt = vaultTypeAccountData.debtRedistributionProduct
+    this.denormalizedDebt = new BN(
+      vaultTypeAccountData.debtRedistributionProduct
       .div(this.debtProductSnapshotBytes)
-      .mul(new Decimal(this.denormalizedDebt))
-      .toNumber()
+      .mul(new Decimal(this.denormalizedDebt.toString()))
+      .floor()
+      .toString()
+    )
 
     const extraCollateralDeposited =
-      this.denormalizedDebt * vaultTypeAccountData.collateralRedistributionAccumulator.sub(this.collateralAccumulatorSnapshotBytes).toNumber()
-    this.deposited += extraCollateralDeposited
+      new Decimal(this.denormalizedDebt.toString()).mul(
+        vaultTypeAccountData.collateralRedistributionAccumulator.sub(this.collateralAccumulatorSnapshotBytes).toNumber()
+      ).floor()
+    this.deposited = this.deposited.add(new BN(extraCollateralDeposited.toString()))
 
     this.collateralAccumulatorSnapshotBytes = vaultTypeAccountData.collateralRedistributionAccumulator
     this.debtProductSnapshotBytes = vaultTypeAccountData.debtRedistributionProduct
@@ -154,8 +199,8 @@ export class VaultAccount {
       arrow = ' <----!!'
     }
     let collateralRatio = 'Infinite'
-    if (this.denormalizedDebt > 0) {
-      collateralRatio = new Decimal(this.deposited).div(new Decimal(this.denormalizedDebt)).toString()
+    if (this.denormalizedDebt.gt(new BN(0))) {
+      collateralRatio = new Decimal(this.deposited.toString()).div(new Decimal(this.denormalizedDebt.toString())).toString()
     }
 
     let nextVault = 'None'
@@ -163,9 +208,9 @@ export class VaultAccount {
       nextVault = this.nextVaultToRedeem.toString().substring(0, 6)
     }
 
-    return `Vault(${this.vaultNumber}): ${this.publicKey.toString().substring(0, 6)}. Debt: ${
-      this.denormalizedDebt
-    } Collat: ${this.deposited} Ratio: ${collateralRatio} ${arrow} `
+    return `${this.publicKey.toString().substring(0, 6)}. Debt: ${this.denormalizedDebt} Collat: ${
+      this.deposited
+    } Ratio: ${collateralRatio} ${arrow} `
   }
   /**
    * Creates a VaultAccount from a slice of data
@@ -180,7 +225,7 @@ export class VaultAccount {
    * @returns a new VaultAccount
    */
   static FromMiniSlice(data: Buffer, pubkey: PublicKey) {
-    const props = [borsh.u64('vaultNumber'), borsh.u64('deposited'), borsh.u64('denormalizedDebt')]
+    const props = [borsh.u64('deposited'), borsh.u64('denormalizedDebt')]
     const miniVaultLayout = borsh.struct(props, 'minVaultLayout')
     const decodedData: any = miniVaultLayout.decode(data)
 

package/src/utils/getLinkedListAccounts.ts

@@ -1,4 +1,4 @@
-import { Program, Provider } from '@project-serum/anchor'
+import { Program, Provider, BN } from '@project-serum/anchor'
 import { PublicKey, Signer } from '@solana/web3.js'
 import _ from 'underscore'
 import { getVaultSystemStatePublicKey, getVaultTypeOracleAccountPublicKey, HEDGE_PROGRAM_PUBLICKEY } from '../Constants'
@@ -12,13 +12,28 @@ import * as borsh from '@project-serum/borsh'
 import base58 from 'bs58'
 import VaultType from '../state/VaultType'
 
+/**
+ * Get the accounts the left and right for re-inserting in the linked list
+ *
+ * @param {Program<Vault>} program - Anchor program <Vault ILD>
+ * @param {PublicKey} vaultTypeAccountPublicKey - Vault Type Account PublicKey
+ * @param {PublicKey} vaultPublicKey - Vault Account PublicKey
+ * @param {BN} depositAmount - Amount that will be deposited into vault with instruction
+ * @param {BN} withdrawAmount - Amount that will be withdrawn from vault with instruction
+ * @param {BN} loanAmount - Amount that will be deposited into vault with transaction (sans fees)
+ * @param {BN} repayAmount - Amount that will be repaid into vault with transaction
+ * @param {boolean} redeem - True if vault is going to be redeemed fully
+ * @param {boolean} liquidate - True if vault is going to be liquidated fully
+ * @param {VaultAccount[]} cachedVaults - Optional list of cached vaults. Saves a request to the on-chain data.
+ */
 export async function getLinkedListAccounts(
   program: Program<Vault>,
-  provider: Provider,
   vaultTypeAccountPublicKey: PublicKey,
   vaultPublicKey: PublicKey,
-  depositAmount: number,
-  loanAmount: number,
+  depositAmount: BN,
+  withdrawAmount: BN,
+  loanAmount: BN,
+  repayAmount: BN,
   redeem: boolean,
   liquidate: boolean,
   cachedVaults?: VaultAccount[]
@@ -58,7 +73,7 @@ export async function getLinkedListAccounts(
 
   // Remove any vaults with no debt or collateral
   vaults = _.filter(vaults, (vault) => {
-    return vault.denormalizedDebt > 0 && vault.deposited > 0
+    return vault.denormalizedDebt.gt(new BN(0)) && vault.deposited.gt(new BN(0))
   })
 
   // Sort them
@@ -117,10 +132,13 @@ export async function getLinkedListAccounts(
 
   // Now that we know it's def in the list, iterate the list and update
   // this vault with the operation we're going to apply
-  const newNormalizedDebt = new Decimal(loanAmount)
   vaults[indexBefore].updateDebtAndCollateral(vaultType)
-  vaults[indexBefore].addDebt(newNormalizedDebt, vaultType)
-  vaults[indexBefore].addDeposit(depositAmount)
+
+  vaults[indexBefore].addDebt(loanAmount, vaultType)
+  vaults[indexBefore].repayDebt(repayAmount, vaultType)
+
+  vaults[indexBefore].depositCollateral(depositAmount)
+  vaults[indexBefore].withdrawCollateral(withdrawAmount)
 
   if (liquidate) {
     vaults[indexBefore].liquidate()
@@ -129,7 +147,7 @@ export async function getLinkedListAccounts(
     vaults[indexBefore].redeem()
   }
 
-  if (vaults[indexBefore].denormalizedDebt === 0) {
+  if (vaults[indexBefore].denormalizedDebt.isZero()) {
     vaults.splice(indexBefore, 1)
   }
 
@@ -180,12 +198,12 @@ export async function getLinkedListAccounts(
 // Sort function we can use to sort the vaults
 // Sorted by collateral ratio. If two are the same, newer vault first
 function sortVaults(a: VaultAccount, b: VaultAccount) {
-  const aRatio = a.deposited / a.denormalizedDebt
-  const bRatio = b.deposited / b.denormalizedDebt
-  if (aRatio === bRatio) {
-    return b.vaultNumber - a.vaultNumber
+  const aRatio = new Decimal(a.deposited.toString()).div(new Decimal(a.denormalizedDebt.toString()))
+  const bRatio = new Decimal(b.deposited.toString()).div(new Decimal(b.denormalizedDebt.toString()))
+  if (aRatio.equals(bRatio)) {
+    return a.publicKey.toString() > b.publicKey.toString() ? 1 : -1
   }
-  return aRatio - bRatio
+  return aRatio.greaterThan(bRatio) ? 1 : -1
 }
 
 async function getMiniVaults(program: Program<Vault>, vaultTypePublicKey: PublicKey) {
@@ -215,8 +233,8 @@ async function getMiniVaults(program: Program<Vault>, vaultTypePublicKey: Public
     // Slice the data only to grab the 3 u64's of size 8 bytes each
     dataSlice: {
       // See programs/hedge-vault/src/account_data/vault.rs for struct layout
-      offset: 8 + 32,
-      length: 24,
+      offset: 8 + 32 + 8,
+      length: 16,
     },
   })