World Chain API Quickstart

Get started building on World Chain and using the JSON-RPC API

Introduction

World Chain is a blockchain designed for humans, created by Worldcoin to accelerate the adoption of Proof of Personhood and decentralized finance. It offers priority blockspace for verified humans, a gas allowance for casual transactions, and deep integration with the Worldcoin protocol.

What is the World Chain API?

The World Chain API allows interaction with the World Chain 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.

npmyarn
Begin with npm by following the npm documentation.For yarn, refer to yarn's installation guide.

2. Set Up Your Project

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

mkdir worldchain-api-quickstart
cd worldchain-api-quickstart
npm init --yes
mkdir worldchain-api-quickstart
cd worldchain-api-quickstart
yarn init --yes

This creates a new directory named worldchain-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://worldchain-mainnet.g.alchemy.com/v2/${apiKey}`;

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 World Chain mainnet:

node index.js

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

Latest Block: 0x...

Next Steps

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

ReadMe