diff --git a/docs/the_auditors_handbook/src/02.4_debugging_Nim_sanitizers_fuzzers.md b/docs/the_auditors_handbook/src/02.4_debugging_Nim_sanitizers_fuzzers.md index 9eafc4986..ce2d1c171 100644 --- a/docs/the_auditors_handbook/src/02.4_debugging_Nim_sanitizers_fuzzers.md +++ b/docs/the_auditors_handbook/src/02.4_debugging_Nim_sanitizers_fuzzers.md @@ -46,10 +46,10 @@ We are currently adding fuzzing to our repositories via libFuzzer and AFL. Sigma Prima is fuzzing all Ethereum 2 clients on the spec (Eth2 core/Validator core) We provide them with a simple C API -- [https://github.com/status-im/nim-beacon-chain/blob/4a2e1806/nfuzz/libnfuzz.h](https://github.com/status-im/nim-beacon-chain/blob/4a2e1806/nfuzz/libnfuzz.h) +- [https://github.com/status-im/nimbus-eth2/blob/4a2e1806/nfuzz/libnfuzz.h](https://github.com/status-im/nimbus-eth2/blob/4a2e1806/nfuzz/libnfuzz.h) That we implement: -- [https://github.com/status-im/nim-beacon-chain/blob/4a2e1806/nfuzz/libnfuzz.nim](https://github.com/status-im/nim-beacon-chain/blob/4a2e1806/nfuzz/libnfuzz.nim) +- [https://github.com/status-im/nimbus-eth2/blob/4a2e1806/nfuzz/libnfuzz.nim](https://github.com/status-im/nimbus-eth2/blob/4a2e1806/nfuzz/libnfuzz.nim) And compile the nim code as a shared or static library. diff --git a/docs/the_auditors_handbook/src/03.2_build_system_and_dependencies.md b/docs/the_auditors_handbook/src/03.2_build_system_and_dependencies.md index 0c6ec079b..7a0f3cfab 100644 --- a/docs/the_auditors_handbook/src/03.2_build_system_and_dependencies.md +++ b/docs/the_auditors_handbook/src/03.2_build_system_and_dependencies.md @@ -4,7 +4,7 @@ ### NBC repo -`nim-beacon-chain` uses a build system based on makefiles. +`nimbus-eth2` uses a build system based on makefiles. Usage is described in the README. In particular a `env.sh` scripts is provided that setups the environment variable @@ -30,7 +30,7 @@ are also setting up a Nim environment from scratch. ### NBC repo -For the `nim-beacon-chain` application, all dependencies are vendored +For the `nimbus-eth2` application, all dependencies are vendored in the `vendor` folder. With regards to the audit scope we have the following dependencies: diff --git a/docs/the_auditors_handbook/src/03_nbc_nimbus_beacon_chain.md b/docs/the_auditors_handbook/src/03_nbc_nimbus_beacon_chain.md index 3a7e41bd1..c34ce288c 100644 --- a/docs/the_auditors_handbook/src/03_nbc_nimbus_beacon_chain.md +++ b/docs/the_auditors_handbook/src/03_nbc_nimbus_beacon_chain.md @@ -1,6 +1,6 @@ # Nimbus Beacon Chain -[https://github.com/status-im/nim-beacon-chain](https://github.com/status-im/nim-beacon-chain) +[https://github.com/status-im/nimbus-eth2](https://github.com/status-im/nimbus-eth2) Nimbus Beacon Chain (NBC) is an implementation of an Ethereum 2 client. diff --git a/docs/the_nimbus_book/src/advanced.md b/docs/the_nimbus_book/src/advanced.md index b1815873b..c64739450 100644 --- a/docs/the_nimbus_book/src/advanced.md +++ b/docs/the_nimbus_book/src/advanced.md @@ -26,7 +26,7 @@ installation directory to "C:\mingw-w64" and add it to your system PATH in "My Computer"/"This PC" -> Properties -> Advanced system settings -> Environment Variables -> Path -> Edit -> New -> C:\mingw-w64\mingw64\bin (it's "C:\mingw-w64\mingw32\bin" on 32-bit) -Install [Git for Windows](https://gitforwindows.org/) and use a "Git Bash" shell to clone and build nim-beacon-chain. +Install [Git for Windows](https://gitforwindows.org/) and use a "Git Bash" shell to clone and build nimbus-eth2. If you don't want to compile PCRE separately, you can fetch pre-compiled DLLs with: @@ -135,7 +135,7 @@ make NIMFLAGS="-d:release" make -j$(nproc) NIMFLAGS="-d:release" USE_MULTITAIL=yes eth2_network_simulation ``` -- don't use the [lightweight stack tracing implementation from nim-libbacktrace](https://github.com/status-im/nim-beacon-chain/pull/745): +- don't use the [lightweight stack tracing implementation from nim-libbacktrace](https://github.com/status-im/nimbus-eth2/pull/745): ```bash make USE_LIBBACKTRACE=0 # expect the resulting binaries to be 2-3 times slower diff --git a/docs/the_nimbus_book/src/beacon_node.md b/docs/the_nimbus_book/src/beacon_node.md index df4ab017a..37b7cdd1b 100644 --- a/docs/the_nimbus_book/src/beacon_node.md +++ b/docs/the_nimbus_book/src/beacon_node.md @@ -15,8 +15,8 @@ To build the beacon run: #### 1. Clone the nim beacon chain repository ``` -git clone https://github.com/status-im/nim-beacon-chain -cd nim-beacon-chain +git clone https://github.com/status-im/nimbus-eth2 +cd nimbus-eth2 ``` #### 2. Run the beacon node build process diff --git a/docs/the_nimbus_book/src/beacon_node_systemd.md b/docs/the_nimbus_book/src/beacon_node_systemd.md index f46f15b25..63537af36 100644 --- a/docs/the_nimbus_book/src/beacon_node_systemd.md +++ b/docs/the_nimbus_book/src/beacon_node_systemd.md @@ -9,10 +9,10 @@ NBC's [external dependencies](./install.md#external-dependencies) and a working ### 1. Clone repositories -Clone the [nim-beacon-chain](https://github.com/status-im/nim-beacon-chain) and [eth2stats](https://github.com/Alethio/eth2stats-client) repositories in the same directory (so that both repositories are adjacent to each other). +Clone the [nimbus-eth2](https://github.com/status-im/nimbus-eth2) and [eth2stats](https://github.com/Alethio/eth2stats-client) repositories in the same directory (so that both repositories are adjacent to each other). ```console -git clone https://github.com/status-im/nim-beacon-chain.git +git clone https://github.com/status-im/nimbus-eth2.git git clone https://github.com/Alethio/eth2stats-client.git ``` @@ -20,9 +20,9 @@ git clone https://github.com/Alethio/eth2stats-client.git Build both repositories by following their respective build instructions. -*nim-beacon-chain* +*nimbus-eth2* ```console -cd nim-beacon-chain +cd nimbus-eth2 make beacon_node ``` @@ -33,7 +33,7 @@ cd eth2stats-client make build ``` -The resulting binaries should appear in `nim-beacon-chain/build/beacon_node` and `eth2stats-client/eth2stats-client`, respectively. +The resulting binaries should appear in `nimbus-eth2/build/beacon_node` and `eth2stats-client/eth2stats-client`, respectively. ### 3. Create an executable script @@ -47,7 +47,7 @@ set +e trap "trap - SIGTERM && kill -- -$$" SIGINT SIGTERM EXIT cd $(dirname "$0") -cd nim-beacon-chain +cd nimbus-eth2 NETWORK=$1 NODE_NAME=${NODE_NAME:-$(whoami)} diff --git a/docs/the_nimbus_book/src/contribute.md b/docs/the_nimbus_book/src/contribute.md index 9560daa16..b39cac3bf 100644 --- a/docs/the_nimbus_book/src/contribute.md +++ b/docs/the_nimbus_book/src/contribute.md @@ -7,7 +7,7 @@ We use an utility tool called mdBook to create online books from Markdown files. ## Before You Start 1. Install mdBook from [here](https://github.com/rust-lang/mdBook). -2. Clone the repository by `git clone https://github.com/status-im/nim-beacon-chain.git`. +2. Clone the repository by `git clone https://github.com/status-im/nimbus-eth2.git`. 3. Go to where the Markdown files are located by `cd docs`. ## Real-Time Update and Preview Changes @@ -17,10 +17,10 @@ We use an utility tool called mdBook to create online books from Markdown files. ## Build and Deploy -The first step is to submit a pull request to the [devel branch](https://github.com/status-im/nim-beacon-chain/tree/devel). +The first step is to submit a pull request to the [devel branch](https://github.com/status-im/nimbus-eth2/tree/devel). Then, after it is merged, do the following under our main repository: -1. `cd nim-beacon-chain` +1. `cd nimbus-eth2` 2. `git checkout devel` 3. `git pull` 4. `make update` (This is to update the submodules to the latest version) diff --git a/docs/the_nimbus_book/src/create_wallet_and_deposit.md b/docs/the_nimbus_book/src/create_wallet_and_deposit.md index 55ba2737e..c2012ab52 100644 --- a/docs/the_nimbus_book/src/create_wallet_and_deposit.md +++ b/docs/the_nimbus_book/src/create_wallet_and_deposit.md @@ -27,7 +27,7 @@ You need to have installed Nimbus' [external dependencies](./install.md#external ## 1. Create a wallet -Run the following command from the the home directory of the `nim-beacon-chain` repository to launch the command line interface app: +Run the following command from the the home directory of the `nimbus-eth2` repository to launch the command line interface app: ``` build/beacon_node wallets create @@ -152,7 +152,7 @@ The following options are available: -*Remember you can find your `deposit_data` JSON file in the `nim-beacon-chain/validators` directory* +*Remember you can find your `deposit_data` JSON file in the `nimbus-eth2/validators` directory*
diff --git a/docs/the_nimbus_book/src/infura-guide.md b/docs/the_nimbus_book/src/infura-guide.md index 5be346297..c00543f73 100644 --- a/docs/the_nimbus_book/src/infura-guide.md +++ b/docs/the_nimbus_book/src/infura-guide.md @@ -62,7 +62,7 @@ To get around this problem, we recommend launching the beacon node with your own -> **Note:** In a previous version of the software it wasn't possible to manually override the web3 endpoint when running `make zinken` or `make medalla`. For the instructions below to work, make sure you've updated to the latest version of the software (run `git pull && make update` from the `master` branch of the `nim-beacon-chain` repository). +> **Note:** In a previous version of the software it wasn't possible to manually override the web3 endpoint when running `make zinken` or `make medalla`. For the instructions below to work, make sure you've updated to the latest version of the software (run `git pull && make update` from the `master` branch of the `nimbus-eth2` repository). ### 1. Visit Infura.io diff --git a/docs/the_nimbus_book/src/intro.md b/docs/the_nimbus_book/src/intro.md index 626bb4f9a..03711f786 100644 --- a/docs/the_nimbus_book/src/intro.md +++ b/docs/the_nimbus_book/src/intro.md @@ -3,7 +3,7 @@ The Nimbus beacon chain is a research implementation of the Beacon Chain – the core system level chain at the heart of Ethereum 2.0. -- Open sourced at [github.com/status-im/nim-beacon-chain](https://github.com/status-im/nim-beacon-chain/tree/master) +- Open sourced at [github.com/status-im/nimbus-eth2](https://github.com/status-im/nimbus-eth2/tree/master) - Specification described at [ethereum/eth2.0-specs](https://github.com/ethereum/eth2.0-specs/tree/v0.12.3#phase-0) @@ -73,7 +73,7 @@ Need help with anything? Join us on [Status](https://join.status.im/nimbus-gener ## Disclaimer -This documentation assumes Nimbus is in its ideal state. The project is still under active development. Please submit a [Github issue](https://github.com/status-im/nim-beacon-chain/issues) if you come across a problem. +This documentation assumes Nimbus is in its ideal state. The project is still under active development. Please submit a [Github issue](https://github.com/status-im/nimbus-eth2/issues) if you come across a problem.