hedge-web3 0.1.2 → 0.1.8

package/src/instructions/redeemVault.ts

@@ -1,22 +1,20 @@
-import { BN, Program } from '@project-serum/anchor'
+import { BN, Program, Provider } from '@project-serum/anchor'
 import { Token, TOKEN_PROGRAM_ID } from '@solana/spl-token'
-import { ConfirmOptions, Connection, Keypair, LAMPORTS_PER_SOL, PublicKey, sendAndConfirmTransaction, Signer, SystemProgram, Transaction, TransactionInstruction } from '@solana/web3.js'
-import { CHAINLINK_SOL_USD_PUBLICKEY, findAssociatedTokenAddress, getHedgeMintPublicKey, getPoolPublicKeyForMint, getUsdhMintPublicKey, getVaultSystemStatePublicKey, HEDGE_PROGRAM_ID } from '../Constants'
-
-import { vaultIdl } from '../idl/idl'
+import { Keypair, LAMPORTS_PER_SOL, PublicKey, sendAndConfirmTransaction, Signer, SystemProgram, Transaction, TransactionInstruction } from '@solana/web3.js'
+import { CHAINLINK_SOL_USD_PUBLICKEY, findAssociatedTokenAddress, getHedgeMintPublicKey, getPoolPublicKeyForMint, getUsdhMintPublicKey, getVaultSystemStatePublicKey } from '../Constants'
 
 export async function redeemVault (
-  connection: Connection,
+  program: Program,
+  provider: Provider,
   payer: Signer,
   vaultPublicKey: PublicKey,
   repayAmount: number,
   chainlinkOverridePrice?: number,
-  transactionOverrideTime?: number,
-  confirmOptions?: ConfirmOptions
+  transactionOverrideTime?: number
 ): Promise<PublicKey> {
   const [usdhMintPublickey] = await getUsdhMintPublicKey()
   const USDH = new Token(
-    connection,
+    provider.connection,
     usdhMintPublickey,
     TOKEN_PROGRAM_ID,
     payer
@@ -28,6 +26,7 @@ export async function redeemVault (
   const history = Keypair.generate()
   const transaction = new Transaction().add(
     await redeemVaultInstruction(
+      program,
       payer.publicKey,
       payerUsdhAccount.address,
       vaultPublicKey,
@@ -37,11 +36,12 @@ export async function redeemVault (
       transactionOverrideTime
     )
   )
-  await sendAndConfirmTransaction(connection, transaction, [payer, history], confirmOptions)
+  await sendAndConfirmTransaction(provider.connection, transaction, [payer, history], provider.opts)
   return vaultPublicKey
 }
 
 export async function redeemVaultInstruction (
+  program: Program,
   payerPublicKey: PublicKey,
   ownerUsdhAccount: PublicKey,
   vaultPublickey: PublicKey,
@@ -50,7 +50,6 @@ export async function redeemVaultInstruction (
   chainlinkOverridePrice?: number,
   transactionOverrideTime?: number
 ): Promise<TransactionInstruction> {
-  const program = new Program(vaultIdl, HEDGE_PROGRAM_ID)
   const [vaultSystemStatePublicKey] = await getVaultSystemStatePublicKey()
   const [usdhMintPublickey] = await getUsdhMintPublicKey()
   const [hedgeMintPublickey] = await getHedgeMintPublicKey()

package/src/instructions/repayVault.ts

@@ -1,20 +1,18 @@
-import { BN, Program } from '@project-serum/anchor'
+import { BN, Program, Provider } from '@project-serum/anchor'
 import { Token, TOKEN_PROGRAM_ID } from '@solana/spl-token'
-import { ConfirmOptions, Connection, Keypair, PublicKey, sendAndConfirmTransaction, Signer, SystemProgram, Transaction, TransactionInstruction } from '@solana/web3.js'
-import { findAssociatedTokenAddress, getHedgeMintPublicKey, getPoolPublicKeyForMint, getUsdhMintPublicKey, getVaultSystemStatePublicKey, HEDGE_PROGRAM_ID } from '../Constants'
-
-import { vaultIdl } from '../idl/idl'
+import { Keypair, PublicKey, sendAndConfirmTransaction, Signer, SystemProgram, Transaction, TransactionInstruction } from '@solana/web3.js'
+import { findAssociatedTokenAddress, getHedgeMintPublicKey, getPoolPublicKeyForMint, getUsdhMintPublicKey, getVaultSystemStatePublicKey } from '../Constants'
 
 export async function repayVault (
-  connection: Connection,
+  program: Program,
+  provider: Provider,
   payer: Signer,
   vaultPublicKey: PublicKey,
-  repayAmount: number,
-  confirmOptions?: ConfirmOptions
+  repayAmount: number
 ): Promise<PublicKey> {
   const [usdhMintPublickey] = await getUsdhMintPublicKey()
   const USDH = new Token(
-    connection,
+    provider.connection,
     usdhMintPublickey,
     TOKEN_PROGRAM_ID,
     payer
@@ -26,6 +24,7 @@ export async function repayVault (
   const history = Keypair.generate()
   const transaction = new Transaction().add(
     await repayVaultInstruction(
+      program,
       payer.publicKey,
       payerUsdhAccount.address,
       vaultPublicKey,
@@ -33,18 +32,18 @@ export async function repayVault (
       repayAmount
     )
   )
-  await sendAndConfirmTransaction(connection, transaction, [payer, history], confirmOptions)
+  await sendAndConfirmTransaction(provider.connection, transaction, [payer, history], provider.opts)
   return vaultPublicKey
 }
 
 export async function repayVaultInstruction (
+  program: Program,
   payerPublicKey: PublicKey,
   ownerUsdhAccount: PublicKey,
   vaultPublickey: PublicKey,
   historyPublicKey: PublicKey,
   repayAmount: number
 ): Promise<TransactionInstruction> {
-  const program = new Program(vaultIdl, HEDGE_PROGRAM_ID)
   const [vaultSystemStatePublicKey] = await getVaultSystemStatePublicKey()
   const [usdhMintPublickey] = await getUsdhMintPublicKey()
   const [hedgeMintPublickey] = await getHedgeMintPublicKey()

package/src/instructions/withdrawStakingPool.ts

@@ -0,0 +1,69 @@
+import { BN, Program, Provider } from '@project-serum/anchor'
+import { ASSOCIATED_TOKEN_PROGRAM_ID, TOKEN_PROGRAM_ID } from '@solana/spl-token'
+import { Keypair, PublicKey, sendAndConfirmTransaction, Signer, SystemProgram, SYSVAR_RENT_PUBKEY, Transaction, TransactionInstruction } from '@solana/web3.js'
+import { parseAnchorErrors } from '../utils/Errors'
+import { findAssociatedTokenAddress, getHedgeMintPublicKey, getPoolPublicKeyForMint, getUsdhMintPublicKey, getVaultSystemStatePublicKey } from '../Constants'
+
+export async function withdrawStakingPool (
+  program: Program,
+  provider: Provider,
+  payer: Signer,
+  poolPositionPublicKey: PublicKey,
+  stakedTokenMintPublicKey: PublicKey,
+  overrideStartTime?: number
+): Promise<PublicKey> {
+  const poolPosition = Keypair.generate()
+  const transaction = new Transaction().add(
+    await withdrawStakingPoolInstruction(
+      program,
+      payer.publicKey,
+      poolPositionPublicKey,
+      stakedTokenMintPublicKey,
+      overrideStartTime
+    )
+  )
+  await sendAndConfirmTransaction(provider.connection, transaction, [payer], provider.opts).catch(parseAnchorErrors)
+  return poolPosition.publicKey
+}
+
+export async function withdrawStakingPoolInstruction (
+  program: Program,
+  payerPublicKey: PublicKey,
+  poolPositionPublicKey: PublicKey,
+  stakedTokenMintPublicKey: PublicKey,
+  overrideStartTime?: number
+): Promise<TransactionInstruction> {
+  const [vaultSystemStatePublicKey] = await getVaultSystemStatePublicKey()
+  const [usdhMintPublickey] = await getUsdhMintPublicKey()
+  const [hedgeMintPublickey] = await getHedgeMintPublicKey()
+  const [poolPublickey] = await getPoolPublicKeyForMint(stakedTokenMintPublicKey)
+  const poolAssociatedStakedTokenAccount = await findAssociatedTokenAddress(poolPublickey, stakedTokenMintPublicKey)
+  const poolAssociatedUsdhTokenAccount = await findAssociatedTokenAddress(poolPublickey, usdhMintPublickey)
+  const payerAssociatedStakedTokenAccount = await findAssociatedTokenAddress(payerPublicKey, stakedTokenMintPublicKey)
+  const payerAssociatedHedgeAccount = await findAssociatedTokenAddress(payerPublicKey, hedgeMintPublickey)
+  const payerAssociatedUsdhAccount = await findAssociatedTokenAddress(payerPublicKey, usdhMintPublickey)
+
+  return program.instruction.withdrawStakingPool(
+    new BN(overrideStartTime ?? Date.now() / 1000), // override current time
+    {
+      accounts: {
+        payer: payerPublicKey,
+        vaultSystemState: vaultSystemStatePublicKey,
+        pool: poolPublickey,
+        poolPosition: poolPositionPublicKey,
+        poolAssociatedStakedTokenAccount: poolAssociatedStakedTokenAccount,
+        poolAssociatedUsdhTokenAccount: poolAssociatedUsdhTokenAccount,
+        payerAssociatedStakedTokenAccount: payerAssociatedStakedTokenAccount,
+        payerAssociatedHedgeAccount: payerAssociatedHedgeAccount,
+        payerAssociatedUsdhAccount: payerAssociatedUsdhAccount,
+        hedgeMint: hedgeMintPublickey,
+        stakedTokenMint: stakedTokenMintPublicKey,
+        usdhMint: usdhMintPublickey,
+        rent: SYSVAR_RENT_PUBKEY,
+        splTokenProgramInfo: TOKEN_PROGRAM_ID,
+        splAssociatedTokenProgramInfo: ASSOCIATED_TOKEN_PROGRAM_ID,
+        systemProgram: SystemProgram.programId
+      },
+      signers: []
+    })
+}

package/src/instructions/withdrawVault.ts

@@ -1,21 +1,19 @@
-import { BN, Program } from '@project-serum/anchor'
+import { BN, Program, Provider } from '@project-serum/anchor'
 import { Token, TOKEN_PROGRAM_ID } from '@solana/spl-token'
-import { ConfirmOptions, Connection, Keypair, LAMPORTS_PER_SOL, PublicKey, sendAndConfirmTransaction, Signer, SystemProgram, Transaction, TransactionInstruction } from '@solana/web3.js'
-import { CHAINLINK_SOL_USD_PUBLICKEY, getUsdhMintPublicKey, getVaultSystemStatePublicKey, HEDGE_PROGRAM_ID } from '../Constants'
-
-import { vaultIdl } from '../idl/idl'
+import { Keypair, LAMPORTS_PER_SOL, PublicKey, sendAndConfirmTransaction, Signer, SystemProgram, Transaction, TransactionInstruction } from '@solana/web3.js'
+import { CHAINLINK_SOL_USD_PUBLICKEY, getUsdhMintPublicKey, getVaultSystemStatePublicKey } from '../Constants'
 
 export async function withdrawVault (
-  connection: Connection,
+  program: Program,
+  provider: Provider,
   payer: Signer,
   vaultPublicKey: PublicKey,
   withdrawAmount: number,
-  chainlinkOverridePrice?: number,
-  confirmOptions?: ConfirmOptions
+  chainlinkOverridePrice?: number
 ): Promise<PublicKey> {
   const [usdhMintPublickey] = await getUsdhMintPublicKey()
   const USDH = new Token(
-    connection,
+    provider.connection,
     usdhMintPublickey,
     TOKEN_PROGRAM_ID,
     payer
@@ -28,6 +26,7 @@ export async function withdrawVault (
   const [vaultSystemStatePublicKey] = await getVaultSystemStatePublicKey()
   const transaction = new Transaction().add(
     withdrawVaultInstruction(
+      program,
       vaultSystemStatePublicKey,
       payer.publicKey,
       vaultPublicKey,
@@ -36,11 +35,12 @@ export async function withdrawVault (
       chainlinkOverridePrice
     )
   )
-  await sendAndConfirmTransaction(connection, transaction, [payer, history], confirmOptions)
+  await sendAndConfirmTransaction(provider.connection, transaction, [payer, history], provider.opts)
   return vaultPublicKey
 }
 
 export function withdrawVaultInstruction (
+  program: Program,
   vaultSystemStatePublicKey: PublicKey,
   payerPublicKey: PublicKey,
   vaultPublickey: PublicKey,
@@ -48,7 +48,6 @@ export function withdrawVaultInstruction (
   withdrawAmount: number,
   chainlinkOverridePrice?: number
 ): TransactionInstruction {
-  const program = new Program(vaultIdl, HEDGE_PROGRAM_ID)
   return program.instruction.withdrawVault(
     new BN(withdrawAmount),
     new BN(chainlinkOverridePrice ?? 200 * LAMPORTS_PER_SOL),

package/src/state/LiquidationPoolEra.ts

@@ -1,6 +1,6 @@
 
 import Decimal from 'decimal.js'
-import { DecimalFromU128 } from '..'
+import { DecimalFromU128 } from '../HedgeDecimal'
 
 /**
  * Represents an on-chian pool era. In the event an era is depleted of deposits, a new era is
@@ -9,13 +9,13 @@ import { DecimalFromU128 } from '..'
 export class LiquidationPoolEra {
   public totalDeposits: number
 
-  product: Decimal
+  public product: Decimal
 
-  sum: Decimal
+  public sum: Decimal
 
-  hedgeRewardsAccumulator: Decimal
+  public hedgeRewardsAccumulator: Decimal
 
-  hedgeRewardsTimestamp: number
+  public hedgeRewardsTimestamp: number
 
   constructor (public liquidyPoolEra: any) {
     this.totalDeposits = liquidyPoolEra.totalDeposits.toNumber()

package/src/state/LiquidationPosition.ts

@@ -1,6 +1,6 @@
-import { PublicKey } from '@solana/web3.js'
+import { LAMPORTS_PER_SOL, PublicKey } from '@solana/web3.js'
 import Decimal from 'decimal.js'
-import { DecimalFromU128 } from '..'
+import { DecimalFromU128 } from '../HedgeDecimal'
 import { LiquidationPoolEra } from './LiquidationPoolEra'
 import { LiquidationPoolState } from './LiquidationPoolState'
 
@@ -48,22 +48,30 @@ export class LiquidationPosition {
     return this.era.sum.minus(this.sumSnapshot).div(this.productSnapshot).mul(new Decimal(this.deposit)).floor()
   }
 
-  //   getHedgeAvailable () {
-  //     const LiquidationPoolTotalSupply = 2000000.0 * LAMPORTS_PER_SOL
-  //     const hedgeRewardsSinceLastUpdate = hedgeRewardsDecay(
-  //       LiquidationPoolTotalSupply,
-  //       this.liquidationPoolState.hedgeInitRewardsTimestamp * 1000,
-  //       this.era.hedgeRewardsTimestamp * 1000,
-  //       Date.now(),
-  //       365 * 1000)
+  public getHedgeAvailable (): Decimal {
+    const LiquidationPoolTotalSupply = 2000000.0 * LAMPORTS_PER_SOL
+    const hedgeRewardsSinceLastUpdate = hedgeRewardsDecay(
+      LiquidationPoolTotalSupply,
+      this.liquidationPoolState.hedgeInitRewardsTimestamp * 1000,
+      this.era.hedgeRewardsTimestamp * 1000,
+      Date.now(),
+      365 * 1000)
 
-  //     if (this.era.totalDeposits === 0) {
-  //       return 0
-  //     }
+    if (this.era.totalDeposits === 0) {
+      return new Decimal(0)
+    }
 
-//     const rewardsPerToken = hedgeRewardsSinceLastUpdate / this.era.totalDeposits * this.era.product
-//     const newAccumulator = this.era.hedgeRewardsAccumulator + rewardsPerToken
-//     const hedgeAvailable = (newAccumulator - this.hedgeRewardsSnapshot) * this.deposit / this.productSnapshot
-//     return hedgeAvailable
-//   }
+    const rewardsPerToken = this.era.product.mul(new Decimal(hedgeRewardsSinceLastUpdate / this.era.totalDeposits))
+    const newAccumulator = rewardsPerToken.add(new Decimal(this.era.hedgeRewardsAccumulator))
+    const hedgeAvailable = (newAccumulator.minus(this.hedgeRewardsSnapshot)).mul(new Decimal(this.deposit)).div(new Decimal(this.productSnapshot))
+    return hedgeAvailable
+  }
+}
+
+function hedgeRewardsDecay (supply: number, birthTime: number, timeIn: number, timeOut: number, halfLifeInDays: number): number {
+  const timeInOffsetStart = timeIn - birthTime
+  const timeOutOffsetStart = timeOut - birthTime
+  const halfLife = -1 * Math.log(2) / (halfLifeInDays * 60 * 60 * 24)
+  const awardedTokens = supply * (Math.pow(Math.E, halfLife * timeInOffsetStart) - Math.pow(Math.E, halfLife * timeOutOffsetStart))
+  return awardedTokens
 }

package/src/state/StakingPool.ts

@@ -1,7 +1,7 @@
 
 import { PublicKey } from '@solana/web3.js'
 import Decimal from 'decimal.js'
-import { DecimalFromU128 } from '..'
+import { DecimalFromU128 } from '../HedgeDecimal'
 
 export class StakingPool {
   public publicKey: PublicKey
@@ -14,10 +14,9 @@ export class StakingPool {
   hedgeRewardAccumulator: Decimal
   usdhFeeAccumulator: Decimal
   solFeeAccumulator: Decimal
-  currentRewardsPerDay: Decimal
 
-  constructor (public poolInfo: any, key: PublicKey) {
-    this.publicKey = key
+  constructor (public poolInfo: any, publicKey: PublicKey) {
+    this.publicKey = publicKey
     this.deposits = poolInfo.deposits.toNumber()
     // this.totalFeesNow = poolInfo.totalFeesNow.toNumber()
     // this.totalFeesPrevious = poolInfo.totalFeesPrevious.toNumber()
@@ -29,7 +28,7 @@ export class StakingPool {
     this.hedgeRewardAccumulator = DecimalFromU128(poolInfo.hedgeRewardAccumulator)
     this.usdhFeeAccumulator = DecimalFromU128(poolInfo.usdhFeeAccumulator)
     this.solFeeAccumulator = DecimalFromU128(poolInfo.solFeeAccumulator)
-    this.currentRewardsPerDay = DecimalFromU128(poolInfo.currentRewardsPerDay)
+    // this.currentRewardsPerDay = DecimalFromU128(poolInfo.currentRewardsPerDay)
   }
 
 //   updateFeeAccumulator () {

package/src/state/StakingPoolPosition.ts

@@ -1,7 +1,7 @@
 
 import { PublicKey } from '@solana/web3.js'
 import Decimal from 'decimal.js'
-import { DecimalFromU128 } from '..'
+import { DecimalFromU128 } from '../HedgeDecimal'
 import { StakingPool } from './StakingPool'
 
 export class StakingPoolPosition {
@@ -33,8 +33,7 @@ export class StakingPoolPosition {
     this.open = poolPositionInfo.state.open !== undefined
   }
 
-//   getCurrentUsdhFeeReward () {
-//     const feesAccured = (this.pool.usdhFeeAccumulator - this.startUsdhFeeAccumulator) * this.deposited
-//     return feesAccured
-//   }
+  public getCurrentUsdhFeeReward (): Decimal {
+    return this.pool.usdhFeeAccumulator.minus(this.startUsdhFeeAccumulator).times(new Decimal(this.deposited))
+  }
 }

package/src/state/VaultAccount.ts

@@ -34,7 +34,6 @@ export class VaultAccount {
     this.deposited = vault.deposited.toNumber()
     this.minCollateralRatio = DecimalFromU128(vault.minCollateralRatio)
     this.liquidationPrice = vault.liquidationPrice.toNumber()
-    this.minCollateralRatio = vault.minCollateralRatio.toNumber()
     this.vaultStatus = Object.keys(vault.vaultStatus)[0]
   }
 

package/src/state/VaultHistoryEvent.ts

@@ -1,7 +1,7 @@
 
 import { PublicKey } from '@solana/web3.js'
 import Decimal from 'decimal.js'
-import { DecimalFromU128 } from '..'
+import { DecimalFromU128 } from '../HedgeDecimal'
 
 export class VaultHistoryEvent {
   publicKey: PublicKey

package/src/types/buffer-layout/index.d.ts

@@ -0,0 +1,88 @@
+
+declare module 'buffer-layout' {
+  // TODO: remove `any`.
+  export class Layout<T = any> {
+    span: number
+    property?: string
+
+    constructor (span: number, property?: string);
+
+    decode (b: Buffer | string, offset?: number): T;
+    encode (src: T, b: Buffer, offset?: number): number;
+    getSpan (b: Buffer, offset?: number): number;
+    replicate (name: string): this;
+  }
+  // TODO: remove any.
+  export class Structure<T = any> extends Layout<T> {
+    span: any
+  }
+  export function greedy (
+    elementSpan?: number,
+    property?: string,
+  ): Layout<number>
+  export function offset<T> (
+    layout: Layout<T>,
+    offset?: number,
+    property?: string,
+  ): Layout<T>
+  export function u8 (property?: string): Layout<number>
+  export function u16 (property?: string): Layout<number>
+  export function u24 (property?: string): Layout<number>
+  export function u32 (property?: string): Layout<number>
+  export function u40 (property?: string): Layout<number>
+  export function u48 (property?: string): Layout<number>
+  export function nu64 (property?: string): Layout<number>
+  export function u16be (property?: string): Layout<number>
+  export function u24be (property?: string): Layout<number>
+  export function u32be (property?: string): Layout<number>
+  export function u40be (property?: string): Layout<number>
+  export function u48be (property?: string): Layout<number>
+  export function nu64be (property?: string): Layout<number>
+  export function s8 (property?: string): Layout<number>
+  export function s16 (property?: string): Layout<number>
+  export function s24 (property?: string): Layout<number>
+  export function s32 (property?: string): Layout<number>
+  export function s40 (property?: string): Layout<number>
+  export function s48 (property?: string): Layout<number>
+  export function ns64 (property?: string): Layout<number>
+  export function s16be (property?: string): Layout<number>
+  export function s24be (property?: string): Layout<number>
+  export function s32be (property?: string): Layout<number>
+  export function s40be (property?: string): Layout<number>
+  export function s48be (property?: string): Layout<number>
+  export function ns64be (property?: string): Layout<number>
+  export function f32 (property?: string): Layout<number>
+  export function f32be (property?: string): Layout<number>
+  export function f64 (property?: string): Layout<number>
+  export function f64be (property?: string): Layout<number>
+  export function struct<T> (
+    fields: Array<Layout<any>>,
+    property?: string,
+    decodePrefixes?: boolean,
+  ): Layout<T>
+  export function bits (
+    word: Layout<number>,
+    msb?: boolean,
+    property?: string,
+  ): any
+  export function seq<T> (
+    elementLayout: Layout<T>,
+    count: number | Layout<number>,
+    property?: string,
+  ): Layout<T[]>
+  export function union (
+    discr: Layout<any>,
+    defaultLayout?: any,
+    property?: string,
+  ): any
+  export function unionLayoutDiscriminator (
+    layout: Layout<any>,
+    property?: string,
+  ): any
+  export function blob (
+    length: number | Layout<number>,
+    property?: string,
+  ): Layout<Buffer>
+  export function cstr (property?: string): Layout<string>
+  export function utf8 (maxSpan: number, property?: string): Layout<string>
+}

package/src/utils/Errors.ts

@@ -0,0 +1,11 @@
+import { parseIdlErrors, ProgramError } from '@project-serum/anchor'
+import { vaultIdl } from '../idl/idl'
+
+export function parseAnchorErrors (error: any): void {
+  const idlErrors = parseIdlErrors(vaultIdl)
+  const parsedError = ProgramError.parse(error, idlErrors)
+  if (parsedError !== null) {
+    throw parsedError
+  }
+  throw error
+}

package/typedoc.json

@@ -2,6 +2,5 @@
   "entryPoints": ["src/index.ts"],
   "excludeInternal": true,
   "excludePrivate": true,
-  "out": "doc",
-  "externalPattern": "./node_modules/**"
+  "out": "doc"
 }