hedge-web3 0.2.22 → 0.2.24

package/declarations/index.d.ts

@@ -1,34 +1,39 @@
-export * from './instructions/createStakingPool';
-export * from './instructions/depositStakingPool';
-export * from './instructions/withdrawStakingPool';
-export * from './instructions/claimStakingPoolPosition';
-export * from './instructions/depositLiquidationPool';
-export * from './instructions/closeLiquidationPoolPosition';
+export * from './Constants';
+export * from './HedgeDecimal';
+export * from './idl/vault';
 export * from './instructions/claimLiquidationPoolPosition';
+export * from './instructions/claimStakingPoolPosition';
 export * from './instructions/closeClaimedLiquidationPoolPosition';
+export * from './instructions/closeLiquidationPoolPosition';
+export * from './instructions/createReferralAccount';
+export * from './instructions/createStakingPool';
+export * from './instructions/createUserReferralAccount';
 export * from './instructions/createVault';
-export * from './instructions/psmMintUsh';
-export * from './instructions/psmRedeemUsh';
+export * from './instructions/depositLiquidationPool';
+export * from './instructions/depositStakingPool';
 export * from './instructions/depositVault';
-export * from './instructions/withdrawVault';
+export * from './instructions/initHedgeFoundation';
+export * from './instructions/initHedgeFoundationTokens';
+export * from './instructions/liquidateVault';
 export * from './instructions/loanVault';
-export * from './instructions/repayVault';
+export * from './instructions/psmMintUsh';
+export * from './instructions/psmRedeemUsh';
 export * from './instructions/redeemVault';
-export * from './instructions/liquidateVault';
+export * from './instructions/referralClaimFees';
 export * from './instructions/refreshOraclePrice';
-export * from './instructions/initHedgeFoundation';
-export * from './instructions/initHedgeFoundationTokens';
+export * from './instructions/repayVault';
 export * from './instructions/setHalted';
-export * from './instructions/updateVaultType';
 export * from './instructions/transferVault';
-export * from './HedgeDecimal';
-export * from './Constants';
-export * from './state/VaultAccount';
-export * from './state/VaultHistoryEvent';
-export * from './state/StakingPool';
-export * from './state/StakingPoolPosition';
+export * from './instructions/updateReferralAccount';
+export * from './instructions/updateReferralState';
+export * from './instructions/updateVaultType';
+export * from './instructions/withdrawStakingPool';
+export * from './instructions/withdrawVault';
 export * from './state/LiquidationPoolEra';
 export * from './state/LiquidationPoolState';
 export * from './state/LiquidationPosition';
+export * from './state/StakingPool';
+export * from './state/StakingPoolPosition';
+export * from './state/VaultAccount';
+export * from './state/VaultHistoryEvent';
 export * from './utils/getLinkedListAccounts';
-export * from './idl/vault';

package/declarations/instructions/closeLiquidationPoolPosition.d.ts

@@ -1,5 +1,5 @@
 import { Program, Provider } from '@project-serum/anchor';
 import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
 import { Vault } from '../idl/vault';
-export declare function closeLiquidationPoolPosition(program: Program<Vault>, provider: Provider, poolPosition: PublicKey, payer: Signer, overrideStartTime?: number): Promise<PublicKey>;
-export declare function closeLiquidationPoolPositionInstruction(program: Program<Vault>, poolEra: PublicKey, poolPosition: PublicKey, payerPublicKey: PublicKey, payerUshAccount: PublicKey, payerAssociatedHedgeAccount: PublicKey, communityAssociatedHedgeTokenAccount: PublicKey, overrideStartTime?: number): Promise<TransactionInstruction>;
+export declare function closeLiquidationPoolPosition(program: Program<Vault>, provider: Provider, poolPosition: PublicKey, payer: Signer, overrideStartTime?: number, referrer?: PublicKey): Promise<PublicKey>;
+export declare function closeLiquidationPoolPositionInstruction(program: Program<Vault>, poolEra: PublicKey, poolPosition: PublicKey, payerPublicKey: PublicKey, payerUshAccount: PublicKey, payerAssociatedHedgeAccount: PublicKey, communityAssociatedHedgeTokenAccount: PublicKey, userReferralAccountPublicKey: PublicKey, referralAccountPublicKey: PublicKey, referralStatePublicKey: PublicKey, overrideStartTime?: number): Promise<TransactionInstruction>;

package/declarations/instructions/createReferralAccount.d.ts

