Network.Polkadot.Api.System

Polkadot RPC methods with system prefix.

Documentation

addReservedPeer

Arguments

:: JsonRpc m

=> Text

Peer URI

-> m Text

Adds a reserved peer.

chain :: JsonRpc m => m Text

Retrieves the chain.

chainType :: JsonRpc m => m ChainType

Retrieves the chain type.

health :: JsonRpc m => m Health

Return health status of the node.

localListenAddresses :: JsonRpc m => m [Text]

The addresses include a trailing p2p with the local PeerId, and are thus suitable to be passed to addReservedPeer or as a bootnode address.

localPeerId :: JsonRpc m => m Text

Returns the base58-encoded PeerId of the node.

name :: JsonRpc m => m Text

Retrieves the node name.

networkState :: JsonRpc m => m Object

Returns current state of the network.

Warning: This API isn't stable.

nodeRoles :: JsonRpc m => m [NodeRole]

Returns the roles the node is running as.

peers :: JsonRpc m => m [PeerInfo]

Returns the currently connected peers.

properties :: JsonRpc m => m Object

Get a custom set of properties as a JSON object, defined in the chain spec.

removeReservedPeer

Arguments

:: JsonRpc m

=> Text

Peer URI

-> m Text

Remove a reserved peer.

version :: JsonRpc m => m Text

Retrieves the version of the node.