hedge-web3 0.1.0 → 0.1.1

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm run build
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "hedge-web3",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Hedge Javascript API",
   "main": "index.js",
   "scripts": {
     "build": "npm run clean; rollup -c",
     "clean": "rimraf ./lib",
     "dev": "rollup -c",
-    "deploy-docs": "npm run docs; gh-pages -d doc",
     "docs": "set -ex; typedoc --treatWarningsAsErrors",
     "test": "echo \"Error: no test specified\" && exit 1"
   },

package/src/accounts/VaultAccount.ts

@@ -1,13 +1,29 @@
 import { LAMPORTS_PER_SOL, PublicKey } from '@solana/web3.js'
 import { HedgeDecimal } from '../HedgeDecimal'
 
+/**
+ * A class that represents an on-chian vault.
+ */
 export class VaultAccount {
+  /** The public key of this vault. */
   publicKey: PublicKey
+
+  /** The public key of the vault owner. */
   vaultOwner: PublicKey
+
+  /** The outstanding debt of the vault (in USDH Lamports). */
   debt: number
+
+  /** The deposited collateral of the vault (in SOL Lamports). */
   deposited: number
+
+  /** The minimum collateral ratio this vault must maintain to not be subject to liquidation. */
   minCollateralRatio: HedgeDecimal
+
+  /** The SOL/USD price at which this vault is subject to liquidation */
   liquidationPrice: number
+
+  /** Current State of the vautl ("Open", "Closed", "Liquidated") */
   vaultStatus: string
 
   constructor (vault: any
@@ -22,18 +38,39 @@ export class VaultAccount {
     this.vaultStatus = Object.keys(vault.vaultStatus)[0]
   }
 
+  /**
+   * Check if some `PublicKey` is the owner
+   *
+   * @param publicKey the publicKey to check against the vault owner
+   * @returns true if publicKey matches the owner publicKey
+   */
   public isOwnedBy (publicKey: PublicKey): boolean {
     return 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 debt value in USDH
+   *
+   * @returns debt value in USDH
+   */
   public inUsd (): number {
     return this.debt / LAMPORTS_PER_SOL
   }
 
+  /**
+   * Pretty print the vault publickey for easy display
+   *
+   * @returns example: `1b6ca...azy71s`
+   */
   public toDisplayString (): string {
     return `${this.publicKey.toString().substring(0, 6)}...${this.publicKey.toString().substring(this.publicKey.toString().length - 6)}`
   }