tmp3

Author: ImplOfAnImpl

.dockerignore

@@ -45,8 +45,7 @@ test/config.ini
 
 # wasm
 wasm-wrappers/pkg/
-wasm-wrappers/js-bindings-test/test.js
-wasm-wrappers/js-bindings-test/test.js.map
+wasm-wrappers/js-bindings-test/dist/
 
 # 'mintlayer-data' will be mapped to home directories of docker containers, so everything
 # inside it will be generated by the containers.

.github/workflows/wasm.yml

@@ -35,8 +35,8 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Install TypeScript
-        run: npm install typescript
+      - name: Install TypeScript & Knip
+        run: npm install typescript knip
       - name: Install wasm-pack
         run: cargo install wasm-pack
       - name: Build the wasm module
@@ -48,6 +48,9 @@ jobs:
       - name: Run the tests
         working-directory: ./wasm-wrappers
         run: node --enable-source-maps js-bindings-test/node-entry.js
+      - name: Run Knip
+        working-directory: ./wasm-wrappers/js-bindings-test
+        run: npx knip
 
   wasm_artifacts:
     runs-on: ubuntu-latest

.gitignore

@@ -43,8 +43,7 @@ test/config.ini
 
 # wasm
 wasm-wrappers/pkg/
-wasm-wrappers/js-bindings-test/test.js
-wasm-wrappers/js-bindings-test/test.js.map
+wasm-wrappers/js-bindings-test/dist/
 
 # 'mintlayer-data' will be mapped to home directories of docker containers, so everything
 # inside it will be generated by the containers.

wasm-wrappers/README.md

@@ -35,7 +35,7 @@ In the wasm Cargo.toml directory, run:
 tsc --project js-bindings-test/tsconfig.json
 ```
 
-### Running the tests in a web browser
+### Run the tests in a web browser
 
 To build the wasm package from the crate, run (in the wasm Cargo.toml directory):
 
@@ -63,7 +63,7 @@ http-server --port 8080 --host 0.0.0.0
 
 The ported wasm functions are exported to the file `js-bindings-test/index.js` and used in the file `js-bindings-test/index.html` with a basic test/example in them using JavaScript. Use your browser's console to see the output.
 
-### Running the tests in Node.js
+### Run the tests in Node.js
 
 To build the wasm package from the crate, run (in the wasm Cargo.toml directory):
 
@@ -77,6 +77,25 @@ Finally, to run the example, run:
 node --enable-source-maps  js-bindings-test/node-entry.js
 ```
 
+### Run `knip`
+
+We use `knip` to make sure that there are no unused exports in `js-bindings-test/tests` (which could
+mean that some of the tests are never run).
+
+**Note: unused local definitions are caught by the TypeScript compiler itself, via the `noUnusedLocals` setting.**
+
+To run `knip` locally, first install it:
+```
+npm install -g knip
+```
+
+And then run (in the wasm Cargo.toml directory):
+```
+(cd js-bindings-test && npx knip)
+```
+
+**Note: to explicitly exclude an export from `knip`'s report, annotate it with `/** @public */`.**
+
 ### Further documentation on wasm
 
 - https://developer.mozilla.org/en-US/docs/WebAssembly/Rust_to_wasm

wasm-wrappers/js-bindings-test/knip.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://unpkg.com/knip@5/schema.json",
+  "entry": ["tests/main.ts"],
+  "project": ["tests/**/*.ts"],
+  "includeEntryExports": true,
+  "ignoreExportsUsedInFile": true
+}

wasm-wrappers/js-bindings-test/node-entry.js

@@ -1,7 +1,7 @@
-import { run_test } from "./test.js";
+import { run_all_tests } from "./dist/main.js";
 
 async function node_run() {
-  await run_test();
+  await run_all_tests();
 }
 
 node_run();

wasm-wrappers/js-bindings-test/test.ts renamed to wasm-wrappers/js-bindings-test/tests/main.ts

@@ -62,43 +62,60 @@ import {
   encode_input_for_unfreeze_token,
   encode_input_for_change_token_authority,
   encode_input_for_change_token_metadata_uri,
-} from "../pkg/wasm_wrappers.js";
+} from "../../pkg/wasm_wrappers.js";
 
-import { test_signed_transaction_intent } from "./tests/signed_transaction_intent_tests.js";
+import { qwe } from "./signed_transaction_intent_tests.js";
 import {
+  MNEMONIC,
   TEXT_ENCODER,
+  PRIVATE_KEY,
+  PUBLIC_KEY,
   ORDERS_V1_TESTNET_FORK_HEIGHT, assert_eq_arrays
-} from "./tests/utils.js";
+} from "./utils.js";
 
 function run_one_test(test_func) {
   console.log(`>> Running ${test_func.name}`);
   test_func();
   console.log(`<< Done running ${test_func.name}`);
 }
 
