Polkadot node API¶

As same as Ethereum nodes Polkadot node exports HTTP/WebSockets JSON-RPC API. For connection with node hs-web3 use internal tiny JSON-RPC client.

Lets try to call Polkadot node with runWeb3' function using ghci.

> import Network.Web3.Provider
> import qualified Network.Polkadot.Api.System as System
> runWeb3' (WsProvider "127.0.0.1" 9944) $ System.name
Right "Parity Polkadot"

It can be useful to define function with Polkadot node endpoint location.

myNode :: Web3 a -> Either Web3Error a
myNode = runWeb3' (Wsprovider "127.0.0.1" 9944)

API Reference¶

Currently implemented the following Polkadot APIs in modules:

Method prefix Implementation

account_* Network.Polkadot.Api.Account

author_* Network.Polkadot.Api.Author

babe_* Network.Polkadot.Api.Babe

chain_* Network.Polkadot.Api.Chain

childstate_* Network.Polkadot.Api.Childstate

contracts_* Network.Polkadot.Api.Contracts

engine_* Network.Polkadot.Api.Engine

grandpa_* Network.Polkadot.Api.Grandpa

offchain_* Network.Polkadot.Api.Offchain

payment_* Network.Polkadot.Api.Payment

rpc_* Network.Polkadot.Api.Rpc

state_* Network.Polkadot.Api.State

system_* Network.Polkadot.Api.System

All modules use descriptive types located at Network.Polkadot.Api.Types.

Note

See classic API reference at Hackage web3 page.