Skip to main content

GoQuorum API methods

This reference describes the GoQuorum JSON-RPC API methods.

caution

GoQuorum is based on Geth Go Ethereum client but only the GoQuorum-specific API methods are listed here.

Visit the Go Ethereum documentation to view the Geth API methods.

Contract extension methods​

The following API methods provide functionality for GoQuorum contract extension.

quorumExtension_activeExtensionContracts​

Lists all active contract extensions involving this node (either as initiator or receiver).

Parameters​

None

Returns​

result: array of objects - list of contract extension objects with the following fields:

  • managementContractAddress: string - address of the extension management contract

  • contractExtended: string - address of the private contract getting extended

  • creationData: data - Tessera hash of creation data for extension management contract

  • initiator: string - contract extension initiator's Ethereum address

  • recipient: string - new participant's Ethereum address; the participant must later approve the extension using this address.

  • recipientPtmKey: string - new participant's Tessera public key

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumExtension_activeExtensionContracts","id":10}' --header "Content-Type: application/json"

quorumExtension_approveExtension​

Submits an approval/denial vote to the specified extension management contract.

Parameters​

  • addressToVoteOn: string - address of the contract extension's management contract (this can be found using quorumExtension_activeExtensionContracts)

  • vote: boolean - true approves the extension process, false cancels the extension process

  • txArgs: object - arguments for the vote submission transaction; privateFor must contain the public key of the node that initiated the contract extension.

Returns​

result: data - hash of the vote submission transaction

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumExtension_approveExtension","params":["0xb1c57951a2f3006910115eadf0f167890e99b9cb",true,{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d","privateFor":["QfeDAys9MPDs2XHExtc84jKGHxZg/aj52DTh0vtA3Xc="]}],"id":10}' --header "Content-Type: application/json"

geth console result

"0x8d34a594b286087f45029daad2d5a8fd42f70abb0ae2492429a256a2ba4cb0dd"
Frequent issues

  • If you attempt to extend a contract in the process of being extended, the following error is returned:

    Error: contract extension in progress for the given contract address

  • The recipient can approve the extension only once. Executing quorumExtension.approveExtension once the extension process is completed results in the following error:

    Error: contract extension process complete. nothing to accept

  • The approver (the from address in txArgs) must be the receiver of the extension (recipientAddress from quorumExtension_extendContract):

    Error: account is not acceptor of this extension request

quorumExtension_cancelExtension​

Cancels the specified active contract extension. This can only be invoked by the initiator of the extension process (the caller of quorumExtension_extendContract).

Parameters​

  • extensionContract: string - address of the contract extension's management contract

  • txArgs: object - arguments for the cancellation transaction

Returns​

result: data - hash of the cancellation transaction

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"quorumExtension_cancelExtension","params":["0x622aff909c081783613c9d3f5f4c47be78b310ac",{"from":"0xca843569e3427144cead5e4d5999a3d0ccf92b8e","value":"0x0","privateFor":["BULeR8JyUWhiuuCMU/HLA0Q5pzkYT+cHII3ZKBey3Bo="],"privacyFlag":1}],"id":63}' --header "Content-Type: application/json"
Frequent issues

The canceller (from address in txArgs) must be the same as the initiator of the extension (the from address in txArgs for the quorumExtension_extendContract call) or the following error is returned:

Error: account is not the creator of this extension request

quorumExtension_extendContract​

Starts the process of extending an existing private contract to a new participant by deploying a new extension management contract to the blockchain.

Parameters​

  • toExtend: string - address of the private contract to extend

  • newRecipientPtmPublicKey: string - new participant's Tessera public key

  • recipientAddress: string - new participant's Ethereum address; the participant must later approve the extension using this address.

  • txArgs: object - arguments for the transaction that deploys the extension management contract; privateFor must contain only the newRecipientPtmPublicKey.

Returns​

result: data - hash of the creation transaction for the new extension management contract

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"quorumExtension_extendContract","params":["0x9aff347f193ca4560276c3322193224dcdbbe578","BULeR8JyUWhiuuCMU/HLA0Q5pzkYT+cHII3ZKBey3Bo=","0xed9d02e382b34818e88b88a309c7fe71e65f419d",{"from":"0xca843569e3427144cead5e4d5999a3d0ccf92b8e","value":"0x0","privateFor":["BULeR8JyUWhiuuCMU/HLA0Q5pzkYT+cHII3ZKBey3Bo="],"privacyFlag":1}],"id":15}' --header "Content-Type: application/json"
Frequent issues
  • If you attempt to extend a contract in the process of being extended, the following error is returned:
Error: contract extension in progress for the given contract address

  • You must execute quorumExtension_extendContract from the node that initially created the contract.

  • If the network is using enhanced network permissioning, then both initiator (the from address in txArgs) and receiver (recipientAddress) of the extension must be network or org admin accounts.

quorumExtension_getExtensionStatus​

Retrieves the status of the specified contract extension.

Parameters​

managementContractAddress: string - address of the extension management contract

Returns​

result: string - status of contract extension (ACTIVE or DONE)

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumExtension_getExtensionStatus","params":["0x1349f3e1b8d71effb47b840594ff27da7e603d17"],"id":10}' --header "Content-Type: application/json"

