Add tx decode to js value to wasm lib

Author: OBorce

Cargo.lock

@@ -19,7 +19,10 @@ serialization = { path = "../serialization" }
 tx-verifier = { path = "../chainstate/tx-verifier" }
 utils = { path = "../utils" }
 
-bip39 = { workspace = true, default-features = false, features = ["std", "zeroize"] }
+bip39 = { workspace = true, default-features = false, features = [
+  "std",
+  "zeroize",
+] }
 fixed-hash.workspace = true
 itertools.workspace = true
 serde.workspace = true
@@ -33,6 +36,7 @@ tsify = "0.5"
 wasm-bindgen = "0.2"
 # web-sys provides `console::log` and is useful during debugging.
 web-sys = { version = "0.3", features = ["console"] }
+serde-wasm-bindgen = "0.6"
 
 [dev-dependencies]
 hex.workspace = true

wasm-wrappers/Cargo.toml

@@ -21,26 +21,16 @@ import {
   estimate_transaction_size,
   make_default_account_privkey,
   make_receiving_address,
+  decode_signed_transaction_to_js,
   Network,
   SignatureHashType,
 } from "../../pkg/wasm_wrappers.js";
 
-import {
-  assert_eq_arrays,
-  get_err_msg,
-  TEXT_ENCODER,
-} from "./utils.js";
+import { assert_eq_arrays, get_err_msg, TEXT_ENCODER } from "./utils.js";
 
