airalab/hs-web3
1
1
Fork 0
mirror of https://github.com/airalab/hs-web3.git synced 2024-10-04 04:07:20 +03:00
Code Issues Projects Releases Wiki Activity
ce366e18fb
hs-web3/README.md
Alexander Krupenkin ce366e18fb
Added user documentation skeleton
2018-10-20 17:32:09 +03:00

1.7 KiB
Raw Blame History

Ethereum API for Haskell

The Haskell Ethereum API which implements the Generic JSON RPC.

Documentation Status Build Status Hackage Haskell Programming Language BSD3 License Code Triagers Badge

Installation

Using Stackage:

stack install web3

Quick start

Lets import library entrypoint modules using ghci:

> import Network.Ethereum.Web3
> import qualified Network.Ethereum.Api.Web3 as Web3

We recomends to import Network.Ethereun.Api.Web3 as qualified, because it has name similar to their prefix in JSON-RPC API.

Looks anything in Web3 API:

> :t Web3.clientVersion
Web3.clientVersion :: JsonRpc m => m Text

To run it use Web3 provider monad:

> :t runWeb3
runWeb3 :: MonadIO m => Web3 a -> m (Either Web3Error a)

> runWeb3 Web3.clientVersion
Right "Parity-Ethereum//v2.0.3-unstable/x86_64-linux-gnu/rustc1.29.0"

Function runWeb3 use default provider at http://localhost:8545, for using custom providers try runweb3'.

See documentation for other examples.