Set up the gRPC calls
This step is not required for the node to mine. Even if you receive errors, your node should not be affected and keep mining normally. But you will have issues querying the node info and balance.
gRPC and REST are two different ways your Quilibrium node communicates with the outside world. gRPC is a high-performance connection primarily used for program-to-program communication, such as when running mining software or automated tools.
When you leave the field blank listenGrpcMultiaddr: ""
, you're enabling the public gRPC endpoint, while setting it to listenGrpcMultiaddr: "/ip4/127.0.0.1/tcp/8337"
enables a local endpoint.
Both setups can be used, if you run into issues leaving the field blank is a good option.
After your node has been running for 30 minutes, run the below script to set up the gRPC calls.
Follow the Safety checks before running this script in your server
If you have issues, try the manual method and also see: Troubleshooting
How to enable gRPC calls manually
This interface is read-only, but it does not require a password and doesn't have limits on the number of requests. To stay secure, you should only enable it if you control access with a firewall or only use it from the same computer (localhost). For example, if port 8337 is for gRPC calls, don't allow access to this port from the internet in your firewall. Instead, make sure gRPC calls are only made from your own computer.
Open the file ~/ceremonyclient/node/.config/config.yml
on your local pc using Termius SFTP feature or WinSCP.
Or, if you want to edit the file via terminal, proceed like this:
Open the node config.yml
file:
Find listenMultiaddr: /ip4/0.0.0.0/udp/8336/quic
and replace it with:
There are two empty spaces before the line! If the line is already there, you don't need to make any change.
Find listenGrpcMultiaddr: ""
(end of the file), and replace it with:
If you prefer to connect to the public RPC, simply leave listenGrpcMultiaddr blank: listenGrpcMultiaddr: ""
Find engine:
(about the middle of the file), and paste right below it:
It will look like this (notice the two empty spaces before the statsMultiaddr
line):
Save the file. If you are on terminal you can save by pressing CTRL + X, then Y, then ENTER
Troubleshooting
If after running the automatic script or settings things manually you have issues (for instance your node starting correctly), you may want to pull out a backup of your config.yml file and compare it with your current one. You can use Diffinity to do this.
Check for any strange differences, pieces of code you may have deleted or that the automatic script may have messed up.
Last updated