-import {
-  MNEMONIC,
-  RANDOM_HEIGHT,
-} from "./defs.js";
-import {
-  ADDRESS
-} from "./test_address_generation.js";
-import {
-  INPUTS,
-} from "./test_encode_other_inputs.js";
+import { MNEMONIC, RANDOM_HEIGHT } from "./defs.js";
+import { ADDRESS } from "./test_address_generation.js";
+import { INPUTS } from "./test_encode_other_inputs.js";
 import {
   OUTPUTS,
   OUTPUT_CREATE_STAKE_POOL,
@@ -50,7 +40,7 @@ import {
 export function test_transaction_and_witness_encoding() {
   const account_pubkey = make_default_account_privkey(
     MNEMONIC,
-    Network.Testnet
+    Network.Testnet,
   );
   const receiving_privkey = make_receiving_address(account_pubkey, 0);
 
@@ -76,19 +66,23 @@ export function test_transaction_and_witness_encoding() {
     console.log("Tested invalid outputs successfully");
   }
 
-  const tx = encode_transaction(Uint8Array.from(INPUTS), Uint8Array.from(OUTPUTS), BigInt(0));
+  const tx = encode_transaction(
+    Uint8Array.from(INPUTS),
+    Uint8Array.from(OUTPUTS),
+    BigInt(0),
+  );
   const expected_tx = [
     1, 0, 8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 1, 4, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
     0, 4, 8, 1, 0, 145, 1, 1, 91, 58, 110, 176, 100, 207, 6, 194, 41, 193, 30,
-    91, 4, 195, 202, 103, 207, 80, 217, 178, 0, 145, 1, 3, 0, 0, 0, 0, 0, 0,
+    91, 4, 195, 202, 103, 207, 80, 217, 178, 0, 145, 1, 3, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-    0, 2, 113, 2, 0, 1, 91, 58, 110, 176, 100, 207, 6, 194, 41, 193, 30, 91,
-    4, 195, 202, 103, 207, 80, 217, 178, 0, 108, 245, 234, 97, 170, 9, 247,
-    158, 169, 100, 84, 123, 235, 183, 147, 29, 136, 118, 203, 24, 146, 56, 60,
-    217, 2, 198, 32, 133, 255, 240, 84, 123, 1, 91, 58, 110, 176, 100, 207, 6,
-    194, 41, 193, 30, 91, 4, 195, 202, 103, 207, 80, 217, 178, 100, 0, 0,
+    2, 113, 2, 0, 1, 91, 58, 110, 176, 100, 207, 6, 194, 41, 193, 30, 91, 4,
+    195, 202, 103, 207, 80, 217, 178, 0, 108, 245, 234, 97, 170, 9, 247, 158,
+    169, 100, 84, 123, 235, 183, 147, 29, 136, 118, 203, 24, 146, 56, 60, 217,
+    2, 198, 32, 133, 255, 240, 84, 123, 1, 91, 58, 110, 176, 100, 207, 6, 194,
+    41, 193, 30, 91, 4, 195, 202, 103, 207, 80, 217, 178, 100, 0, 0,
   ];
   assert_eq_arrays(tx, expected_tx);
   console.log("tx encoding ok");
@@ -98,7 +92,12 @@ export function test_transaction_and_witness_encoding() {
   assert_eq_arrays(witness, expected_no_signature_witness);
   console.log("empty witness encoding ok");
 
-  const opt_utxos = [1, ...OUTPUT_LOCK_THEN_TRANSFER, 1, ...OUTPUT_CREATE_STAKE_POOL];
+  const opt_utxos = [
+    1,
+    ...OUTPUT_LOCK_THEN_TRANSFER,
+    1,
+    ...OUTPUT_CREATE_STAKE_POOL,
+  ];
 
   try {
     const invalid_private_key = TEXT_ENCODER.encode("invalid private key");
@@ -111,7 +110,7 @@ export function test_transaction_and_witness_encoding() {
       0,
       { pool_info: {}, order_info: {} },
       BigInt(RANDOM_HEIGHT),
-      Network.Testnet
+      Network.Testnet,
     );
     throw new Error("Invalid private key worked somehow!");
   } catch (e) {
@@ -131,7 +130,7 @@ export function test_transaction_and_witness_encoding() {
       0,
       { pool_info: {}, order_info: {} },
       BigInt(RANDOM_HEIGHT),
-      Network.Testnet
+      Network.Testnet,
     );
     throw new Error("Invalid address worked somehow!");
   } catch (e) {
@@ -151,7 +150,7 @@ export function test_transaction_and_witness_encoding() {
       0,
       { pool_info: {}, order_info: {} },
       BigInt(RANDOM_HEIGHT),
-      Network.Testnet
+      Network.Testnet,
     );
     throw new Error("Invalid transaction worked somehow!");
   } catch (e) {
@@ -171,7 +170,7 @@ export function test_transaction_and_witness_encoding() {
       0,
       { pool_info: {}, order_info: {} },
       BigInt(RANDOM_HEIGHT),
-      Network.Testnet
+      Network.Testnet,
     );
     throw new Error("Invalid utxo worked somehow!");
   } catch (e) {
@@ -191,11 +190,15 @@ export function test_transaction_and_witness_encoding() {
       0,
       { pool_info: {}, order_info: {} },
       BigInt(RANDOM_HEIGHT),
-      Network.Testnet
+      Network.Testnet,
     );
     throw new Error("Invalid utxo worked somehow!");
   } catch (e) {
-    if (!get_err_msg(e).includes("Error creating sighash input commitments: Utxo not found")) {
+    if (
+      !get_err_msg(e).includes(
+        "Error creating sighash input commitments: Utxo not found",
+      )
+    ) {
       throw e;
     }
     console.log("Tested invalid utxo count in encode witness successfully");
@@ -211,7 +214,7 @@ export function test_transaction_and_witness_encoding() {
       invalid_input_idx,
       { pool_info: {}, order_info: {} },
       BigInt(RANDOM_HEIGHT),
-      Network.Testnet
+      Network.Testnet,
     );
     throw new Error("Invalid address worked somehow!");
   } catch (e) {
@@ -230,18 +233,18 @@ export function test_transaction_and_witness_encoding() {
     0,
     { pool_info: {}, order_info: {} },
     BigInt(RANDOM_HEIGHT),
-    Network.Testnet
+    Network.Testnet,
   );
 
   // as signatures are random, hardcode one so we can test the encodings for the signed transaction
   const random_witness2 = [
     1, 1, 141, 1, 0, 2, 227, 252, 33, 195, 223, 44, 38, 35, 73, 145, 212, 180,
-    49, 115, 4, 150, 204, 250, 205, 123, 131, 201, 114, 130, 186, 209, 98,
-    181, 118, 233, 133, 89, 0, 99, 87, 109, 227, 15, 21, 164, 83, 151, 14,
-    235, 106, 83, 230, 40, 64, 146, 112, 52, 103, 203, 31, 216, 54, 141, 223,
-    27, 175, 133, 164, 172, 239, 122, 121, 17, 88, 114, 99, 6, 19, 220, 156,
-    167, 40, 17, 211, 196, 45, 209, 111, 170, 161, 2, 254, 122, 169, 127, 235,
-    158, 62, 127, 177, 12, 228,
+    49, 115, 4, 150, 204, 250, 205, 123, 131, 201, 114, 130, 186, 209, 98, 181,
+    118, 233, 133, 89, 0, 99, 87, 109, 227, 15, 21, 164, 83, 151, 14, 235, 106,
+    83, 230, 40, 64, 146, 112, 52, 103, 203, 31, 216, 54, 141, 223, 27, 175,
+    133, 164, 172, 239, 122, 121, 17, 88, 114, 99, 6, 19, 220, 156, 167, 40, 17,
+    211, 196, 45, 209, 111, 170, 161, 2, 254, 122, 169, 127, 235, 158, 62, 127,
+    177, 12, 228,
   ];
 
   try {
@@ -261,7 +264,7 @@ export function test_transaction_and_witness_encoding() {
   } catch (e) {
     if (
       !get_err_msg(e).includes(
-        "The number of signatures does not match the number of inputs"
+        "The number of signatures does not match the number of inputs",
       )
     ) {
       throw e;
@@ -287,39 +290,91 @@ export function test_transaction_and_witness_encoding() {
     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 1, 4, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
     0, 4, 8, 1, 0, 145, 1, 1, 91, 58, 110, 176, 100, 207, 6, 194, 41, 193, 30,
-    91, 4, 195, 202, 103, 207, 80, 217, 178, 0, 145, 1, 3, 0, 0, 0, 0, 0, 0,
+    91, 4, 195, 202, 103, 207, 80, 217, 178, 0, 145, 1, 3, 0, 0, 0, 0, 0, 0, 0,
     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-    0, 2, 113, 2, 0, 1, 91, 58, 110, 176, 100, 207, 6, 194, 41, 193, 30, 91,
-    4, 195, 202, 103, 207, 80, 217, 178, 0, 108, 245, 234, 97, 170, 9, 247,
-    158, 169, 100, 84, 123, 235, 183, 147, 29, 136, 118, 203, 24, 146, 56, 60,
-    217, 2, 198, 32, 133, 255, 240, 84, 123, 1, 91, 58, 110, 176, 100, 207, 6,
-    194, 41, 193, 30, 91, 4, 195, 202, 103, 207, 80, 217, 178, 100, 0, 0, 8,
-    1, 1, 141, 1, 0, 2, 227, 252, 33, 195, 223, 44, 38, 35, 73, 145, 212, 180,
-    49, 115, 4, 150, 204, 250, 205, 123, 131, 201, 114, 130, 186, 209, 98,
-    181, 118, 233, 133, 89, 0, 99, 87, 109, 227, 15, 21, 164, 83, 151, 14,
+    2, 113, 2, 0, 1, 91, 58, 110, 176, 100, 207, 6, 194, 41, 193, 30, 91, 4,
+    195, 202, 103, 207, 80, 217, 178, 0, 108, 245, 234, 97, 170, 9, 247, 158,
+    169, 100, 84, 123, 235, 183, 147, 29, 136, 118, 203, 24, 146, 56, 60, 217,
+    2, 198, 32, 133, 255, 240, 84, 123, 1, 91, 58, 110, 176, 100, 207, 6, 194,
+    41, 193, 30, 91, 4, 195, 202, 103, 207, 80, 217, 178, 100, 0, 0, 8, 1, 1,
+    141, 1, 0, 2, 227, 252, 33, 195, 223, 44, 38, 35, 73, 145, 212, 180, 49,
+    115, 4, 150, 204, 250, 205, 123, 131, 201, 114, 130, 186, 209, 98, 181, 118,
+    233, 133, 89, 0, 99, 87, 109, 227, 15, 21, 164, 83, 151, 14, 235, 106, 83,
+    230, 40, 64, 146, 112, 52, 103, 203, 31, 216, 54, 141, 223, 27, 175, 133,
+    164, 172, 239, 122, 121, 17, 88, 114, 99, 6, 19, 220, 156, 167, 40, 17, 211,
+    196, 45, 209, 111, 170, 161, 2, 254, 122, 169, 127, 235, 158, 62, 127, 177,
+    12, 228, 1, 1, 141, 1, 0, 2, 227, 252, 33, 195, 223, 44, 38, 35, 73, 145,
+    212, 180, 49, 115, 4, 150, 204, 250, 205, 123, 131, 201, 114, 130, 186, 209,
+    98, 181, 118, 233, 133, 89, 0, 99, 87, 109, 227, 15, 21, 164, 83, 151, 14,
     235, 106, 83, 230, 40, 64, 146, 112, 52, 103, 203, 31, 216, 54, 141, 223,
     27, 175, 133, 164, 172, 239, 122, 121, 17, 88, 114, 99, 6, 19, 220, 156,
     167, 40, 17, 211, 196, 45, 209, 111, 170, 161, 2, 254, 122, 169, 127, 235,
-    158, 62, 127, 177, 12, 228, 1, 1, 141, 1, 0, 2, 227, 252, 33, 195, 223,
-    44, 38, 35, 73, 145, 212, 180, 49, 115, 4, 150, 204, 250, 205, 123, 131,
-    201, 114, 130, 186, 209, 98, 181, 118, 233, 133, 89, 0, 99, 87, 109, 227,
-    15, 21, 164, 83, 151, 14, 235, 106, 83, 230, 40, 64, 146, 112, 52, 103,
-    203, 31, 216, 54, 141, 223, 27, 175, 133, 164, 172, 239, 122, 121, 17, 88,
-    114, 99, 6, 19, 220, 156, 167, 40, 17, 211, 196, 45, 209, 111, 170, 161,
-    2, 254, 122, 169, 127, 235, 158, 62, 127, 177, 12, 228,
+    158, 62, 127, 177, 12, 228,
   ];
   assert_eq_arrays(signed_tx, expected_signed_tx);
 
   const estimated_size = estimate_transaction_size(
     Uint8Array.from(INPUTS),
     [ADDRESS, ADDRESS],
     Uint8Array.from(OUTPUTS),
-    Network.Testnet
+    Network.Testnet,
   );
   if (estimated_size != expected_signed_tx.length) {
     throw new Error("wrong estimated size");
   }
   console.log(
-    `estimated size ${estimated_size} vs real ${expected_signed_tx.length}`
+    `estimated size ${estimated_size} vs real ${expected_signed_tx.length}`,
+  );
+
+  let decoded_tx = decode_signed_transaction_to_js(signed_tx);
+  console.log("decoded tx format:");
+  console.dir(decoded_tx, { depth: null });
+
+  // top-level check
+  if (!decoded_tx.V1) {
+    throw new Error("Missing V1 field in decoded transaction");
+  }
+
+  if (decoded_tx.V1.version !== 1) {
+    throw new Error(`Unexpected version: ${decoded_tx.V1.version}`);
+  }
+
+  if (!Array.isArray(decoded_tx.V1.inputs)) {
+    throw new Error("Inputs is not an array");
+  }
+
+  if (!Array.isArray(decoded_tx.V1.outputs)) {
+    throw new Error("Outputs is not an array");
+  }
+
+  // specific input check
+  const firstInput = decoded_tx.V1.inputs[0];
+  if (!firstInput.Utxo) {
+    throw new Error("First input is not Utxo");
+  }
+  if (firstInput.Utxo.index !== 1) {
+    throw new Error(`Unexpected Utxo index: ${firstInput.Utxo.index}`);
+  }
+
+  // structural checks
+  if (decoded_tx.V1.inputs.length === 0) {
+    throw new Error("No inputs found");
+  }
+  if (decoded_tx.V1.outputs.length === 0) {
+    throw new Error("No outputs found");
+  }
+
+  // example output check
+  const lockTransfer = decoded_tx.V1.outputs.find(
+    (o: any) => o.LockThenTransfer,
   );
+  if (!lockTransfer) {
+    throw new Error("Missing LockThenTransfer output");
+  }
+  const coin = lockTransfer.LockThenTransfer[0];
+  if (!coin.Coin || coin.Coin.atoms !== "100") {
+    throw new Error(
+      `Unexpected LockThenTransfer coin: ${JSON.stringify(coin)}`,
+    );
+  }
 }

wasm-wrappers/js-bindings-test/tests/test_transaction_and_witness_encoding.ts

@@ -81,6 +81,9 @@ pub enum Error {
     #[error("Invalid signed transaction intent encoding: {0}")]
     InvalidSignedTransactionIntentEncoding(serialization::Error),
 
+    #[error("Invalid signed transaction encoding: {0}")]
+    InvalidSignedTransactionEncoding(serialization::Error),
+
     #[error("Error creating multisig spend: {0}")]
     MultisigSpendCreationError(DestinationSigError),
 

wasm-wrappers/src/error.rs

@@ -31,6 +31,8 @@
 
 use std::{num::NonZeroU8, str::FromStr};
 
+use wasm_bindgen::JsValue;
+
 use bip39::Language;
 use itertools::Itertools as _;
 use wasm_bindgen::prelude::*;
@@ -689,6 +691,16 @@ pub fn encode_transaction(inputs: &[u8], outputs: &[u8], flags: u64) -> Result<V
     Ok(tx.encode())
 }
 
+/// Decodes a signed transaction from its binary encoding into a JavaScript object.
+#[wasm_bindgen]
+pub fn decode_signed_transaction_to_js(transaction: &[u8]) -> Result<JsValue, Error> {
+    let tx = SignedTransaction::decode_all(&mut &transaction[..])
+        .map_err(Error::InvalidSignedTransactionEncoding)?;
+    let value =
+        serde_wasm_bindgen::to_value(tx.transaction()).expect("Should not fail to create js value");
+    Ok(value)
+}
+
 /// Encode an input witness of the variant that contains no signature.
 #[wasm_bindgen]
 pub fn encode_witness_no_signature() -> Vec<u8> {