Rollux — eth, optimism

API reference for Rollux. All methods ->

eth_getUncleByBlockHashAndIndex

Returns information about an uncle of a block by hash and uncle index position.

Parameters

• id (integer; required): a request ID (example: 1).

• jsonrpc (string; required): a JSON RPC spec used (example: 2.0).

• method (string; required): a method used for the request.

• params (array; required):

  1. <string> (data, 32 bytes): the hash of a block.
  2. <string> (quantity): the uncle's index position.

Returns

• <object>: a block object, or null when no block was found:
  • number (string; quantity): the block number; null when it's a pending block.
  • hash (string; data, 32 bytes): the hash of the block; null when it's a pending block.
  • parentHash (string; data, 32 bytes): the hash of the parent block.
  • nonce (string; data, 8 bytes): the hash of the generated proof-of-work; null when it's a pending block.
  • sha3Uncles (string; data, 32 bytes): SHA3 of the uncles data in the block.
  • logsBloom (string; data, 256 bytes): the bloom filter for the logs of the block. null when its pending block.
  • transactionsRoot (string; data, 32 bytes): the root of the transaction trie of the block.
  • stateRoot (string; data, 32 bytes): the root of the final state trie of the block.
  • receiptsRoot (string; data, 32 bytes): the root of the receipts trie of the block.
  • miner (string; data, 20 bytes): the address of the beneficiary to whom the mining rewards were given.
  • difficulty (string; quantity): the difficulty for this block.
  • totalDifficulty (string; quantity): the total difficulty of the chain until this block.
  • extraData (string; data): the extra data field of this block.
  • size (string; quantity): the size of this block in bytes.
  • gasLimit (string; quantity): the maximum gas allowed in this block.
  • gasUsed (string; quantity): the total used gas by all transactions in this block.
  • timestamp (string; quantity): the unix timestamp for when the block was collated.
  • transactions (array of strings): an array of transaction objects, or 32 bytes transaction hashes depending on the last given parameter.
  • uncles (array of strings): an array of uncle hashes.

Request example

curl -X POST https://rpc.ankr.com/rollux/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getUncleByBlockHashAndIndex",
      "params": ["0x09a358b7a22b1edea3e7dd72bb265aeca6a1cafe4487330c0be5d8fff9a32376", "0x0"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "difficulty": "0x4ea3f27bc",
        "extraData": "0x476574682f4c5649562f76312e302e302f6c696e75782f676f312e342e32",
        "gasLimit": "0x1388",
        "gasUsed": "0x0",
        "hash": "0xdc0818cf78f21a8e70579cb46a43643f78291264dda342ae31049421c82d21ae",
        "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
        "miner": "0xbb7b8287f3f0a933474a79eae42cbca977791171",
        "mixHash": "0x4fffe9ae21f1c9e15207b1f472d5bbdd68c9595d461666602f2be20daf5e7843",
        "nonce": "0x689056015818adbe",
        "number": "0x1b4",
        "parentHash": "0xe99e022112df268087ea7eafaf4790497fd21dbeeb6bd7a1721df161a6657a54",
        "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
        "size": "0x220",
        "stateRoot": "0xddc8b0234c2e0cad087c8b389aa7ef01f7d79b2570bccb77ce48648aa61c904d",
        "timestamp": "0x55ba467c",
        "totalDifficulty": "0x78ed983323d",
        "transactions": [],
        "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "uncles": []
    }
}

---

eth_getUncleByBlockNumberAndIndex

Returns information about an uncle of a block by number and uncle index position.

Parameters

• id (integer; required): a request ID (example: 1).

• jsonrpc (string; required): a JSON RPC spec used (example: 2.0).

• method (string; required): a method used for the request.

• params (array; required):

  1. <string> (quantity|tag): either the hex value of a block number or one of the following block tags:
     • earliest: the lowest numbered block available on the client.
     • finalized: the most recent crypto-economically secure block; cannot be re-orged outside of manual intervention driven by community coordination.
     • safe: the most recent block that is safe from re-orgs under honest majority and certain synchronicity assumptions.
     • latest: the most recent block in the canonical chain observed by the client; this block can be re-orged out of the canonical chain even under healthy/normal conditions.
     • pending: a sample next block built by the client on top of the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.
  2. <string> (quantity): the uncle's index position.

Returns