Debug methods​

The following API methods allow you to inspect and debug the network.

debug_dumpAddress​

Retrieves the state of an address at the specified block number.

Parameters​

  • address: string - account address of the state to retrieve

  • blockNumber: number - integer representing a block number or one of the string tags latest (the last block mined) or pending (the last block mined plus pending transactions)

Returns​

result: object - state of the account address

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"debug_dumpAddress","params":["0xfff7ac99c8e4feb60c9750054bdc14ce1857f181",10],"id":15}' --header "Content-Type: application/json"

debug_privateStateRoot​

Returns the private state root hash at the specified block number.

Parameters​

blockNumber: number - integer representing a block number or one of the string tags latest (the last block mined) or pending (the last block mined plus pending transactions).

Returns​

result: data - private state root hash

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"debug_privateStateRoot","params":["latest"],"id":1}' --header "Content-Type: application/json"

IBFT methods​

The following API methods provide access to the IBFT and QBFT consensus engines.

To use these methods:

  1. Run Istanbul geth with --http.api "istanbul".

  2. Run geth attach.

istanbul_candidates​

Returns the current candidates which the node tries to vote in or out.

Parameters​

None

Returns​

result: map of strings to booleans - current candidates map

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_candidates","id":1}' --header "Content-Type: application/json"

istanbul_discard​

Drops a currently running candidate, stopping further votes from being cast either for or against the candidate.

Parameters​

address: string - address of the candidate

Returns​

result: null

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_discard","params":["0xfff7ac99c8e4feb60c9750054bdc14ce1857f181"],"id":1}' --header "Content-Type: application/json"

istanbul_getSignersFromBlock​

Retrieves the public addresses whose seals are included in the specified block number. This means that they participated in the consensus for this block and attested to its validity.

Parameters​

blockNumber: number - (optional) block number to retrieve; defaults to current block

Returns​

result: object - result object with the following fields:

  • number: number - retrieved block's number

  • hash: string - retrieved block's hash

  • author: string - address of the block proposer

  • committers: array of strings - list of all addresses whose seal appears in this block

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_getSignersFromBlock","params":[10],"id":1}' --header "Content-Type: application/json"

istanbul_getSignersFromBlockByHash​

Retrieves the public addresses whose seals are included in the specified block number. This means that they participated in the consensus for this block and attested to its validity.

Parameters​

blockHash: string - hash of the block to retrieve (required)

Returns​

result: object - result object with the following fields:

  • number: number - retrieved block's number

  • hash: string - retrieved block's hash

  • author: string - address of the block proposer

  • committers: array of strings - list of all addresses whose seal appears in this block

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_getSignersFromBlockByHash","params":["0xfe88c94d860f01a17f961bf4bdfb6e0c6cd10d3fda5cc861e805ca1240c58553"],"id":1}' --header "Content-Type: application/json"

istanbul_getSnapshot​

Retrieves the state snapshot at the specified block number.

Parameters​

blockNumber: number or string - (optional) integer representing a block number or the string tag latest (the last block mined); defaults to latest

Returns​

result: object - snapshot object

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_getSnapshot","params":[10],"id":1}' --header "Content-Type: application/json"

istanbul_getSnapshotAtHash​

Retrieves the state snapshot at the specified block hash.

Parameters​

blockHash: string - block hash

Returns​

result: object - snapshot object

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_getSnapshotAtHash","params":["0xfe88c94d860f01a17f961bf4bdfb6e0c6cd10d3fda5cc861e805ca1240c58553"],"id":1}' --header "Content-Type: application/json"

istanbul_getValidators​

Retrieves the list of authorized validators at the specified block number.

Parameters​

blockNumber: number or string - (optional) integer representing a block number or the string tag latest (the last block mined); defaults to latest

Returns​

result: array of strings - list of validator addresses

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_getValidators","params":[10],"id":1}' --header "Content-Type: application/json"

istanbul_getValidatorsAtHash​

Retrieves the list of authorized validators at the specified block hash.

Parameters​

blockHash: string - block hash

Returns​

result: array of strings - list of validator addresses

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_getValidatorsAtHash","params":["0xfe88c94d860f01a17f961bf4bdfb6e0c6cd10d3fda5cc861e805ca1240c58553"],"id":1}' --header "Content-Type: application/json"

istanbul_isValidator​

Indicates if this node is the validator for the specified block number.

Parameters​

blockNumber: number - (optional) block number; defaults to latest block number

Returns​

result: boolean - true if this node is the validator for the given blockNumber, otherwise false

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_isValidator","params":[10],"id":1}' --header "Content-Type: application/json"

istanbul_nodeAddress​

Retrieves the public address that is used to sign proposals, which is derived from the node's nodekey.

Parameters​

None

Returns​

result: string - node's public signing address

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_nodeAddress","id":1}' --header "Content-Type: application/json"

istanbul_propose​

Injects a new authorization candidate that the validator attempts to push through. If a majority of the validators vote the candidate in/out, the candidate is added/removed in the validator set.

Parameters​

  • address: string - address of candidate

  • auth: boolean - true votes the candidate in and false votes out

Returns​

result: null

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_propose","params":["0x9811ebc35d7b06b3fa8dc5809a1f9c52751e1deb",true],"id":1}' --header "Content-Type: application/json"

