parity.md

Parity module

parity.clearEngineSigner

Clears an authority account for signing consensus messages. Blocks will not be sealed.

Invocation
parity.clearEngineSigner()

This method doesn't have parameters.

Returned type	Description
Boolean

{% tabs %} {% tab title="Example request of parity.clearEngineSigner" %}

parity.clearEngineSigner()

{% endtab %} {% endtabs %}

See also JSON RPC parity_clearEngineSigner

parity.enode

Returns the node enode URI.

Invocation
parity.enode

This method doesn't have parameters.

Returned type	Description
String

{% tabs %} {% tab title="Example request of parity.enode" %}

parity.enode

{% endtab %} {% endtabs %}

See also JSON RPC parity_enode

parity.getBlockReceipts

Get receipts from all transactions from particular block, more efficient than fetching the receipts one-by-one.

Invocation
parity.getBlockReceipts(blockParameter)

Parameter	Type	Description
blockParameter	BlockParameter object

Returned type	Description
ReceiptForRpc object

{% tabs %} {% tab title="Example request of parity.getBlockReceipts" %}

parity.getBlockReceipts(blockParameter)

{% endtab %}

{% tab title="Objects in parity_getBlockReceipts" %} BlockParameter

Field name	Type
Type	BlockParameterType object
BlockNumber	Quantity
BlockHash	Hash
RequireCanonical	Boolean

BlockParameterType

• Quantity or String (latest, earliest, pending)

ReceiptForRpc

Field name	Type
TransactionHash	Hash
TransactionIndex	Quantity
BlockHash	Hash
BlockNumber	Quantity
CumulativeGasUsed	Quantity
GasUsed	Quantity
From	Address
To	Address
ContractAddress	Address
Logs	LogEntryForRpc[] object
LogsBloom	Bloom Object
Root	Hash
Status	Quantity
Error	String
Type	TxType object

LogEntryForRpc[]

Field name	Type
Removed	Boolean
LogIndex	Quantity
TransactionIndex	Quantity
TransactionHash	Hash
BlockHash	Hash
BlockNumber	Quantity
Address	Address
Data	Data
Topics	Keccak[] object

TxType

• EIP2718 transaction type {% endtab %} {% endtabs %}

See also JSON RPC parity_getBlockReceipts

parity.netPeers

Returns connected peers. Peers with non-empty protocols have completed handshake.

Invocation
parity.netPeers

This method doesn't have parameters.

Returned type	Description
ParityNetPeers object

{% tabs %} {% tab title="Example request of parity.netPeers" %}

parity.netPeers

{% endtab %}

{% tab title="Objects in parity_netPeers" %} ParityNetPeers

Field name	Type
Active	Quantity
Connected	Quantity
Max	Quantity
Peers	PeerInfo[] object

PeerInfo[]

Field name	Type
Id	String
Name	String
Caps	Array
Network	PeerNetworkInfo object
Protocols	Array
{% endtab %}
{% endtabs %}

See also JSON RPC parity_netPeers

parity.pendingTransactions

Returns a list of transactions currently in the queue.

Invocation
parity.pendingTransactions()

This method doesn't have parameters.

Returned type	Description
ParityTransaction object

{% tabs %} {% tab title="Example request of parity.pendingTransactions" %}

parity.pendingTransactions()

{% endtab %}

{% tab title="Objects in parity_pendingTransactions" %} ParityTransaction

Field name	Type
Hash	Hash
Nonce	Quantity
BlockHash	Hash
BlockNumber	Quantity
TransactionIndex	Quantity
From	Address
To	Address
Value	Quantity
GasPrice	Quantity
Gas	Quantity
Input	Data
Raw	Data
Creates	Address
PublicKey	PublicKey object
ChainId	Quantity
Condition	Object
R	Data
S	Data
V	Quantity
StandardV	Quantity

PublicKey

Field name	Type
Address	Address
Bytes	Data
PrefixedBytes	Data
{% endtab %}
{% endtabs %}

See also JSON RPC parity_pendingTransactions

parity.setEngineSigner

Sets an authority account for signing consensus messages.

Invocation
parity.setEngineSigner(address, password)

Parameter	Type	Description
address	Address
password	String

Returned type	Description
Boolean

{% tabs %} {% tab title="Example request of parity.setEngineSigner" %}

parity.setEngineSigner(address, password)

{% endtab %} {% endtabs %}

See also JSON RPC parity_setEngineSigner

parity.setEngineSignerSecret

Sets an authority account for signing consensus messages.

Invocation
parity.setEngineSignerSecret(privateKey)

Parameter	Type	Description
privateKey	String

Returned type	Description
Boolean

{% tabs %} {% tab title="Example request of parity.setEngineSignerSecret" %}

parity.setEngineSignerSecret(privateKey)

{% endtab %} {% endtabs %}

See also JSON RPC parity_setEngineSignerSecret