@hawksightco/hawk-sdk 1.3.276 → 1.3.277

package/dist/classes/CreateTxMetadata.d.ts

@@ -1,6 +1,12 @@
 import * as web3 from "@solana/web3.js";
 import { TransactionMetadata, TransactionMetadataWithActions, TransactionMetadataResponse, TransactionMetadataResponse2 } from "../types";
 import { GeneralUtility } from "./GeneralUtility";
+/**
+ * Where the blockhash baked into a transaction at construction time comes from.
+ * Either a value or a function producing one, mirroring how callers hand a blockhash
+ * to `addPriorityFeeIx`.
+ */
+export type ConstructionBlockhashSource = web3.BlockhashWithExpiryBlockHeight | (() => Promise<web3.BlockhashWithExpiryBlockHeight> | web3.BlockhashWithExpiryBlockHeight);
 /**
  * The CreateTxMetadata class is responsible for creating and managing transaction metadata,
  * including handling address lookup tables and constructing transactions with the necessary parameters.
@@ -8,12 +14,34 @@ import { GeneralUtility } from "./GeneralUtility";
 export declare class CreateTxMetadata {
     private constructor();
     private connection?;
+    /**
+     * A blockhash that is valid to compile against but not to land against. Callers that
+     * have proven every path overwrites the construction blockhash before signing can hand
+     * this over and save one foreground getLatestBlockhash per transaction built (H-2582).
+     * Same value `toVersionedTransaction` and `Transaction.simulateTransaction` compile with.
+     */
+    static readonly PLACEHOLDER_BLOCKHASH: web3.BlockhashWithExpiryBlockHeight;
+    private constructionBlockhash?;
     /**
      * Sets the connection to the Solana blockchain.
      *
      * @param connection - The Solana blockchain connection object.
      */
     setConnection(connection: web3.Connection): void;
+    /**
+     * Overrides where the blockhash baked in at construction comes from. Left unset (the
+     * default) one is fetched per transaction built, which every transaction the SDK builds
+     * needs since `Transaction`'s constructor compiles a versioned transaction.
+     *
+     * @param source - A blockhash, a function producing one, or undefined to fetch.
+     */
+    setConstructionBlockhash(source?: ConstructionBlockhashSource): void;
+    /**
+     * Resolves the blockhash to construct a transaction with.
+     *
+     * @param connection - The Solana blockchain connection object, used only when no source is set.
+     */
+    private resolveConstructionBlockhash;
     private static _instance;
     /**
      * Gets the singleton instance of the CreateTxMetadata class.

package/dist/classes/CreateTxMetadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CreateTxMetadata.d.ts","sourceRoot":"","sources":["../../src/classes/CreateTxMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,8BAA8B,EAAE,2BAA2B,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAE1I,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAIlD;;;GAGG;AACH,qBAAa,gBAAgB;IAE3B,OAAO;IAEP,OAAO,CAAC,UAAU,CAAC,CAAkB;IAErC;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU;IAEzC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAmB;IAE3C;;;;OAIG;IACH,MAAM,CAAC,QAAQ,IAAI,gBAAgB;IAOnC,OAAO,CAAC,IAAI,CAaV;IAEF;;OAEG;IACG,IAAI;IAIV;;OAEG;IACG,UAAU;IAUhB;;;;;;;OAOG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC;IAcvG;;;;;OAKG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAIzE;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,yBAAyB;IAI7D;;;;;;OAMG;IACG,WAAW,CACf,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,CAAC;IA8B5C;;;;;;;;;;;;;;;OAeG;IACG,gBAAgB,CACpB,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,2BAA2B,GAChC,OAAO,CAAC,mBAAmB,CAAC;IAoE/B;;;;;;;;;;;;;;;OAeG;IACG,2BAA2B,CAC/B,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,8BAA8B,CAAC;IA6EpC,iBAAiB,CACrB,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,2BAA2B,GAChC,OAAO,CAAC,mBAAmB,EAAE,CAAC;CA0ElC"}
+{"version":3,"file":"CreateTxMetadata.d.ts","sourceRoot":"","sources":["../../src/classes/CreateTxMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,8BAA8B,EAAE,2BAA2B,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAE1I,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAIlD;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GACnC,IAAI,CAAC,8BAA8B,GACnC,CAAC,MACG,OAAO,CAAC,IAAI,CAAC,8BAA8B,CAAC,GAC5C,IAAI,CAAC,8BAA8B,CAAC,CAAC;AAE7C;;;GAGG;AACH,qBAAa,gBAAgB;IAE3B,OAAO;IAEP,OAAO,CAAC,UAAU,CAAC,CAAkB;IAErC;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,IAAI,CAAC,8BAA8B,CAGxE;IAEF,OAAO,CAAC,qBAAqB,CAAC,CAA8B;IAE5D;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU;IAEzC;;;;;;OAMG;IACH,wBAAwB,CAAC,MAAM,CAAC,EAAE,2BAA2B;IAI7D;;;;OAIG;YACW,4BAA4B;IAW1C,OAAO,CAAC,MAAM,CAAC,SAAS,CAAmB;IAE3C;;;;OAIG;IACH,MAAM,CAAC,QAAQ,IAAI,gBAAgB;IAOnC,OAAO,CAAC,IAAI,CAaV;IAEF;;OAEG;IACG,IAAI;IAIV;;OAEG;IACG,UAAU;IAUhB;;;;;;;OAOG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC;IAcvG;;;;;OAKG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAIzE;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,yBAAyB;IAI7D;;;;;;OAMG;IACG,WAAW,CACf,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,CAAC;IA8B5C;;;;;;;;;;;;;;;OAeG;IACG,gBAAgB,CACpB,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,2BAA2B,GAChC,OAAO,CAAC,mBAAmB,CAAC;IAoE/B;;;;;;;;;;;;;;;OAeG;IACG,2BAA2B,CAC/B,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,8BAA8B,CAAC;IA6EpC,iBAAiB,CACrB,cAAc,EAAE,cAAc,EAC9B,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,2BAA2B,GAChC,OAAO,CAAC,mBAAmB,EAAE,CAAC;CA0ElC"}

package/dist/classes/CreateTxMetadata.js

@@ -75,6 +75,31 @@ class CreateTxMetadata {
      * @param connection - The Solana blockchain connection object.
      */
     setConnection(connection) { this.connection = connection; }
