Skip to main content

Private network API methods

Important
  • This reference contains API methods that apply to only private networks. For API methods that apply to both private and public networks, see the public network API reference.
  • All JSON-RPC HTTP examples use the default host and port endpoint http://127.0.0.1:8545. If using the --rpc-http-host or --rpc-http-port options, update the endpoint.

CLIQUE methods​

The CLIQUE API methods provide access to the Clique consensus engine.

note

The CLIQUE API methods are not enabled by default for JSON-RPC. To enable the CLIQUE API methods use the --rpc-http-api or --rpc-ws-api options.

clique_discard​

Discards a proposal to add or remove a signer with the specified address.

Parameters​

address: string - 20-byte address of proposed signer

Returns​

result: boolean - indicates if the proposal is discarded

curl -X POST --data '{"jsonrpc":"2.0","method":"clique_discard","params":["0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73"], "id":1}' http://127.0.0.1:8545

clique_getSigners​

Lists signers for the specified block.

Parameters​

blockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

note

pending returns the same value as latest.

Returns​

result: array of string - list of 20-byte addresses of signers

curl -X POST --data '{"jsonrpc":"2.0","method":"clique_getSigners","params":["latest"], "id":1}' http://127.0.0.1:8545

clique_getSignerMetrics​

Provides the following validator metrics for the specified range:

  • Number of blocks from each validator

  • Block number of the last block proposed by each validator (if any proposed in the specified range)

  • All validators present in the last block

Parameters​

  • fromBlockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

  • toBlockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

note

pending returns the same value as latest.

If you specify:

  • No parameters, the call provides metrics for the last 100 blocks, or all blocks if there are less than 100 blocks.

  • Only the first parameter, the call provides metrics for all blocks from the block specified to the latest block.

Returns​

result: array of objects - list of validator objects

note

The proposer of the genesis block has address 0x0000000000000000000000000000000000000000.

curl -X POST --data '{"jsonrpc":"2.0","method":"clique_getSignerMetrics","params":["1", "100"], "id":1}' http://127.0.0.1:8545

clique_getSignersAtHash​

Lists signers for the specified block.

Parameters​

hash: string - 32-byte block hash

Returns​

result: array of string - list of 20-byte addresses of signers

curl -X POST --data '{"jsonrpc":"2.0","method":"clique_getSignersAtHash","params":["0x98b2ddb5106b03649d2d337d42154702796438b3c74fd25a5782940e84237a48"], "id":1}' http://127.0.0.1:8545

clique_proposals​

Returns current proposals.

Parameters​

None

Returns​

result: map of strings to booleans - map of account addresses to corresponding boolean values indicating the proposal for each account (if true, the proposal is to add a signer; if false, the proposal is to remove a signer.)

curl -X POST --data '{"jsonrpc":"2.0","method":"clique_proposals","params":[], "id":1}' http://127.0.0.1:8545

clique_propose​

Proposes to add or remove a signer with the specified address.

Parameters​

  • address: string - 20-byte address

  • proposal: boolean - true to propose adding signer or false to propose removing signer

Returns​

result: boolean - true

curl -X POST --data '{"jsonrpc":"2.0","method":"clique_propose","params":["0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73", true], "id":1}' http://127.0.0.1:8545

EEA methods​

The EEA API methods provide functionality for private transactions and privacy groups.

note

The EEA API methods are not enabled by default for JSON-RPC. To enable the EEA API methods, use the --rpc-http-api or --rpc-ws-api options.

eea_sendRawTransaction​

Distributes the private transaction, generates the privacy marker transaction and submits it to the transaction pool, and returns the transaction hash of the privacy marker transaction.

The signed transaction passed as an input parameter includes the privateFrom, privateFor or privacyGroupId, and restriction fields.

The gas and gasPrice are used by the privacy marker transaction not the private transaction itself.

To avoid exposing your private key, create signed transactions offline and send the signed transaction data using eea_sendRawTransaction.

important

For production systems requiring private transactions, use a network with a consensus mechanism supporting transaction finality to make sure the private state does not become inconsistent with the chain. For example, IBFT 2.0 and QBFT provide the required finality.

Using private transactions with pruning or fast sync isn't supported.

Parameters​