istanbul_status​

Returns the signing status of blocks for the specified block range.

Parameters​

  • startBlockNumber: number - start block number

  • endBlockNumber: number - end block number

If the start block and end block numbers are not provided, the status of the last 64 blocks is returned.

Returns​

result: object - result object with the following fields:

  • numBlocks: number - number of blocks for which sealer activity is retrieved

  • sealerActivity: map of strings to numbers - key is the validator and value is the number of blocks sealed by the validator

curl -X POST http://localhost:8545 --data '{"jsonrpc":"2.0","method":"istanbul_status","params":[1,10],"id":1}' --header "Content-Type: application/json"

Permission methods​

The following API methods provide functionality for GoQuorum permissioning.

quorumPermission_acctList​

Returns a list of permissioned accounts in the network.

Parameters​

None

Returns​

result: array of objects - list of permissioned account objects with the following fields:

  • acctId: string - account ID

  • isOrgAdmin: boolean - indicates if the account is admin account for the organization

  • orgId: string - organization ID

  • roleId: string - role assigned to the account

  • status: number - account status

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_acctList","id":10}' --header "Content-Type: application/json"

quorumPermission_addAccountToOrg​

Adds an account to an organization and assigns a role to the account. This method can be called by an organization admin account.

The account can only be linked to a single organization or sub-organization.

Parameters​

  • acctId: string - account ID

  • orgId: string - organization ID

  • roleId: string - role ID

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_addAccountToOrg","params":["0xf017976fdf1521de2e108e63b423380307f501f8","ABC","TRANSACT",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_addNewRole​

Creates a new role for the organization. This method can be called by an organization admin account.

Parameters​

  • orgId: string - organization ID for which the role is being created

  • roleId: string - unique role ID

  • accountAccess: number - account level access

  • isVoter: boolean - indicates if the role is a voting role

  • isAdminRole: boolean - indicates if the role is an admin role

note

When adding a new role to a sub-organization, the role ID must exist in the master organization under which the sub-organization falls.

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_addNewRole","params":["ABC","TRANSACT",1,false,false,{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_addNode​

Adds a node to the specified organization or sub-organization. This method can be called by an organization admin account. A node cannot be part of multiple organizations.

Parameters​

  • orgId: string - organization or sub-organization ID to which the node belongs

  • enodeId: string - complete enode ID

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_addNode","params":["ABC.SUB1.SUB2.SUB3","enode://239c1f044a2b03b6c4713109af036b775c5418fe4ca63b04b1ce00124af00ddab7cc088fc46020cdc783b6207efe624551be4c06a994993d8d70f684688fb7cf@127.0.0.1:21006?discport=0&raftport=50407",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_addOrg​

Proposes a new organization into the network. This method can be called by a network admin account.

If there are any pending items for approval, proposal of any new organization fails. Also, the enode ID and account ID can only be linked to one organization.

Parameter​

  • orgId: string - unique organization ID

  • enodeId: string - complete enode ID

  • accountId: string - account to be the organization admin account

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_addOrg","params":["ABC","enode://3d9ca5956b38557aba991e31cf510d4df641dce9cc26bfeb7de082f0c07abb6ede3a58410c8f249dabeecee4ad3979929ac4c7c496ad20b8cfdd061b7401b4f5@127.0.0.1:21003?discport=0&raftport=50404","0x0638e1574728b6d862dd5d3a3e0942c3be47d996",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_addSubOrg​

Creates a sub-organization under the master organization. This method can be called by an organization admin account.

Parameters​

  • parentOrgId: string - parent organization ID under which the sub-organization is being added
note

The parent organization ID should contain the complete organization hierarchy from master organization ID to the immediate parent. The organization hierarchy is separated by . (dot character). For example, if master organization ABC has a sub-organization SUB1, then while creating the sub-organization at SUB1 level, the parent organization should be given as ABC.SUB1.

  • subOrgId: string - sub-organization ID

  • enodeId: string - complete enode ID of the node linked to the sub-organization ID; if left as an empty string, inherits the enode ID from the parent organization.

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_addSubOrg","params":["ABC.SUB1","SUB2","",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_approveAdminRole​

Approves the organization admin or network admin role assignment to the specified account. This method can be called by a network admin account. The role is approved once the majority of network admins approve.

Parameters​

  • orgId: string - organization ID to which the account belongs

  • acctId: string - account ID

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_approveAdminRole","params":["ABC","0xf017976fdf1521de2e108e63b423380307f501f8",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_approveBlackListedAccountRecovery​

Approves the recovery of the specified denylisted (blacklisted) account. This method can be called by a network admin account. Once a majority of the network admins approve, the account is marked as active.

Parameters​

  • orgId: string - organization or sub-organization ID to which the node belongs

  • acctId: string - denylisted account ID

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_approveBlackListedNodeRecovery","params":["ABC.SUB1.SUB2.SUB3","0xf017976fdf1521de2e108e63b423380307f501f8",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_approveBlackListedNodeRecovery​

Approves the recovery of the specified denylisted (blacklisted) node. This method can be called by a network admin account. Once the majority of network admins approve, the denylisted node is marked as active.

