@hawksightco/hawk-sdk 0.0.18 → 0.0.20

package/dist/src/classes/Transaction.d.ts

@@ -47,6 +47,14 @@ export declare class Transaction {
      * @throws Error if a signer is not required or has already signed the transaction when not idempotent.
      */
     sign(signers: web3.Signer[], idempotent?: boolean): void;
+    /**
+     * Add a signature on the transaction with provided signature.
+     *
+     * @param publicKey The public key of the signer
+     * @param signature A signature of the signed transaction
+     * @throws Error if a signer is not required or has already signed the transaction.
+     */
+    addSignature(publicKey: web3.PublicKey, signature: Uint8Array): void;
     /**
      * Checks if all required signers have signed the transaction.
      *

package/dist/src/classes/Transaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../../src/classes/Transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,6BAA6B,CAAC;AACtD,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,MAAM,UAAU,CAAC;AAGrF,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;GAGG;AACH,qBAAa,WAAW;IAoCpB,QAAQ,CAAC,kBAAkB,EAAE,2BAA2B;IACxD,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS;IACjC,OAAO,CAAC,eAAe;IACvB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,yBAAyB,EAAE;IAC/C,OAAO,CAAC,cAAc;IAtCxB,2FAA2F;IAC3F,OAAO,CAAC,UAAU,CAA0B;IAC5C,IAAI,SAAS,IAAI,IAAI,CAAC,kBAAkB,CAA2B;IAEnE,+DAA+D;IAC/D,OAAO,CAAC,qBAAqB,CAA4B;IACzD,IAAI,oBAAoB,IAAI,IAAI,CAAC,oBAAoB,CAAuC;IAE5F,+EAA+E;IAC/E,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElD,oFAAoF;IACpF,OAAO,CAAC,oBAAoB,CAAc;IAC1C,IAAI,mBAAmB,IAAI,MAAM,CAAsC;IAEvE,6CAA6C;IAC7C,IAAI,eAAe,IAAI,MAAM,CAA2C;IAExE,yEAAyE;IACzE,OAAO,CAAC,aAAa,CAAgC;IACrD,IAAI,YAAY,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAA+B;IAEhF,8BAA8B;IAC9B,IAAI,oBAAoB,IAAI,MAAM,CAAsD;IAExF;;;;;;;OAOG;gBAEQ,kBAAkB,EAAE,2BAA2B,EAC/C,QAAQ,EAAE,IAAI,CAAC,SAAS,EACzB,eAAe,EAAE,IAAI,CAAC,8BAA8B,EACnD,IAAI,EAAE,IAAI,CAAC,yBAAyB,EAAE,EACvC,cAAc,EAAE,cAAc;IAkCxC;;;;;;OAMG;IACH,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,UAAU,GAAE,OAAe,GAAG,IAAI;IAqB/D;;;;OAIG;IACH,yBAAyB,IAAI,OAAO;IAIpC;;OAEG;IACG,gBAAgB,CACpB,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,aAAa,EAAE,MAAM,CAAC,0CAA0C,EAChE,gBAAgB,EAAE,MAAM,EACxB,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;IA+BzC;;;;;OAKG;IACG,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,4BAA4B,CAAC;IA+B7F;;OAEG;IACH,gBAAgB,CAAC,eAAe,EAAE,IAAI,CAAC,8BAA8B,GAAG,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,oBAAoB,CAAC;IAY5H;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAS1B;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAQpC;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAQpC;;OAEG;IACH,OAAO,CAAC,oBAAoB;CAW7B"}
+{"version":3,"file":"Transaction.d.ts","sourceRoot":"","sources":["../../../src/classes/Transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,6BAA6B,CAAC;AACtD,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AAGxC,OAAO,EACL,4BAA4B,EAC5B,2BAA2B,EAC5B,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;GAGG;AACH,qBAAa,WAAW;IA+CpB,QAAQ,CAAC,kBAAkB,EAAE,2BAA2B;IACxD,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS;IACjC,OAAO,CAAC,eAAe;IACvB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,yBAAyB,EAAE;IAC/C,OAAO,CAAC,cAAc;IAlDxB,2FAA2F;IAC3F,OAAO,CAAC,UAAU,CAA0B;IAC5C,IAAI,SAAS,IAAI,IAAI,CAAC,kBAAkB,CAEvC;IAED,+DAA+D;IAC/D,OAAO,CAAC,qBAAqB,CAA4B;IACzD,IAAI,oBAAoB,IAAI,IAAI,CAAC,oBAAoB,CAEpD;IAED,+EAA+E;IAC/E,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAElD,oFAAoF;IACpF,OAAO,CAAC,oBAAoB,CAAc;IAC1C,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED,6CAA6C;IAC7C,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,yEAAyE;IACzE,OAAO,CAAC,aAAa,CAAgC;IACrD,IAAI,YAAY,IAAI,IAAI,CAAC,sBAAsB,EAAE,CAEhD;IAED,8BAA8B;IAC9B,IAAI,oBAAoB,IAAI,MAAM,CAEjC;IAED;;;;;;;OAOG;gBAEQ,kBAAkB,EAAE,2BAA2B,EAC/C,QAAQ,EAAE,IAAI,CAAC,SAAS,EACzB,eAAe,EAAE,IAAI,CAAC,8BAA8B,EACnD,IAAI,EAAE,IAAI,CAAC,yBAAyB,EAAE,EACvC,cAAc,EAAE,cAAc;IAyCxC;;;;;;OAMG;IACH,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,UAAU,GAAE,OAAe,GAAG,IAAI;IAuB/D;;;;;;OAMG;IACH,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,GAAG,IAAI;IAcpE;;;;OAIG;IACH,yBAAyB,IAAI,OAAO;IAIpC;;OAEG;IACG,gBAAgB,CACpB,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,aAAa,EAAE,MAAM,CAAC,0CAA0C,EAChE,gBAAgB,EAAE,MAAM,EACxB,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;IA2CzC;;;;;OAKG;IACG,mBAAmB,CACvB,UAAU,EAAE,IAAI,CAAC,UAAU,GAC1B,OAAO,CAAC,4BAA4B,CAAC;IA4BxC;;OAEG;IACH,gBAAgB,CACd,eAAe,EAAE,IAAI,CAAC,8BAA8B,GACnD,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,oBAAoB,CAAC;IAcvD;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAUpC;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAUpC;;OAEG;IACH,OAAO,CAAC,oBAAoB;CAW7B"}

package/dist/src/classes/Transaction.js

@@ -34,21 +34,33 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Transaction = void 0;
 const web3 = __importStar(require("@solana/web3.js"));
-const functions_1 = require("../functions");
 const bn_js_1 = require("bn.js");
+const functions_1 = require("../functions");
 /**
  * Represents a transaction object in Solana using the web3.js library.
  * This class encapsulates the logic for creating, signing, and verifying signatures of transactions.
  */
 class Transaction {
-    get txMessage() { return this._txMessage; }
-    get versionedTransaction() { return this._versionedTransaction; }
-    get priorityFeeEstimate() { return this._priorityFeeEstimate; }
+    get txMessage() {
+        return this._txMessage;
+    }
+    get versionedTransaction() {
+        return this._versionedTransaction;
+    }
+    get priorityFeeEstimate() {
+        return this._priorityFeeEstimate;
+    }
     /** The blockhash of a recent ledger entry */
-    get recentBlockhash() { return this.latestBlockhash.blockhash; }
-    get instructions() { return this._instructions; }
+    get recentBlockhash() {
+        return this.latestBlockhash.blockhash;
+    }
+    get instructions() {
+        return this._instructions;
+    }
     /** last valid block height */
-    get lastValidBlockHeight() { return this.latestBlockhash.lastValidBlockHeight; }
+    get lastValidBlockHeight() {
+        return this.latestBlockhash.lastValidBlockHeight;
+    }
     /**
      * Constructs a new Transaction object.
      *
@@ -76,13 +88,17 @@ class Transaction {
         /** Estimated fee in SOL for priority fee when addPriorityFee() method is called. */
         this._priorityFeeEstimate = "";
         // Construct main instructions
-        const mainIxs = txMetadataResponse.mainInstructions.map(ix => {
+        const mainIxs = txMetadataResponse.mainInstructions.map((ix) => {
             return new web3.TransactionInstruction({
-                keys: ix.accounts.map(meta => {
-                    return { pubkey: new web3.PublicKey(meta.pubkey), isSigner: meta.isSigner, isWritable: meta.isWritable };
+                keys: ix.accounts.map((meta) => {
+                    return {
+                        pubkey: new web3.PublicKey(meta.pubkey),
+                        isSigner: meta.isSigner,
+                        isWritable: meta.isWritable,
+                    };
                 }),
                 programId: new web3.PublicKey(ix.programId),
-                data: Buffer.from(ix.data, 'base64'),
+                data: Buffer.from(ix.data, "base64"),
             });
         });
         this._instructions = [...mainIxs];
@@ -90,11 +106,10 @@ class Transaction {
         this._txMessage = txMessage;
         this._versionedTransaction = versionedTransaction;
         this.requiredSigners = this.getRequiredSigners();
-        if (typeof this.requiredSigners[payerKey.toString()] !== 'boolean') {
+        if (typeof this.requiredSigners[payerKey.toString()] !== "boolean") {
             throw new Error(`Warning: The payer ${payerKey} is not one of the required signers of this transaction.`);
         }
     }
-    ;
     /**
      * Signs the transaction with provided signers.
      *
@@ -104,9 +119,9 @@ class Transaction {
      */
     sign(signers, idempotent = false) {
         // First validate all signers
-        signers.forEach(signer => {
+        signers.forEach((signer) => {
             const key = signer.publicKey.toString();
-            if (typeof this.requiredSigners[key] !== 'boolean') {
+            if (typeof this.requiredSigners[key] !== "boolean") {
                 throw new Error(`Key ${key} is not a required signer!`);
             }
             if (!idempotent && this.requiredSigners[key]) {
@@ -114,19 +129,37 @@ class Transaction {
             }
         });
         // If all signers are valid and the process is idempotent or they haven't signed yet, update and sign
-        signers.forEach(signer => {
+        signers.forEach((signer) => {
             const key = signer.publicKey.toString();
             this.requiredSigners[key] = true;
         });
         this.versionedTransaction.sign(signers);
     }
+    /**
+     * Add a signature on the transaction with provided signature.
+     *
+     * @param publicKey The public key of the signer
+     * @param signature A signature of the signed transaction
+     * @throws Error if a signer is not required or has already signed the transaction.
+     */
+    addSignature(publicKey, signature) {
+        const key = publicKey.toBase58();
+        if (typeof this.requiredSigners[key] !== "boolean") {
+            throw new Error(`Key ${key} is not a required signer!`);
+        }
+        if (this.requiredSigners[key]) {
+            throw new Error(`Key ${key} has already been signed by required signer!`);
+        }
+        this.requiredSigners[key] = true;
+        this.versionedTransaction.addSignature(publicKey, signature);
+    }
     /**
      * Checks if all required signers have signed the transaction.
      *
      * @returns Boolean indicating whether all required signers have signed.
      */
     isSignedByRequiredSigners() {
-        return Object.values(this.requiredSigners).every(isSigned => isSigned);
+        return Object.values(this.requiredSigners).every((isSigned) => isSigned);
     }
     /**
      * Add priority fee instructions (compute budget)
@@ -137,10 +170,14 @@ class Transaction {
             this.removePriorityFeeIxs();
             // Then get fee estimate by simulating the transaction
             const estimate = yield (0, functions_1.getFeeEstimate)(this.generalUtility, priorityLevel, this.txMetadataResponse);
-            const priorityFeeEstimate = maxPriorityFee !== undefined && maxPriorityFee > 0 ? Math.round(Math.min(estimate, maxPriorityFee)) : Math.round(estimate);
+            const priorityFeeEstimate = maxPriorityFee !== undefined && maxPriorityFee > 0
+                ? Math.round(Math.min(estimate, maxPriorityFee))
+                : Math.round(estimate);
             // Create priority fee ixs for transaction
             const priorityFeeIxs = [
-                web3.ComputeBudgetProgram.setComputeUnitLimit({ units: computeUnitLimit }),
+                web3.ComputeBudgetProgram.setComputeUnitLimit({
+                    units: computeUnitLimit,
+                }),
                 web3.ComputeBudgetProgram.setComputeUnitPrice({
                     // CU * CU PRICE -> 1400000 * feeEstimate.priorityFeeEstimate
                     microLamports: priorityFeeEstimate,
@@ -149,7 +186,8 @@ class Transaction {
             this._priorityFeeEstimate = (new bn_js_1.BN(priorityFeeEstimate)
                 .mul(new bn_js_1.BN(computeUnitLimit))
                 .div(new bn_js_1.BN(1000000))
-                .add(new bn_js_1.BN(5000)).toNumber() / 1000000000).toString();
+                .add(new bn_js_1.BN(5000))
+                .toNumber() / 1000000000).toString();
             // Append priority fee instruction at the beginning
             this._instructions.unshift(...priorityFeeIxs);
             // Rebuild versioned transaction
@@ -180,7 +218,7 @@ class Transaction {
                 sigVerify: false,
             });
             if (simulation.value.unitsConsumed === undefined) {
-                throw new Error('Unable to calculate compute budget.');
+                throw new Error("Unable to calculate compute budget.");
             }
             return {
                 err: simulation.value.err,
@@ -210,17 +248,20 @@ class Transaction {
      * @returns A record of signer public keys mapped to a boolean indicating whether they have signed.
      */
     getRequiredSigners() {
-        const signerKeys = this.instructions.flatMap(ix => ix.keys.filter(meta => meta.isSigner).map(meta => meta.pubkey.toString()));
+        const signerKeys = this.instructions.flatMap((ix) => ix.keys
+            .filter((meta) => meta.isSigner)
+            .map((meta) => meta.pubkey.toString()));
         const result = {};
-        signerKeys.forEach(key => result[key] = false);
+        signerKeys.forEach((key) => (result[key] = false));
         return result;
     }
     /**
      * Find setComputeUnitLimit index within the instructions
      */
     findSetComputeUnitLimitIndex() {
-        return this.instructions.findIndex(ix => {
-            const isComputeBudgetProgram = ix.programId.toString() === 'ComputeBudget111111111111111111111111111111';
+        return this.instructions.findIndex((ix) => {
+            const isComputeBudgetProgram = ix.programId.toString() ===
+                "ComputeBudget111111111111111111111111111111";
             const isSetComputeLimitIx = ix.data[0] === 2;
             return isComputeBudgetProgram && isSetComputeLimitIx;
         });
@@ -229,8 +270,9 @@ class Transaction {
      * Find setComputeUnitPrice index within the instructions
      */
     findSetComputeUnitPriceIndex() {
-        return this.instructions.findIndex(ix => {
-            const isComputeBudgetProgram = ix.programId.toString() === 'ComputeBudget111111111111111111111111111111';
+        return this.instructions.findIndex((ix) => {
+            const isComputeBudgetProgram = ix.programId.toString() ===
+                "ComputeBudget111111111111111111111111111111";
             const isSetComputeUnitPriceIx = ix.data[0] === 3;
             return isComputeBudgetProgram && isSetComputeUnitPriceIx;
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hawksightco/hawk-sdk",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "description": "Hawksight v2 SDK",
   "main": "dist/src/index.js",
   "repository": "https://github.com/ghabxph/hawk-api-client.git",
@@ -27,6 +27,7 @@
   "scripts": {
     "start": "npx ts-node src/index.ts",
     "test": "npx jest --silent=false",
-    "build": "tsc --outDir dist/"
+    "build": "tsc --outDir dist/",
+    "prepublishOnly": "npm run build"
   }
 }