transaction: string - signed RLP-encoded private transaction

Returns​

result: string - 32-byte transaction hash of the privacy marker transaction

tip

If creating a contract, use priv_getTransactionReceipt to retrieve the contract address after the transaction is finalized.

curl -X POST --data '{"jsonrpc":"2.0","method":"eea_sendRawTransaction","params": ["0xf869018203e882520894f17f52151ebef6c7334fad080c5704d77216b732881bc16d674ec80000801ba02da1c48b670996dcb1f447ef9ef00b33033c48a4fe938f420bec3e56bfd24071a062e0aa78a81bf0290afbc3a9d8e9a068e6d74caa66c5e0fa8a46deaae96b0833"], "id":1}' http://127.0.0.1:8545

IBFT 2.0 methods​

The IBFT API methods provide access to the IBFT 2.0 consensus engine.

note

The IBFT API methods are not enabled by default for JSON-RPC. To enable the IBFT API methods, use the --rpc-http-api or --rpc-ws-api options.

ibft_discardValidatorVote​

Discards a proposal to add or remove a validator with the specified address.

Parameters​

address: string - 20-byte address of proposed validator

Returns​

result: boolean - indicates if the proposal is discarded

curl -X POST --data '{"jsonrpc":"2.0","method":"ibft_discardValidatorVote","params":["0xef1bfb6a12794615c9b0b5a21e6741f01e570185"], "id":1}' http://127.0.0.1:8545

ibft_getPendingVotes​

Returns votes cast in the current epoch.

Parameters​

None

Returns​

result: map of strings to booleans - map of account addresses to corresponding boolean values indicating the vote for each account; if true, the vote is to add a validator. If false, the proposal is to remove a validator.

curl -X POST --data '{"jsonrpc":"2.0","method":"ibft_getPendingVotes","params":[], "id":1}' http://127.0.0.1:8545

ibft_getSignerMetrics​

Provides the following validator metrics for the specified range:

  • Number of blocks from each validator

  • Block number of the last block proposed by each validator (if any proposed in the specified range)

  • All validators present in the last block of the range

Parameters​

  • fromBlockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

  • toBlockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

note

pending returns the same value as latest.

If you specify:

  • No parameters, the call provides metrics for the last 100 blocks, or all blocks if there are less than 100 blocks.

  • Only the first parameter, the call provides metrics for all blocks from the block specified to the latest block.

Returns​

result: array of objects - list of validator objects

note

The proposer of the genesis block has address 0x0000000000000000000000000000000000000000.

curl -X POST --data '{"jsonrpc":"2.0","method":"ibft_getSignerMetrics","params":["1", "100"], "id":1}' http://127.0.0.1:8545

ibft_getValidatorsByBlockHash​

Lists the validators defined in the specified block.

Parameters​

block: string - 32-byte block hash

Returns​

result: array of strings - list of validator addresses

curl -X POST --data '{"jsonrpc":"2.0","method":"ibft_getValidatorsByBlockHash","params":["0xbae7d3feafd743343b9a4c578cab5e5d65eb735f6855fb845c00cab356331256"], "id":1}' http://127.0.0.1:8545

ibft_getValidatorsByBlockNumber​

Lists the validators defined in the specified block.

Parameters​

blockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

note

pending returns the same value as latest.

Returns​

result: array of strings - list of validator addresses

curl -X POST --data '{"jsonrpc":"2.0","method":"ibft_getValidatorsByBlockNumber","params":["latest"], "id":1}' http://127.0.0.1:8545

ibft_proposeValidatorVote​

Proposes to add or remove a validator with the specified address.

Parameters​

  • address: string - account address

  • proposal: boolean - true to propose adding validator or false to propose removing validator

Returns​

result: boolean - true

curl -X POST --data '{"jsonrpc":"2.0","method":"ibft_proposeValidatorVote","params":["42d4287eac8078828cf5f3486cfe601a275a49a5",true], "id":1}' http://127.0.0.1:8545

PERM (Permissioning) methods​

The PERM API methods provide permissioning functionality. Use these methods for local permissioning only.

important

The PERM API methods are not enabled by default for JSON-RPC. To enable the PERM API methods, use the --rpc-http-api or --rpc-ws-api CLI options.

