hedge-web3 0.2.22 → 0.2.24

package/src/instructions/referralClaimFees.ts

@@ -0,0 +1,159 @@
+import { BN, Idl, Program, Provider } from '@project-serum/anchor'
+import { TokenInstructions } from '@project-serum/serum'
+import { ASSOCIATED_TOKEN_PROGRAM_ID, TOKEN_PROGRAM_ID, getOrCreateAssociatedTokenAccount } from '@solana/spl-token'
+import {
+  Keypair,
+  PublicKey,
+  sendAndConfirmTransaction,
+  Signer,
+  SystemProgram,
+  SYSVAR_RENT_PUBKEY,
+  Transaction,
+  TransactionInstruction,
+} from '@solana/web3.js'
+import {
+  getVaultSystemStatePublicKey,
+  getReferralAccountPublicKey,
+  getHedgeMintPublicKey,
+  getReferralStatePublicKey,
+  getUshMintPublicKey,
+  getPoolPublicKeyForMint
+} from '../Constants'
+
+import { parseAnchorErrors } from '../utils/Errors'
+import sendAndConfirmWithDebug from '../utils/sendAndConfirmWithDebug'
+import { Vault } from '../idl/vault'
+
+
+
+/** @type {Function}  - Allows a referrer to claims their fees.
+ * This checks the user has enough HDG in their wallet or staked and
+ * then allows them to claim earned fees. If they meet the PSM referral threshold,
+ * they will be eligible for PSM cut.
+ * Params:
+ * - program: Program<Vault> : The program instance of Hedge Vault program
+ * - provider: Provider : Current connection
+ * - payer: Signer : who we are creating the referral account for
+ * - poolPublicKey: PublicKey : a key to a pool position. If the position is closed or does not belong to the signer it will be ignored
+ * - referrer: PublicKey
+*/
+export async function referralClaimFees(
+  program: Program<Vault>,
+  provider: Provider,
+  payer: Signer,
+  poolPosition: PublicKey
+): Promise<PublicKey> {
+  // setup transaction  
+  const transaction = new Transaction()
+  const signers = [payer]
+
+  // General variables
+  const vaultSystemStatePublicKey = await getVaultSystemStatePublicKey()
+
+  // Find referrer account
+  const referrer = await payer.publicKey
+  const referralAccountPublicKey = await getReferralAccountPublicKey(referrer)
+
+
+  // Derive the user referral account public key
+  const referallStatePublicKey = await getReferralStatePublicKey()
+
+  const hedgeMintPublicKey = await getHedgeMintPublicKey()
+  
+  // Get HDG account of signer
+  const payerHdgAssociatedTokenAccount = await getOrCreateAssociatedTokenAccount(
+    provider.connection,
+    payer,
+    hedgeMintPublicKey,
+    payer.publicKey
+  )
+
+  const ushMintPublicKey = await getUshMintPublicKey()
+
+  // Get USH account of signer
+  const payerUshAssociatedTokenAccount = await getOrCreateAssociatedTokenAccount(
+    provider.connection,
+    payer,
+    ushMintPublicKey,
+    payer.publicKey
+  )
+
+  // Get community_associated_hedge_token_account
+  const communityAssociatedHedgeTokenAccount = await getOrCreateAssociatedTokenAccount(
+    provider.connection,
+    payer,
+    hedgeMintPublicKey,
+    vaultSystemStatePublicKey,
+    true
+  )
+
+  const [feePoolPublicKey] = await getPoolPublicKeyForMint(hedgeMintPublicKey)
+  
+  const feePoolAssociatedUshTokenAccount = await getOrCreateAssociatedTokenAccount(
+    provider.connection,
+    payer,
+    ushMintPublicKey,
+    feePoolPublicKey,
+    true
+  )
+  transaction.add(
+    await referralClaimFeesInstruction(
+      program,
+      payer.publicKey,
+      vaultSystemStatePublicKey,
+      poolPosition,
+      referralAccountPublicKey,
+      referallStatePublicKey,
+      hedgeMintPublicKey,
+      payerHdgAssociatedTokenAccount.address,
+      ushMintPublicKey,
+      payerUshAssociatedTokenAccount.address,
+      communityAssociatedHedgeTokenAccount.address,
+      feePoolPublicKey,
+      feePoolAssociatedUshTokenAccount.address
+    )
+  )
+
+
+  await sendAndConfirmWithDebug(provider.connection, transaction, signers).catch(parseAnchorErrors)
+  return referralAccountPublicKey
+}
+
+
+export async function referralClaimFeesInstruction(
+  program: Program<Vault>,
+  payerPublicKey: PublicKey,
+  vaultSystemStatePublicKey: PublicKey,
+  poolPositionPublicKey: PublicKey,
+  referralAccountPublicKey: PublicKey,
+  referralStatePublicKey: PublicKey,
+  hedgeMintPublicKey: PublicKey,
+  hdgAssociatedTokenAccountPublicKey: PublicKey,
+  ushMintPublicKey: PublicKey,
+  ushAssociatedTokenAccountPublicKey: PublicKey,
+  communityAssociatedHedgeTokenAccountPublicKey: PublicKey,
+  feePoolPublicKey: PublicKey,
+  feePoolAssociatedUshTokenAccountPublicKey: PublicKey
+): Promise<TransactionInstruction> {
+
+  return await program.methods
+    .referralClaimFees()
+    .accounts({
+      signer: payerPublicKey,
+      vaultSystemState: vaultSystemStatePublicKey,
+      referralState: referralStatePublicKey,
+      referralAccount: referralAccountPublicKey,
+      poolPosition: poolPositionPublicKey,
+      hedgeMint: hedgeMintPublicKey,
+      signerHdgAta: hdgAssociatedTokenAccountPublicKey,
+      ushMint: ushMintPublicKey,
+      signerUshAta: ushAssociatedTokenAccountPublicKey,
+      communityAssociatedHedgeTokenAccount: communityAssociatedHedgeTokenAccountPublicKey,
+      feePool: feePoolPublicKey,
+      feePoolAssociatedUshTokenAccount: feePoolAssociatedUshTokenAccountPublicKey,
+      systemProgram: SystemProgram.programId,
+      tokenProgram: TOKEN_PROGRAM_ID,
+      rent: SYSVAR_RENT_PUBKEY,
+    })
+    .instruction()
+}

