Rootstock API Quickstart

Introduction

Rootstock is the first and longest-lasting Bitcoin sidechain, combining the security of Bitcoin's proof of work with Ethereum's smart contract capabilities. It's an open-source, EVM-compatible platform secured by over 60% of Bitcoin's hashing power, allowing developers to build trustless, innovative dApps within a thriving ecosystem.

What is the Rootstock API?

The Rootstock API allows interaction with the Rootstock network through a set of JSON-RPC methods. Its design is familiar to developers who have worked with Ethereum's JSON-RPC APIs, making it intuitive and straightforward to use.

Getting Started Instructions

1. Choose a Package Manager (npm or yarn)

Select a package manager to manage your project's dependencies. Choose between npm and yarn based on your preference or project requirements.

2. Set Up Your Project

Open your terminal and execute the following commands to create and initialize your project:

mkdir rootstock-api-quickstart
cd rootstock-api-quickstart
npm init --yes

mkdir rootstock-api-quickstart
cd rootstock-api-quickstart
yarn init --yes

This creates a new directory named rootstock-api-quickstart and initializes a Node.js project within it.

3. Make Your First Request

Install Axios, a popular HTTP client, to make API requests:

npm install axios
# Or with yarn
# yarn add axios

Create an index.js file in your project directory and paste the following code:

const axios = require('axios');

const url = `https://rootstock-mainnet.g.alchemy.com/v2/${yourAPIKey}`;

const payload = {
  jsonrpc: '2.0',
  id: 1,
  method: 'eth_blockNumber',
  params: []
};

axios.post(url, payload)
  .then(response => {
    console.log('Latest Block:', response.data.result);
  })
  .catch(error => {
    console.error(error);
  });

4. Run Your Script

Execute your script to make a request to the Rootstock mainnet:

node index.js

You should see the latest block information from Rootstock's mainnet outputted to your console:

Latest Block: 0x...

Next Steps

Congratulations! You've made your first request to the Rootstock API on the mainnet. You can now explore the various JSON-RPC methods available on Rootstock and start building your dApps on this innovative platform.