Skip to content

Here you will find the ABIs for the existing precompiled contracts in Rootstock. You will also get their addresses and a builder to use it with web3js.

Notifications You must be signed in to change notification settings

rsksmart/precompiled-abis

Repository files navigation

Github CI/CD CodeQL

Rootstock

Welcome to the precompiled ABIs from Rootstock

Here you will find the ABIs for the existing precompiled contracts in Rootstock. You will also get their addresses and a builder to use it with web3js.

Version

Different versions of the package mentioned are required for different Rootstock releases.

Until Fingerroot, the semantic versioning of this package doesn’t correlate to the semantic versioning of Rootstock. For each named release of Rootstock, there will be a corresponding name version in npm.

This package's support starts with ORCHID.

How to use it

For the installation of these package you must execute in a terminal window:

npm install @rsksmart/rsk-precompiled-abis@<version>

As an example to define and use it:

  1. Include the Web3 package.
const Web3 = require('web3');
  1. Include the rsk-precompiled-abis package.
const precompiled = require('@rsksmart/rsk-precompiled-abis');
  1. Create an instance of the contract using package build method and Web3 as a parameter.

(i.e.: using Bridge)

var bridge = precompiled.bridge.build(new Web3('http://localhost:4444'));
  1. Use a contract's method. For example, here we call getFederationAddress, and displays its result in the console.
bridge.methods.getFederationAddress().call().then(console.log);

Important note

If the version to be installed is not defined in the command line, it will install the latest version by default.

Versioning table

Package Version RSK version
1.0.0-ORCHID ORCHID-0.6.2
2.0.0-WASABI WASABI-1.0.0
2.0.1-WASABI WASABI-1.0.0
3.0.0-PAPYRUS PAPYRUS-2.0.0
4.0.0-IRIS IRIS-3.0.0
4.0.2-IRIS IRIS-3.0.0
5.0.0-HOP HOP-4.0.0
5.0.0-FINGERROOT FINGERROOT-5.0.0
6.0.0-ARROWHEAD ARROWHEAD-6.0.0
7.0.0-LOVELL LOVELL-7.0.0

Rootstock Bridge Methods Selectors and Events Topics page

A standalone HTML project to get the RSK bridge methods selectors and events topics is included under /tools folder, called PrecompiledAbis.html.

Simply download it and open it in the browser, or visit https://rsksmart.github.io/precompiled-abis/ to view the available HTML tools directly from this repo.

Rootstock bridge abis methods

Rootstock bridge abis events

You can see the rsk bridge abi methods and events during a given fork by selecting using the Abis For Fork dropdown.

RootstockBridge HTML utility page

A standalone HTML project to interact with the RSK bridge methods is included under /tools folder, called RootstockBridge.html.

Simply download it and open it in the browser.

It will look like this:

Rootstock bridge html utility project

Simply click on any of the buttons with the name of the Bridge method that you want to call.

For the ones that accept input, simply add the inputs required and click the button.

Change the network from Testnet to Mainnet using the Network select at the top of the page.

Clear all the inputs and results clicking on the Clear button.

Copy the result by clicking on the copy icon to the right of the result box.

To use a custom network, click on Use Custom Network checkbox and you will have a text field to input a custom url. Hit enter/return and use the tool as usual.

About

Here you will find the ABIs for the existing precompiled contracts in Rootstock. You will also get their addresses and a builder to use it with web3js.

Resources

Stars

Watchers

Forks