hedge-web3 0.2.8 → 0.2.11

package/lib/state/VaultAccount.js

@@ -27,12 +27,16 @@ const web3_js_1 = require("@solana/web3.js");
 const decimal_js_1 = __importDefault(require("decimal.js"));
 const HedgeDecimal_1 = require("../HedgeDecimal");
 const borsh = __importStar(require("@project-serum/borsh"));
+const bn_js_1 = __importDefault(require("bn.js"));
 /**
  * A class that represents an on-chian vault.
  */
 class VaultAccount {
     constructor(vault, publicKey) {
-        var _a, _b;
+        /** The deposited collateral of the vault (in SOL Lamports). */
+        this.deposited = new bn_js_1.default(0);
+        /** The outstanding debt of the vault (in USH Lamports). Denormalized to time 0. */
+        this.denormalizedDebt = new bn_js_1.default(0);
         /** The ordered number of when this vault was created. */
         this.vaultNumber = 0;
         /** Debt redistribution snapshot */
@@ -44,8 +48,8 @@ class VaultAccount {
         this.publicKey = publicKey;
         this.vaultOwner = vault.vaultOwner;
         this.pdaSalt = vault.pdaSalt;
-        this.deposited = (_a = vault.deposited) === null || _a === void 0 ? void 0 : _a.toNumber();
-        this.denormalizedDebt = (_b = vault.denormalizedDebt) === null || _b === void 0 ? void 0 : _b.toNumber();
+        this.deposited = vault.deposited;
+        this.denormalizedDebt = vault.denormalizedDebt;
         if (vault.vaultNumber) {
             this.vaultNumber = vault.vaultNumber.toNumber();
         }
@@ -71,21 +75,22 @@ class VaultAccount {
     isOwnedBy(publicKey) {
         return publicKey && publicKey.toString() === this.vaultOwner.toString();
     }
-    /**
-     * Get the collateral value in SOL
-     *
-     * @returns collateral value in SOL
-     */
-    inSol() {
-        return this.deposited / web3_js_1.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
      *
      * @returns debt value in USH
      */
     inUsd() {
-        return this.denormalizedDebt / web3_js_1.LAMPORTS_PER_SOL;
+        return new decimal_js_1.default(this.denormalizedDebt.toString()).div(web3_js_1.LAMPORTS_PER_SOL).toNumber();
     }
     /**
      * Pretty print the vault publickey for easy display
@@ -97,35 +102,69 @@ class VaultAccount {
             .toString()
             .substring(this.publicKey.toString().length - 6)}`;
     }
+    /**
+     * Add additional debt to the vault.
+     *
+     * @param {BN} additionalDebt - Additional normalized debt to add in (USH) lamports.
+     * @param {VaultType} vaultTypeAccount - Vault's vaultType
+     *
+     */
     addDebt(additionalDebt, vaultTypeAccount) {
-        let loanFee = new decimal_js_1.default(0);
-        if (additionalDebt.isPositive()) {
-            loanFee = vaultTypeAccount.loanInitFee.mul(additionalDebt);
-        }
-        const totalNormalizedLoan = additionalDebt.add(loanFee);
-        const denormalizedNewDebt = totalNormalizedLoan.div(new decimal_js_1.default(vaultTypeAccount.cumulativeRate.toString()));
-        this.denormalizedDebt = denormalizedNewDebt.add(new decimal_js_1.default(this.denormalizedDebt)).floor().toNumber();
+        const additionalDebtAsDecimal = new decimal_js_1.default(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_js_1.default(totalNormalizedLoan.div(vaultTypeAccount.cumulativeRate).floor().toString());
+        this.denormalizedDebt = this.denormalizedDebt.add(denormalizedNewDebt);
     }
-    addDeposit(depositAmount) {
-        this.deposited += depositAmount;
+    /**
+     * Repay debt on a vault
+     *
+     * @param {BN} repayAmount - Normalized debt to repay in (USH) lamports.
+     * @param {VaultType} vaultTypeAccount - Vault's vaultType
+     *
+     */
+    repayDebt(repayAmount, vaultTypeAccount) {
+        const denormalizedRepayment = new decimal_js_1.default(repayAmount.toString()).div(vaultTypeAccount.cumulativeRate).floor();
+        this.denormalizedDebt = this.denormalizedDebt.sub(new bn_js_1.default(denormalizedRepayment.toString()));
+    }
+    /**
+     * Deposit Collateral
+     *
+     * @param {BN} depositAmount - Amount to deposit in (CollateralMint) lamports
+     *
+     */
+    depositCollateral(depositAmount) {
+        this.deposited = this.deposited.add(depositAmount);
+    }
+    /**
+     * Withdraw Collateral
+     *
+     * @param {BN} withdrawAmount - Amount to withdraw in (CollateralMint) lamports
+     *
+     */
+    withdrawCollateral(withdrawAmount) {
+        this.deposited = this.deposited.sub(withdrawAmount);
     }
     redeem() {
         // TODO - Calculate actual redeem amount and adust correctly
-        this.denormalizedDebt = 0;
+        this.denormalizedDebt = new bn_js_1.default(0);
         this.vaultStatus = 'initialized';
     }
     liquidate() {
         // TODO - Calculate actual liquidate amount and adust correctly
-        this.denormalizedDebt = 0;
+        this.denormalizedDebt = new bn_js_1.default(0);
         this.vaultStatus = 'liquidated';
     }
     updateDebtAndCollateral(vaultTypeAccountData) {
-        this.denormalizedDebt = vaultTypeAccountData.debtRedistributionProduct
+        this.denormalizedDebt = new bn_js_1.default(vaultTypeAccountData.debtRedistributionProduct
             .div(this.debtProductSnapshotBytes)
-            .mul(new decimal_js_1.default(this.denormalizedDebt))
-            .toNumber();
-        const extraCollateralDeposited = this.denormalizedDebt * vaultTypeAccountData.collateralRedistributionAccumulator.sub(this.collateralAccumulatorSnapshotBytes).toNumber();
-        this.deposited += extraCollateralDeposited;
+            .mul(new decimal_js_1.default(this.denormalizedDebt.toString()))
+            .floor()
+            .toString());
+        const extraCollateralDeposited = new decimal_js_1.default(this.denormalizedDebt.toString()).mul(vaultTypeAccountData.collateralRedistributionAccumulator.sub(this.collateralAccumulatorSnapshotBytes).toNumber()).floor();
+        this.deposited = this.deposited.add(new bn_js_1.default(extraCollateralDeposited.toString()));
         this.collateralAccumulatorSnapshotBytes = vaultTypeAccountData.collateralRedistributionAccumulator;
         this.debtProductSnapshotBytes = vaultTypeAccountData.debtRedistributionProduct;
     }
@@ -135,8 +174,8 @@ class VaultAccount {
             arrow = ' <----!!';
         }
         let collateralRatio = 'Infinite';
-        if (this.denormalizedDebt > 0) {
-            collateralRatio = new decimal_js_1.default(this.deposited).div(new decimal_js_1.default(this.denormalizedDebt)).toString();
+        if (this.denormalizedDebt.gt(new bn_js_1.default(0))) {
+            collateralRatio = new decimal_js_1.default(this.deposited.toString()).div(new decimal_js_1.default(this.denormalizedDebt.toString())).toString();
         }
         let nextVault = 'None';
         if (this.nextVaultToRedeem) {

package/lib/utils/getLinkedListAccounts.js

@@ -13,13 +13,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLinkedListAccounts = void 0;
+const anchor_1 = require("@project-serum/anchor");
 const underscore_1 = __importDefault(require("underscore"));
 const Constants_1 = require("../Constants");
 const VaultAccount_1 = require("../state/VaultAccount");
 const decimal_js_1 = __importDefault(require("decimal.js"));
 const bs58_1 = __importDefault(require("bs58"));
 const VaultType_1 = __importDefault(require("../state/VaultType"));
-function getLinkedListAccounts(program, provider, vaultTypeAccountPublicKey, vaultPublicKey, depositAmount, loanAmount, redeem, liquidate, cachedVaults) {
+/**
+ * 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.
+ */
+function getLinkedListAccounts(program, vaultTypeAccountPublicKey, vaultPublicKey, depositAmount, withdrawAmount, loanAmount, repayAmount, redeem, liquidate, cachedVaults) {
     return __awaiter(this, void 0, void 0, function* () {
         const vaultTypeRaw = yield program.account.vaultType.fetch(vaultTypeAccountPublicKey);
         const vaultType = new VaultType_1.default(vaultTypeRaw, vaultTypeAccountPublicKey);
@@ -50,7 +65,7 @@ function getLinkedListAccounts(program, provider, vaultTypeAccountPublicKey, vau
         // })
         // Remove any vaults with no debt or collateral
         vaults = underscore_1.default.filter(vaults, (vault) => {
-            return vault.denormalizedDebt > 0 && vault.deposited > 0;
+            return vault.denormalizedDebt.gt(new anchor_1.BN(0)) && vault.deposited.gt(new anchor_1.BN(0));
         });
         // Sort them
         vaults.sort(sortVaults);
@@ -101,17 +116,18 @@ function getLinkedListAccounts(program, provider, vaultTypeAccountPublicKey, vau
         }
         // 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_js_1.default(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();
         }
         if (redeem) {
             vaults[indexBefore].redeem();
         }
-        if (vaults[indexBefore].denormalizedDebt === 0) {
+        if (vaults[indexBefore].denormalizedDebt.isZero()) {
             vaults.splice(indexBefore, 1);
         }
         // Sort it again since we've changed one vault
@@ -154,12 +170,12 @@ exports.getLinkedListAccounts = 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, b) {
-    const aRatio = a.deposited / a.denormalizedDebt;
-    const bRatio = b.deposited / b.denormalizedDebt;
-    if (aRatio === bRatio) {
+    const aRatio = new decimal_js_1.default(a.deposited.toString()).div(new decimal_js_1.default(a.denormalizedDebt.toString()));
+    const bRatio = new decimal_js_1.default(b.deposited.toString()).div(new decimal_js_1.default(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;
 }
 function getMiniVaults(program, vaultTypePublicKey) {
     return __awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hedge-web3",
-  "version": "0.2.8",
+  "version": "0.2.11",
   "description": "Hedge Javascript Web3 API",
   "main": "lib/index.js",
   "types": "declarations/index.d.ts",

package/src/Constants.ts

@@ -14,6 +14,9 @@ export const CHAINLINK_PROGRAM_ID = "HEvSKofvBgfaexv23kMabbYqxasxU3mQ4ibBMEmJWHn
 
 const enc = new TextEncoder()
 
+/**
+ * @returns The Liquidation pool public key
+ */
 export async function getLiquidationPoolStatePublicKey(): Promise<PublicKey> {
   const [poolPublicKey] = await PublicKey.findProgramAddress(
     [enc.encode('LiquidationPoolStateV1')],
@@ -21,7 +24,10 @@ export async function getLiquidationPoolStatePublicKey(): Promise<PublicKey> {
   )
   return poolPublicKey
 }
-
+/**
+ * 
+ * @returns The liquidation pool ush account public key
+ */
 export async function getLiquidationPoolUshAccountPublicKey(): Promise<PublicKey> {
   const [poolPublicKey] = await PublicKey.findProgramAddress(
     [enc.encode('LiquidationPoolUSHAccountV1')],
@@ -29,7 +35,10 @@ export async function getLiquidationPoolUshAccountPublicKey(): Promise<PublicKey
   )
   return poolPublicKey
 }
-
+/**
+ * 
+ * @returns The USH mint public key
+ */
 export async function getUshMintPublicKey(): Promise<PublicKey> {
   const [findMintPublicKey] = await PublicKey.findProgramAddress(
     [enc.encode('UshMintV1')],
@@ -37,7 +46,10 @@ export async function getUshMintPublicKey(): Promise<PublicKey> {
   )
   return findMintPublicKey
 }
-
+/**
+ * 
+ * @returns The Vault System State public key
+ */
 export async function getVaultSystemStatePublicKey(): Promise<PublicKey> {
   const [publicKey] = await PublicKey.findProgramAddress(
     [enc.encode('VaultSystemStateV1')],
@@ -46,6 +58,10 @@ export async function getVaultSystemStatePublicKey(): Promise<PublicKey> {
   return publicKey
 }
 
+/**
+ * 
+ * @returns The HDG mint public key
+ */
 export async function getHedgeMintPublicKey(): Promise<PublicKey> {
   const [publicKey] = await PublicKey.findProgramAddress(
     [enc.encode('HEDGEMintV1')],
@@ -53,7 +69,12 @@ export async function getHedgeMintPublicKey(): Promise<PublicKey> {
   )
   return publicKey
 }
-
+/**
+ * Get the public key for any staking pool
+ * 
+ * @param mintPublicKey Staked collateral mint public key
+ * @returns the public key for that staking pool
+ */
 export async function getPoolPublicKeyForMint(
   mintPublicKey: PublicKey
 ): Promise<[PublicKey, number, string]> {
@@ -64,6 +85,12 @@ export async function getPoolPublicKeyForMint(
   )
   return [publicKey, bump, strToEncode]
 }
+
+/**
+ * 
+ * @param collateralType String name of the collateral type (must be 16 chars)
+ * @returns The public key for that Vault Type account
+ */
 export async function getVaultTypeAccountPublicKey(
   collateralType: string
 ): Promise<PublicKey> {
@@ -73,6 +100,12 @@ export async function getVaultTypeAccountPublicKey(
   )
   return vaultTypeAccount
 }
+
+/**
+ * 
+ * @param collateralType String name of the collateral type (must be 16 chars)
+ * @returns The public key for that Vault Type oracle info
+ */
 export async function getVaultTypeOracleAccountPublicKey(
   collateralType: string
 ): Promise<PublicKey> {
@@ -82,6 +115,13 @@ export async function getVaultTypeOracleAccountPublicKey(
   )
   return vaultTypeOracleAccount
 }
+
+/**
+ * Vaults are stored in PDA accounts. Use this to get the address from a salt
+ * 
+ * @param vaultSalt String salt for the vault (must be 8 chars)
+ * @returns The public key for that Vault Type oracle info
+ */
 export async function findVaultAddress(vaultSalt: string): Promise<PublicKey> {
   const [vaultAddress] = await PublicKey.findProgramAddress(
     [enc.encode('Vault'), enc.encode(vaultSalt)],
@@ -90,6 +130,12 @@ export async function findVaultAddress(vaultSalt: string): Promise<PublicKey> {
   return vaultAddress
 }
 
+/**
+ * 
+ * @param walletAddress Owner public key
+ * @param tokenMintAddress Token mint
+ * @returns The associated token account public key
+ */
 export async function findAssociatedTokenAddress(
   walletAddress: PublicKey,
   tokenMintAddress: PublicKey

package/src/idl/pyth.ts

@@ -0,0 +1,159 @@
+export type Pyth = {
+  "version": "0.1.0",
+  "name": "pyth",
+  "instructions": [
+    {
+      "name": "initialize",
+      "accounts": [
+        {
+          "name": "payer",
+          "isMut": true,
+          "isSigner": true
+        },
+        {
+          "name": "price",
+          "isMut": true,
+          "isSigner": true
+        },
+        {
+          "name": "systemProgram",
+          "isMut": false,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "price",
+          "type": "i64"
+        },
+        {
+          "name": "expo",
+          "type": "i32"
+        },
+        {
+          "name": "conf",
+          "type": "u64"
+        }
+      ]
+    },
+    {
+      "name": "setPrice",
+      "accounts": [
+        {
+          "name": "price",
+          "isMut": true,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "price",
+          "type": "i64"
+        }
+      ]
+    }
+  ],
+  "accounts": [
+    {
+      "name": "priceWrapper",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "price",
+            "type": {
+              "defined": "Price"
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "errors": [
+    {
+      "code": 6000,
+      "name": "InvalidTradingStatus",
+      "msg": "invalid trading status"
+    }
+  ]
+};
+
+export const IDL: Pyth = {
+  "version": "0.1.0",
+  "name": "pyth",
+  "instructions": [
+    {
+      "name": "initialize",
+      "accounts": [
+        {
+          "name": "payer",
+          "isMut": true,
+          "isSigner": true
+        },
+        {
+          "name": "price",
+          "isMut": true,
+          "isSigner": true
+        },
+        {
+          "name": "systemProgram",
+          "isMut": false,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "price",
+          "type": "i64"
+        },
+        {
+          "name": "expo",
+          "type": "i32"
+        },
+        {
+          "name": "conf",
+          "type": "u64"
+        }
+      ]
+    },
+    {
+      "name": "setPrice",
+      "accounts": [
+        {
+          "name": "price",
+          "isMut": true,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "price",
+          "type": "i64"
+        }
+      ]
+    }
+  ],
+  "accounts": [
+    {
+      "name": "priceWrapper",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "price",
+            "type": {
+              "defined": "Price"
+            }
+          }
+        ]
+      }
+    }
+  ],
+  "errors": [
+    {
+      "code": 6000,
+      "name": "InvalidTradingStatus",
+      "msg": "invalid trading status"
+    }
+  ]
+};

package/src/idl/vault.ts

@@ -1754,6 +1754,47 @@ export type Vault = {
         }
       ],
       "args": []
+    },
+    {
+      "name": "adminResetVault",
+      "accounts": [
+        {
+          "name": "payer",
+          "isMut": true,
+          "isSigner": true
+        },
+        {
+          "name": "vaultSystemState",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "vaultAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "vaultAssociatedTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "vaultTypeAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "vaultTypeAssociatedTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "amountToSendFromVaultType",
+          "type": "u64"
+        }
+      ]
     }
   ],
   "accounts": [
@@ -2558,9 +2599,6 @@ export type Vault = {
           },
           {
             "name": "Distributed"
-          },
-          {
-            "name": "Redeemed"
           }
         ]
       }
@@ -4643,6 +4681,47 @@ export const IDL: Vault = {
         }
       ],
       "args": []
+    },
+    {
+      "name": "adminResetVault",
+      "accounts": [
+        {
+          "name": "payer",
+          "isMut": true,
+          "isSigner": true
+        },
+        {
+          "name": "vaultSystemState",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "vaultAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "vaultAssociatedTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "vaultTypeAccount",
+          "isMut": true,
+          "isSigner": false
+        },
+        {
+          "name": "vaultTypeAssociatedTokenAccount",
+          "isMut": true,
+          "isSigner": false
+        }
+      ],
+      "args": [
+        {
+          "name": "amountToSendFromVaultType",
+          "type": "u64"
+        }
+      ]
     }
   ],
   "accounts": [
@@ -5447,9 +5526,6 @@ export const IDL: Vault = {
           },
           {
             "name": "Distributed"
-          },
-          {
-            "name": "Redeemed"
           }
         ]
       }

package/src/instructions/depositVault.ts

@@ -67,11 +67,12 @@ export async function depositVault(
   const signers = [payer, history]
   const [oldSmallerPublicKey, newSmallerPublicKey, newLargerPublicKey] = await getLinkedListAccounts(
     program,
-    provider,
     vaultAccount.vaultType,
     vaultPublicKey,
-    depositAmount,
-    0,
+    new BN(depositAmount),
+    new BN(0),
+    new BN(0),
+    new BN(0),
     false,
     false
   )

package/src/instructions/liquidateVault.ts

@@ -87,11 +87,12 @@ export async function liquidateVault(
 
   const [oldSmallerPublicKey, newSmallerPublicKey, newLargerPublicKey] = await getLinkedListAccounts(
     program,
-    provider,
     vaultAccount.vaultType,
     vaultPublicKey,
-    0,
-    0,
+    new BN(0),
+    new BN(0),
+    new BN(0),
+    new BN(0),
     false,
     true
   )

package/src/instructions/loanVault.ts

@@ -59,11 +59,12 @@ export async function loanVault(
   )
   const [oldSmallerPublicKey, newSmallerPublicKey, newLargerPublicKey] = await getLinkedListAccounts(
     program,
-    provider,
     vaultAccount.vaultType,
     vaultPublicKey,
-    0,
-    loanAmount,
+    new BN(0),
+    new BN(0),
+    new BN(loanAmount),
+    new BN(0),
     false,
     false
   )