RPC endpoints#

X Layer supports JSON-RPC methods that are compatible with Ethereum, and ZKEVM RPC methods for zkEVM.

Mainnet (chain-id: 0xC4, 196 in decimals)#

RPC:

• ChainID: 196
• https://rpc.xlayer.tech
• https://xlayerrpc.okx.com

Testnet (chain-id: 0xC3, 195 in decimals)#

RPC:

• ChainID: 195
• https://testrpc.xlayer.tech
• https://xlayertestrpc.okx.com

Prerequisite readings#

Before you begin using RPC endpoints on X Layer, it’s important to read the relevant articles for guidance:

• Ethereum JSON-RPC

Starting HTTP JSON-RPC#

To start the HTTP JSON-RPC, curl method is recommended:

# mainnet
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}' -H "Content-Type: application/json" https://rpc.xlayer.tech
# testnet
curl -X POST --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}' -H "Content-Type: application/json" https://testrpc.xlayer.tech

JSON-RPC methods#

There are two types of RPC methods on X Layer, one is Ethereum compatible RPC, and the other one is ZKEVM RPC. Each RPC offers specific functionalities.

1. Ethereum compatible RPC#

Here you will find the list of all supported JSON RPC endpoints and the differences between them in comparison to the default behavior of an Ethereum node. If a specific endpoint is not in the list below, it means that this specific endpoint is not supported yet. You can find more details in Ethereum’s JSON-RPC doc.

2. ZKEVM RPC#

You can use the following RPC methods to execute specific ZKEVM functionalities:

zkevm_batchNumber#

Returns the latest batch number

Parameters

• None

Returns

• String - the hex representation of latest batch number

Example

// Request
curl -X POST --data '{
    "jsonrpc": "2.0",
    "method": "zkevm_batchNumber",
    "params": [],
    "id": 1
}' -H "Content-Type: application/json" https://xlayertestrpc.okx.com/

// Response
{
        "jsonrpc": "2.0",
        "id": 1,
        "result": "0x82"
}

zkevm_batchNumberByBlockNumber#

Returns the batch number of the batch connected to the block

Parameters

• An array of strings
• String - the hex representation of the block's height

Returns

• String - the hex representation of latest batch number

Example

// Request
curl -X POST --data '{
    "jsonrpc": "2.0",
    "method": "zkevm_batchNumberByBlockNumber",
    "params": ["0x2"],
    "id": 1
}' -H "Content-Type: application/json" https://xlayertestrpc.okx.com/

// Response
{"jsonrpc":"2.0","id":1,"result":"0x4"}

zkevm_consolidatedBlockNumber#

Returns the latest block number that is connected to the latest batch verified

Parameters

• None

Returns

• String - the hex representation of latest block number

Example

// Request
curl -X POST --data '{
    "jsonrpc": "2.0",
    "method": "zkevm_consolidatedBlockNumber",
    "params": [],
    "id": 1
}' -H "Content-Type: application/json" https://xlayertestrpc.okx.com/

// Response
{"jsonrpc":"2.0","id":1,"result":"0x84"}

zkevm_getBatchByNumber#

Gets a batch for a given number

Parameters

• An array of strings
• String - the batch number (in hex) or batch tag

The optional batch height descriptions are:

• latest - This is the most recent batch in the canonical chain observed by the client. This batch may be re-orged out of the canonical chain even under healthy/normal conditions.
• earliest - This is the lowest-numbered batch the client has available. Intuitively, you can think of this as the first batch created.

Returns

• number: string - the hex representation of given batch number
• coinbase: string - the Coinbase address
• stateRoot: string - the state root
• globalExitRoot: string - the global exit root
• mainnetExitRoot: string - the mainnet exit root
• rollupExitRoot: string - the rollup exit root
• localExitRoot: string - the local exit root
• accInputHash: string - the accumulated input hash
• timestamp: string - the timestamp
• sendSequencesTxHash: string - the send sequences transaction hash
• verifyBatchTxHash: string - the verify batch transaction hash
• transactions: array[String] - the transactions