perm_addAccountsToAllowlist​

Adds accounts (participants) to the accounts permission list.

Parameters​

addresses: array of strings - list of account addresses

note

The parameters list contains a list which is why the account addresses are enclosed by double square brackets.

Returns​

result: string - Success or error (errors include attempting to add accounts already on the allowlist and including invalid account addresses.)

curl -X POST --data '{"jsonrpc":"2.0","method":"perm_addAccountsToAllowlist","params":[["0xb9b81ee349c3807e46bc71aa2632203c5b462032", "0xb9b81ee349c3807e46bc71aa2632203c5b462034"]], "id":1}' http://127.0.0.1:8545

perm_addNodesToAllowlist​

Adds nodes to the nodes allowlist.

To use domain names in enode URLs, ensure you enable DNS support to avoid receiving a request contains an invalid node error.

warning

Enode URL domain name support is an early access feature.

Parameters​

enodes: array of strings - list of enode URLs

note

The parameters list contains a list which is why the enode URLs are enclosed by double square brackets.

Returns​

result: string - Success or error; errors include attempting to add nodes already on the allowlist or including invalid enode URLs.

curl -X POST --data '{"jsonrpc":"2.0","method":"perm_addNodesToAllowlist","params":[["enode://7e4ef30e9ec683f26ad76ffca5b5148fa7a6575f4cfad4eb0f52f9c3d8335f4a9b6f9e66fcc73ef95ed7a2a52784d4f372e7750ac8ae0b544309a5b391a23dd7@127.0.0.1:30303","enode://2feb33b3c6c4a8f77d84a5ce44954e83e5f163e7a65f7f7a7fec499ceb0ddd76a46ef635408c513d64c076470eac86b7f2c8ae4fcd112cb28ce82c0d64ec2c94@127.0.0.1:30304"]], "id":1}' http://127.0.0.1:8545

perm_getAccountsAllowlist​

Lists accounts (participants) in the accounts permissions list.

Parameters​

None

Returns​

result: array of strings - list of accounts (participants) in the accounts allowlist

curl -X POST --data '{"jsonrpc":"2.0","method":"perm_getAccountsAllowlist","params":[], "id":1}' http://127.0.0.1:8545

perm_getNodesAllowlist​

Lists nodes in the nodes allowlist.

Parameters​

None

Returns​

result: array of strings - enode URLs of nodes in the nodes allowlist

curl -X POST --data '{"jsonrpc":"2.0","method":"perm_getNodesAllowlist","params":[], "id":1}' http://127.0.0.1:8545

perm_reloadPermissionsFromFile​

Reloads the accounts and nodes allowlists from the permissions configuration file.

Parameters​

None

Returns​

result: string - Success, or error if the permissions configuration file is not valid

curl -X POST --data '{"jsonrpc":"2.0","method":"perm_reloadPermissionsFromFile","params":[], "id":1}' http://127.0.0.1:8545

perm_removeAccountsFromAllowlist​

Removes accounts (participants) from the accounts permissions list.

Parameters​

addresses: array of strings - list of account addresses

note

The parameters list contains a list which is why the account addresses are enclosed by double square brackets.

Returns​

result: string - Success or error (errors include attempting to remove accounts not on the allowlist and including invalid account addresses.)

curl -X POST --data '{"jsonrpc":"2.0","method":"perm_removeAccountsFromAllowlist","params":[["0xb9b81ee349c3807e46bc71aa2632203c5b462032", "0xb9b81ee349c3807e46bc71aa2632203c5b462034"]], "id":1}' http://127.0.0.1:8545

perm_removeNodesFromAllowlist​

Removes nodes from the nodes allowlist.

Parameters​

enodes: array of strings - list of enode URLs

note

The parameters list contains a list which is why the enode URLs are enclosed by double square brackets.

Returns​

result: string - Success or error (errors include attempting to remove nodes not on the allowlist and including invalid enode URLs.)