+    /**
+     * Overrides where the blockhash baked in at construction comes from. Left unset (the
+     * default) one is fetched per transaction built, which every transaction the SDK builds
+     * needs since `Transaction`'s constructor compiles a versioned transaction.
+     *
+     * @param source - A blockhash, a function producing one, or undefined to fetch.
+     */
+    setConstructionBlockhash(source) {
+        this.constructionBlockhash = source;
+    }
+    /**
+     * Resolves the blockhash to construct a transaction with.
+     *
+     * @param connection - The Solana blockchain connection object, used only when no source is set.
+     */
+    resolveConstructionBlockhash(connection) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.constructionBlockhash === undefined) {
+                return yield connection.getLatestBlockhash();
+            }
+            return typeof this.constructionBlockhash === "function"
+                ? yield this.constructionBlockhash()
+                : this.constructionBlockhash;
+        });
+    }
     /**
      * Gets the singleton instance of the CreateTxMetadata class.
      *
@@ -257,7 +282,7 @@ class CreateTxMetadata {
             (0, Logging_1.Log)(`createTxMetadata: Checkpoint: (jupAlts after loop) ${(new Date().getTime() / 1000) - startTime}`);
             // Get the recent blockhash
             startTime = new Date().getTime() / 1000;
-            const latestBlockhash = yield connection.getLatestBlockhash();
+            const latestBlockhash = yield this.resolveConstructionBlockhash(connection);
             (0, Logging_1.Log)(`createTxMetadata: Checkpoint: (latestBlockhash) ${(new Date().getTime() / 1000) - startTime}`);
             // Create initial transaction instance
             const transaction = new Transaction_1.Transaction(data, new web3.PublicKey(payer), latestBlockhash, alts, generalUtility);
@@ -334,7 +359,7 @@ class CreateTxMetadata {
             (0, Logging_1.Log)(`createTxMetadataWithActions: Checkpoint: (jupAlts after loop) ${(new Date().getTime() / 1000) - startTime}`);
             // Get the recent blockhash
             startTime = new Date().getTime() / 1000;
-            const latestBlockhash = yield connection.getLatestBlockhash();
+            const latestBlockhash = yield this.resolveConstructionBlockhash(connection);
             (0, Logging_1.Log)(`createTxMetadataWithActions: Checkpoint: (latestBlockhash) ${(new Date().getTime() / 1000) - startTime}`);
             // Create initial transaction instance
             const transaction = new Transaction_1.Transaction({
@@ -366,7 +391,7 @@ class CreateTxMetadata {
             const mainStartTime = new Date().getTime() / 1000;
             // Get the recent blockhash
             let startTime = mainStartTime;
-            const latestBlockhash = yield connection.getLatestBlockhash();
+            const latestBlockhash = yield this.resolveConstructionBlockhash(connection);
             (0, Logging_1.Log)(`createTxMetadata2: Checkpoint: (latestBlockhash) ${(new Date().getTime() / 1000) - startTime}`);
             startTime = new Date().getTime() / 1000;
             const batchExecute = new TransactionBatchExecute2_1.TransactionBatchExecute2(data.addressLookupTableAddresses.map(p => new web3.PublicKey(p)), data.mainInstructions.map(ix => {
@@ -413,3 +438,13 @@ class CreateTxMetadata {
     }
 }
 exports.CreateTxMetadata = CreateTxMetadata;
+/**
+ * A blockhash that is valid to compile against but not to land against. Callers that
+ * have proven every path overwrites the construction blockhash before signing can hand
+ * this over and save one foreground getLatestBlockhash per transaction built (H-2582).
+ * Same value `toVersionedTransaction` and `Transaction.simulateTransaction` compile with.
+ */
+CreateTxMetadata.PLACEHOLDER_BLOCKHASH = {
+    blockhash: web3.PublicKey.default.toString(),
+    lastValidBlockHeight: 0,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hawksightco/hawk-sdk",
-  "version": "1.3.276",
+  "version": "1.3.277",
   "description": "Hawksight v2 SDK",
   "main": "dist/index.js",
   "repository": "https://github.com/ghabxph/hawk-api-client.git",