Merge pull request #60 from HorizenLabs/ddb/update_readme_m2

Updated readme with new naming
HorizenLabs · May 21, 2024 · 69f8162 · 69f8162
2 parents afe39f9 + c75c99a
commit 69f8162
Show file tree

Hide file tree

Showing 16 changed files with 31 additions and 28 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [workspace.package]
 authors = ["Horizen Labs <[email protected]>"]
 edition = "2021"
-repository = "https://github.com/HorizenLabs/NH-core"
+repository = "https://github.com/HorizenLabs/zkVerify"
 homepage = "https://horizenlabs.io"
 
 [workspace]

diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
-# NH-core
+# zkVerify
 
-Implementation of a node for the **New Horizen Proof Verification Layer**.
+Implementation of a node for the **zkVerify Proof Verification Layer**.
 
 It is based on the [Substrate](https://substrate.io/) framework.
 
 > [!IMPORTANT]
-> ***NH-core*** is currently in an early **testnet** stage.
+> ***zkVerify*** is currently in an early **testnet** stage.
 > The plan for going live on Mainnet will be communicated later.
-> For more information see [horizen.io](https://www.horizen.io/).
+> For more information see [zkVerify.io](https://zkverify.io/).
 
 ## Building and running
 
@@ -102,15 +102,18 @@ The client will run a chain with a single validator (Alice) and start producing
 2024-03-28 11:49:18 ✨ Imported #2 (0x8226…df51)
 2024-03-28 11:49:19 💤 Idle (0 peers), best: #2 (0x8226…df51), finalized #1 (0x89e3…c6c4), ⬇ 0 ⬆ 0
 ```
+## Documentation
+
+The official documentation is available at [docs.zkverify.io](https://docs.zkverify.io/).
 
 ## Docker
 
-NH-core includes some Docker files for building the client and running one or more nodes locally.
+zkVerify includes some Docker files for building the client and running one or more nodes locally.
 For more information, see [docker/README.md](docker/README.md).
 
 ## License
 
-NH-core as a whole is released under the [GPL 3.0 license](LICENSE-GPL3). This is mostly due to the fact that the proof verification implemented by the `settlement-fflonk` pallet is based on GPL 3.0 software.
+zkVerify as a whole is released under the [GPL 3.0 license](LICENSE-GPL3). This is mostly due to the fact that the proof verification implemented by the `settlement-fflonk` pallet is based on GPL 3.0 software.
 
 For this reason, all the crates that include such dependency are GPL 3.0 licensed:
 

diff --git a/docker/dockerfiles/binary_injected.Dockerfile b/docker/dockerfiles/binary_injected.Dockerfile
@@ -11,8 +11,8 @@ ARG IMAGE_NAME
 ARG BINARY=nh-node
 
 ARG BIN_FOLDER=.
-ARG DOC_URL=https://github.com/HorizenLabs/NH-core
-ARG DESCRIPTION="NH-core"
+ARG DOC_URL=https://github.com/HorizenLabs/zkVerify
+ARG DESCRIPTION="zkVerify"
 ARG AUTHORS="[email protected]"
 ARG VENDOR="Horizen Labs"
 
@@ -23,7 +23,7 @@ LABEL io.hl.image.authors=${AUTHORS} \
 	io.hl.image.created="${BUILD_DATE}" \
 	io.hl.image.documentation="${DOC_URL}" \
 	io.hl.image.description="${DESCRIPTION}" \
-	io.hl.image.source="https://github.com/HorizenLabs/NH-core/blob/${VCS_REF}/docker/dockerfiles/binary_injected.Dockerfile"
+	io.hl.image.source="https://github.com/HorizenLabs/zkVerify/blob/${VCS_REF}/docker/dockerfiles/binary_injected.Dockerfile"
 
 USER root
 WORKDIR /app

diff --git a/docker/dockerfiles/hl-node.Dockerfile b/docker/dockerfiles/hl-node.Dockerfile
@@ -24,7 +24,7 @@ SHELL ["/bin/bash", "-c"]
 
 # That can be a single one or a comma separated list
 ARG BINARY=nh-node
-ARG DESCRIPTION="New Horizen Core"
+ARG DESCRIPTION="zkVerify Core"
 ARG AUTHORS="[email protected]"
 ARG VENDOR="Horizen Labs"
 ARG PROFILE="release"
@@ -62,4 +62,4 @@ RUN apt-get update \
 USER ${RUN_USER}
 
 # ENTRYPOINT
-ENTRYPOINT ["/app/entrypoint.sh"]
+ENTRYPOINT ["/app/entrypoint.sh"]
diff --git a/e2e-tests/README.md b/e2e-tests/README.md
@@ -1,12 +1,12 @@
-# NH-core end-to-end tests
+# zkVerify end-to-end tests
 
 ## Summary: requirements for a local run
 - node
 - npm
 - yarn
 
 ## Summary: brief instructions for executing the tests
-- Compile NH-core (debug or release mode).
+- Compile zkVerify (debug or release mode).
 - Run from within the `e2e-tests` directory:
 - - `yarn install`
 - - `yarn test`
@@ -19,9 +19,9 @@ It will then execute all the end to end test (all the `.zndsl` file listed in `t
 ---
 
 
-# NH-core end-to-end tests
+# zkVerify end-to-end tests
 
-This folder contains the `NH-core` end-to-end tests written for the Polkadot zombienet testing framework.
+This folder contains the `zkVerify` end-to-end tests written for the Polkadot zombienet testing framework.
 
 Each end-to-end test requires the following files:
 - A network configuration specification file, in `.toml` format; these are stored in the `e2e-tests/network_defs`.
@@ -32,7 +32,7 @@ Each end-to-end test requires the following files:
 
 ### Prerequisites
 
-All tests are executed by running actual `NH-core` nodes, so an instance of the `nh-node` executable must be present on the target system. This can be obtained by compiling this repository, as the test runner script looks for the compiled binary in the `target/debug/` or `target/release/` directories. Optionally, it is possible to download the pre-compiled binary from our official `NH-core` repository, and copy that in the `e2e-tests/bin` directory.
+All tests are executed by running actual `zkVerify` nodes, so an instance of the `nh-node` executable must be present on the target system. This can be obtained by compiling this repository, as the test runner script looks for the compiled binary in the `target/debug/` or `target/release/` directories. Optionally, it is possible to download the pre-compiled binary from our official `zkVerify` repository, and copy that in the `e2e-tests/bin` directory.
 
 The test runner script also automatically downloads the `zombienet` executable from the official GitHub repo: https://github.com/paritytech/zombienet/releases and places that in the `e2e-tests/bin` as well.
 

diff --git a/node/Cargo.toml b/node/Cargo.toml
@@ -3,7 +3,7 @@ name = "mainchain"
 version = "0.2.0"
 description = "New Horizen Mainchain."
 authors.workspace = true
-homepage = "https://github.com/HorizenLabs/NH-core"
+homepage = "https://github.com/HorizenLabs/zkVerify"
 edition.workspace = true
 publish = false
 repository.workspace = true

diff --git a/runtime/Cargo.toml b/runtime/Cargo.toml
@@ -3,7 +3,7 @@ name = "nh-runtime"
 version = "0.2.0"
 description = "New Horizen Mainchain Runtime."
 authors.workspace = true
-homepage = "https://github.com/HorizenLabs/NH-core"
+homepage = "https://github.com/HorizenLabs/zkVerify"
 edition.workspace = true
 publish = false
 repository.workspace = true

diff --git a/runtime/src/weights/frame_system.rs b/runtime/src/weights/frame_system.rs
@@ -51,7 +51,7 @@
 use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
 use core::marker::PhantomData;
 
-/// Weights for `frame_system` using the New Horizen node and recommended hardware.
+/// Weights for `frame_system` using the zkVerify node and recommended hardware.
 pub struct NHWeight<T>(PhantomData<T>);
 
 impl<T: frame_system::Config> frame_system::WeightInfo for NHWeight<T> {

diff --git a/runtime/src/weights/pallet_balances.rs b/runtime/src/weights/pallet_balances.rs
@@ -51,7 +51,7 @@
 use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
 use core::marker::PhantomData;
 
-/// Weights for `pallet_balances` using the New Horizen node and recommended hardware.
+/// Weights for `pallet_balances` using the zkVerify node and recommended hardware.
 pub struct NHWeight<T>(PhantomData<T>);
 
 impl<T: frame_system::Config> pallet_balances::WeightInfo for NHWeight<T> {

diff --git a/runtime/src/weights/pallet_im_online.rs b/runtime/src/weights/pallet_im_online.rs
@@ -51,7 +51,7 @@
 use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
 use core::marker::PhantomData;
 
-/// Weights for `pallet_im_online` using the New Horizen node and recommended hardware.
+/// Weights for `pallet_im_online` using the zkVerify node and recommended hardware.
 pub struct NHWeight<T>(PhantomData<T>);
 
 impl<T: frame_system::Config> pallet_im_online::WeightInfo for NHWeight<T> {

diff --git a/runtime/src/weights/pallet_poe.rs b/runtime/src/weights/pallet_poe.rs
@@ -51,7 +51,7 @@
 use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
 use core::marker::PhantomData;
 
-/// Weights for `pallet_poe` using the New Horizen node and recommended hardware.
+/// Weights for `pallet_poe` using the zkVerify node and recommended hardware.
 pub struct NHWeight<T>(PhantomData<T>);
 
 impl<T: frame_system::Config> pallet_poe::WeightInfo for NHWeight<T> {

diff --git a/runtime/src/weights/pallet_settlement_fflonk.rs b/runtime/src/weights/pallet_settlement_fflonk.rs
@@ -51,7 +51,7 @@
 use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
 use core::marker::PhantomData;
 
-/// Weights for `pallet_settlement_fflonk` using the New Horizen node and recommended hardware.
+/// Weights for `pallet_settlement_fflonk` using the zkVerify node and recommended hardware.
 pub struct NHWeight<T>(PhantomData<T>);
 
 impl<T: frame_system::Config> pallet_settlement_fflonk::WeightInfo for NHWeight<T> {

diff --git a/runtime/src/weights/pallet_settlement_zksync.rs b/runtime/src/weights/pallet_settlement_zksync.rs
@@ -51,7 +51,7 @@
 use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
 use core::marker::PhantomData;
 
-/// Weights for `pallet_settlement_zksync` using the New Horizen node and recommended hardware.
+/// Weights for `pallet_settlement_zksync` using the zkVerify node and recommended hardware.
 pub struct NHWeight<T>(PhantomData<T>);
 
 impl<T: frame_system::Config> pallet_settlement_zksync::WeightInfo for NHWeight<T> {

diff --git a/runtime/src/weights/pallet_sudo.rs b/runtime/src/weights/pallet_sudo.rs
@@ -51,7 +51,7 @@
 use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
 use core::marker::PhantomData;
 
-/// Weights for `pallet_sudo` using the New Horizen node and recommended hardware.
+/// Weights for `pallet_sudo` using the zkVerify node and recommended hardware.
 pub struct NHWeight<T>(PhantomData<T>);
 
 impl<T: frame_system::Config> pallet_sudo::WeightInfo for NHWeight<T> {

diff --git a/runtime/src/weights/pallet_timestamp.rs b/runtime/src/weights/pallet_timestamp.rs
@@ -51,7 +51,7 @@
 use frame_support::{traits::Get, weights::{Weight, constants::RocksDbWeight}};
 use core::marker::PhantomData;
 
-/// Weights for `pallet_timestamp` using the New Horizen node and recommended hardware.
+/// Weights for `pallet_timestamp` using the zkVerify node and recommended hardware.
 pub struct NHWeight<T>(PhantomData<T>);
 
 impl<T: frame_system::Config> pallet_timestamp::WeightInfo for NHWeight<T> {

diff --git a/scripts/run_all_benchmarks.sh b/scripts/run_all_benchmarks.sh
@@ -96,7 +96,7 @@ EXCLUDED_PALLETS=(
         # "pallet_im_online" "frame_benchmarking" "frame_system" "pallet_balances"
     )
 
-echo "[+] Benchmarking ${#PALLETS[@]} nh-core pallets. (IGNORE SET [${#EXCLUDED_PALLETS[@]}])"
+echo "[+] Benchmarking ${#PALLETS[@]} zkVerify pallets. (IGNORE SET [${#EXCLUDED_PALLETS[@]}])"
 
 
 is_pallet_excluded() {