curl -X POST --data '{"jsonrpc":"2.0","method":"perm_removeNodesFromAllowlist","params":[["enode://7e4ef30e9ec683f26ad76ffca5b5148fa7a6575f4cfad4eb0f52f9c3d8335f4a9b6f9e66fcc73ef95ed7a2a52784d4f372e7750ac8ae0b544309a5b391a23dd7@127.0.0.1:30303","enode://2feb33b3c6c4a8f77d84a5ce44954e83e5f163e7a65f7f7a7fec499ceb0ddd76a46ef635408c513d64c076470eac86b7f2c8ae4fcd112cb28ce82c0d64ec2c94@127.0.0.1:30304"]], "id":1}' http://127.0.0.1:8545

PRIV methods​

The PRIV API methods provide functionality for private transactions and privacy groups.

note

The PRIV API methods are not enabled by default for JSON-RPC. To enable the PRIV API methods, use the --rpc-http-api or --rpc-ws-api options.

priv_call​

Invokes a private contract function locally and does not change the privacy group state.

For private contracts, priv_call is the same as eth_call for public contracts.

Parameters​

  • privacyGroupId: string - 32-byte privacy Group ID

  • call: object - transaction call object

  • blockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

    note

    pending returns the same value as latest.

Returns​

result: data - return value of the executed contract

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_call","params":["tb8NVyQqZnHNegf/3mYsyB+HEud4SPWn90rz3GoskRw=", {"to":"0x69498dd54bd25aa0c886cf1f8b8ae0856d55ff13","data": "0x3fa4f245"}, "latest"],"id":1}' http://127.0.0.1:8545

priv_createPrivacyGroup​

Creates a group of nodes, specified by their Tessera public key.

Parameters​

options: object - request options object with the following fields:

  • addresses: array of strings - list of nodes specified by Tessera public keys

  • name: string - (optional) privacy group name

  • description: string - (optional) privacy group description

Returns​

result: string - privacy group ID

curl -X POST --data '{"jsonrpc":"2.0","method": "priv_createPrivacyGroup", "params": [{"addresses":["sTZpbQhcOfd9ZaFDnC00e/N2Ofv9p4/ZTBbEeVtXJ3E=","quhb1pQPGN1w8ZSZSyiIfncEAlVY/M/rauSyQ5wVMRE="],"name":"Group A","description":"Description Group A"}],"id":1}' http://127.0.0.1:8545

priv_debugGetStateRoot​

Returns the state root of the specified privacy group at the specified block.

Parameters​

  • privacyGroupId: string - 32-byte privacy Group ID

  • blockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

    note

    pending returns the same value as latest.

Returns​

result: string - 32-byte state root

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_debugGetStateRoot","params":["xJdxvWOEmrs2MCkKWlgArTzWIXFfU/tmVxI3EKssVTk=","latest"],"id":1}' http://127.0.0.1:8545

priv_deletePrivacyGroup​

Deletes the specified privacy group.

Parameters​

privacyGroupId: string - privacy group ID

Returns​

result: string - deleted privacy group ID

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_deletePrivacyGroup","params":["ewuTVoc5nlvWMwTFdRRK/wvV0dcyQo/Pauvx5bNEbTk="],"id":1}' http://127.0.0.1:8545

priv_distributeRawTransaction​

Distributes a signed, RLP encoded private transaction.

tip

If you want to sign the privacy marker transaction outside of Besu, use priv_distributeRawTransaction instead of eea_sendRawTransaction.

Parameters​

transaction: string - signed RLP-encoded private transaction

Returns​

result: string - 32-byte enclave key (the enclave key is a pointer to the private transaction in Tessera.)

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_distributeRawTransaction","params": ["0xf869018203e882520894f17f52151ebef6c7334fad080c5704d77216b732881bc16d674ec80000801ba02da1c48b670996dcb1f447ef9ef00b33033c48a4fe938f420bec3e56bfd24071a062e0aa78a81bf0290afbc3a9d8e9a068e6d74caa66c5e0fa8a46deaae96b0833"], "id":1}' http://127.0.0.1:8545

priv_findPrivacyGroup​

Returns a list of privacy groups containing only the listed members. For example, if the listed members are A and B, a privacy group containing A, B, and C is not returned.

Parameters​

members: array of strings - members specified by Tessera public keys

Returns​

result: array of objects - privacy group objects containing only the specified members; privacy groups are EEA-compliant or Besu-extended with types:

  • LEGACY for EEA-compliant groups.

  • PANTHEON for Besu-extended groups.

