@quicknode/sdk 2.3.0 → 2.4.1

package/cjs/index.js

@@ -347,6 +347,17 @@ function setupGlobalFetch() {
     }
 }
 
+// Ideally we read directly from package.json, but ran into some packaging issues with that
+const PACKAGE_VERSION = '2.4.1';
+
+// Headers to use in RPC clients
+function getClientHeaders() {
+    const packageVersion = PACKAGE_VERSION ;
+    return {
+        'x-qn-sdk-version': packageVersion,
+    };
+}
+
 const buildQNActions = (config) => {
     return (client) => ({
         ...nftAndTokenActions(client, config),
@@ -355,10 +366,15 @@ const buildQNActions = (config) => {
 class Core {
     constructor({ endpointUrl, chain, config = {} }) {
         setupGlobalFetch();
+        const clientHeaders = getClientHeaders();
         this.endpointUrl = endpointUrl;
         const baseClient = viem.createClient({
             chain: chain || deriveChainFromUrl(endpointUrl),
-            transport: viem.http(this.endpointUrl),
+            transport: viem.http(this.endpointUrl, {
+                fetchOptions: {
+                    headers: clientHeaders,
+                },
+            }),
         }).extend(viem.publicActions);
         const qnClient = baseClient.extend(buildQNActions(config));
         this.client = qnClient;
@@ -368,8 +384,11 @@ class Core {
 // eslint-disable-next-line @nx/enforce-module-boundaries
 class Solana {
     constructor({ endpointUrl }) {
+        const clientHeaders = getClientHeaders();
         this.endpointUrl = endpointUrl;
-        this.connection = new web3_js.Connection(endpointUrl);
+        this.connection = new web3_js.Connection(endpointUrl, {
+            httpHeaders: clientHeaders,
+        });
     }
     /**
      * Sends a transaction with a dynamically generated priority fee based on the current network conditions and compute units needed by the transaction.
@@ -420,7 +439,7 @@ class Solana {
     async fetchEstimatePriorityFees(args = {}) {
         const payload = {
             method: 'qn_estimatePriorityFees',
-            params: args,
+            params: { api_version: 2, ...args },
             id: 1,
             jsonrpc: '2.0',
         };
@@ -442,7 +461,9 @@ class Solana {
     }
     async createDynamicPriorityFeeInstruction(feeType = 'medium') {
         const { result } = await this.fetchEstimatePriorityFees({});
-        const priorityFee = result.per_compute_unit[feeType];
+        const priorityFee = feeType === 'recommended'
+            ? result.recommended
+            : result.per_compute_unit[feeType];
         const priorityFeeInstruction = web3_js.ComputeBudgetProgram.setComputeUnitPrice({
             microLamports: priorityFee,
         });

package/esm/core/core.js

@@ -2,6 +2,7 @@ import { createClient, http, publicActions } from 'viem';
 import { nftAndTokenActions } from './addOns/nftTokenV2/actions.js';
 import { deriveChainFromUrl } from './chains.js';
 import { setupGlobalFetch } from '../lib/helpers/globalFetch.js';
+import { getClientHeaders } from '../lib/helpers/getClientHeaders.js';
 
 const buildQNActions = (config) => {
     return (client) => ({
@@ -11,10 +12,15 @@ const buildQNActions = (config) => {
 class Core {
     constructor({ endpointUrl, chain, config = {} }) {
         setupGlobalFetch();
+        const clientHeaders = getClientHeaders();
         this.endpointUrl = endpointUrl;
         const baseClient = createClient({
             chain: chain || deriveChainFromUrl(endpointUrl),
-            transport: http(this.endpointUrl),
+            transport: http(this.endpointUrl, {
+                fetchOptions: {
+                    headers: clientHeaders,
+                },
+            }),
         }).extend(publicActions);
         const qnClient = baseClient.extend(buildQNActions(config));
         this.client = qnClient;

package/esm/lib/constants.js

@@ -0,0 +1,4 @@
+// Ideally we read directly from package.json, but ran into some packaging issues with that
+const PACKAGE_VERSION = '2.4.1';
+
+export { PACKAGE_VERSION };

package/esm/lib/helpers/getClientHeaders.js

@@ -0,0 +1,11 @@
+import { PACKAGE_VERSION } from '../constants.js';
+
+// Headers to use in RPC clients
+function getClientHeaders() {
+    const packageVersion = PACKAGE_VERSION ;
+    return {
+        'x-qn-sdk-version': packageVersion,
+    };
+}
+
+export { getClientHeaders };

package/esm/solana/index.d.ts

@@ -2,7 +2,7 @@ import * as _solana_web3_js from '@solana/web3.js';
 import { Transaction, PublicKey, Keypair, SendOptions, Connection } from '@solana/web3.js';
 
 type PercentileRangeUnion = '0' | '5' | '10' | '15' | '20' | '25' | '30' | '35' | '40' | '45' | '50' | '55' | '60' | '65' | '70' | '75' | '80' | '85' | '90' | '95' | '100';
-type PriorityFeeLevels = 'low' | 'medium' | 'high' | 'extreme';
+type PriorityFeeLevels = 'low' | 'medium' | 'high' | 'extreme' | 'recommended';
 interface PriorityFeeRequestPayload {
     method: string;
     params: {
@@ -29,12 +29,14 @@ interface PriorityFeeResponseData {
         };
         per_compute_unit: PriorityFeeEstimates;
         per_transaction: PriorityFeeEstimates;
+        recommended: number;
     };
     id: number;
 }
 interface EstimatePriorityFeesParams {
     last_n_blocks?: number;
     account?: string;
+    api_version?: number;
 }
 interface SolanaClientArgs {
     endpointUrl: string;

package/esm/solana/solana.js

@@ -1,10 +1,15 @@
 import { Connection, ComputeBudgetProgram, VersionedTransaction, TransactionMessage, PublicKey } from '@solana/web3.js';
+import 'cross-fetch';
+import { getClientHeaders } from '../lib/helpers/getClientHeaders.js';
 
 // eslint-disable-next-line @nx/enforce-module-boundaries
 class Solana {
     constructor({ endpointUrl }) {
+        const clientHeaders = getClientHeaders();
         this.endpointUrl = endpointUrl;
-        this.connection = new Connection(endpointUrl);
+        this.connection = new Connection(endpointUrl, {
+            httpHeaders: clientHeaders,
+        });
     }
     /**
      * Sends a transaction with a dynamically generated priority fee based on the current network conditions and compute units needed by the transaction.
@@ -55,7 +60,7 @@ class Solana {
     async fetchEstimatePriorityFees(args = {}) {
         const payload = {
             method: 'qn_estimatePriorityFees',
-            params: args,
+            params: { api_version: 2, ...args },
             id: 1,
             jsonrpc: '2.0',
         };
@@ -77,7 +82,9 @@ class Solana {
     }
     async createDynamicPriorityFeeInstruction(feeType = 'medium') {
         const { result } = await this.fetchEstimatePriorityFees({});
-        const priorityFee = result.per_compute_unit[feeType];
+        const priorityFee = feeType === 'recommended'
+            ? result.recommended
+            : result.per_compute_unit[feeType];
         const priorityFeeInstruction = ComputeBudgetProgram.setComputeUnitPrice({
             microLamports: priorityFee,
         });

package/index.d.ts

@@ -561,7 +561,7 @@ declare class Core {
 }
 
 type PercentileRangeUnion = '0' | '5' | '10' | '15' | '20' | '25' | '30' | '35' | '40' | '45' | '50' | '55' | '60' | '65' | '70' | '75' | '80' | '85' | '90' | '95' | '100';
-type PriorityFeeLevels = 'low' | 'medium' | 'high' | 'extreme';
+type PriorityFeeLevels = 'low' | 'medium' | 'high' | 'extreme' | 'recommended';
 interface PriorityFeeRequestPayload {
     method: string;
     params: {
@@ -588,12 +588,14 @@ interface PriorityFeeResponseData {
         };
         per_compute_unit: PriorityFeeEstimates;
         per_transaction: PriorityFeeEstimates;
+        recommended: number;
     };
     id: number;
 }
 interface EstimatePriorityFeesParams {
     last_n_blocks?: number;
     account?: string;
+    api_version?: number;
 }
 interface SolanaClientArgs {
     endpointUrl: string;

package/package.json

@@ -6,7 +6,7 @@
     "directory": "packages/libs/sdk"
   },
   "license": "MIT",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "main": "./cjs/index.js",
   "module": "./esm/index.js",
   "types": "./index.d.ts",