@velocity-exchange/sdk 0.1.0 → 0.2.0

package/lib/browser/tx/whileValidTxSender.js

@@ -60,6 +60,9 @@ class WhileValidTxSender extends baseTxSender_1.BaseTxSender {
     async prepareTx(tx, additionalSigners, opts, preSigned) {
         var _a;
         let latestBlockhash = await this.txHandler.getLatestBlockhashForTransaction();
+        if (!latestBlockhash) {
+            throw new Error('WhileValidTxSender: failed to fetch latest blockhash for transaction');
+        }
         // handle tx
         let signedTx = tx;
         if (!preSigned) {
@@ -72,12 +75,22 @@ class WhileValidTxSender extends baseTxSender_1.BaseTxSender {
             latestBlockhash = tx.SIGNATURE_BLOCK_AND_EXPIRY;
         }
         // handle subclass-specific side effects
-        const txSig = bs58_1.default.encode((signedTx === null || signedTx === void 0 ? void 0 : signedTx.signature) || ((_a = signedTx.signatures[0]) === null || _a === void 0 ? void 0 : _a.signature));
+        const signature = (signedTx === null || signedTx === void 0 ? void 0 : signedTx.signature) || ((_a = signedTx.signatures[0]) === null || _a === void 0 ? void 0 : _a.signature);
+        if (!signature) {
+            throw new Error('WhileValidTxSender: signed transaction is missing a signature');
+        }
+        const txSig = bs58_1.default.encode(signature);
+        if (!latestBlockhash) {
+            throw new Error('WhileValidTxSender: failed to resolve latest blockhash for transaction');
+        }
         this.untilValid.set(txSig, latestBlockhash);
         return signedTx;
     }
     async sendVersionedTransaction(tx, additionalSigners, opts, preSigned) {
         let latestBlockhash = await this.txHandler.getLatestBlockhashForTransaction();
+        if (!latestBlockhash) {
+            throw new Error('WhileValidTxSender: failed to fetch latest blockhash for transaction');
+        }
         let signedTx;
         if (preSigned) {
             signedTx = tx;
@@ -100,17 +113,24 @@ class WhileValidTxSender extends baseTxSender_1.BaseTxSender {
             additionalSigners === null || additionalSigners === void 0 ? void 0 : additionalSigners.filter((s) => s !== undefined).forEach((kp) => {
                 tx.sign([kp]);
             });
-            signedTx = await this.txHandler.signVersionedTx(tx, additionalSigners, latestBlockhash);
+            signedTx = await this.txHandler.signVersionedTx(tx, additionalSigners !== null && additionalSigners !== void 0 ? additionalSigners : [], latestBlockhash);
         }
         if (opts === undefined) {
             opts = this.opts;
         }
-        const txSig = bs58_1.default.encode(signedTx.signatures[0]);
+        const signature = signedTx.signatures[0];
+        if (!signature) {
+            throw new Error('WhileValidTxSender: signed transaction is missing a signature');
+        }
+        const txSig = bs58_1.default.encode(signature);
+        if (!latestBlockhash) {
+            throw new Error('WhileValidTxSender: failed to resolve latest blockhash for transaction');
+        }
         this.untilValid.set(txSig, latestBlockhash);
         return this.sendRawTransaction(signedTx.serialize(), opts);
     }
     async sendRawTransaction(rawTransaction, opts) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c;
         const startTime = this.getTimestamp();
         const txid = await this.connection.sendRawTransaction(rawTransaction, opts);
         (_a = this.txSigCache) === null || _a === void 0 ? void 0 : _a.set(txid, false);
@@ -143,16 +163,18 @@ class WhileValidTxSender extends baseTxSender_1.BaseTxSender {
         try {
             const result = await this.confirmTransaction(txid, opts.commitment);
             (_b = this.txSigCache) === null || _b === void 0 ? void 0 : _b.set(txid, true);
-            await this.checkConfirmationResultForError(txid, result === null || result === void 0 ? void 0 : result.value);
-            if (((_c = result === null || result === void 0 ? void 0 : result.value) === null || _c === void 0 ? void 0 : _c.err) && this.throwOnTransactionError) {
-                // Fallback error handling if there's a problem reporting the error in checkConfirmationResultForError
-                throw new web3_js_1.SendTransactionError({
-                    action: 'send',
-                    signature: txid,
-                    transactionMessage: `Transaction Failed`,
-                });
+            if (result) {
+                await this.checkConfirmationResultForError(txid, result.value);
+                if (((_c = result.value) === null || _c === void 0 ? void 0 : _c.err) && this.throwOnTransactionError) {
+                    // Fallback error handling if there's a problem reporting the error in checkConfirmationResultForError
+                    throw new web3_js_1.SendTransactionError({
+                        action: 'send',
+                        signature: txid,
+                        transactionMessage: `Transaction Failed`,
+                    });
+                }
+                slot = result.context.slot;
             }
-            slot = (_d = result === null || result === void 0 ? void 0 : result.context) === null || _d === void 0 ? void 0 : _d.slot;
             // eslint-disable-next-line no-useless-catch
         }
         catch (e) {

package/lib/browser/types.d.ts

@@ -428,8 +428,8 @@ export declare class SettlePnlMode {
         mustSettle: {};
     };
 }
-export declare function isVariant(object: unknown, type: string): boolean;
-export declare function isOneOfVariant(object: unknown, types: string[]): boolean;
+export declare function isVariant(object: unknown, type: string): any;
+export declare function isOneOfVariant(object: unknown, types: string[]): any;
 export declare function getVariant(object: unknown): string;
 export declare enum TradeSide {
     None = 0,
@@ -720,38 +720,6 @@ export type DeleteUserRecord = {
     subAccountId: number;
     keeper: PublicKey | null;
 };
-export type InsuranceFundSwapRecord = {
-    rebalanceConfig: PublicKey;
-    inIfTotalSharesBefore: BN;
-    outIfTotalSharesBefore: BN;
-    inIfUserSharesBefore: BN;
-    outIfUserSharesBefore: BN;
-    inIfTotalSharesAfter: BN;
-    outIfTotalSharesAfter: BN;
-    inIfUserSharesAfter: BN;
-    outIfUserSharesAfter: BN;
-    ts: BN;
-    inAmount: BN;
-    outAmount: BN;
-    outOraclePrice: BN;
-    outOraclePriceTwap: BN;
-    inVaultAmountBefore: BN;
-    outVaultAmountBefore: BN;
-    inFundVaultAmountAfter: BN;
-    outFundVaultAmountAfter: BN;
-    inMarketIndex: number;
-    outMarketIndex: number;
-};
-export type TransferProtocolIfSharesToRevenuePoolRecord = {
-    ts: BN;
-    marketIndex: number;
-    amount: BN;
-    shares: BN;
-    ifVaultAmountBefore: BN;
-    protocolSharesBefore: BN;
-    protocolSharesAfter: BN;
-    transferAmount: BN;
-};
 export type LPSwapRecord = {
     ts: BN;
     slot: BN;
@@ -833,13 +801,15 @@ export type StateAccount = {
     hotLpCache: PublicKey;
     hotLpSwap: PublicKey;
     hotLpSettle: PublicKey;
-    hotIfRebalance: PublicKey;
     hotFeatureFlag: PublicKey;
     hotFuel: PublicKey;
     hotUserFlag: PublicKey;
     hotVaultDeposit: PublicKey;
     hotMmOracleCrank: PublicKey;
     hotAmmSpreadAdjust: PublicKey;
+    hotFeeWithdraw: PublicKey;
+    protocolFeeRecipientPerp: PublicKey;
+    protocolFeeRecipientSpot: PublicKey;
     exchangeStatus: number;
     whitelistMint: PublicKey;
     discountMint: PublicKey;
@@ -882,8 +852,12 @@ export type PerpMarketAccount = {
     nextFillRecordId: BN;
     nextFundingRateRecordId: BN;
     pnlPool: PoolBalance;
+    protocolFeePool: PoolBalance;
+    feeLedger: FeeLedger;
     liquidatorFee: number;
     ifLiquidationFee: number;
+    protocolLiquidationFee: number;
+    feePoolBufferTarget: BN;
     imfFactor: number;
     unrealizedPnlImfFactor: number;
     unrealizedPnlMaxImbalance: BN;
@@ -921,8 +895,6 @@ export type PerpMarketAccount = {
     quoteBreakEvenAmountShort: BN;
     totalSocialLoss: BN;
     maxOpenInterest: BN;
-    totalExchangeFee: BN;
-    totalLiquidationFee: BN;
     cumulativeFundingRateLong: BN;
     cumulativeFundingRateShort: BN;
     lastFundingRate: BN;
@@ -930,7 +902,6 @@ export type PerpMarketAccount = {
     lastFundingRateShort: BN;
     lastFundingRateTs: BN;
     netUnsettledFundingPnl: BN;
-    lastFundingOracleTwap: BN;
     orderStepSize: BN;
     orderTickSize: BN;
 };
@@ -969,11 +940,13 @@ export type SpotMarketAccount = {
         unstakingPeriod: BN;
         lastRevenueSettleTs: BN;
         revenueSettlePeriod: BN;
-        totalFactor: number;
-        userFactor: number;
+        ifFeeFactor: number;
     };
     revenuePool: PoolBalance;
+    protocolFeePool: PoolBalance;
     ifLiquidationFee: number;
+    protocolLiquidationFee: number;
+    protocolFeeFactor: number;
     decimals: number;
     optimalUtilization: number;
     optimalBorrowRate: number;
@@ -1016,11 +989,20 @@ export type SpotMarketAccount = {
     minBorrowRate: number;
     tokenProgramFlag: number;
     poolId: number;
+    feeAdjustment: number;
 };
 export type PoolBalance = {
     scaledBalance: BN;
     marketIndex: number;
 };
+export type FeeLedger = {
+    totalExchangeFee: BN;
+    totalLiquidationFee: BN;
+    pendingProtocolFee: BN;
+    pendingIfFee: BN;
+    ammProtocolFeesReceived: BN;
+    pendingAmmProvision: BN;
+};
 export type AMM = {
     feePool: PoolBalance;
     baseAssetReserve: BN;
@@ -1049,6 +1031,7 @@ export type AMM = {
     ammSpreadAdjustment: number;
     ammInventorySpreadAdjustment: number;
     referencePriceOffsetDeadbandPct: number;
+    fundingBiasSensitivity: number;
 };
 export type MarketStats = {
     lastMarkPriceTwap: BN;
@@ -1072,6 +1055,7 @@ export type MarketStats = {
     lastOracleNormalisedPrice: BN;
     lastReferencePriceOffset: number;
     lastOracleValid: boolean;
+    lastFundingOracleTwap: BN;
     historicalOracleData: HistoricalOracleData;
 };
 export type PerpPosition = {
@@ -1110,7 +1094,6 @@ export type UserStatsAccount = {
     referrerStatus: number;
     authority: PublicKey;
     ifStakedQuoteAssetAmount: BN;
-    ifStakedGovTokenAmount: BN;
     delegatePermissions: number;
 };
 export type UserAccount = {
@@ -1161,7 +1144,6 @@ export type Order = {
     marketIndex: number;
     price: BN;
     baseAssetAmount: BN;
-    quoteAssetAmount: BN;
     baseAssetAmountFilled: BN;
     quoteAssetAmountFilled: BN;
     direction: PositionDirection;
@@ -1276,7 +1258,7 @@ export type OptionalOrderParams = {
 export type ModifyOrderParams = {
     [Property in keyof OrderParams]?: OrderParams[Property] | null;
 } & {
-    policy?: ModifyOrderPolicy;
+    policy?: ModifyOrderPolicy | null;
 };
 export declare enum ModifyOrderPolicy {
     MustModify = 1,
@@ -1378,7 +1360,8 @@ export type FeeStructure = {
     feeTiers: FeeTier[];
     fillerRewardStructure: OrderFillerRewardStructure;
     flatFillerFee: BN;
-    referrerRewardEpochUpperBound: BN;
+    ammFeeNumerator: number;
+    ifFeeNumerator: number;
 };
 export type FeeTier = {
     feeNumerator: number;
@@ -1486,32 +1469,6 @@ export type SignedTxData = {
     lastValidBlockHeight?: number;
     blockHash: string;
 };
-export type IfRebalanceConfigAccount = {
-    pubkey: PublicKey;
-    totalInAmount: BN;
-    currentInAmount: BN;
-    currentOutAmount: BN;
-    currentOutAmountTransferred: BN;
-    epochStartTs: BN;
-    epochInAmount: BN;
-    epochMaxInAmount: BN;
-    epochDuration: BN;
-    outMarketIndex: number;
-    inMarketIndex: number;
-    maxSlippageBps: number;
-    swapMode: number;
-    status: number;
-};
-export type IfRebalanceConfigParams = {
-    totalInAmount: BN;
-    epochMaxInAmount: BN;
-    epochDuration: BN;
-    outMarketIndex: number;
-    inMarketIndex: number;
-    maxSlippageBps: number;
-    swapMode: number;
-    status: number;
-};
 export interface SignedMsgOrderParams {
     /**
      * The encoded order params that were signed (borsh encoded then hexified).

package/lib/browser/types.js

@@ -290,12 +290,12 @@ exports.SettlePnlMode = SettlePnlMode;
 SettlePnlMode.TRY_SETTLE = { trySettle: {} };
 SettlePnlMode.MUST_SETTLE = { mustSettle: {} };
 function isVariant(object, type) {
-    return object.hasOwnProperty(type);
+    return Object.prototype.hasOwnProperty.call(object, type);
 }
 exports.isVariant = isVariant;
 function isOneOfVariant(object, types) {
     return types.reduce((result, type) => {
-        return result || object.hasOwnProperty(type);
+        return result || Object.prototype.hasOwnProperty.call(object, type);
     }, false);
 }
 exports.isOneOfVariant = isOneOfVariant;

package/lib/browser/user.d.ts

@@ -45,9 +45,21 @@ export declare class User {
      */
     fetchAccounts(): Promise<void>;
     unsubscribe(): Promise<void>;
-    getUserAccount(): UserAccount;
-    forceGetUserAccount(): Promise<UserAccount>;
+    getUserAccount(): UserAccount | undefined;
+    /**
+     * Like {@link getUserAccount} but throws a named error instead of returning
+     * `undefined` when the account has not been loaded yet. Use at call sites
+     * that structurally require a loaded account.
+     */
+    getUserAccountOrThrow(): UserAccount;
+    forceGetUserAccount(): Promise<UserAccount | undefined>;
     getUserAccountAndSlot(): DataAndSlot<UserAccount> | undefined;
+    /**
+     * Like {@link getUserAccountAndSlot} but throws a named error instead of
+     * returning `undefined` when the account has not been loaded yet. Use at
+     * call sites that structurally require a loaded account.
+     */
+    getUserAccountAndSlotOrThrow(): DataAndSlot<UserAccount>;
     getPerpPositionForUserAccount(userAccount: UserAccount, marketIndex: number): PerpPosition | undefined;
     /**
      * Gets the user's current position for a given perp market. If the user has no position returns undefined
@@ -56,6 +68,7 @@ export declare class User {
      */
     getPerpPosition(marketIndex: number): PerpPosition | undefined;
     getPerpPositionOrEmpty(marketIndex: number): PerpPosition;
+    getPerpPositionOrThrow(marketIndex: number): PerpPosition;
     getPerpPositionAndSlot(marketIndex: number): DataAndSlot<PerpPosition | undefined>;
     getSpotPositionForUserAccount(userAccount: UserAccount, marketIndex: number): SpotPosition | undefined;
     /**
@@ -95,7 +108,7 @@ export declare class User {
      */
     getOrderByUserOrderId(userOrderId: number): Order | undefined;
     getOrderByUserOrderIdAndSlot(userOrderId: number): DataAndSlot<Order | undefined>;
-    getOpenOrdersForUserAccount(userAccount?: UserAccount): Order[];
+    getOpenOrdersForUserAccount(userAccount?: UserAccount): Order[] | undefined;
     getOpenOrders(): Order[];
     getOpenOrdersAndSlot(): DataAndSlot<Order[]>;
     getUserAccountPublicKey(): PublicKey;
@@ -110,8 +123,9 @@ export declare class User {
      * calculates Buying Power = free collateral / initial margin ratio
      * @returns : Precision QUOTE_PRECISION
      */
-    getPerpBuyingPower(marketIndex: number, collateralBuffer?: BN, maxMarginRatio?: any, positionType?: 'isolated' | 'cross'): BN;
-    getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex: number, freeCollateral: BN, baseAssetAmount: BN, perpMarketMaxMarginRatio?: any): BN;
+    getPerpBuyingPower(marketIndex: number, collateralBuffer?: BN, maxMarginRatio?: number | undefined, positionType?: 'isolated' | 'cross'): BN;
+    private resolveMaxMarginRatio;
+    getPerpBuyingPowerFromFreeCollateralAndBaseAssetAmount(marketIndex: number, freeCollateral: BN, baseAssetAmount: BN, perpMarketMaxMarginRatio?: number | undefined): BN;
     /**
      * calculates Free Collateral = Total collateral - margin requirement
      * @returns : Precision QUOTE_PRECISION
@@ -216,7 +230,7 @@ export declare class User {
         spotAssetValue: BN;
         spotLiabilityValue: BN;
     }): BN;
-    getLeverageComponents(includeOpenOrders?: boolean, marginCategory?: MarginCategory, perpMarketIndex?: number): {
+    getLeverageComponents(includeOpenOrders?: boolean, marginCategory?: MarginCategory | undefined, perpMarketIndex?: number): {
         perpLiabilityValue: BN;
         perpPnl: BN;
         spotAssetValue: BN;
@@ -315,7 +329,7 @@ export declare class User {
      * @param tradeSide
      * @returns { tradeSize: BN, oppositeSideTradeSize: BN} : Precision QUOTE_PRECISION
      */
-    getMaxTradeSizeUSDCForPerp(targetMarketIndex: number, tradeSide: PositionDirection, maxMarginRatio?: any, positionType?: 'isolated' | 'cross'): {
+    getMaxTradeSizeUSDCForPerp(targetMarketIndex: number, tradeSide: PositionDirection, maxMarginRatio?: number | undefined, positionType?: 'isolated' | 'cross'): {
         tradeSize: BN;
         oppositeSideTradeSize: BN;
     };