Parameters​

  • orgId: string - organization or sub-organization ID to which the node belongs

  • enodeId: string - complete enode ID

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_approveBlackListedNodeRecovery","params":["ABC.SUB1.SUB2.SUB3","enode://239c1f044a2b03b6c4713109af036b775c5418fe4ca63b04b1ce00124af00ddab7cc088fc46020cdc783b6207efe624551be4c06a994993d8d70f684688fb7cf@127.0.0.1:21006?discport=0&raftport=50407",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_approveOrg​

Approves the specified proposed organization into the network. This method can be called by a network admin account.

Parameters​

  • orgId: string - unique organization ID

  • enodeId: string - complete enode ID

  • accountId: string - account to be the organization admin account

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_approveOrg","params":["ABC","enode://3d9ca5956b38557aba991e31cf510d4df641dce9cc26bfeb7de082f0c07abb6ede3a58410c8f249dabeecee4ad3979929ac4c7c496ad20b8cfdd061b7401b4f5@127.0.0.1:21003?discport=0&raftport=50404","0x0638e1574728b6d862dd5d3a3e0942c3be47d996",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_approveOrgStatus​

Approves an organization status change proposal. This method can be called by a network admin account. Once a majority of the network admins approve the status update, the organization status is updated.

When an organization is in suspended status, no transactions or contract deployment activities are allowed from any nodes linked to the organization and sub-organizations under it. Similarly, no transactions are allowed from any accounts linked to the organization.

Parameters​

  • orgId: string - organization ID

  • action: number -

    • 1 - for approving organization suspension

    • 2 - for approving activation of the suspended organization

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_approveOrgStatus","params":["ABC",1,{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_assignAdminRole​

Adds a new account as network admin or changes the organization admin account for an organization. This method can be called by a network admin account. Once a majority of the network admins approve, the role is approved.

Parameters​

  • orgId: string - organization ID to which the account belongs

  • acctId: string - account ID

  • roleId: string - new role ID to be assigned to the account; this can be the network admin role or an organization admin role only.

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_assignAdminRole","params":["ABC","0xf017976fdf1521de2e108e63b423380307f501f8","NWADMIN",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_changeAccountRole​

Assigns a role to the specified account. This method can be called by an organization admin account.

Parameters​

  • acctId: string - account ID

  • orgId: string - organization ID

  • roleId: string - new role ID to be assigned to the account

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_changeAccountRole","params":["0xf017976fdf1521de2e108e63b423380307f501f8","ABC","TRANSACT",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_connectionAllowed​

Checks if the specified node is allowed to join the network.

Parameters​

  • enodeId: string - enode ID

  • ipAddress: string - IP address of the node

  • portNum: number - port number

Returns​

result: boolean - indicates if the connection is allowed or not

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_connectionAllowed","params":["239c1f044a2b03b6c4713109af036b775c5418fe4ca63b04b1ce00124af00ddab7cc088fc46020cdc783b6207efe624551be4c06a994993d8d70f684688fb7cf","127.0.0.1",21006],"id":50}' --header "Content-Type: application/json"

quorumPermission_getOrgDetails​

Returns lists of accounts, nodes, roles, and sub-organizations linked to the specified organization.

Parameters​

orgId: string - organization or sub-organization ID

Returns​

result: object - result object with the following fields:

  • acctList: array of objects - list of account objects

  • nodeList: array of objects - list of node objects

  • roleList: array of objects - list of role objects

  • subOrgList: array of objects - list of sub-organization objects

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_getOrgDetails","params":["INITORG"],"id":10}' --header "Content-Type: application/json"

quorumPermission_nodeList​

Returns a list of permissioned nodes in the network.

Parameters​

None

Returns​

result: array of objects - list of permissioned node objects with the following fields:

  • orgId: string - organization ID to which the node belongs

  • status: number - node status

  • url: string - complete enode ID

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_nodeList","id":10}' --header "Content-Type: application/json"

quorumPermission_orgList​

Returns a list of all organizations with the status of each organization in the network.

Parameters​

None

Returns​

result: array of objects - list of organization objects with the following fields:

  • fullOrgId: string - complete organization ID including all the parent organization IDs separated by .

  • level: number - level of the organization in the organization hierarchy

  • orgId: string - organization ID

  • parentOrgId: string - immediate parent organization ID

  • status: number - organization status

  • subOrgList: array of strings - list of sub-organizations linked to the organization

  • ultimateParent: string - master organization under which the organization falls

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_orgList","id":10}' --header "Content-Type: application/json"

quorumPermission_recoverBlackListedAccount​

Initiates the recovery of the specified denylisted (blacklisted) account. This method can be called by a network admin account. Once a majority of the network admins approve, the denylisted account is marked as active.

Parameters​

  • orgId: string - organization or sub-organization ID to which the node belongs

  • acctId: string - denylisted account ID

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_recoverBlackListedAccount","params":["ABC.SUB1.SUB2.SUB3","0xf017976fdf1521de2e108e63b423380307f501f8",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_recoverBlackListedNode​

Initiates the recovery of the specified denylisted (blacklisted) node. This method can be called by a network admin account. Once the majority of network admins approve, the denylisted node is marked as active.

