The `parity_set` Module - Wiki OpenEthereum Documentation

JSON-RPC methods

• parity_acceptNonReservedPeers
• parity_addReservedPeer
• parity_dropNonReservedPeers
• parity_executeUpgrade
• parity_hashContent
• parity_removeReservedPeer
• parity_setAuthor
• parity_setChain
• parity_setEngineSigner
• parity_setExtraData
• parity_setGasCeilTarget
• parity_setGasFloorTarget
• parity_setMaxTransactionGas
• parity_setMinGasPrice
• parity_setMode
• parity_setTransactionsLimit
• parity_upgradeReady

JSON-RPC API Reference

parity_acceptNonReservedPeers

Set OpenEthereum to accept non-reserved peers (default behavior).

Parameters

None

Returns

• Boolean - true if successful.

Example

Request

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

Response

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

parity_addReservedPeer

Add a reserved peer.

Parameters

1. String - Enode address

params: ["enode://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@22.99.55.44:7770"]

Returns

• Boolean - true if successful.

Example

Request

curl --data '{"method":"parity_addReservedPeer","params":["enode://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@22.99.55.44:7770"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_dropNonReservedPeers

Set the client to drop all non-reserved peers. To restore default behavior call parity_acceptNonReservedPeers.

Parameters

None

Returns

• Boolean - true if successful.

Example

Request

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

Response

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

parity_executeUpgrade

Attempts to upgrade OpenEthereum to the version specified in parity_upgradeReady.

Parameters

None

Returns

• Boolean - returns true if the upgrade to the new release was successfully executed, false if not.

Example

Request

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

Response

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

parity_hashContent

Creates a hash of a file at a given URL.

Parameters

1. String - The url of the content.

params: ["https://raw.githubusercontent.com/openethereum/openethereum/master/README.md"]

Returns

• Hash - The SHA-3 hash of the content.

Example

Request

curl --data '{"method":"parity_hashContent","params":["https://raw.githubusercontent.com/openethereum/openethereum/master/README.md"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": "0x2547ea3382099c7c76d33dd468063b32d41016aacb02cbd51ebc14ff5d2b6a43"
}

parity_removeReservedPeer

Remove a reserved peer.

Parameters

1. String - Encode address

params: ["enode://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@22.99.55.44:7770"]

Returns

• Boolean - true if successful.

Example

Request

curl --data '{"method":"parity_removeReservedPeer","params":["enode://a979fb575495b8d6db44f750317d0f4622bf4c2aa3365d6af7c284339968eef29b69ad0dce72a4d8db5ebb4968de0e3bec910127f134779fbcb0cb6d3331163c@22.99.55.44:7770"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setAuthor

Changes author (coinbase) for mined blocks.

Parameters

1. Address - 20 Bytes - Address

params: ["0x407d73d8a49eeb85d32cf465507dd71d507100c1"]

Returns

• Boolean - true if the call was successful.

Example

Request

curl --data '{"method":"parity_setAuthor","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setChain

Sets the network spec file the client is using.

Parameters

1. String - Chain spec name, one of the chain presets or a filename.

params: ["foundation"]

Returns

• Boolean - true if the call succeeded.

Example

Request

curl --data '{"method":"parity_setChain","params":["foundation"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setEngineSigner

Sets an authority account for signing consensus messages. For more information check the Proof of Authority Chains page.

Parameters

1. Address - Identifier of a valid authority account.
2. String - Passphrase to unlock the account.

params: [
  "0x407d73d8a49eeb85d32cf465507dd71d507100c1",
  "hunter2"
]

Returns

• Boolean - True if the call succeeded

Example

Request

curl --data '{"method":"parity_setEngineSigner","params":["0x407d73d8a49eeb85d32cf465507dd71d507100c1","hunter2"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setExtraData

Changes extra data for newly mined blocks

Parameters

1. Data - Extra Data

params: ["0x"]

Returns

• Boolean - whether the call was successful

Example

Request

curl --data '{"method":"parity_setExtraData","params":["0x"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setGasCeilTarget

Sets new gas ceiling target for mined blocks.

Parameters

1. Quantity - (default: 0x0) Gas ceiling target.

params: [
  "0x2540be400" // 10000000000
]

Returns

• Boolean - true if the call was successful.

Example

Request

curl --data '{"method":"parity_setGasCeilTarget","params":["0x2540be400"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setGasFloorTarget

Sets a new gas floor target for mined blocks..

Parameters

1. Quantity - (default: 0x0) Gas floor target.

params: [
  "0x3e8" // 1000
]

Returns

• Boolean - true if the call was successful.

Example

Request

curl --data '{"method":"parity_setGasFloorTarget","params":["0x3e8"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setMaxTransactionGas

Sets the maximum amount of gas a single transaction may consume.

Parameters

1. Quantity - Gas amount

params: [
  "0x186a0" // 100000
]

Returns

• Boolean - true if the call was successful.

Example

Request

curl --data '{"method":"parity_setMaxTransactionGas","params":["0x186a0"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setMinGasPrice

Changes minimal gas price for transaction to be accepted to the queue.

Parameters

1. Quantity - Minimal gas price

params: [
  "0x3e8" // 1000
]

Returns

• Boolean - whether the call was successful

Example

Request

curl --data '{"method":"parity_setMinGasPrice","params":["0x3e8"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setMode

Changes the client operating mode.

Parameters

1. String - The mode to set, one of:
   • "active" - Client continuously syncs the chain.
   • "passive" - Client syncs initially, then sleeps and wakes regularly to resync.
   • "dark" - Client syncs only when the RPC is active.
   • "offline" - Client doesn’t sync.

params: ["passive"]

Returns

• Boolean - true if the call succeeded.

Example

Request

curl --data '{"method":"parity_setMode","params":["passive"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_setTransactionsLimit

This method is currently deprecated due to significant changes in the txqueue

Changes limit for transactions in queue.

Parameters

1. Quantity - New Limit

params: [
  "0x3e8" // 1000
]

Returns

• Boolean - whether the call was successful

Example

Request

curl --data '{"method":"parity_setTransactionsLimit","params":["0x3e8"],"id":1,"jsonrpc":"2.0"}' -H "Content-Type: application/json" -X POST localhost:8545

Response

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

parity_upgradeReady

Returns a ReleaseInfo object describing the release which is available for upgrade or null if none is available.

Parameters

None

Returns

• Object - Details or null if no new release is available.
  • version: Object - Information on the version.
  • is_critical: Boolean - Does this release contain critical security updates?
  • fork: Quantity - The latest fork that this release can handle.
  • binary: Data - (optional) Keccak-256 checksum of the release openethereum binary, if known.

Example

Request

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

Response

{
  "id": 1,
  "jsonrpc": "2.0",
  "result": null
}