Example

// Request
curl -X POST --data '{
    "jsonrpc": "2.0",
    "method": "zkevm_getBatchByNumber",
    "params": ["0x2"],
    "id": 1
}' -H "Content-Type: application/json" https://xlayertestrpc.okx.com/

// Response
{"jsonrpc":"2.0","id":1,"result":{"number":"0x2","coinbase":"0xcec3f45ca495d89a37ff680c087df91741aa9ef6","stateRoot":"0xe683502473ee45ab47f55ea254bb8637f5324250e758e391476b15388f818617","globalExitRoot":"0xe95ee03593d34c4ff03c2e5369cf6eaef4e3e19fc66ab1c93d512fcccbc33f41","mainnetExitRoot":"0x2c352238d75ce63aa81d466c6d17aa41bc12dce33c954a10d6752f6863e42511","rollupExitRoot":"0x0000000000000000000000000000000000000000000000000000000000000000","localExitRoot":"0x0000000000000000000000000000000000000000000000000000000000000000","accInputHash":"0xb36f9860fd62baa2ecbf52ed337a0e9686bce2441909c80f541b98c88601c84c","timestamp":"0x64f5d7a1","sendSequencesTxHash":"0x77f311f450e7d1075b4c5e51e2ac727c74082eed7494d5e7d74fa40f4ff6b071","verifyBatchTxHash":"0x519da5b4a2f6ce344f749e5e553588b61b661280a9d8dfd0cc6b03cab74cb0da","transactions":["0x5e33e1eb2064e3bad97b3734b2aa25882ecd88f9f91da81d1526dbbc90a531b8"]}}

zkevm_isBlockConsolidated#

Returns true if the provided block number is already connected to a batch that was already verified, otherwise false

Parameters

• String - the hex representation of the block's height

Returns

• Boolean - result of verified

Example

// Request
curl -X POST --data '{
    "jsonrpc": "2.0",
    "method": "zkevm_isBlockConsolidated",
    "params": ["0x1"],
    "id": 1
}' -H "Content-Type: application/json" https://xlayertestrpc.okx.com/

// Response
{"jsonrpc":"2.0","id":1,"result":true}

zkevm_isBlockVirtualized#

Returns true if the provided block number is already connected to a batch that was already virtualized, otherwise false

Parameters

• String - the hex representation of the block's height

Returns

• Boolean - result of virtualized

Example

// Request
curl -X POST --data '{
    "jsonrpc": "2.0",
    "method": "zkevm_isBlockVirtualized",
    "params": ["0x12"],
    "id": 1
}' -H "Content-Type: application/json" https://xlayertestrpc.okx.com/

// Response
{"jsonrpc":"2.0","id":1,"result":true}

zkevm_verifiedBatchNumber#

Returns the latest verified batch number

Parameters

• None

Returns

• Boolean - the latest verified batch number

Example

// Request
curl -X POST --data '{
    "jsonrpc": "2.0",
    "method": "zkevm_verifiedBatchNumber",
    "params": [],
    "id": 1
}' -H "Content-Type: application/json" https://xlayertestrpc.okx.com/

// Response
{"jsonrpc":"2.0","id":1,"result":"0x81"}

zkevm_virtualBatchNumber#

Returns the latest virtual batch number

Parameters

• None

Returns

• Boolean - the latest virtual batch number

Example

// Request
curl -X POST --data '{
    "jsonrpc": "2.0",
    "method": "zkevm_virtualBatchNumber",
    "params": [],
    "id": 1
}' -H "Content-Type: application/json" https://xlayertestrpc.okx.com/

// Response
{"jsonrpc":"2.0","id":1,"result":"0x81"}

Infrastructure providers#

Public RPCs may have rate limits or traffic restrictions. For dedicated free RPC URLs, consider the following providers:

• ZAN
• Ankr