package/src/instructions/updateReferralAccount.ts

@@ -0,0 +1,77 @@
+import { BN, Program, Provider } from '@project-serum/anchor'
+import {
+  Keypair,
+  PublicKey,
+  sendAndConfirmTransaction,
+  Signer,
+  SystemProgram,
+  SYSVAR_RENT_PUBKEY,
+  Transaction,
+  TransactionInstruction,
+} from '@solana/web3.js'
+import {
+  getVaultSystemStatePublicKey,
+  getReferralAccountPublicKey,
+} from '../Constants'
+
+import { parseAnchorErrors } from '../utils/Errors'
+import sendAndConfirmWithDebug from '../utils/sendAndConfirmWithDebug'
+import { Vault } from '../idl/vault'
+
+export interface ReferralAccountConfig {
+  setupCut?: BN
+  referredUserDiscount?: BN
+  stabilityCut?: BN
+  psmCut?: BN
+
+  hdgThreshold?: BN
+}
+
+export async function updateReferralAccount(
+  program: Program<Vault>,
+  provider: Provider,
+  payer: Signer,
+  referrer: PublicKey,
+  config: ReferralAccountConfig
+): Promise<PublicKey> {
+  const vaultSystemStatePublicKey = await getVaultSystemStatePublicKey()
+  const referralAccountPublicKey = await getReferralAccountPublicKey(referrer)
+  const transaction = new Transaction().add(
+    await updateReferralAccountInstruction(
+      program,
+      vaultSystemStatePublicKey,
+      referralAccountPublicKey,
+      payer.publicKey,
+      config
+    )
+  )
+
+  await sendAndConfirmWithDebug(provider.connection, transaction, [payer])
+  return referralAccountPublicKey
+}
+
+export async function updateReferralAccountInstruction(
+  program: Program<Vault>,
+  vaultSystemStatePublicKey: PublicKey,
+  referralAccountPublicKey: PublicKey,
+  payerPublicKey: PublicKey,
+  referralAccountConfig: ReferralAccountConfig
+): Promise<TransactionInstruction> {
+  const config = {
+    setupCut: referralAccountConfig.setupCut ?? null,
+    stabilityCut: referralAccountConfig.stabilityCut ?? null,
+    referredUserDiscount: referralAccountConfig.referredUserDiscount ?? null,
+    psmCut: referralAccountConfig.psmCut ?? null,
+    hdgThreshold: referralAccountConfig.hdgThreshold ?? null,
+  }
+
+  return await program.methods
+    .updateReferralAccount(config)
+    .accounts({
+      signer: payerPublicKey,
+      vaultSystemState: vaultSystemStatePublicKey,
+      referralAccount: referralAccountPublicKey,
+      systemProgram: SystemProgram.programId,
+    })
+    .instruction()
+}