@@ -0,0 +1,17 @@
+import { Program, Provider } from '@project-serum/anchor';
+import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
+import { Vault } from '../idl/vault';
+/** @type {Function}  - Creates a new referral account.
+ * This checks the user has enough HDG in their wallet or staked and
+ * then allows them to create a referral account. 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
+ * - overrideTime?: number
+*/
+export declare function createReferralAccount(program: Program<Vault>, provider: Provider, payer: Signer, poolPosition: PublicKey, overrideTime?: number): Promise<PublicKey>;
+export declare function createReferralAccountInstruction(program: Program<Vault>, payerPublicKey: PublicKey, poolPositionPublicKey: PublicKey, referralAccountPublicKey: PublicKey, referralStatePublicKey: PublicKey, hedgeMintPublicKey: PublicKey, hdgAssociatedTokenAccountPublicKey: PublicKey, userReferralAccountPublicKey: PublicKey, overrideTime?: number): Promise<TransactionInstruction>;

package/declarations/instructions/createUserReferralAccount.d.ts

@@ -0,0 +1,5 @@
+import { Program, Provider } from '@project-serum/anchor';
+import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
+import { Vault } from '../idl/vault';
+export declare function createUserReferralAccount(program: Program<Vault>, provider: Provider, payer: Signer, referrer?: PublicKey, overrideTime?: number): Promise<PublicKey>;
+export declare function createUserReferralAccountInstruction(program: Program<Vault>, payerPublicKey: PublicKey, referralAccount: PublicKey, userReferralAccount: PublicKey, overrideTime?: number): Promise<TransactionInstruction>;

package/declarations/instructions/depositLiquidationPool.d.ts

@@ -2,5 +2,5 @@
 import { BN, Program, Provider } from '@project-serum/anchor';
 import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
 import { Vault } from '../idl/vault';
-export declare function depositLiquidationPool(program: Program<Vault>, provider: Provider, payer: Signer, depositAmount: BN, overrideStartTime?: number): Promise<PublicKey>;
-export declare function depositLiquidationPoolInstruction(program: Program<Vault>, payerPublicKey: PublicKey, payerUshAccount: PublicKey, poolPositionPublicKey: PublicKey, depositAmount: BN, overrideStartTime?: number): Promise<TransactionInstruction>;
+export declare function depositLiquidationPool(program: Program<Vault>, provider: Provider, payer: Signer, depositAmount: BN, overrideStartTime?: number, referrer?: PublicKey): Promise<PublicKey>;
+export declare function depositLiquidationPoolInstruction(program: Program<Vault>, payerPublicKey: PublicKey, vaultSystemStatePublicKey: PublicKey, payerUshAccount: PublicKey, poolPositionPublicKey: PublicKey, depositAmount: BN, userReferralAccountPublicKey: PublicKey, referralAccountPublicKey: PublicKey, overrideStartTime?: number): Promise<TransactionInstruction>;

package/declarations/instructions/loanVault.d.ts

@@ -2,5 +2,5 @@
 import { BN, Program, Provider } from '@project-serum/anchor';
 import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
 import { Vault } from '../idl/vault';
-export declare function loanVault(program: Program<Vault>, provider: Provider, payer: Signer, vaultPublicKey: PublicKey, loanAmount: number, overrideTime?: number): Promise<PublicKey>;
-export declare function loanVaultInstruction(program: Program<Vault>, payerPublicKey: PublicKey, ownerUshAccount: PublicKey, vaultPublickey: PublicKey, vaultAssociatedTokenAccount: PublicKey, historyPublicKey: PublicKey, vaultTypeAccount: PublicKey, vaultTypeAssociatedTokenAccount: PublicKey, oldSmallerPublicKey: PublicKey, newSmallerPublicKey: PublicKey, newLargerPublicKey: PublicKey, loanAmount: BN, overrideTime?: number): Promise<TransactionInstruction>;
+export declare function loanVault(program: Program<Vault>, provider: Provider, payer: Signer, vaultPublicKey: PublicKey, loanAmount: number, overrideTime?: number, referrer?: PublicKey): Promise<PublicKey>;
+export declare function loanVaultInstruction(program: Program<Vault>, payerPublicKey: PublicKey, ownerUshAccount: PublicKey, vaultPublickey: PublicKey, vaultAssociatedTokenAccount: PublicKey, historyPublicKey: PublicKey, vaultTypeAccount: PublicKey, vaultTypeAssociatedTokenAccount: PublicKey, oldSmallerPublicKey: PublicKey, newSmallerPublicKey: PublicKey, newLargerPublicKey: PublicKey, loanAmount: BN, referralAccountPublicKey: PublicKey, overrideTime?: number): Promise<TransactionInstruction>;