-export async function run_test() {
+/** @public */
+export async function run_all_tests() {
+  run_one_test(main_test);
+  run_one_test(test_verify_signature_for_spending);
+  run_one_test(test_public_key_from_bad_private_key);
+  run_one_test(test_make_default_account_privkey_from_bad_mnemonic);
+  run_one_test(test_sign_challenge);
+  run_one_test(test_address_generation);
+
+  run_one_test(test_get_transaction_id);
+  // run_one_test(test_signed_transaction_intent);
+
+  qwe();
+}
+
+async function test_verify_signature_for_spending() {
   // Try signature verification
-  const priv_key = make_private_key();
-  console.log(`priv key = ${priv_key}`);
-  const pub_key = public_key_from_private_key(priv_key);
-  console.log(`pub key = ${pub_key}`);
   const message = TEXT_ENCODER.encode("Hello, world!");
-  const signature = sign_message_for_spending(priv_key, message);
-  console.log(`signature = ${signature}`);
-  const verified = verify_signature_for_spending(pub_key, signature, message);
-  console.log(`verified valid message with correct key = ${verified}`);
+
+  const signature = sign_message_for_spending(PRIVATE_KEY, message);
+  
+  const verified = verify_signature_for_spending(PUBLIC_KEY, signature, message);
+
   if (!verified) {
     throw new Error("Signature verification failed!");
   }
   const verified_bad = verify_signature_for_spending(
-    pub_key,
+    PUBLIC_KEY,
     signature,
     TEXT_ENCODER.encode("bro!")
   );
   if (verified_bad) {
     throw new Error("Invalid message signature verification passed!");
   }
+}
 
+async function test_public_key_from_bad_private_key() {
   // Attempt to use a bad private key to get a public key (test returned Result<> object, which will become a string error)
   const bad_priv_key = TEXT_ENCODER.encode("bad");
   try {
@@ -112,7 +129,9 @@ export async function run_test() {
     }
     console.log("Tested decoding bad private key successfully");
   }
+}
 
+async function test_make_default_account_privkey_from_bad_mnemonic() {
   try {
     const invalid_mnemonic = "asd asd";
     make_default_account_privkey(invalid_mnemonic, Network.Mainnet);
@@ -123,27 +142,33 @@ export async function run_test() {
     }
     console.log("Tested invalid mnemonic successfully");
   }
+}
 
-  {
-    let challenge = sign_challenge(priv_key, message);
-    let address = pubkey_to_pubkeyhash_address(pub_key, Network.Testnet);
-    let result = verify_challenge(address, Network.Testnet, challenge, message);
-    if (!result) {
-      throw new Error("Invalid sing and verify challenge");
-    }
+async function test_sign_challenge() {
+  const message = TEXT_ENCODER.encode("Hello, world!");
 
-    const different_priv_key = make_private_key();
-    const different_pub_key = public_key_from_private_key(different_priv_key);
-    let different_address = pubkey_to_pubkeyhash_address(different_pub_key, Network.Testnet);
-    try {
-      verify_challenge(different_address, Network.Testnet, challenge, message);
-    } catch (e) {
-      if (!e.includes("Public key to public key hash mismatch")) {
-        throw e;
-      }
-      console.log("Tested verify with different address successfully");
+  let challenge = sign_challenge(PRIVATE_KEY, message);
+  let address = pubkey_to_pubkeyhash_address(PUBLIC_KEY, Network.Testnet);
+  let result = verify_challenge(address, Network.Testnet, challenge, message);
+  if (!result) {
+    throw new Error("Invalid sing and verify challenge");
+  }
+
+  const different_priv_key = make_private_key();
+  const different_pub_key = public_key_from_private_key(different_priv_key);
+  let different_address = pubkey_to_pubkeyhash_address(different_pub_key, Network.Testnet);
+  try {
+    verify_challenge(different_address, Network.Testnet, challenge, message);
+  } catch (e) {
+    if (!e.includes("Public key to public key hash mismatch")) {
+      throw e;
     }
+    console.log("Tested verify with different address successfully");
   }
+}
+
+async function test_address_generation() {
+  const bad_priv_key = TEXT_ENCODER.encode("bad");
 
   try {
     make_receiving_address(bad_priv_key, 0);
@@ -165,11 +190,9 @@ export async function run_test() {
     console.log("Tested decoding bad account private key successfully");
   }
 
-  const mnemonic =
-    "walk exile faculty near leg neutral license matrix maple invite cupboard hat opinion excess coffee leopard latin regret document core limb crew dizzy movie";
   {
     const account_private_key = make_default_account_privkey(
-      mnemonic,
+      MNEMONIC,
       Network.Mainnet
     );
     console.log(`acc private key = ${account_private_key}`);
@@ -234,7 +257,7 @@ export async function run_test() {
   {
     // Test generating an address for Testnet
     const account_private_key = make_default_account_privkey(
-      mnemonic,
+      MNEMONIC,
       Network.Testnet
     );
     console.log(`acc private key = ${account_private_key}`);
@@ -252,7 +275,9 @@ export async function run_test() {
       throw new Error("Incorrect address generated");
     }
   }
+}
 
+async function main_test() {
   {
     const lock_for_blocks = staking_pool_spend_maturity_block_count(
       BigInt(1000),
@@ -574,7 +599,7 @@ export async function run_test() {
     assert_eq_arrays(encoded_fungible_token, expected_fungible_token);
 
     const account_pubkey = make_default_account_privkey(
-      mnemonic,
+      MNEMONIC,
       Network.Testnet
     );
     const receiving_privkey = make_receiving_address(account_pubkey, 0);
@@ -1423,9 +1448,6 @@ export async function run_test() {
       throw new Error(`Effective balance test failed ${eff_bal}`);
     }
   }
-
-  run_one_test(test_get_transaction_id);
-  run_one_test(test_signed_transaction_intent);
 }
 
 function test_get_transaction_id() {

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

@@ -1,70 +1,18 @@
 import {
-  make_private_key,
-  public_key_from_private_key,
-  sign_message_for_spending,
-  verify_signature_for_spending,
-  make_default_account_privkey,
-  make_receiving_address,
-  make_change_address,
-  pubkey_to_pubkeyhash_address,
-  make_receiving_address_public_key,
-  make_change_address_public_key,
-  extended_public_key_from_extended_private_key,
   Network,
-  encode_input_for_utxo,
-  encode_output_coin_burn,
-  encode_output_token_burn,
-  encode_transaction,
-  encode_witness_no_signature,
-  encode_signed_transaction,
-  encode_lock_until_height,
-  encode_output_create_stake_pool,
-  encode_output_token_transfer,
-  encode_output_lock_then_transfer,
-  encode_output_token_lock_then_transfer,
-  encode_stake_pool_data,
-  encode_output_htlc,
-  encode_witness,
-  encode_witness_htlc_secret,
-  encode_multisig_challenge,
-  encode_witness_htlc_multisig,
-  extract_htlc_secret,
-  encode_create_order_output,
-  encode_input_for_fill_order,
-  encode_input_for_freeze_order,
-  encode_input_for_conclude_order,
-  SignatureHashType,
-  encode_input_for_withdraw_from_delegation,
-  estimate_transaction_size,
-  staking_pool_spend_maturity_block_count,
-  get_transaction_id,
-  effective_pool_balance,
-  Amount,
-  TotalSupply,
-  FreezableToken,
-  encode_output_issue_nft,
-  encode_output_issue_fungible_token,
   sign_challenge,
-  verify_challenge,
-  get_token_id,
   make_transaction_intent_message_to_sign,
   encode_signed_transaction_intent,
   verify_transaction_intent,
-  encode_input_for_mint_tokens,
-  encode_input_for_unmint_tokens,
-  encode_input_for_lock_token_supply,
-  encode_input_for_freeze_token,
-  TokenUnfreezable,
-  encode_input_for_unfreeze_token,
-  encode_input_for_change_token_authority,
-  encode_input_for_change_token_metadata_uri,
 } from "../../pkg/wasm_wrappers.js";
 
 import {
     TEXT_ENCODER,
     assert_eq_arrays
   } from "./utils.js";
 
+export function qwe() {}
+
 export function test_signed_transaction_intent() {
   try {
     const invalid_tx_id = "invalid tx id";

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

@@ -1,9 +1,23 @@
+import {
+  make_private_key,
+  public_key_from_private_key,
+} from "../../pkg/wasm_wrappers.js";
+
 // Taken from TESTNET_FORK_HEIGHT_5_ORDERS_V1 in common/src/chain/config/builder.rs.
 // This will be updated to the actual height after we choose one.
 export const ORDERS_V1_TESTNET_FORK_HEIGHT = 999_999_999;
 
 export const TEXT_ENCODER = new TextEncoder();
 
+export const MNEMONIC =
+    "walk exile faculty near leg neutral license matrix maple invite cupboard hat opinion excess coffee leopard latin regret document core limb crew dizzy movie";
+
+export const PRIVATE_KEY = make_private_key();
+export const PUBLIC_KEY = public_key_from_private_key(PRIVATE_KEY);
+
+console.log(`PRIVATE_KEY = ${PRIVATE_KEY}`);
+console.log(`PUBLIC_KEY = ${PUBLIC_KEY}`);
+
 export function assert_eq_arrays(arr1, arr2) {
   const equal = arr1.length == arr2.length && arr1.every((value, index) => value == arr2[index]);
 

wasm-wrappers/js-bindings-test/tsconfig.json

@@ -2,7 +2,8 @@
   "compilerOptions": {
     "target": "es2022",
     "module": "nodenext",
-    "sourceMap": true
-  },
-  "include": ["test.ts", "tests/**/*.ts" ],
+    "sourceMap": true,
+    "outDir": "./dist",
+    "noUnusedLocals": true
+  }
 }