package/src/instructions/updateReferralState.ts

@@ -0,0 +1,93 @@
+import { BN, Program, Provider } from '@project-serum/anchor'
+import {
+  Keypair,
+  PublicKey,
+  sendAndConfirmTransaction,
+  Signer,
+  SystemProgram,
+  SYSVAR_RENT_PUBKEY,
+  Transaction,
+  TransactionInstruction,
+} from '@solana/web3.js'
+import {
+  getVaultSystemStatePublicKey,
+  getReferralStatePublicKey,
+} from '../Constants'
+
+import { parseAnchorErrors } from '../utils/Errors'
+import sendAndConfirmWithDebug from '../utils/sendAndConfirmWithDebug'
+import { Vault } from '../idl/vault'
+
+export interface ReferralStateConfig {
+  setupCut?: BN
+  referredUserDiscount?: BN
+  stabilityCut?: BN
+  psmCut?: BN
+
+  maxSetupCut?: BN
+  maxReferredDiscount?: BN
+  maxStabilityCut?: BN
+  maxPsmCut?: BN
+
+  hdgThreshold?: BN
+  hdgPsmThreshold?: BN
+
+  referralThreshold?: BN
+
+  referralEnabled?: boolean
+}
+
+export async function updateReferralState(
+  program: Program<Vault>,
+  provider: Provider,
+  payer: Signer,
+  config: ReferralStateConfig
+): Promise<PublicKey> {
+  const vaultSystemStatePublicKey = await getVaultSystemStatePublicKey()
+  const referralStatePublicKey = await getReferralStatePublicKey()
+  const transaction = new Transaction().add(
+    await updateReferralStateInstruction(
+      program,
+      vaultSystemStatePublicKey,
+      referralStatePublicKey,
+      payer.publicKey,
+      config
+    )
+  )
+
+  await sendAndConfirmWithDebug(provider.connection, transaction, [payer])
+  return referralStatePublicKey
+}
+
+export async function updateReferralStateInstruction(
+  program: Program<Vault>,
+  vaultSystemStatePublicKey: PublicKey,
+  referralStatePublicKey: PublicKey,
+  payerPublicKey: PublicKey,
+  referralStateConfig: ReferralStateConfig
+): Promise<TransactionInstruction> {
+  const config = {
+    setupCut: referralStateConfig.setupCut ?? null,
+    stabilityCut: referralStateConfig.stabilityCut ?? null,
+    referredUserDiscount: referralStateConfig.referredUserDiscount ?? null,
+    psmCut: referralStateConfig.psmCut ?? null,
+    maxSetupCut: referralStateConfig.maxSetupCut ?? null,
+    maxReferredDiscount: referralStateConfig.maxReferredDiscount ?? null,
+    maxStabilityCut: referralStateConfig.maxStabilityCut ?? null,
+    maxPsmCut: referralStateConfig.maxPsmCut ?? null,
+    hdgThreshold: referralStateConfig.hdgThreshold ?? null,
+    hdgPsmThreshold: referralStateConfig.hdgPsmThreshold ?? null,
+    referralPromoThreshold: referralStateConfig.referralThreshold ?? null,
+    referralEnabled: referralStateConfig.referralEnabled ?? null,
+  }
+
+  return await program.methods
+    .updateReferralState(config)
+    .accounts({
+      signer: payerPublicKey,
+      vaultSystemState: vaultSystemStatePublicKey,
+      referralState: referralStatePublicKey,
+      systemProgram: SystemProgram.programId,
+    })
+    .instruction()
+}