package/declarations/instructions/psmEditAccount.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="bn.js" />
+import { BN, Program, Provider } from '@project-serum/anchor';
+import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
+import { Vault } from '../idl/vault';
+export declare enum psmStatus {
+    PsmEnabled = 0,
+    PsmDisabled = 1,
+    MintOnly = 2,
+    RedeemOnly = 3
+}
+export declare function psmEditAccount(program: Program<Vault>, provider: Provider, payer: Signer, collateralMint: PublicKey, mintFee: number, redeemFee: number, debtLimit: number, minSwap: number, overrideTime?: number): Promise<PublicKey>;
+export declare function psmEditAccountInstruction(program: Program<Vault>, payerPublicKey: PublicKey, psmAccount: PublicKey, collateralMint: PublicKey, mintFee: BN, redeemFee: BN, debtLimit: BN, minSwap: BN, overrideTime?: number): Promise<TransactionInstruction>;

package/declarations/instructions/psmMintUsh.d.ts

@@ -2,5 +2,5 @@
 import { BN, Program, Provider } from '@project-serum/anchor';
 import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
 import { Vault } from '../idl/vault';
-export declare function psmMintUsh(program: Program<Vault>, provider: Provider, payer: Signer, collateralMint: PublicKey, collateralAmount: number, overrideTime?: number): Promise<PublicKey>;
-export declare function psmMintUshInstruction(program: Program<Vault>, payerPublicKey: PublicKey, psmAccount: PublicKey, collateralMint: PublicKey, collateralAmount: BN, overrideTime?: number): Promise<TransactionInstruction>;
+export declare function psmMintUsh(program: Program<Vault>, provider: Provider, payer: Signer, collateralMint: PublicKey, collateralAmount: number, overrideTime?: number, referrer?: PublicKey): Promise<PublicKey>;
+export declare function psmMintUshInstruction(program: Program<Vault>, payerPublicKey: PublicKey, psmAccount: PublicKey, collateralMint: PublicKey, collateralAmount: BN, referralStatePublicKey: PublicKey, referralAccountPublicKey: PublicKey, overrideTime?: number): Promise<TransactionInstruction>;

package/declarations/instructions/psmRedeemUsh.d.ts

@@ -2,5 +2,5 @@
 import { BN, Program, Provider } from '@project-serum/anchor';
 import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
 import { Vault } from '../idl/vault';
-export declare function psmRedeemUsh(program: Program<Vault>, provider: Provider, payer: Signer, collateralMint: PublicKey, ushAmount: number, overrideTime?: number): Promise<PublicKey>;
-export declare function psmRedeemUshInstruction(program: Program<Vault>, payerPublicKey: PublicKey, psmAccount: PublicKey, collateralMint: PublicKey, ushAmount: BN, overrideTime?: number): Promise<TransactionInstruction>;
+export declare function psmRedeemUsh(program: Program<Vault>, provider: Provider, payer: Signer, collateralMint: PublicKey, ushAmount: number, overrideTime?: number, referrer?: PublicKey): Promise<PublicKey>;
+export declare function psmRedeemUshInstruction(program: Program<Vault>, payerPublicKey: PublicKey, psmAccount: PublicKey, collateralMint: PublicKey, ushAmount: BN, referralStatePublicKey: PublicKey, referralAccountPublicKey: PublicKey, overrideTime?: number): Promise<TransactionInstruction>;

package/declarations/instructions/referralClaimFees.d.ts

@@ -0,0 +1,16 @@
+import { Program, Provider } from '@project-serum/anchor';
+import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
+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 declare function referralClaimFees(program: Program<Vault>, provider: Provider, payer: Signer, poolPosition: PublicKey): Promise<PublicKey>;
+export declare 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>;

package/declarations/instructions/updateReferralAccount.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="bn.js" />
+import { BN, Program, Provider } from '@project-serum/anchor';
+import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
+import { Vault } from '../idl/vault';
+export interface ReferralAccountConfig {
+    setupCut?: BN;
+    referredUserDiscount?: BN;
+    stabilityCut?: BN;
+    psmCut?: BN;
+    hdgThreshold?: BN;
+}
+export declare function updateReferralAccount(program: Program<Vault>, provider: Provider, payer: Signer, referrer: PublicKey, config: ReferralAccountConfig): Promise<PublicKey>;
+export declare function updateReferralAccountInstruction(program: Program<Vault>, vaultSystemStatePublicKey: PublicKey, referralAccountPublicKey: PublicKey, payerPublicKey: PublicKey, referralAccountConfig: ReferralAccountConfig): Promise<TransactionInstruction>;