curl -X POST --data '{"jsonrpc": "2.0","method": "priv_findPrivacyGroup","params": [["negmDcN2P4ODpqn/6WkJ02zT/0w0bjhGpkZ8UP6vARk=", "g59BmTeJIn7HIcnq8VQWgyh/pDbvbt2eyP0Ii60aDDw="]],"id": 1}' http://127.0.0.1:8545

priv_getCode​

Returns the code of the private smart contract at the specified address. Compiled smart contract code is stored as a hexadecimal value.

Parameters​

  • privacyGroupId: string - 32-byte privacy Group ID

  • address: string - 20-byte contract address

  • blockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

    note

    pending returns the same value as latest.

Returns​

result: data - code stored at the specified address

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_getCode","params":["1lJxSIP4JOp6uRn9wYsPeWwqoOP1c4nPQjylB4FExUA=", "0xeaf1c1bd00ef0bec5e39fba81740f1c5d05aa201", "latest"],"id":1}' http://127.0.0.1:8545

priv_getEeaTransactionCount​

Returns the private transaction count for the specified account and group of sender and recipients.

::caution important If sending more than one transaction to be mined in the same block (that is, you are not waiting for the transaction receipt), you must calculate the private transaction nonce outside Besu instead of using priv_getEeaTransactionCount. :::

Parameters​

  • address: string - account address

  • sender: string - base64-encoded Tessera address of the sender

  • recipients: array of strings - base64-encoded Tessera addresses of recipients

Returns​

result: string - integer representing the number of private transactions sent from the address to the specified group of sender and recipients

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_getEeaTransactionCount","params":["0xfe3b557e8fb62b89f4916b721be55ceb828dbd73", "GGilEkXLaQ9yhhtbpBT03Me9iYa7U/mWXxrJhnbl1XY=", ["KkOjNLmCI6r+mICrC6l+XuEDjFEzQllaMQMpWLl4y1s=","eLb69r4K8/9WviwlfDiZ4jf97P9czyS3DkKu0QYGLjg="]], "id":1}' http://127.0.0.1:8545

priv_getFilterChanges​

Polls the specified filter for a private contract and returns an array of changes that have occurred since the last poll.

Filters for private contracts can only be created by priv_newFilter so unlike eth_getFilterChanges, priv_getFilterChanges always returns an array of log objects or an empty list.

Parameters​

  • privacyGroupId: string - 32-byte privacy Group ID

  • filterId: string - filter ID

Returns​

result: array of objects - list of log objects, or an empty list if nothing has changed since the last poll

curl -X POST --data '{"jsonrpc": "2.0","method": "priv_getFilterChanges","params": ["4rFldHM792LeP/e2WPkTXZedjwKuTr/KwCFTt6mBbkI=","0x4a35b92809d73f4f53a2355d62125442"],"id": 1}' http://127.0.0.1:8545

priv_getFilterLogs​

Returns an array of logs for the specified filter for a private contract.

For private contracts, priv_getFilterLogs is the same as eth_getFilterLogs for public contracts except there's no automatic log bloom caching for private contracts.

note

priv_getFilterLogs is only used for filters created with priv_newFilter. To specify a filter object and get logs without creating a filter, use priv_getLogs.

Parameters​

  • privacyGroupId: string - 32-byte privacy Group ID

  • filterId: string - filter ID

Returns​

result: array of objects - list of log objects

curl -X POST --data '{"jsonrpc": "2.0","method": "priv_getFilterLogs","params":["4rFldHM792LeP/e2WPkTXZedjwKuTr/KwCFTt6mBbkI=","0x4a35b92809d73f4f53a2355d62125442"],"id": 1}' http://127.0.0.1:8545

priv_getLogs​

Returns an array of logs matching a specified filter object.

For private contracts, priv_getLogs is the same as eth_getLogs for public contracts except there is no automatic log bloom caching for private contracts.

Parameters​

Returns​

result: array of objects - list of log objects

