@bithomp/xrpl-api 3.1.17 → 3.1.18

package/lib/wallet.d.ts

@@ -6,6 +6,12 @@ interface GenerateAddressInterface {
     address: string;
     seed: string;
 }
+export interface VerifySignatureInterface {
+    signedBy?: string;
+    signatureValid?: boolean;
+    signatureMultiSign?: boolean;
+    error?: string;
+}
 export declare function isValidSecret(secret: string): boolean;
 export interface WalletFromSeedInterface {
     masterAddress?: string;
@@ -21,6 +27,7 @@ export declare function signTransaction(wallet: Wallet, transaction: Transaction
     tx_blob: string;
     hash: string;
 };
-export declare function verifyTransaction(wallet: Wallet, signedTransaction: Transaction | string): boolean;
+export declare function verifyTransaction(signedTransaction: Transaction | string, definitions?: XrplDefinitionsBase): boolean;
+export declare function verifySignature(signedTransaction: Transaction | string, explicitMultiSigner?: string | null, definitions?: XrplDefinitionsBase): VerifySignatureInterface;
 declare function hashSignedTx(tx: Transaction | string, definitions?: XrplDefinitionsBase, validateTx?: boolean): string;
 export { XrplDefinitionsBase, XrplDefinitions, DEFAULT_DEFINITIONS, hashSignedTx };

package/lib/wallet.js

@@ -34,6 +34,7 @@ exports.isValidClassicAddress = isValidClassicAddress;
 exports.checksumClassicAddress = checksumClassicAddress;
 exports.signTransaction = signTransaction;
 exports.verifyTransaction = verifyTransaction;
+exports.verifySignature = verifySignature;
 exports.hashSignedTx = hashSignedTx;
 const bignumber_js_1 = __importDefault(require("bignumber.js"));
 const omitBy_1 = __importDefault(require("lodash/omitBy"));
@@ -147,11 +148,83 @@ function signTransaction(wallet, transaction, multisign, definitions, validateTx
         hash: hashSignedTx(serialized, definitions),
     };
 }
-function verifyTransaction(wallet, signedTransaction) {
-    const tx = typeof signedTransaction === "string" ? (0, ripple_binary_codec_1.decode)(signedTransaction) : signedTransaction;
-    const messageHex = (0, ripple_binary_codec_1.encodeForSigning)(tx);
+function verifyTransaction(signedTransaction, definitions) {
+    const tx = typeof signedTransaction === "string" ? (0, ripple_binary_codec_1.decode)(signedTransaction, definitions) : signedTransaction;
+    const messageHex = (0, ripple_binary_codec_1.encodeForSigning)(tx, definitions);
     const signature = tx.TxnSignature;
-    return (0, ripple_keypairs_1.verify)(messageHex, signature, wallet.publicKey);
+    const publicKey = tx.SigningPubKey;
+    return (0, ripple_keypairs_1.verify)(messageHex, signature, publicKey);
+}
+function verifySignature(signedTransaction, explicitMultiSigner, definitions) {
+    let tx;
+    let signedBy = "";
+    let signatureValid = false;
+    try {
+        if (typeof signedTransaction === "string") {
+            tx = (0, ripple_binary_codec_1.decode)(signedTransaction, definitions);
+        }
+        else if (signedTransaction !== null && typeof signedTransaction === "object") {
+            tx = signedTransaction;
+        }
+    }
+    catch (err) {
+        return { signatureValid: false, error: err.message };
+    }
+    if (!tx) {
+        return { signatureValid: false, error: "The transaction could not be decoded." };
+    }
+    if (!tx.TxnSignature && !tx.Signers) {
+        return { signatureValid: false, error: "The transaction must be signed to verify the signature." };
+    }
+    const signatureMultiSign = typeof tx.Signers !== "undefined" &&
+        Array.isArray(tx.Signers) &&
+        tx.Signers.length > 0 &&
+        typeof tx.SigningPubKey === "string" &&
+        tx.SigningPubKey === "";
+    try {
+        if (signatureMultiSign && explicitMultiSigner && explicitMultiSigner.match(/^r/)) {
+            signedBy = explicitMultiSigner;
+        }
+        else if (signatureMultiSign && explicitMultiSigner) {
+            signedBy = (0, ripple_keypairs_1.deriveAddress)(explicitMultiSigner);
+        }
+        else {
+            let signer = tx.SigningPubKey;
+            if (signatureMultiSign && tx.Signers && tx.Signers.length > 0) {
+                const firstSigner = Object.values(tx.Signers)[0];
+                signer = firstSigner.Signer.SigningPubKey;
+            }
+            signedBy = (0, ripple_keypairs_1.deriveAddress)(signer);
+        }
+    }
+    catch (err) {
+        return { signatureValid: false, error: err.message };
+    }
+    try {
+        if (signatureMultiSign && tx.Signers) {
+            const matchingSigners = Object.values(tx.Signers).filter((signer) => {
+                return (0, ripple_keypairs_1.deriveAddress)(signer.Signer.SigningPubKey) === signedBy;
+            });
+            if (matchingSigners.length > 0) {
+                const multiSigner = matchingSigners[0];
+                signatureValid = (0, ripple_keypairs_1.verify)((0, ripple_binary_codec_1.encodeForMultisigning)(tx, signedBy, definitions), multiSigner.Signer.TxnSignature, multiSigner.Signer.SigningPubKey);
+            }
+            else {
+                return { signatureValid: false, error: "Explicit MultiSigner not in Signers" };
+            }
+        }
+        else {
+            signatureValid = (0, ripple_keypairs_1.verify)((0, ripple_binary_codec_1.encodeForSigning)(tx, definitions), tx.TxnSignature, tx.SigningPubKey);
+        }
+    }
+    catch (err) {
+        return { signedBy, signatureValid: false, error: err.message };
+    }
+    return {
+        signedBy,
+        signatureValid,
+        signatureMultiSign,
+    };
 }
 function computeSignature(tx, privateKey, signAs, definitions) {
     if (signAs) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bithomp/xrpl-api",
-  "version": "3.1.17",
+  "version": "3.1.18",
   "description": "A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -55,28 +55,28 @@
     "axios": "^1.7.7",
     "base-x": "^5.0.0",
     "bignumber.js": "^9.1.2",
-    "elliptic": "^6.6.0",
+    "elliptic": "^6.6.1",
     "lodash": "^4.17.21",
     "ripple-address-codec": "^5.0.0",
     "ripple-binary-codec": "^2.1.0",
     "xrpl": "^4.0.0"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.19",
-    "@types/chai-as-promised": "^7.1.8",
+    "@types/chai": "^5.0.1",
+    "@types/chai-as-promised": "^8.0.1",
     "@types/lodash": "^4.17.13",
     "@types/mocha": "^10.0.9",
     "@types/nconf": "^0.10.7",
     "@types/node": "^20.14.15",
-    "@typescript-eslint/eslint-plugin": "^8.13.0",
-    "@typescript-eslint/parser": "^8.13.0",
+    "@typescript-eslint/eslint-plugin": "^8.14.0",
+    "@typescript-eslint/parser": "^8.14.0",
     "chai": "^4.5.0",
     "chai-as-promised": "^7.1.2",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-chai-friendly": "^1.0.1",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-n": "^17.12.0",
+    "eslint-plugin-n": "^17.13.2",
     "eslint-plugin-promise": "^7.1.0",
     "mocha": "^10.8.2",
     "nconf": "^0.12.1",