• <object>: a block object, or null when no block was found:
  • number (string; quantity): the block number; null when it's a pending block.
  • hash (string; data, 32 bytes): the hash of the block; null when it's a pending block.
  • parentHash (string; data, 32 bytes): the hash of the parent block.
  • nonce (string; data, 8 bytes): the hash of the generated proof-of-work; null when it's a pending block.
  • sha3Uncles (string; data, 32 bytes): SHA3 of the uncles data in the block.
  • logsBloom (string; data, 256 bytes): the bloom filter for the logs of the block. null when its pending block.
  • transactionsRoot (string; data, 32 bytes): the root of the transaction trie of the block.
  • stateRoot (string; data, 32 bytes): the root of the final state trie of the block.
  • receiptsRoot (string; data, 32 bytes): the root of the receipts trie of the block.
  • miner (string; data, 20 bytes): the address of the beneficiary to whom the mining rewards were given.
  • difficulty (string; quantity): the difficulty for this block.
  • totalDifficulty (string; quantity): the total difficulty of the chain until this block.
  • extraData (string; data): the extra data field of this block.
  • size (string; quantity): the size of this block in bytes.
  • gasLimit (string; quantity): the maximum gas allowed in this block.
  • gasUsed (string; quantity): the total used gas by all transactions in this block.
  • timestamp (string; quantity): the unix timestamp for when the block was collated.
  • transactions (array of strings): an array of transaction objects, or 32 bytes transaction hashes depending on the last given parameter.
  • uncles (array of strings): an array of uncle hashes.

Request example

curl -X POST https://rpc.ankr.com/rollux/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getUncleByBlockNumberAndIndex",
      "params": ["latest", "0x0"],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "difficulty": "0x57f117f5c",
        "extraData": "0x476574682f76312e302e302f77696e646f77732f676f312e342e32",
        "gasLimit": "0x1388",
        "gasUsed": "0x0",
        "hash": "0x932bdf904546a2287a2c9b2ede37925f698a7657484b172d4e5184f80bdd464d",
        "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
        "miner": "0x5bf5e9cf9b456d6591073513de7fd69a9bef04bc",
        "mixHash": "0x4500aa4ee2b3044a155252e35273770edeb2ab6f8cb19ca8e732771484462169",
        "nonce": "0x24732773618192ac",
        "number": "0x299",
        "parentHash": "0xa779859b1ee558258b7008bbabff272280136c5dd3eb3ea3bfa8f6ae03bf91e5",
        "receiptsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "sha3Uncles": "0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347",
        "size": "0x21d",
        "stateRoot": "0x2604fbf5183f5360da249b51f1b9f1e0f315d2ff3ffa1a4143ff221ad9ca1fec",
        "timestamp": "0x55ba4827",
        "totalDifficulty": "0xc46826a2c6a",
        "transactions": [],
        "transactionsRoot": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421",
        "uncles": []
    }
}

---

eth_getLogs

Returns an array of all logs matching a given filter object.

Parameters

• id (integer; required): a request ID (example: 1).

• jsonrpc (string; required): a JSON RPC spec used (example: 2.0).

• method (string; required): a method used for the request.

• params (array; required):

  1. object: the filter options:

     • fromBlock (string; quantity|tag; optional; default: "latest"): either the block number or one of the following block tags:

       • latest: for the last mined block.
       • earliest: for the lowest numbered block available on the client.
       • pending: for not yet mined transactions.

     • toBlock (string; quantity|tag; optional; default: "latest"): either the block number or one of the following block tags:

       • latest: for the last mined block.
       • earliest: for the lowest numbered block available on the client.
       • pending: for not yet mined transactions.

     • address (array of strings; data, 20 bytes; optional): a contract address or a list of addresses from which logs should originate.

     • topics (array of strings; data; optional): an array of 32 bytes data topics. Topics are order-dependent. Each topic can also be an array of data with "or" options.

     • blockhash (string; data, 32 bytes; optional; future): with the addition of EIP-234, blockHash will be a new filter option which restricts the logs returned to the single block with the 32-byte hash blockHash. Using blockHash is equivalent to fromBlock = toBlock = the block number with hash blockHash. If blockHash is present in the filter criteria, then neither fromBlock nor toBlock are allowed.

Returns

