tinchou/rskj repository overview

⁠Disclaimer

THIS IS NOT AN OFFICIAL BUILD

This is my own build of the RSKj source code, which can be found here: https://github.com/rsksmart/rskj⁠.

This image is not tested nor recommended for production, but might be useful for quick tests, demos, etc..

⁠Basic usage

• Mainnet: docker run -p "5050:5050/udp" -p "5050:5050/tcp" tinchou/rskj
• Testnet: docker run -p "50505:50505/udp" -p "50505:50505/tcp" tinchou/rskj --testnet

⁠RPC

The following configuration will allow querying the RPC server at localhost:4444

• Regtest (with RPC port mapping):

docker run \
    -p "4444:4444" \
    -e "rpc.providers.web.http.bind_address=0.0.0.0" \
    -e "rpc.providers.web.http.hosts.0=localhost" \
    tinchou/rskj --regtest

E.g.:

curl -H "Content-Type: application/json" \
    --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":42}' \
    localhost:4444

⁠About

RskJ is a Java implementation of the RSK node. For more information about RSK, visit www.rsk.co⁠. The RSK white paper⁠ provides a complete conceptual overview of the platform.

If you have questions about the code please find us on

You may also want to check our blog⁠ for articles and updates on the project.

⁠Getting Started

Information about compiling and running an RSK node can be found in the wiki⁠.

⁠Report Security Vulnerabilities

If you find a security issue, please contact us at [email protected]⁠, or report it through our bug bounty program⁠. We reward security experts, software developers and hackers who dedicate time and effort to improve the RSK platform.

⁠License

RskJ is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

⁠Your Pledge

RskJ has been developed with the intention to foster the progress of society. By using RskJ, you make a pledge not to use it to incur in:

• Any kind of illegal or criminal act, activity or business;
• Any kind of act, activity or business that requires any kind of governmental authorization or license to legally occur or exist, without previously obtaining such authorization or license;
• Any kind of act, activity or business that is expected to infringe upon intellectual property rights belonging to other people;
• Any kind of act, activity or business involving dangerous or controlled goods or substances, including stolen goods, firearms, radioactive materials or drugs. Something will be considered illegal, criminal, or requiring any kind of governmental authorization or license, when either the laws or regulations of the country in which you reside, or the laws or regulations of the country from which you use RskJ, consider it illegal, criminal, or requiring any kind of governmental authorization or license.