Parameters​

  • orgId: string - organization or sub-organization ID to which the node belongs

  • enodeId: string - complete enode ID

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_recoverBlackListedNode","params":["ABC.SUB1.SUB2.SUB3","enode://239c1f044a2b03b6c4713109af036b775c5418fe4ca63b04b1ce00124af00ddab7cc088fc46020cdc783b6207efe624551be4c06a994993d8d70f684688fb7cf@127.0.0.1:21006?discport=0&raftport=50407",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_removeRole​

Removes the specified role from an organization. This method can be called by an organization admin account.

Parameters​

  • orgId: string - organization or sub-organization ID to which the role belongs

  • roleId: string - role ID

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_removeRole","params":["ABC","TRANSACT",{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_roleList​

Returns a list of roles in the network.

Parameters​

None

Returns​

result: array of objects - list of role objects with the following fields:

  • access: number - account access

  • active: boolean - indicates if the role is active or not

  • isAdmin: boolean - indicates if the role is organization admin role

  • isVoter: boolean - indicates if the role is enabled for voting - applicable only for network admin role

  • orgId: string - organization ID to which the role is linked

  • roleId: string - unique role ID

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_roleList","id":10}' --header "Content-Type: application/json"

quorumPermission_transactionAllowed​

Checks if the account initiating the specified transaction has sufficient permissions to execute the transaction.

Parameters​

  • txArgs: object - transaction arguments object

Returns​

result: boolean - indicates if transaction is allowed or not

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_transactionAllowed","params":[{"from":"0xf2cd20ed7904c103ce2ca0ef73fb77539930c59f"}],"id":50}' --header "Content-Type: application/json"

quorumPermission_updateAccountStatus​

Updates the status of the specified account. This method can be called by an organization admin account.

Parameters​

  • orgId: string - organization or sub-organization ID to which the account belongs

  • acctId: string - account ID

  • action: number -

    • 1 - for suspending the account

    • 2 - for activating the suspended account

    • 3 - for denylisting (blacklisting) the account

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_updateAccountStatus","params":["ABC","0xf017976fdf1521de2e108e63b423380307f501f8",1,{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_updateNodeStatus​

Updates the status of the specified node. This method can be called by an organization admin account.

Parameters​

  • orgId: string - organization or sub-organization ID to which the node belongs

  • enodeId: string - complete enode ID

  • action: number -

    • 1 - for deactivating the node

    • 2 - for activating the deactivated node

    • 3 - for denylisting (blacklisting) the node

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_updateNodeStatus","params":["ABC.SUB1.SUB2.SUB3","enode://239c1f044a2b03b6c4713109af036b775c5418fe4ca63b04b1ce00124af00ddab7cc088fc46020cdc783b6207efe624551be4c06a994993d8d70f684688fb7cf@127.0.0.1:21006?discport=0&raftport=50407",1,{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

quorumPermission_updateOrgStatus​

Temporarily suspends the specified organization or re-activates the specified suspended organization. This method can be called by a network admin account. This can only be performed for the master organization and requires the majority of network admins to approve.

Parameters​

  • orgId: string - organization ID

  • action: number -

    • 1 - for suspending the organization

    • 2 - for activating the suspended organization

Returns​