• removed (string; tag): true when the log was removed, due to a chain reorganization; false if it's a valid log.
• logIndex (string; quantity): the log index position in the block; null when it's a pending log.
• transactionIndex (string; quantity): the transactions index position log was created from; null when it's a pending log.
• transactionHash (string; data, 32 bytes): a hash of the transactions this log was created from; null when it's a pending log.
• blockHash (string; data, 32 bytes): a hash of the block containing the log; null when it's pending; null when it's a pending log.
• blockNumber (string; quantity): the number of the block containing the log; null when it's pending; null when it's a pending log.
• address (string; data, 20 bytes): an address from which this log originated.
• data (string; data): contains one or more 32 bytes non-indexed arguments of the log.
• topics (array of strings; data): an array of 0 to 4 32 bytes data of indexed log arguments. (In solidity: The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except you declared the event with the anonymous specifier.)

Request example

curl -X POST https://rpc.ankr.com/rollux/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "eth_getLogs",
      "params": [{"address": "0xDeaDDEaDDeAdDeAdDEAdDEaddeAddEAdDEAd0001"}],
      "id": 1
    }'

Response example

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": [
        {
            "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "topics": [
                "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                "0x0000000000000000000000009acbb72cf67103a30333a32cd203459c6a9c3311",
                "0x000000000000000000000000994871e1103c5da4be270365fa62771ea4525520"
            ],
            "data": "0x000000000000000000000000000000000000000000000000000000001ec39aa0",
            "blockNumber": "0xf6289d",
            "transactionHash": "0xc7ed73c9b219d4243872e5993ad2950c8ea87d15af28562d33b0c05d46a90cee",
            "transactionIndex": "0x1e",
            "blockHash": "0x1e12377f0357320c0e5cfcadc2dfbc9c75fc339be668e118c34e4333f835ef31",
            "logIndex": "0x13",
            "removed": false
        },
        {
            "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
            "topics": [
                "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                "0x0000000000000000000000005879975799597392c031f10b6eff282cb7974ac8",
                "0x0000000000000000000000006d52ab66340f3f78d0c1007bec484268876b5948"
            ],
            "data": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "blockNumber": "0xf6289d",
            "transactionHash": "0x0118499f7be4c3510bd60fe3a3aee5f5f316743b6cc13a8cb0528d784f962aec",
            "transactionIndex": "0x20",
            "blockHash": "0x1e12377f0357320c0e5cfcadc2dfbc9c75fc339be668e118c34e4333f835ef31",
            "logIndex": "0x14",
            "removed": false
        }
    ]
}

---

optimism_outputAtBlock

Retrieves the output root at a specific block.

Parameters

• id (integer; required): a request ID (example: 1).

• jsonrpc (string; required): a JSON RPC spec used (example: 2.0).

• method (string; required): a method used for the request.

• params (array; required):

  • blockNumber (quantity|tag): either the 64 bits L2 integer block number or one of the following block tag strings:
    • safe: the most recent block that is safe from re-orgs under honest majority and certain synchronicity assumptions.
    • latest: the most recent block in the canonical chain observed by the client; this block can be re-orged out of the canonical chain even under healthy/normal conditions.
    • pending: a sample next block built by the client on top of the latest and containing the set of transactions usually taken from local mempool. In other words, it is the block that has not been mined yet.

Returns

• <version> (data, 32 bytes): the output root version number, beginning with 0.
• <l2OutputRoot> (data, 32 bytes): the output root.

Request example

curl -X POST https://rpc.ankr.com/rollux_opnode/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "optimism_outputAtBlock",
      "params": ["0x7EFB22"],
      "id": 1
    }'

Response example

{
   "jsonrpc":"2.0",
   "id":1,
   "result":[
      "0x0000000000000000000000000000000000000000000000000000000000000000",
      "0xabe711e34c1387c8c56d0def8ce77e454d6a0bfd26cef2396626202238442421"
   ]
}

---

optimism_syncStatus

Retrieves the synchronization status.

Parameters

• id (integer; required): a request ID (example: 1).
• jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
• method (string; required): a method used for the request.
• params (array; required): None.

Request example

curl -X POST https://rpc.ankr.com/rollux_opnode/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "optimism_syncStatus",
      "params": [],
      "id": 1
    }'

