Dead link fixes and other small improvements to the fluffy book (#1859)

This commit is contained in:
Kim De Mey 2023-10-25 13:23:17 +02:00 committed by GitHub
parent 26ede94a73
commit 75b62b45f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 20 additions and 21 deletions

View File

@ -11,7 +11,7 @@
## Introduction ## Introduction
Fluffy is the Nimbus client implementation of the Fluffy is the Nimbus client implementation of the
[Portal network specifications](https://github.com/ethereum/portal-network-specs/blob/master/portal-network.md). [Portal network specifications](https://github.com/ethereum/portal-network-specs).
You can find all the information you need to run a Fluffy node in You can find all the information you need to run a Fluffy node in
[The Fluffy Book](https://status-im.github.io/nimbus-eth1). [The Fluffy Book](https://status-im.github.io/nimbus-eth1).

View File

@ -14,7 +14,7 @@ E.g.:
<!-- TODO: Add most important development tips from following page here and <!-- TODO: Add most important development tips from following page here and
remove the link --> remove the link -->
More [development tips](https://github.com/status-im/nimbus-eth1/README.md#devel-tips) More [development tips](https://github.com/status-im/nimbus-eth1/blob/master/README.md#devel-tips)
can be found on the general nimbus-eth1 readme. can be found on the general nimbus-eth1 readme.
The code follows the The code follows the

View File

@ -1,7 +1,7 @@
# The Nimbus Fluffy Guide # The Nimbus Fluffy Guide
Fluffy is the Nimbus client implementation of the Fluffy is the Nimbus client implementation of the
[Portal network specifications](https://github.com/ethereum/portal-network-specs/blob/master/portal-network.md). [Portal network specifications]https://github.com/ethereum/portal-network-specs).
The Portal Network aims to deliver a reliable, sync-free, and decentralized The Portal Network aims to deliver a reliable, sync-free, and decentralized
access to the Ethereum blockchain. The network can be used by a light client to access to the Ethereum blockchain. The network can be used by a light client to

View File

@ -46,10 +46,10 @@ installed:
!!! note !!! note
If the online installer isn't working you can try installing `mingw-w64` through [MSYS2](https://www.msys2.org/). If the online installer isn't working you can try installing `mingw-w64` through [MSYS2](https://www.msys2.org/).
- Install [cmake](https://cmake.org/). - Install [CMake](https://cmake.org/).
- Install [Git for Windows](https://gitforwindows.org/) and use a "Git Bash" - Install [Git for Windows](https://gitforwindows.org/) and use a "Git Bash"
shell to clone nimbus-eth1 and build fluffy. shell to clone nimbus-eth1 and build Fluffy.
=== "Android" === "Android"

View File

@ -12,21 +12,15 @@ The guide assumes Windows is being used. For Linux/macOS users follow this
## Steps ## Steps
### Prerequisites ### Prerequisites
- Install & setup Mingw-w64: - Developer tools (C compiler, Make, Bash, CMake, Git 2.9.4 or newer)
- Download Mingw-w64 for your architecture using the "[MinGW-W64 Online
Installer](https://sourceforge.net/projects/mingw-w64/files/)" (first link
under the directory listing).
- Run it and select your architecture in the setup
menu ("i686" on 32-bit, "x86\_64" on 64-bit), set the threads to "win32" and
the exceptions to "dwarf" on 32-bit and "seh" on 64-bit. Change the
installation directory to "C:\mingw-w64".
- 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 [cmake](https://cmake.org/). If you need help installing these tools, you can consult our
[prerequisites page](./prerequisites.md).
- Install [Git for Windows](https://gitforwindows.org/) and use a "Git Bash" !!! note
shell to clone and build Fluffy in the next steps. To build Fluffy on Windows, the MinGW-w64 build environment is recommended.
The build commands in the rest of this page assume the MinGW build
environment is used.
### Build the Fluffy client ### Build the Fluffy client
```bash ```bash

View File

@ -9,7 +9,10 @@ The guide assumes Linux or macOS is being used. For Windows users follow this
## Steps ## Steps
### Prerequisites ### Prerequisites
- GNU Make, Bash and the usual POSIX utilities. Git 2.9.4 or newer. - Developer tools (C compiler, Make, Bash, CMake, Git 2.9.4 or newer)
If you need help installing these tools, you can consult our
[prerequisites page](./prerequisites.md).
### Build the Fluffy client ### Build the Fluffy client
```bash ```bash

View File

@ -22,7 +22,7 @@ activated.
TRUSTED_BLOCK_ROOT=0x1234567890123456789012345678901234567890123456789012345678901234 # Replace with trusted block root. TRUSTED_BLOCK_ROOT=0x1234567890123456789012345678901234567890123456789012345678901234 # Replace with trusted block root.
# Run the script, start 8 nodes + beacon_chain_bridge # Run the script, start 8 nodes + beacon_chain_bridge
./fluffy/scripts/launch_local_testnet.sh -n8 --trusted-block-root ${TRUSTED_BLOCK_ROOT}--beacon-chain-bridge ./fluffy/scripts/launch_local_testnet.sh -n8 --trusted-block-root ${TRUSTED_BLOCK_ROOT} --beacon-chain-bridge
``` ```
## Run the local testnet script and launch the bridge manually ## Run the local testnet script and launch the bridge manually
@ -37,9 +37,11 @@ TRUSTED_BLOCK_ROOT=0x12345678901234567890123456789012345678901234567890123456789
./fluffy/scripts/launch_local_testnet.sh -n8 --trusted-block-root ${TRUSTED_BLOCK_ROOT} ./fluffy/scripts/launch_local_testnet.sh -n8 --trusted-block-root ${TRUSTED_BLOCK_ROOT}
``` ```
Next, start the `beacon_chain_bridge` Next, build and run the `beacon_chain_bridge`
```bash ```bash
make beacon_chain_bridge
# --rpc-port 10000 = default node0 # --rpc-port 10000 = default node0
# --rest-url = access to beacon node API, default http://127.0.0.1:5052 # --rest-url = access to beacon node API, default http://127.0.0.1:5052
./build/beacon_chain_bridge --trusted-block-root:${TRUSTED_BLOCK_ROOT} --rest-url:http://127.0.0.1:5052 --backfill-amount:128 --rpc-port:10000 ./build/beacon_chain_bridge --trusted-block-root:${TRUSTED_BLOCK_ROOT} --rest-url:http://127.0.0.1:5052 --backfill-amount:128 --rpc-port:10000