Alastria red B Network is a public-permissioned Blockchain network that uses the Hyperledger BESU technology, IBFT 2.0 consensus algorithm, and it's managed by Alastria partners, 🖖.
There are 2 main steps to set up an Alatria Node:
1. Installation & configuration: There are two different ways to install the Alastria Besu node.
- Docker: Follow the installation steps in this document and your node will be ready.
- Binary: Please navigate to the Binaries doc
2. Getting permissioned: In order to use Alastria Network, your node must be previously accepted.
If you are a rookie in Blockchain or Ethereum please consider reading these references:
If you would like you to know more about Hyperledger Ecosystem, this link is a good start.
Alastria partners can add its own node. Otherwise contact [email protected] to start with administrative permissioning.
There are 2 main steps to set up an Alatria Node:
1. Installation: Follow the installation process and your node will be ready to be permissioned.
2. Getting permissioned: In order to use Alastria Network, your node must be previously accepted, after filling the form.
If a member wants to remove a node from the network, please send us a removal request using the same electronic form.
Before starting, consider the following guide to add a dedicated disk for the node database, independent of the system disk.
The following process explains the installation for a node:
- Clone or download this repository:
git clone https://github.com/alastria/alastria-node-besu.git- Edit the
.envfile in the docker-compose directory and modify the NODE_NAME attribute:
cd alastria-node-besu/docker-composeSet the NODE_NAME attribute according to the name you want for this node. The name SHOULD follow the convention:
REG_<COMPANY>_B_<Y>_<Z>_<NN>
Where <COMPANY> is your company/entity name, <Y> is the number of processors of the machine, <Z> is the amount of memory in Gb and <NN> is a sequential counter for each machine that you may have (starting at 00). For example:
NODE_NAME="REG_ExampleOrg_B_2_8_00"
This is the name that will be given to the docker container.
-
Optionally, uncomment the RPC API and/or WebSocket ports of the container in the
docker-compose.yamlif you need to use them. -
To start the node run:
docker-compose up -dWe are done. Now, we will have the followings available:
-
Node's database at
/data/alastria-node-besu/database -
Node's logging files at
/data/alastria-node-besu/logs -
Node's keys files at
/data/alastria-node-besu/keys
All nodes in Alastria Networks must be permissioned. To ask for permission you must enter your data in this electronic form, providing these information of your node:
1. ENODE: String ENODE from ENODE_ADDRESS (enode://ENODE@IP:30303)
2. Public IP: The external IP of your node.
3. System details: Hosting provider, number of cores (vCPUs), RAM Memory and Hard disk size.
In order to get permissioning, follow these steps to get the information that you will be asked for in the previous form:
-
You can find the ENODE_ADDRESS using
curl -X POST --data '{"jsonrpc":"2.0","method":"admin_nodeInfo","params":[],"id":1}' http://127.0.0.1:8545. -
Get the IP address of your node, as seen from the external world.
curl https://ifconfig.me/- Once your request is fulfilled after form submission, you will see that your node starts connecting to its peers and starts synchronizing the blockchain. The process of synchronization can take hours or even one or two days depending on the speed of your network and machine.
If your installation was done with docker-compose everything is set up in the container and there's nothing else to do 🎉
However, if your installation was done prior to June 2022, ensure you have the more up-to-date code running in your machine following these steps:
- Stop the node with
docker-compose down - Do a backup of the
docker-compose.ymland the.envfiles to make sure you don't lose any configuration - Pull the more current code from the repository with
git pull - Edit the
docker-compose.ymland the.envfiles if you need a custom configuration involumesandportssections, and to set the type and the name of your node - Start the container forcing the image to be build again with
docker-compose up --build -d
We can add an additional security layer to our Besu node using API Key implementation in order to identify or authenticate an user for using the service.
Please, navigate to the section to set up the node. 👉 API Key
-
Operating System: Ubuntu 16.04/18.04/20.04 LTS 64 bits. CentOS, Redhat,... and other rpm systems are also allowed.
-
Hosting: Euro Zone; in order to complain with GDPR directives.
-
Hardware:
| Hardware | Minimum | Desired |
|---|---|---|
| CPU's: | 2 | 4 |
| Memory: | 4 Gb | 8 Gb |
| Hard Disk (SSD): | 256 Gb | 512 Gb |
Blockchain database is about 16Gb at mid-2021 and grows at rate of 2Gb/month. Take this into consideration when provisioning space for cache, logs etc. SSD Disk is mandatory
You need to open the following ports to deploy a node:
| Port | Type | From | Definition |
|---|---|---|---|
| 30303 | TCP | 0.0.0.0 | Ethereum client data transfer ports |
| 30303 | UDP | 0.0.0.0 | Ethereum client listener and discovery ports |
| 9545 | TCP | 18.201.52.140 | Scraping Prometheus metrics from Alastria |
Notes:
- Default Alastria configuration exposes BESU metrics in
tcp/9545port and exposeshttp://node_ip:9545/metricsroute in order to be integrated in your local monitoring infraestructure. More information in https://besu.hyperledger.org/public-networks/how-to/monitor/metrics and https://grafana.com/grafana/dashboards/16455-besu-full/. Please, keep this access restricted to authorized hosts, as described in the documentation.
| Port | Type | From | Definition |
|---|---|---|---|
| 8080 | TCP | (orion parners) | |
| 8545 | TCP | (web3 client) | json+rpc (in case you use remix/truffle/.../web3) |
| 8546 | TCP | (web3 client) | json+ws (in case you use remix/truffle/.../web3) |
Notes:
⚠️ Please, be very carefull opening web3 ports: this protocol does not have enabled (natively) neither authentication nor encryption!⚠️ Opening web3 ports, can be tuned in/data/alastria-node-besu/config/config.tomlfile: listening interface,web3methods available,...- Ninja sysadmins don't use outbound firewall rules 😂
Alastria has a group of channels available on Slack message platform, url: alastria.slack.com. You need to be invited, for it, please send a email to [email protected] asking to join the channel. Provide the following information:
- Name and organization.
- e-mail address to be added.
- Channel list where to be joined.
Once accepted in the Alastria Slack group you are automatically included in:
#generalGeneral purpose channel (public)#notificacionesNotifications Github channel (public)
You can add yourself to the following channels:
#besu-groupChannel for thered Bteam, 🍺
- How how can I see the logs of the container?
docker logs -f NODE_NAME- How to know if the node is already permissioned?
2021-04-29 14:58:44.465+00:00 | EthScheduler-Services-5 (importBlock) | INFO | FullImportBlockStep | Import reached block 10145800 (0x82c9..ea34), Peers: 1
The last column should show, at least, one "Peer".
- How to know if the node has finished syncing?
Use eth_syncing method to see the synchronization progress:
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}' http://127.0.0.1:8545- How can I manage the node?
curl -X POST --data '{"jsonrpc":"2.0","method":"admin_peers","params":[],"id":1}' http://127.0.0.1:8545
curl -X POST --data '{"jsonrpc":"2.0","method":"admin_nodeInfo","params":[],"id":1}' http://127.0.0.1:8545Other ADMIN methods, in Besu API method
Also, IBFT and PERM methods (for validator nodes), in Private network API methods
- Will the functionality (docker | ansible | whatever) be supported soon?
It's in your hands! Alastria is an open group and everyone is welcome to contribute. If you need any support we are here to help 🤗
- Connection from Remix/Truffle/Hardhat
You can refer to the smart-contract-deployment repository.
- Red B Blockscout Network Explorer - Hosted by Izertis 🙌
- Red B Network Monitor (login alastria/alastria) - Hosted by Alastria 🙌