Response example

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "current_l1": {
      "hash": "0x5adcfcbd1c2fcf9e06bfdaa8414a4586f84e11f487396abca940299eb0ed2da5",
      "number": 7569281,
      "parentHash": "0xfd022ca8a8c4e0f3bfd67081c18551840ea0717cc01d9a94601e1e41e92616d3",
      "timestamp": 1662862860
    },
    "head_l1": {
      "hash": "0x5c12fde5ea79aefe4b52c0c8cc0e0eb33a2ccb423cb3cd9c9132e18ad42e89b6",
      "number": 8042823,
      "parentHash": "0x74818f8ecaa932431bf9523e929dcfa11ab382c752529d8271a24810884a2551",
      "timestamp": 1669735356
    },
    "safe_l1": {
      "hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "number": 0,
      "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "timestamp": 0
    },
    "finalized_l1": {
      "hash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "number": 0,
      "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "timestamp": 0
    },
    "unsafe_l2": {
      "hash": "0x1cad05886ec0e2cda728674e00eadcbb9245ff34c0bfd86c866673a615c1c43a",
      "number": 1752,
      "parentHash": "0x0115dbbd26aaf9563d7e3cad65bad41926d94b2643ccb080f71e394c2c3d62a3",
      "timestamp": 1662861300,
      "l1origin": {
        "hash": "0x43fe1601041056e9a2a5dabaa20715518ae0058abf67a69f5ebdd53b1f6ff02f",
        "number": 7569162
      },
      "sequenceNumber": 0
    },
    "safe_l2": {
      "hash": "0x1cad05886ec0e2cda728674e00eadcbb9245ff34c0bfd86c866673a615c1c43a",
      "number": 1752,
      "parentHash": "0x0115dbbd26aaf9563d7e3cad65bad41926d94b2643ccb080f71e394c2c3d62a3",
      "timestamp": 1662861300,
      "l1origin": {
        "hash": "0x43fe1601041056e9a2a5dabaa20715518ae0058abf67a69f5ebdd53b1f6ff02f",
        "number": 7569162
      },
      "sequenceNumber": 0
    },
    "finalized_l2": {
      "hash": "0x6758307d692d4f2f6650acd3762674749a0c1cc2530b9b481845d0f8ee1bd456",
      "number": 0,
      "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
      "timestamp": 1662857796,
      "l1origin": {
        "hash": "0xb0bbb79a00fb8485185b1bedfac386812d662e1cddba77b67a26e1ed9ba8f0ec",
        "number": 7568910
      },
      "sequenceNumber": 0
    }
  }
}

---

optimism_rollupConfig

Retrieves the rollup configuration parameters.

Parameters

• id (integer; required): a request ID (example: 1).
• jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
• method (string; required): a method used for the request.
• params (array; required): None.

Request example

curl -X POST https://rpc.ankr.com/rollux_opnode/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "optimism_rollupConfig",
      "params": [],
      "id": 1
    }'

Response example

{
   "jsonrpc":"2.0",
   "id":1,
   "result":{
      "genesis":{
         "l1":{
            "hash":"0xb0bbb79a00fb8485185b1bedfac386812d662e1cddba77b67a26e1ed9ba8f0ec",
            "number":7568910
         },
         "l2":{
            "hash":"0x6758307d692d4f2f6650acd3762674749a0c1cc2530b9b481845d0f8ee1bd456",
            "number":0
         },
         "l2_time":1662857796
      },
      "block_time":2,
      "max_sequencer_drift":120,
      "seq_window_size":120,
      "channel_timeout":30,
      "l1_chain_id":5,
      "l2_chain_id":28528,
      "p2p_sequencer_address":"0x59dc8e68a80833cc8a9592d532fed42374c8b5dc",
      "fee_recipient_address":"0xdffc6a1c238ff9504b055ad7efeee0148f2d62bd",
      "batch_inbox_address":"0xfeb2acb903f95fb5f5497157c0727a7d16e3fd16",
      "batch_sender_address":"0x4ff79526ea1d492a3db2aa210d7318ff13f2012c",
      "deposit_contract_address":"0xa581ca3353db73115c4625ffc7adf5db379434a8"
   }
}

---

optimism_version

Retrieves the software version.

Parameters

Parameters

• id (integer; required): a request ID (example: 1).
• jsonrpc (string; required): a JSON RPC spec used (example: 2.0).
• method (string; required): a method used for the request.
• params (array; required): None.

Request example

curl -X POST https://rpc.ankr.com/rollux_opnode/YOUR_ANKR_API_KEY \
-H 'Content-Type: application/json' \
-d '{
      "jsonrpc": "2.0",
      "method": "optimism_version",
      "params": [],
      "id": 1
    }'

Response example

{
   "jsonrpc":"2.0",
   "id":1,
   "result":"v0.0.0-"
}