diff --git a/docs/deploy.md b/docs/deploy.md index dc897d0d..4f0c7a10 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -60,16 +60,16 @@ Now, we can deploy the Blobstream contract to a new EVM chain: blobstream deploy \ --evm.chain-id 4 \ --evm.contract-address 0x27a1F8CE94187E4b043f4D57548EF2348Ed556c7 \ - --core.grpc.host localhost \ - --core.grpc.port 9090 \ + --core.grpc localhost:9090 \ + --core.rpc localhost:26657 \ --starting-nonce latest \ --evm.rpc http://localhost:8545 ``` -The `latest` can be replaced by the following: +The `--starting-nonce` can have the following values: - `latest`: to deploy the Blobstream contract starting from the latest validator set. - `earliest`: to deploy the Blobstream contract starting from genesis. -- `nonce`: you can provide a custom nonce on where you want Blobstream to start. If the provided nonce is not a `Valset` attestation, then the one before it will be used to deploy the Blobstream smart contract. +- `nonce`: you can provide a custom nonce on where you want Blobstream to start. If the provided nonce is not a `Valset` attestation, then the valset before it will be used to deploy the Blobstream smart contract. And, now you will see the Blobstream smart contract address in the logs along with the transaction hash. diff --git a/docs/orchestrator.md b/docs/orchestrator.md index 83d6c93c..827fac6a 100644 --- a/docs/orchestrator.md +++ b/docs/orchestrator.md @@ -120,20 +120,19 @@ Usage: blobstream orchestrator start [flags] ``` +Also, you can set the necessary configuration in the orchestrator's TOML config file. You can find the latter in the orchestrator's home directory under `config/config.toml`. + +> **_NOTE:_** The CLI flags take precedence over the config files for the same parameters. + To start the orchestrator in the default home directory, run the following: ```sh -blobstream orchestrator start \ - --core.grpc.host localhost \ - --core.grpc.port 9090 \ - --core.rpc.host localhost \ - --core.rpc.port 26657 \ - --evm.account 0x966e6f22781EF6a6A82BBB4DB3df8E225DfD9488 \ - --p2p.bootstrappers /ip4/127.0.0.1/tcp/30001/p2p/12D3KooWFFHahpcZcuqnUhpBoX5fJ68Qm5Hc8dxiBcX1oo46fLxh \ - --p2p.listen-addr /ip4/0.0.0.0/tcp/30000 +blobstream orchestrator start --evm.account 0x966e6f22781EF6a6A82BBB4DB3df8E225DfD9488 ``` -And, you will be prompted to enter your EVM key passphrase so that the orchestrator can use it to sign attestations. Make sure that it's the EVM address that was provided when creating the validator. If not, then the orchestrator will not sign, and you will keep seeing a "validator not part of valset" warning message. If you see such message, first verify that your validator is part of the active validator set. If so, then probably the EVM address provided to the orchestrator is not the right one, and you should check which EVM address is registered to your validator. Check the next section for more information. +> **_NOTE:_** The above command assumes that the necessary configuration is specified in the `/config/config.toml` file. + +Then, you will be prompted to enter your EVM key passphrase so that the orchestrator can use it to sign attestations. Make sure that it's the EVM address that was provided when creating the validator. If not, then the orchestrator will not sign, and you will keep seeing a "validator not part of valset" warning message. If you see such message, first verify that your validator is part of the active validator set. If so, then probably the EVM address provided to the orchestrator is not the right one, and you should check which EVM address is registered to your validator. Check the next section for more information. If you no longer have access to your EVM address, you could always edit your validator with a new EVM address. This can be done through the `edit-validator` command. Check the next section. @@ -278,7 +277,7 @@ After=network.target [Service] Type=simple -ExecStart= orchestrator start --evm.account --evm.passphrase --core.grpc.host --core.grpc.port --core.rpc.host --core.rpc.port --p2p.bootstrappers +ExecStart= orchestrator start --evm.account --evm.passphrase LimitNOFILE=infinity LimitCORE=infinity Restart=always diff --git a/docs/relayer.md b/docs/relayer.md index af787155..cb704579 100644 --- a/docs/relayer.md +++ b/docs/relayer.md @@ -108,20 +108,16 @@ Usage: blobstream relayer start [flags] ``` +Also, you can set the necessary configuration in the relayers's TOML config file. You can find the latter in the relayer's home directory under `config/config.toml`. + +> **_NOTE:_** The CLI flags take precedence over the config files for the same parameters. + To start the relayer using the default home directory, run the following: ```sh -/bin/blobstream relayer start \ - --evm.contract-address=0x27a1F8CE94187E4b043f4D57548EF2348Ed556c7 \ - --core.rpc.host=localhost \ - --core.rpc.port=26657 \ - --core.grpc.host=localhost \ - --core.grpc.port=9090 \ - --evm.chain-id=4 \ - --evm.rpc=http://localhost:8545 \ - --evm.account=0x35a1F8CE94187E4b043f4D57548EF2348Ed556c8 \ - --p2p.bootstrappers=/ip4/127.0.0.1/tcp/30001/p2p/12D3KooWFFHahpcZcuqnUhpBoX5fJ68Qm5Hc8dxiBcX1oo46fLxh \ - --p2p.listen-addr=/ip4/0.0.0.0/tcp/30001 +/bin/blobstream relayer start --evm.account=0x35a1F8CE94187E4b043f4D57548EF2348Ed556c8 ``` -And, you will be prompted to enter your EVM key passphrase for the EVM address passed using the `-d` flag, so that the relayer can use it to send transactions to the target Blobstream smart contract. Make sure that it's funded. +> **_NOTE:_** The above command assumes that the necessary configuration is specified in the `/config/config.toml` file. + +Then, you will be prompted to enter your EVM key passphrase for the EVM address passed using the `--evm.account` flag, so that the relayer can use it to send transactions to the target Blobstream smart contract. Make sure that it's funded.