rbbnet / scripts

Scripts para dar suporte às instituições envolvidas com a RBB

Roteiro para rodar os scripts

Este roteiro tem como objetivo explicar como rodar cada script disponível.

Primeiramente, começarei explicando cada seção:

Seção 1 - Preparação

• Nesta seção irá encontrar os pré-requisitos para executar qualquer script deste repositório, tal como os comandos para baixá-lo tanto para Windows quanto para Linux.

Seção 2 - Consultas API BESU (Deve ser executado em Ambiente Windows)

• Nesta seção irá encontrar o roteiro para consultas da rede lab, como por exemplo o AdminPeers, que retorna informações de rede sobre nós remotos conectados.

Atente-se aos avisos, eles contêm o símbolo ⚠️ em seu início.

Seção 3 - Rede Toy (Deve ser executado em Ambiente Linux)

• Nesta seção irá encontrar o roteiro para subir uma rede toy com quantidades de Validator diferentes, como por exemplo o Script com permissionamento (2 validators), que levanta uma rede toy com 2 validators e permissionamento.

Atente-se aos avisos, eles contêm o símbolo ⚠️ em seu início.

1 - Preparação

1.1 - Pré-requisitos

• Yarn
• Node.js

1.2 - Baixar o repositório scripts

Via Windows

• Execute o seguinte comando:

 curl -L -O https://github.com/RBBNet/scripts/archive/refs/tags/v1.0.2.zip

• Agora você deve descompactar e acessar a pasta que contém os scripts desejado

Via Linux

• Execute o seguinte comando:

curl -#SL https://github.com/RBBNet/scripts/archive/refs/tags/v1.0.2.tar.gz | tar xz

• Agora você deve acessar a pasta que contém os scripts desejado

2 - Consultas API Besu

• Execute o comando abaixo para acessar o diretório consultas_api_besu:

cd consultas_api_besu

• ⚠️ Atenção! Antes de executar qualquer script, baixe o enodes.md e adicione dentro desta pasta.

(O arquivo enodes.md é encontrado na RBBNet\participantes, dentro do repositório você escolhe o enodes.md de qual irá te atender melhor entre as pastas lab e piloto.)

Daqui para frente, considere que todos os comandos deverão ser executados dentro do diretório Consultas API Besu.

• Execute o seguinte comando para instalar as dependências:

Via Yarn

yarn install

Via Node

npm install

⚠️ Atenção! Verifique se o tunelamento dos nós estão abertos antes de exercutar qualquer script!!!

⚠️ lembrete! Nesta Seção 2, rode todos os comandos em ambiente Windows (CMD)!!!

2.3 Dashboard

Um Dashboard que contém os script adminPeers e getSignerMetrics em conjunto.

• Execute o seguinte comando para rodar o Dashboard:

auto.bat

ou, caso preferir, rode cada script separado a seguir:

2.2 adminPeers

• Execute o seguinte comando para rodar o script adminPeers:

node adminPeers.js

2.1 SignerMetrics

• Execute o seguinte comando para rodar o script SignerMetrics:

node getSignerMetrics.js

3 - Rede Toy

⚠️ lembrete! Nesta Seção 3, rode todos os comandos em ambiente Linux!!!

• Execute o comando abaixo para acessar o diretório rede_toy:

cd rede_toy

• Edite o script que deseja alterando as seguintes variáveis:

projectname="NomeDoProjeto"
branch="-b NomeDaBranch"

PortaBoot="10071"
PortaValidator="10072"
PortaWriter="10073"

• projectname -> Nome da pasta que deseja.
• branch -> Selecione a branch do repositório Permissionamento que deseja usar. Este é o repositório que contém o código dos smart contracts de permissionamento.
• Portas -> São as portas RPC (default 8545). Altere para não dar conflito com outras que já estão levantadas e ocasionar um erro.

Caso queria mover o arquivo para uma pasta de sua escolha que deseja executar o script, use o comando mv, por exemplo:

mv <script.sh> /caminho_da_pasta/pasta

3.1 - Script sem permissionamento (1 validator)

Script para subir uma Rede Toy com 1 Validator e sem Permissionamento.

• Execute os seguintes comandos:

chmod +x 01_Script_sem_permissionamento_1_validator.sh
./01_Script_sem_permissionamento_1_validator.sh

3.2 - Script com permissionamento (1 validator)

Script para subir uma Rede Toy com 1 Validator e com Permissionamento.

• Execute os seguintes comandos:

chmod +x 02_Script_com_permissionamento_1_validator.sh
./02_Script_com_permissionamento_1_validator.sh

3.3 - Script com permissionamento (2 validators)

Script para subir uma Rede Toy com 2 Validators e com Permissionamento.

• Execute os seguintes comandos:

chmod +x 03_Script_com_permissionamento_2_validators.sh
./03_Script_com_permissionamento_2_validators.sh

3.4 - Script com permissionamento (4 validators)

Script para subir uma Rede Toy com 3 Validators e com Permissionamento.

• Execute os seguintes comandos:

chmod +x 04_Script_com_permissionamento_4_validators.sh
./04_Script_com_permissionamento_4_validators.sh

Versionamento

Mais informações aqui. O versionamento semântico é uma boa prática que adotamos, seguindo o guia disponível em https://semver.org/. O Permissionamento já segue essa prática.

No caso dos scripts, a API pública são os próprios scripts.

⚠️ IMPORTANTE: ler sessão Dinâmica, que dita o comportamento para a implementação de novas funcionalidades.