curl -X POST --data '{"jsonrpc": "2.0","method": "priv_getLogs","params":["vGy/TZgO6y8VPMVeJAQ99MF1NaTf5ohA3TFfzoEF71k=",{"fromBlock": "earliest","toBlock": "latest","addresses": ["0x630c507ff633312087dc33c513b66276abcd2fc3"],"topics": ["0x85bea11d86cefb165374e0f727bacf21dc2f4ea816493981ecf72dcfb212a410"]}],"id": 1}' http://127.0.0.1:8545

priv_getPrivacyPrecompileAddress​

Returns the address of the privacy precompiled contract. The address is derived and based on the value of the privacy-flexible-groups-enabled option.

Parameters​

None

Returns​

result: string - address of the privacy precompile

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_getPrivacyPrecompileAddress","params":[], "id":1}' http://127.0.0.1:8545

priv_getPrivateTransaction​

Returns the private transaction if you are a participant, otherwise, null.

Parameters​

transaction: string - transaction hash returned by eea_sendRawTransaction.

Returns​

result: object - private transaction object, or null if not a participant in the private transaction

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_getPrivateTransaction","params":["0x623c4ce5275a87b91f4f1c521012d39ca19311c787bde405490f4c0426a71498"], "id":1}' http://127.0.0.1:8545

priv_getTransactionCount​

Returns the private transaction count for specified account and privacy group.

important

If sending more than one transaction to be mined in the same block (that is, you are not waiting for the transaction receipt), you must calculate the private transaction nonce outside Besu instead of using priv_getTransactionCount.

Parameters​

  • address: string - account address

  • privacyGroupId: string - privacy group ID

Returns​

result: string - integer representing the number of private transactions sent from the address to the specified privacy group

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_getTransactionCount","params":["0xfe3b557e8fb62b89f4916b721be55ceb828dbd73", "kAbelwaVW7okoEn1+okO+AbA4Hhz/7DaCOWVQz9nx5M="], "id":1}' http://127.0.0.1:8545

priv_getTransactionReceipt​

Returns information about the private transaction after mining the transaction. Receipts for pending transactions are not available.

Parameters​

transaction: string - 32-byte hash of a transaction

Returns​

result: object - private Transaction receipt object, or null if no receipt found

curl -X POST --data '{"jsonrpc":"2.0","method":"priv_getTransactionReceipt","params":["0xf3ab9693ad92e277bf785e1772f29fb1864904bbbe87b0470455ddb082caab9d"],"id":1}' http://127.0.0.1:8545

priv_newFilter​

Creates a log filter for a private contract. To poll for logs associated with the created filter, use priv_getFilterChanges. To get all logs associated with the filter, use priv_getFilterLogs.

For private contracts, priv_newFilter is the same as eth_newFilter for public contracts.

Parameters​

note

fromBlock and toBlock in the filter options object default to latest.

Returns​

result: string - filter ID

curl -X POST --data '{"jsonrpc": "2.0","method": "priv_newFilter","params": ["4rFldHM792LeP/e2WPkTXZedjwKuTr/KwCFTt6mBbkI=",{"fromBlock": "earliest","toBlock": "latest","addresses": ["0x991cc548c154b2953cc48c02f782e1314097dfbb"],"topics": ["0x85bea11d86cefb165374e0f727bacf21dc2f4ea816493981ecf72dcfb212a410"]}],"id": 1}' http://127.0.0.1:8545

priv_traceTransaction​

Provides a transaction trace for a private transaction.

Parameters​

  • privacyGroupId: string - the privacy group ID associated with the transaction

  • transactionHash: string - the hash of the private transaction to trace

Returns​

result: array of objects - list of calls to other contracts containing one object per call, in the order called by the transaction. If revert reason is enabled with --revert-reason-enabled, the returned list items include the revert reason.

curl -X POST --data '{"jsonrpc": "2.0", "method": "priv_traceTransaction","params": ["0x4c253746668dca6ac3f7b9bc18248b558a95b5fc881d140872c2dff984d344a7", {"privacyGroupId": "Fhya8sZ1SKKH9jMNcZrE2I3i2RJSJIQtrOaZkF8WQcM="}],"id": 1}' http://127.0.0.1:8545

priv_uninstallFilter​

Uninstalls a filter for a private contract with the specified ID. When a filter is no longer required, call this method.

Filters time out when not requested by priv_getFilterChanges or priv_getFilterLogs for 10 minutes.