result: string - response message

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"quorumPermission_updateOrgStatus","params":["ABC",1,{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d"}],"id":10}' --header "Content-Type: application/json"

Privacy methods​

The following API methods provide functionality for GoQuorum privacy.

note

Gas price is removed from GoQuorum networks, so is not included as a transaction object parameter in GoQuorum privacy methods. When using standard Ethereum JSON-RPC methods such as sendSignedTransaction, set gasPrice to 0.

eth_distributePrivateTransaction​

Send a signed private transaction to the local private transaction manager and share with private participant's transaction managers.

This API method is to be used as part of the process for sending externally signed privacy marker transactions. The private transaction should be signed, sent to participants with this API, and the resulting hash set as the PMT's data.

note

Two step process:

  1. Performs the same as eth_sendRawPrivateTransaction (simulation and calling /sendsignedtx), but doesn’t submit private transaction to txpool.
  2. Sends the private transaction to Tessera to generate a hash, which should be placed in the privacy marker transaction.

Parameters​

  • string - signed private transaction in hex format
  • object - private data to send, with the following fields:
    • privateFor: List<String> - an array of the recipients' base64-encoded public keys
    • privateFrom: String - (optional) the sending party’s base64-encoded public key to use (Privacy Manager default if not provided)
    • privacyFlag: Number - (optional) 0 for SP (default if not provided), 1 for PP, 2 for MPP, and 3 for PSV transactions
    • mandatoryFor: List<String> - an array of the recipients' base64-encoded public keys

Returns​

  • string - Transaction Manager hash to be used as a privacy marker transaction's data when externally signing

Example​

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"eth_distributePrivateTransaction","params":["0xf88d01808347b7608080b84034ec48699ce5877f0f97a5bea4550d52296368b1dcdc89667559555066c9894525e4878d0689cfeb4b6fda3dd6566aa06ce772f2e19e0404e45fe6351ebf640326a0ffecedc570d3520d283508f00d8b2c162096ebddca753979da95062c1df234cea033ceb36d46e3e86a399e8fde35b078248c90fb71344aadcc7e83b9324958a4ed", {"privateFor": ["ROAZBWtSacxXQrOe3FGAqJDyJjFePR5ce4TSIzmJ0Bc="]}],"id":15}' --header "Content-Type: application/json"

eth_fillTransaction​

Supports offline signing of the specified transaction. This can be used to fill and sign both public and private transactions. Defaults to RLP plus json.

Parameters​

transaction: object - transaction object to send, with the following fields:

  • from: string - address for the sending account

  • to: string - (optional) destination address of the message

  • value: number - (optional) value transferred for the transaction in Wei, also the endowment if it's a contract-creation transaction

  • data: data - (optional) either a byte string containing the associated data of the message, or in the case of a contract-creation transaction, the initialization code

  • privateFor: array of strings - (optional) when sending a private transaction, an array of the recipients' base64-encoded public keys

Returns​

result: object - result object with the following fields:

  • raw: data - RLP-encoded bytes for the passed transaction object

  • tx: object - transaction object

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"eth_fillTransaction","params":[{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d","data":"0x6060604052341561000f57600080fd5b604051602080610149833981016040528080519060200190919050505b806000819055505b505b610104806100456000396000f30060606040526000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff1680632a1afcd914605157806360fe47b11460775780636d4ce63c146097575b600080fd5b3415605b57600080fd5b606160bd565b6040518082815260200191505060405180910390f35b3415608157600080fd5b6095600480803590602001909190505060c3565b005b341560a157600080fd5b60a760ce565b6040518082815260200191505060405180910390f35b60005481565b806000819055505b50565b6000805490505b905600a165627a7a72305820d5851baab720bba574474de3d09dbeaabc674a15f4dd93b974908476542c23f00029000000000000000000000000000000000000000000000000000000000000002a","gas":0x47b760,"privateFor":["ROAZBWtSacxXQrOe3FGAqJDyJjFePR5ce4TSIzmJ0Bc="]}],"id":10}' --header "Content-Type: application/json"

eth_getContractPrivacyMetadata​

Queries the privacy metadata for the specified contract account address.

Parameter​

string - contract address

Returns​

result: object - result object with the following fields:

  • creationTxHash: data - affected contract's original transaction's encrypted payload hash

  • privacyFlag: number - 0 for SP, 1 for PP, 2 for MPP, and 3 for PSV transactions

  • mandatoryFor: string - an array of the recipients' base64-encoded public keys

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"eth_getContractPrivacyMetadata","params":["0x1932c48b2bf8102ba33b4a6b545c32236e342f34"],"id":15}' --header "Content-Type: application/json"

eth_getPrivacyPrecompileAddress​

Get the address of the privacy precompile contract, to be used as the to address for privacy marker transactions.

Parameters​

None

Returns​

  • string - contract address for the privacy precompile in hex format

Examples​

curl -X POST http://localhost:22000 --data '{ "jsonrpc":"2.0", "id":2, "method":"eth_getPrivacyPrecompileAddress"}' --header "Content-Type: application/json"

eth_getPrivateTransactionByHash​

Retrieve the details of a privacy marker transaction's internal private transaction using the PMT's transaction hash.

Parameters​

  • string - privacy marker transaction's hash in hex format

Returns​

  • object - private transaction (nil if caller is not a participant)

Examples​

curl -X POST http://localhost:22000 --data '{ "jsonrpc":"2.0", "id":2, "method":"eth_getPrivateTransactionByHash", "params": ["0xcb1f39245a88d5be49dca35e1a34a11f98bcb825ea4aa70829923ff5404c8a82"]}' --header "Content-Type: application/json"

eth_getPrivateTransactionReceipt​

Retrieve the receipt of a privacy marker transaction's (PMT) internal private transaction using the PMT's transaction hash.

Parameters​

  • string - privacy marker transaction's hash in hex format

Returns​

  • object - private transaction receipt (nil if caller is not a participant)

Examples​

curl -X POST http://localhost:22000 --data '{ "jsonrpc":"2.0", "id":2, "method":"eth_getPrivateTransactionReceipt", "params": ["0xcb1f39245a88d5be49dca35e1a34a11f98bcb825ea4aa70829923ff5404c8a82"]}' --header "Content-Type: application/json"

eth_getPSI​

When using multiple private states, returns the private state the user is operating on.

Parameters​

None

Returns​

result: string - the private state identifier (PSI)

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"eth_getPSI","id":1}'

eth_getQuorumPayload​

Returns the unencrypted payload from Tessera.

Parameters​

id: string - the generated SHA3-512 hash of the encrypted payload from the Private Transaction Manager, in hex (This is seen in the transaction as the input field.)

Returns​

result: string - unencrypted transaction payload in hex format

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"eth_getQuorumPayload","params":["0x5e902fa2af51b186468df6ffc21fd2c26235f4959bf900fc48c17dc1774d86d046c0e466230225845ddf2cf98f23ede5221c935aac27476e77b16604024bade0"],"id":67}'

eth_sendRawPrivateTransaction​

Sends the specified pre-signed transaction, for example using SilentCicero/ethereumjs-accounts.

If the transaction is a contract creation, use web3.eth.getTransactionReceipt() to get the contract address after the transaction is mined.

danger

Before calling this method, storeraw needs to be called to Tessera.

