RSK node can be installed on all major platforms, including Linux, Windows, and Mac. In this tutorial, we provide step-by-step instructions for running a local RegNet node through Docker. Docker installation supports Mac, Windows, and Linux.
The tutorial project files can be downloaded from this github repo.
git clone https://github.com/rsksmart/truffle-integration
cd truffle-integration
For Mac OSX Developers:
Please ensure you are running xcode directly and not the command-line instance. Run
sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
Docker Desktop provides an easy and fast way for running containerized applications on various of operating systems.
For Mac OSX and Windows:
For Linux:
sudo for all docker commands, by default. To avoid this additional steps are required.Ensure that docker is running by running the following command - it should run without any errors.
docker ps
Dockerfiles corresponding to the different environments can be downloaded from the RSK Artifacts page.
Next run the following commands to build the Docker images for each of the environments.
git clone git@github.com:rsksmart/artifacts.git
cd cd artifacts/Dockerfiles/RSK-Node/
docker build -t mainnet -f Dockerfile.MainNet .
docker build -t testnet -f Dockerfile.TestNet .
docker build -t regtest -f Dockerfile.RegTest .
The final line of output for each of the docker build commands should look similar to Successfully tagged regtest:latest.
For this quick start tutorial, we are going to use the RegTest docker
Run this command to build a RSKJ node for RegNet
cd <tutorial-root>/docker/
docker build -t regtest -f Dockerfile.RegTest .
Start a container with the built image. This command will start an RSKJ node with port 4444, 4445 and 30305 open.
docker run -d --name regtest-node-01 -p 4444:4444 -p 4445:4445 -p 30305:30305 regtest
If the container runs successfully, you should get an output that is a hash, for example: 2f75d6c3f08dc15232be42ed2dabcc370742b3dd573f45fcac7253abce151f9d.
You should be able to view the shell output for the container. Instead of the container ID, you may also use the hash that was output previously.
sudo docker container logs --follow regtest-node-01
You should see this in the logs: INFO success: rsk entered RUNNING state, process has stayed up for > than 1 seconds (startsecs). That indicates that an RSKJ node is running within this docker container.
After finishing the tutorial, you can use the following commands to shut down or remove the container.
docker container list
docker kill <container id>
docker rm <container id>
For the above example, <container id> is regtest-node-01.