For private contracts, priv_uninstallFilter is the same as eth_uninstallFilter for public contracts.

Parameters​

  • privacyGroupId: string - 32-byte privacy group ID

  • filterId: string - filter ID

Returns​

result: boolean - indicates if the filter is successfully uninstalled

curl -X POST --data '{"jsonrpc": "2.0","method": "priv_uninstallFilter","params":["4rFldHM792LeP/e2WPkTXZedjwKuTr/KwCFTt6mBbkI=","0x4a35b92809d73f4f53a2355d62125442"],"id": 1}' http://127.0.0.1:8545

QBFT methods​

The QBFT API methods provide access to the QBFT consensus engine.

note

The QBFT API methods are not enabled by default for JSON-RPC. To enable the QBFT API methods, use the --rpc-http-api or --rpc-ws-api options.

qbft_discardValidatorVote​

Discards a proposal to add or remove a validator with the specified address.

Parameters​

address: string - 20-byte address of proposed validator

Returns​

result: boolean - indicates if the proposal is discarded

curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_discardValidatorVote","params":["0xef1bfb6a12794615c9b0b5a21e6741f01e570185"], "id":1}' http://127.0.0.1:8545

qbft_getPendingVotes​

Returns votes cast in the current epoch.

Parameters​

None

Returns​

result: map of strings to booleans - map of account addresses to corresponding boolean values indicating the vote for each account; if true, the vote is to add a validator. If false, the proposal is to remove a validator.

curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_getPendingVotes","params":[], "id":1}' http://127.0.0.1:8545

qbft_getSignerMetrics​

Provides the following validator metrics for the specified range:

  • Number of blocks from each validator

  • Block number of the last block proposed by each validator (if any proposed in the specified range)

  • All validators present in the last block of the range

Parameters​

  • fromBlockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

  • toBlockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

note

pending returns the same value as latest.

If you specify:

  • No parameters, the call provides metrics for the last 100 blocks, or all blocks if there are less than 100 blocks.

  • Only the first parameter, the call provides metrics for all blocks from the block specified to the latest block.

Returns​

result: array of objects - list of validator objects

note

The proposer of the genesis block has address 0x0000000000000000000000000000000000000000.

curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_getSignerMetrics","params":["1", "100"], "id":1}' http://127.0.0.1:8545

qbft_getValidatorsByBlockHash​

Lists the validators defined in the specified block.

Parameters​

block: string - 32-byte block hash

Returns​

result: array of strings - list of validator addresses

curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_getValidatorsByBlockHash","params":["0xbae7d3feafd743343b9a4c578cab5e5d65eb735f6855fb845c00cab356331256"], "id":1}' http://127.0.0.1:8545

qbft_getValidatorsByBlockNumber​

Lists the validators for the specified block.

For all blocks up to the chain head block this method returns the validators that were used at the time the block was produced.

Use blockNumber to get the list of validators for that block.

For the chain head block there are two validator lists associated with it:

  1. The validators that were used at the time the block was produced. This list is returned by passing latest as the input parameter.
  2. The validators that will be used to produce the next block. This list is returned by passing pending as the input parameter.

In most instances the two lists for the chain head block are the same. However, when voting has completed to add or remove a validator, the validators that will be used to produce the next block are different. Comparing the two lists can be helpful when diagnosing a stalled chain.

note

When the validator list changes, an INFO log message displays, showing the previous list of validators and the new list of validators.

Parameters​

  • blockNumber: string - hexadecimal or decimal integer representing a block number, or one of the string tags latest, earliest, pending, finalized, or safe, as described in block parameter

Returns​

result: array of strings - list of validator addresses

curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_getValidatorsByBlockNumber","params":["latest"], "id":1}' http://127.0.0.1:8545

qbft_proposeValidatorVote​

Proposes to add or remove a validator with the specified address.

Parameters​

  • address: string - account address

  • proposal: boolean - true to propose adding validator or false to propose removing validator

Returns​

result: boolean - true

curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_proposeValidatorVote","params":["42d4287eac8078828cf5f3486cfe601a275a49a5",true], "id":1}' http://127.0.0.1:8545

*[EEA]: Enterprise Ethereum Alliance