Merge pull request #75 from ChainSafe/irubido/addChainsafeScope

project scope changed to chainsafe, packages naming changed to webzjs

Author: irubido

Cargo.lock

@@ -2,10 +2,10 @@
 resolver = "2"
 
 members = [
-    "crates/webz-common",
-    "crates/webz-keys",
-    "crates/webz-requests",
-    "crates/webz-wallet",
+    "crates/webzjs-common",
+    "crates/webzjs-keys",
+    "crates/webzjs-requests",
+    "crates/webzjs-wallet",
 ]
 
 [profile.release]
@@ -16,7 +16,7 @@ codegen-units = 1
 
 [workspace.dependencies]
 ## Web dependencies
-wasm-bindgen = "0.2.99" # higher versions has an issues with attachment of the file: webz-wallet/snippets/wasm-bindgen-rayon-3e04391371ad0a8e/src/workerHelpers.worker.js
+wasm-bindgen = "0.2.99" # higher versions has an issues with attachment of the file: webzjs-wallet/snippets/wasm-bindgen-rayon-3e04391371ad0a8e/src/workerHelpers.worker.js
 js-sys = "0.3.77"
 wasm-bindgen-futures = "0.4.43"
 web-sys = { version = "0.3.70", features = [

Cargo.toml

@@ -13,7 +13,7 @@ Being a private blockchain Zcash places a lot more demands on the wallet than a
 
 ## Quickstart
 
-Add the `@webzjs/webz-wallet` package to your javascript project.
+Add the `@chainsafe/webzjs-wallet` package to your javascript project.
 
 Before using the library it is important to initialize the Wasm module and the thread pool.
 
@@ -22,7 +22,7 @@ Before using the library it is important to initialize the Wasm module and the t
 > Failing to call them or calling them more than once per page load will result in an error
 
 ```javascript
-import initWasm, { initThreadPool, WebWallet } from "@webzjs/webz-wallet";
+import initWasm, { initThreadPool, WebWallet } from "@chainsafe/webzjs-wallet";
 
 initWasm();
 initThreadPool(8); // can set any number of threads here, ideally match it to window.navigator.hardwareConcurrency
@@ -66,7 +66,7 @@ For more details check out the hosted docs at https://chainsafe.github.io/WebZjs
 
 ### Building WebZjs
 
-This just script uses wasm-pack to build a web-ready copy of `webz-wallet` and `webz-keys` into the `packages` directory 
+This just script uses wasm-pack to build a web-ready copy of `webzjs-wallet` and `webzjs-keys` into the `packages` directory 
 
 ```shell
 just build

README.md

@@ -1,10 +1,18 @@
 #!/bin/bash
 
-# Create the directory if it doesn't exist
-mkdir -p packages/webz-wallet/snippets/wasm_thread-8ee53d0673203880/src/wasm32/js
+# Find the wasm_thread directory regardless of the hash
+WASM_THREAD_DIR=$(find packages/webzjs-wallet/snippets -type d -name "wasm_thread-*" | head -n 1)
+
+if [ -z "$WASM_THREAD_DIR" ]; then
+    echo "Error: Could not find wasm_thread directory"
+    exit 1
+fi
+
+# Create the directory structure
+mkdir -p "$WASM_THREAD_DIR/src/wasm32/js"
 
 # Create the worker module file
-cat > packages/webz-wallet/snippets/wasm_thread-8ee53d0673203880/src/wasm32/js/web_worker_module.bundler.js << 'EOL'
+cat > "$WASM_THREAD_DIR/src/wasm32/js/web_worker_module.bundler.js" << 'EOL'
 // synchronously, using the browser, import wasm_bindgen shim JS scripts
 import init, { wasm_thread_entry_point } from "../../../../../";
 // Wait for the main thread to send us the shared module/memory and work context.
@@ -41,4 +49,6 @@ self.onended = function(e) {
     console.error('Worker ended:', e.message);
     throw e;
 }
-EOL
+EOL
+
+echo "Added worker module to: $WASM_THREAD_DIR/src/wasm32/js/web_worker_module.bundler.js"

add-worker-module.sh

@@ -1,5 +1,5 @@
 [package]
-name = "webz-common"
+name = "webzjs-common"
 version = "0.1.0"
 authors = ["ChainSafe Systems"]
 license = "MIT OR Apache-2.0"

crates/webz-common/Cargo.toml renamed to crates/webzjs-common/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "webz-keys"
+name = "webzjs-keys"
 version = "0.1.0"
 authors = ["ChainSafe Systems"]
 license = "MIT OR Apache-2.0"
@@ -14,7 +14,7 @@ crate-type = ["cdylib", "rlib"]
 wasm-opt = ["-O4", "-O4"]
 
 [dependencies]
-webz-common = { path = "../webz-common" }
+webzjs-common = { path = "../webzjs-common" }
 
 js-sys.workspace = true
 thiserror.workspace = true

crates/webz-common/src/error.rs renamed to crates/webzjs-common/src/error.rs

@@ -2,8 +2,8 @@ use wasm_bindgen::JsValue;
 
 #[derive(thiserror::Error, Debug)]
 pub enum Error {
-    #[error("webz-common crate gives error: {0}")]
-    WebzCommon(#[from] webz_common::Error),
+    #[error("webzjs-common crate gives error: {0}")]
+    WebzJSCommon(#[from] webzjs_common::Error),
     #[error("Invalid account id")]
     AccountIdConversion(#[from] zcash_primitives::zip32::TryFromIntError),
     #[error("Failed to derive key from seed")]

crates/webz-common/src/lib.rs renamed to crates/webzjs-common/src/lib.rs

@@ -6,7 +6,7 @@ use wasm_bindgen::prelude::*;
 
 use crate::error::Error;
 use bip0039::{Count, English, Mnemonic};
-use webz_common::Network;
+use webzjs_common::Network;
 use zcash_primitives::zip32::AccountId;
 
 /// A ZIP32 seed fingerprint. Essentially a Blake2b hash of the seed.

crates/webz-common/src/network.rs renamed to crates/webzjs-common/src/network.rs

@@ -6,7 +6,7 @@ use std::collections::BTreeMap;
 use std::convert::Infallible;
 use std::str::FromStr;
 use wasm_bindgen::prelude::wasm_bindgen;
-use webz_common::{Network, Pczt};
+use webzjs_common::{Network, Pczt};
 use zcash_primitives::consensus::{NetworkConstants, Parameters};
 use zcash_primitives::legacy::keys::{NonHardenedChildIndex, TransparentKeyScope};
 

crates/webz-common/src/pczt.rs renamed to crates/webzjs-common/src/pczt.rs

@@ -1,5 +1,5 @@
 [package]
-name = "webz-requests"
+name = "webzjs-requests"
 version = "0.1.0"
 authors = ["ChainSafe Systems"]
 license = "MIT OR Apache-2.0"

crates/webz-keys/Cargo.toml renamed to crates/webzjs-keys/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "webz-wallet"
+name = "webzjs-wallet"
 version = "0.1.0"
 authors = ["ChainSafe Systems"]
 license = "MIT OR Apache-2.0"
@@ -28,8 +28,8 @@ console_error_panic_hook = ["dep:console_error_panic_hook"]
 no-bundler = ["wasm-bindgen-rayon?/no-bundler", "wasm_thread/no-bundler"]
 
 [dependencies]
-webz-common = { path = "../webz-common" }
-webz-keys = { path = "../webz-keys" }
+webzjs-common = { path = "../webzjs-common" }
+webzjs-keys = { path = "../webzjs-keys" }
 ## Web dependencies
 wasm-bindgen.workspace = true
 js-sys.workspace = true

crates/webz-keys/src/error.rs renamed to crates/webzjs-keys/src/error.rs

@@ -12,8 +12,8 @@ use crate::error::Error;
 use crate::wallet::usk_from_seed_str;
 use crate::{bindgen::proposal::Proposal, Wallet, PRUNING_DEPTH};
 use wasm_thread as thread;
-use webz_common::{Network, Pczt};
-use webz_keys::{ProofGenerationKey, SeedFingerprint, UnifiedSpendingKey};
+use webzjs_common::{Network, Pczt};
+use webzjs_keys::{ProofGenerationKey, SeedFingerprint, UnifiedSpendingKey};
 use zcash_address::ZcashAddress;
 use zcash_client_backend::data_api::{AccountPurpose, InputSource, WalletRead, Zip32Derivation};
 use zcash_client_backend::proto::service::{

crates/webz-keys/src/keys.rs renamed to crates/webzjs-keys/src/keys.rs

@@ -6,8 +6,8 @@ use wasm_bindgen::JsValue;
 
 #[derive(thiserror::Error, Debug)]
 pub enum Error {
-    #[error("webz-common crate gives error: {0}")]
-    WebzCommon(#[from] webz_common::Error),
+    #[error("webzjs-common crate gives error: {0}")]
+    WebzJSCommon(#[from] webzjs_common::Error),
     #[error("Invalid account id")]
     AccountIdConversion(#[from] zcash_primitives::zip32::TryFromIntError),
     #[error("Failed to derive key from seed")]

crates/webz-keys/src/lib.rs renamed to crates/webzjs-keys/src/lib.rs

@@ -12,7 +12,7 @@ use tonic::{
 
 use crate::error::Error;
 use crate::BlockRange;
-use webz_common::Network;
+use webzjs_common::Network;
 
 use pczt::roles::combiner::Combiner;
 use pczt::roles::prover::Prover;

crates/webz-keys/src/pczt_sign.rs renamed to crates/webzjs-keys/src/pczt_sign.rs

@@ -45,14 +45,14 @@ const config = {
 				projectRoot: join(__dirname, '..'),
 				// Monorepo
 				packages: [    {
-          path: 'packages/webz-wallet',
-          entry: 'webz_wallet.d.ts',
+          path: 'packages/webzjs-wallet',
+          entry: 'webzjs_wallet.d.ts',
         },{
-          path: 'packages/webz-keys',
-          entry: 'webz_keys.d.ts',
+          path: 'packages/webzjs-keys',
+          entry: 'webzjs_keys.d.ts',
         }, {
-          path: 'packages/webz-requests',
-          entry: 'webz_requests.d.ts',
+          path: 'packages/webzjs-requests',
+          entry: 'webzjs_requests.d.ts',
         }],
 				minimal: false,
 				debug: true,

crates/webz-requests/Cargo.toml renamed to crates/webzjs-requests/Cargo.toml

@@ -7,14 +7,14 @@ build:
     just build-requests
 
 build-wallet *features:
-    cd crates/webz-wallet && wasm-pack build -t web --release --scope webzjs --out-dir ../../packages/webz-wallet --no-default-features --features="wasm wasm-parallel {{features}}" -Z build-std="panic_abort,std"
+    cd crates/webzjs-wallet && wasm-pack build -t web --release --scope chainsafe --out-dir ../../packages/webzjs-wallet --no-default-features --features="wasm wasm-parallel {{features}}" -Z build-std="panic_abort,std"
     ./add-worker-module.sh
 
 build-keys *features:
-    cd crates/webz-keys && wasm-pack build -t web --release --scope webzjs --out-dir ../../packages/webz-keys --no-default-features --features="{{features}}" -Z build-std="panic_abort,std"
+    cd crates/webzjs-keys && wasm-pack build -t web --release --scope chainsafe --out-dir ../../packages/webzjs-keys --no-default-features --features="{{features}}" -Z build-std="panic_abort,std"
 
 build-requests *features:
-    cd crates/webz-requests && wasm-pack build -t web --release --scope webzjs --out-dir ../../packages/webz-requests --no-default-features --features="{{features}}" -Z build-std="panic_abort,std"
+    cd crates/webzjs-requests && wasm-pack build -t web --release --scope chainsafe --out-dir ../../packages/webzjs-requests --no-default-features --features="{{features}}" -Z build-std="panic_abort,std"
 
 # All Wasm Tests
 test-web *features:

crates/webz-requests/src/error.rs renamed to crates/webzjs-requests/src/error.rs

@@ -14,15 +14,15 @@
   },
   "packageManager": "yarn@4.5.1",
   "scripts": {
-    "dev": "yarn workspace @webzjs/web-wallet run dev & yarn run snap:start",
-    "demo-wallet:serve": "yarn workspace @webzjs/demo-wallet run serve",
+    "dev": "yarn workspace @chainsafe/webzjs-web-wallet run dev & yarn run snap:start",
+    "demo-wallet:serve": "yarn workspace @chainsafe/webzjs-demo-wallet run serve",
     "demo-wallet:dev": "yarn run just:build-keys && yarn run snap:start & yarn run web-wallet:dev",
-    "demo-wallet:build": "yarn workspace @webzjs/demo-wallet run build",
-    "web-wallet:dev": "yarn workspace @webzjs/web-wallet run dev & yarn run snap:start",
-    "web-wallet:build": "yarn workspace @webzjs/web-wallet run build",
-    "test:e2e": "yarn workspace @webzjs/e2e-tests test",
-    "snap:start": "yarn workspace @webzjs/zcash-snap run start",
-    "snap:build": "yarn workspace @webzjs/zcash-snap run build",
+    "demo-wallet:build": "yarn workspace @chainsafe/webzjs-demo-wallet run build",
+    "web-wallet:dev": "yarn workspace @chainsafe/webzjs-web-wallet run dev & yarn run snap:start",
+    "web-wallet:build": "yarn workspace @chainsafe/webzjs-web-wallet run build",
+    "test:e2e": "yarn workspace @chainsafe/webzjs-e2e-tests test",
+    "snap:start": "yarn workspace @chainsafe/webzjs-zcash-snap run start",
+    "snap:build": "yarn workspace @chainsafe/webzjs-zcash-snap run build",
     "just:build": "just build",
     "just:build-keys": "just build-keys"
   }

crates/webz-requests/src/lib.rs renamed to crates/webzjs-requests/src/lib.rs

@@ -1,5 +1,5 @@
 {
-  "name": "@webzjs/demo-wallet",
+  "name": "@chainsafe/webzjs-demo-wallet",
   "source": "index.html",
   "version": "0.1.0",
   "scripts": {
@@ -9,11 +9,11 @@
   },
   "type": "module",
   "dependencies": {
+    "@chainsafe/webzjs-keys": "workspace:^",
+    "@chainsafe/webzjs-wallet": "workspace:^",
     "@metamask/providers": "^18.1.0",
     "@types/react": "^18.3.9",
     "@types/react-dom": "^18.3.0",
-    "@webzjs/webz-keys": "workspace:^",
-    "@webzjs/webz-wallet": "workspace:^",
     "bootstrap": "^5.3.3",
     "idb-keyval": "^6.2.1",
     "react": "^18.2.0",

crates/webz-requests/src/requests.rs renamed to crates/webzjs-requests/src/requests.rs

@@ -1,14 +1,14 @@
-import initWebzWallet, { initThreadPool, WebWallet } from '@webzjs/webz-wallet';
-import initWebzKeys from '@webzjs/webz-keys';
+import initWebzJSWallet, { initThreadPool, WebWallet } from '@chainsafe/webzjs-wallet';
+import initWebzJSKeys from '@chainsafe/webzjs-keys';
 
 import { get, set } from 'idb-keyval';
 
 import { State, Action } from './App';
 import { MAINNET_LIGHTWALLETD_PROXY } from './Constants';
 
 export async function init(state: State, dispatch: React.Dispatch<Action>) {
-  await initWebzWallet();
-  await initWebzKeys();
+  await initWebzJSWallet();
+  await initWebzJSKeys();
 
   await initThreadPool(10);
 

crates/webz-wallet/Cargo.toml renamed to crates/webzjs-wallet/Cargo.toml

@@ -9,7 +9,7 @@ import Stack from 'react-bootstrap/Stack';
 import Container from 'react-bootstrap/Container';
 import LoadingOverlay from 'react-loading-overlay';
 
-import { WebWallet, WalletSummary } from '@webzjs/webz-wallet';
+import { WebWallet, WalletSummary } from '@chainsafe/webzjs-wallet';
 
 import { init, triggerRescan } from './Actions';
 import { Header } from './components/Header';

crates/webz-wallet/src/bindgen/mod.rs renamed to crates/webzjs-wallet/src/bindgen/mod.rs

@@ -3,7 +3,7 @@ import React, { FormEvent, useContext, useEffect, useState } from 'react';
 import Button from 'react-bootstrap/Button';
 import Form from 'react-bootstrap/Form';
 import { toast, ToastContainer } from 'react-toastify';
-import { generate_seed_phrase } from '@webzjs/webz-keys';
+import { generate_seed_phrase } from '@chainsafe/webzjs-keys';
 
 import { WalletContext } from '../App';
 import {

crates/webz-wallet/src/bindgen/proposal.rs renamed to crates/webzjs-wallet/src/bindgen/proposal.rs

@@ -1,5 +1,5 @@
 import React from "react";
-import { WalletSummary } from "@webzjs/webz-wallet";
+import { WalletSummary } from "@chainsafe/webzj-wallet";
 
 export function Summary({
   summary,

crates/webz-wallet/src/bindgen/wallet.rs renamed to crates/webzjs-wallet/src/bindgen/wallet.rs

@@ -15,7 +15,7 @@ export default defineConfig({
     rollupOptions: {
       input: {
         main: "index.html",
-        worker: "node_modules/@webzjs/webz-wallet/snippets/wasm-bindgen-rayon-3e04391371ad0a8e/src/workerHelpers.worker.js",
+        worker: "node_modules/@chainsafe/webzjs-wallet/snippets/wasm-bindgen-rayon-3e04391371ad0a8e/src/workerHelpers.worker.js",
       },
     },
     manifest: true,

crates/webz-wallet/src/error.rs renamed to crates/webzjs-wallet/src/error.rs

@@ -1,4 +1,4 @@
-# WebZ e2e Tests
+# WebZJS e2e Tests
 
 This package uses playwright to test the highest level API of WebZjs running in a browser. This allows testing the interaction of different WebWorkers with the page, as well as testing on different browsers.
 
@@ -9,7 +9,7 @@ New tests should be added as files named `.spec.ts` inside the `e2e` directory.
 Tests should use the `page.evaluate` method from playwright to execute javascript code in the browser page where the wallet exists and return a result to the test runner to check. e.g.
 
 ```typescript
-test('Test some webz functionality..', async ({ page }) => {
+test('Test some webzjs functionality..', async ({ page }) => {
   // code here runs in the test runner (node), not in the browser
   let result = await page.evaluate(async () => {
     // everything here executes in the web page