Parameters​

  • string - signed transaction data in hex format

  • object - private data to send, with the following fields:

    • privateFor: array of strings - when sending a private transaction, an array of the recipients' base64-encoded public keys

    • privacyFlag: number - (optional) 0 for SP (default if not provided), 1 for PP, 2 for MPP, and 3 for PSV transactions

    • mandatoryFor: array of strings - when sending a private transaction, an array of the recipients' base64-encoded public keys

  • callback: function - (optional) callback function; if you pass a callback, the HTTP request is made asynchronous.

Returns​

result: string - 32-byte transaction hash as a hex string

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"eth_sendRawPrivateTransaction","params":["0xf889808609184e72a00082271094000000000000000000000000000000000000000080a47f74657374320000000000000000000000000000000000000000000000000000006000571ca08a8bbf888cfa37bbf0bb965423625641fc956967b81d12e23709cead01446075a01ce999b56a8a88504be365442ea61239198e23d1fce7d00fcfc5cd3b44b7215f", {"privateFor": ["ROAZBWtSacxXQrOe3FGAqJDyJjFePR5ce4TSIzmJ0Bc="]}],"id":15}' --header "Content-Type: application/json"

eth_sendTransaction​

note

To support private transactions in GoQuorum, the Web3js web3.eth.sendTransaction(object) API method has been modified to include private transaction parameters.

Sends the specified transaction to the network.

If the transaction is a contract creation, use web3.eth.getTransactionReceipt() (eth_getTransactionReceipt) to get the contract address after the transaction is mined.

Parameters​

  • transaction: object - transaction object to send, with the following fields:

    • from: string - address for the sending account; defaults to web3.eth.defaultAccount

    • to: string - (optional) destination address of the message; defaults to undefined

    • value: number - (optional) value transferred for the transaction in Wei, also the endowment if it's a contract-creation transaction

    • gas: number - (optional) amount of gas to use for the transaction (unused gas is refunded)

    • data: data - (optional) either a byte string containing the associated data of the message, or in the case of a contract-creation transaction, the initialization code

    • input: data - (optional) either a byte string containing the associated data of the message, or in the case of a contract-creation transaction, the initialization code

    • nonce: number - (optional) integer of a nonce; allows you to overwrite your own pending transactions that use the same nonce

    • privateFrom: string - (optional) when sending a private transaction, the sending party's base64-encoded public key to use; if not present and passing privateFor, use the default key as configured in the TransactionManager.

    • privateFor: array of strings - (optional) when sending a private transaction, an array of the recipients' base64-encoded public keys

    • privacyFlag: number - (optional) 0 for SP (default if not provided), 1 for PP, 2 for MPP, and 3 for PSV transactions

    • mandatoryFor: array of strings - (optional) when sending a private transaction, an array of the recipients' base64-encoded public keys

  • callback: function - (optional) callback function; if you pass a callback, the HTTP request is made asynchronous.

note

input cannot co-exist with data if they are set to different values. input is the new naming of data. They are the same parameters, but both remain for backwards compatibility.

Returns​

result: string - 32-byte transaction hash as a hex string

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"eth_getContractPrivacyMetadata","params":[{"data":"603d80600c6000396000f3007c01000000000000000000000000000000000000000000000000000000006000350463c6888fa18114602d57005b6007600435028060005260206000f3","privateFor":["ROAZBWtSacxXQrOe3FGAqJDyJjFePR5ce4TSIzmJ0Bc="]}],"id":15}' --header "Content-Type: application/json"

eth_sendTransactionAsync​

Sends the specified transaction to the network asynchronously. This returns immediately, potentially before the transaction has been submitted to the transaction pool. A callback can be provided to receive the result of submitting the transaction; a server must be set up to receive POST requests at the given URL.

If the transaction is a contract creation, use web3.eth.getTransactionReceipt() to get the contract address after the transaction is mined.

Parameters​

transaction: object - transaction object to send, with the following fields:

  • from: string - address for the sending account; defaults to web3.eth.defaultAccount

  • to: string - (optional) destination address of the message; defaults to undefined

  • value: number - (optional) value transferred for the transaction in Wei, also the endowment if it's a contract-creation transaction

  • gas: number - (optional) amount of gas to use for the transaction (unused gas is refunded)

  • data: data - (optional) either a byte string containing the associated data of the message, or in the case of a contract-creation transaction, the initialization code

  • input: data - (optional) either a byte string containing the associated data of the message, or in the case of a contract-creation transaction, the initialization code

  • nonce: number - (optional) integer of a nonce; allows you to overwrite your own pending transactions that use the same nonce

  • privateFrom: string - (optional) when sending a private transaction, the sending party's base64-encoded public key to use; if not present and passing privateFor, use the default key as configured in the TransactionManager.

  • privateFor: array of strings - (optional) when sending a private transaction, an array of the recipients' base64-encoded public keys

  • privacyFlag: number - (optional) 0 for SP (default if not provided), 1 for PP, 2 for MPP, and 3 for PSV transactions

  • mandatoryFor: array of strings - (optional) when sending a private transaction, an array of the recipients' base64-encoded public keys

  • callbackUrl: string - (optional) URL to perform a POST request to post the result of submitting the transaction

note