package/declarations/instructions/updateReferralState.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="bn.js" />
+import { BN, Program, Provider } from '@project-serum/anchor';
+import { PublicKey, Signer, TransactionInstruction } from '@solana/web3.js';
+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 declare function updateReferralState(program: Program<Vault>, provider: Provider, payer: Signer, config: ReferralStateConfig): Promise<PublicKey>;
+export declare function updateReferralStateInstruction(program: Program<Vault>, vaultSystemStatePublicKey: PublicKey, referralStatePublicKey: PublicKey, payerPublicKey: PublicKey, referralStateConfig: ReferralStateConfig): Promise<TransactionInstruction>;

package/lib/Constants.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findAssociatedTokenAddress = exports.findVaultAddress = exports.getVaultTypeOracleAccountPublicKey = exports.getVaultTypeAccountPublicKey = exports.getPoolPublicKeyForMint = exports.getHedgeMintPublicKey = exports.getVaultSystemStatePublicKey = exports.getUshMintPublicKey = exports.getLiquidationPoolUshAccountPublicKey = exports.getLiquidationPoolStatePublicKey = exports.CHAINLINK_PROGRAM_ID = exports.CHAINLINK_SOL_USD_PUBLICKEY = exports.CHAINLINK_SOL_USD_ID = exports.HEDGE_PROGRAM_PUBLICKEY = exports.HEDGE_PROGRAM_ID = void 0;
+exports.findAssociatedTokenAddress = exports.findVaultAddress = exports.getVaultTypeOracleAccountPublicKey = exports.getVaultTypeAccountPublicKey = exports.getPoolPublicKeyForMint = exports.getHedgeMintPublicKey = exports.getUserReferralAccountPublicKey = exports.getReferralAccountPublicKey = exports.getReferralStatePublicKey = exports.getVaultSystemStatePublicKey = exports.getUshMintPublicKey = exports.getLiquidationPoolUshAccountPublicKey = exports.getLiquidationPoolStatePublicKey = exports.CHAINLINK_PROGRAM_ID = exports.CHAINLINK_SOL_USD_PUBLICKEY = exports.CHAINLINK_SOL_USD_ID = exports.HEDGE_PROGRAM_PUBLICKEY = exports.HEDGE_PROGRAM_ID = void 0;
 const spl_token_1 = require("@solana/spl-token");
 const web3_js_1 = require("@solana/web3.js");
 exports.HEDGE_PROGRAM_ID = 'HedgeEohwU6RqokrvPU4Hb6XKPub8NuKbnPmY7FoMMtN';
@@ -61,6 +61,41 @@ function getVaultSystemStatePublicKey() {
     });
 }
 exports.getVaultSystemStatePublicKey = getVaultSystemStatePublicKey;
+/**
+ *
+ * @returns The Referral State public key
+ */
+function getReferralStatePublicKey() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const [publicKey] = yield web3_js_1.PublicKey.findProgramAddress([enc.encode('ReferralStateV1')], exports.HEDGE_PROGRAM_PUBLICKEY);
+        return publicKey;
+    });
+}
+exports.getReferralStatePublicKey = getReferralStatePublicKey;
+/**
+ *
+ * @returns The Referral State public key based off the owner's public key
+ */
+function getReferralAccountPublicKey(ownerPublicKey) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const strToEncode = ownerPublicKey.toBuffer(); //.substring(0, 28)
+        const [publicKey] = yield web3_js_1.PublicKey.findProgramAddress([enc.encode('refer_acct'), strToEncode], exports.HEDGE_PROGRAM_PUBLICKEY);
+        return publicKey;
+    });
+}
+exports.getReferralAccountPublicKey = getReferralAccountPublicKey;
+/**
+ *
+ * @returns The user referral account public key based off the user's public key
+ */
+function getUserReferralAccountPublicKey(ownerPublicKey) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const strToEncode = ownerPublicKey.toBuffer(); //.substring(0, 28)
+        const [publicKey] = yield web3_js_1.PublicKey.findProgramAddress([enc.encode('user_ref'), strToEncode], exports.HEDGE_PROGRAM_PUBLICKEY);
+        return publicKey;
+    });
+}
+exports.getUserReferralAccountPublicKey = getUserReferralAccountPublicKey;
 /**
  *
  * @returns The HDG mint public key