input cannot co-exist with data if they are set to different values. input is the new naming of data. They are the same parameters, but both remain for backwards compatibility.

Returns​

  • result: string - empty hash, defined as 0x0000000000000000000000000000000000000000000000000000000000000000

The callback URL receives the following object:

  • result: object - result object with the following fields:

    • id: string - ID in the original RPC call, used to match this result to the request

    • txHash: string - transaction hash that was generated, if successful

    • error: string - error that occurred while submitting the transaction

The call and the immediate response:

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"eth_sendTransactionAsync","params":[{"from":"0xed9d02e382b34818e88b88a309c7fe71e65f419d","data":"0x6060604052341561000f57600080fd5b604051602080610149833981016040528080519060200190919050505b806000819055505b505b610104806100456000396000f30060606040526000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff1680632a1afcd914605157806360fe47b11460775780636d4ce63c146097575b600080fd5b3415605b57600080fd5b606160bd565b6040518082815260200191505060405180910390f35b3415608157600080fd5b6095600480803590602001909190505060c3565b005b341560a157600080fd5b60a760ce565b6040518082815260200191505060405180910390f35b60005481565b806000819055505b50565b6000805490505b905600a165627a7a72305820d5851baab720bba574474de3d09dbeaabc674a15f4dd93b974908476542c23f00029000000000000000000000000000000000000000000000000000000000000002a","gas":"0x47b760","privateFor":["ROAZBWtSacxXQrOe3FGAqJDyJjFePR5ce4TSIzmJ0Bc="]}],"id":67}'

eth_storageRoot​

Returns the storage root hash of the specified address. If the contract is a private contract, returns the storage root hash from the private state database.

Parameters​

  • address: String - address to fetch the storage root from in hex

  • block: string - (optional) block number to fetch the storage root from in hex; defaults to the latest block

Returns​

result: string - 32-byte storage root hash as a hex string

curl -X POST http://127.0.0.1:22000 --data '{"jsonrpc":"2.0","method":"eth_storageRoot","params":["0x1349f3e1b8d71effb47b840594ff27da7e603d17","0x1"],"id":67}'

Raft methods​

The following API methods provide access to the Raft consensus engine.

raft_addLearner​

Adds a new node to the network as a learner node. The learner node syncs with the network and can transact, but isn't part of the Raft cluster and doesn't provide block confirmation to the minter node.

Parameters​

enodeId: string - enode ID of the node to add

Returns​

result: string - Raft ID for the node being added

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"raft_addLearner","params":["enode://3701f007bfa4cb26512d7df18e6bbd202e8484a6e11d387af6e482b525fa25542d46ff9c99db87bd419b980c24a086117a397f6d8f88e74351b41693880ea0cb@127.0.0.1:21004?discport=0&raftport=50405"],"id":10}' --header "Content-Type: application/json"

raft_addPeer​

Adds a new peer to the network.

Parameters​

enodeId: string - enode ID of the node to be added to the network

Returns​

result: string - Raft ID for the node being added, or an error message if the node is already part of the network

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"raft_addPeer","params":["enode://3701f007bfa4cb26512d7df18e6bbd202e8484a6e11d387af6e482b525fa25542d46ff9c99db87bd419b980c24a086117a397f6d8f88e74351b41693880ea0cb@127.0.0.1:21004?discport=0&raftport=50405"],"id":10}' --header "Content-Type: application/json"

raft_cluster​

Returns the details of all nodes part of the Raft cluster.

Parameters​

None

Returns​

result: array - list of node objects with the following fields:

  • hostName: string - DNS name or the host IP address

  • nodeActive: boolean - indicates if the node is active in the Raft cluster

  • nodeId: string - enode ID of the node

  • p2pPort: number - p2p port

  • raftId: string - Raft ID of the node

  • raftPort: number - Raft port

  • role: string - role of the node in the Raft cluster (minter/verifier/learner); "" if there is no leader at the network level

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"raft_cluster","id":10}' --header "Content-Type: application/json"

raft_leader​

Returns the enode ID of the leader node.

Parameters​

None

Returns​

result: string - enode ID of the leader, or an error message if there is no leader

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"raft_leader","id":10}' --header "Content-Type: application/json"

raft_promoteToPeer​

Promotes the specified learner node to peer and thus to be part of the Raft cluster.

Parameters​

raftId: string - Raft ID of the node to be promoted

Returns​

result: boolean - indicates if the node is promoted

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"raft_promoteToPeer","params":[4],"id":10}' --header "Content-Type: application/json"

raft_removePeer​

Removes the specified peer from the Raft cluster.

Parameters​

raftId: string - Raft ID of the peer to be removed from the cluster

Returns​

result: null

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"raft_removePeer","params":[4],"id":10}' --header "Content-Type: application/json"

raft_role​

Returns the role of the current node in the Raft cluster.

Parameters​

None

Returns​

result: string - role of the node in the Raft cluster (minter/verifier/learner); "" if there is no leader at the network level

curl -X POST http://127.0.0.1:22001 --data '{"jsonrpc":"2.0","method":"raft_role","id":10}' --header "Content-Type: application/json"

[PP]: Counter-Party Protection [MPP]: Mandatory Party Protection [PSV]: Private State Validation [SP]: Standard Private