Network.Ethereum.Web3

An Ethereum node offers a RPC interface. This interface gives Ðapp’s access to the Ethereum blockchain and functionality that the node provides, such as compiling smart contract code. It uses a subset of the JSON-RPC 2.0 specification (no support for notifications or named parameters) as serialisation protocol and is available over HTTP and IPC (unix domain sockets on linux/OSX and named pipe’s on Windows).

Web3 Haskell library currently use JSON-RPC over HTTP to access node functionality.

Web3 monad and service provider

data Web3 a b

Any communication with Ethereum node wrapped with Web3 monad

Instances

Monad (Web3 a)

Methods

(>>=) :: Web3 a a -> (a -> Web3 a b) -> Web3 a b

(>>) :: Web3 a a -> Web3 a b -> Web3 a b

return :: a -> Web3 a a

fail :: String -> Web3 a a

Functor (Web3 a)

Methods

fmap :: (a -> b) -> Web3 a a -> Web3 a b

(<$) :: a -> Web3 a b -> Web3 a a

Applicative (Web3 a)

Methods

pure :: a -> Web3 a a

(<*>) :: Web3 a (a -> b) -> Web3 a a -> Web3 a b

(*>) :: Web3 a a -> Web3 a b -> Web3 a b

(<*) :: Web3 a a -> Web3 a b -> Web3 a a

MonadIO (Web3 a)

Methods

liftIO :: IO a -> Web3 a a

class Provider a where

Ethereum node service provider

Minimal complete definition

rpcUri

Methods

rpcUri :: Web3 a String

JSON-RPC provider URI, default: localhost:8545

Instances

Provider DefaultProvider

Methods

rpcUri :: Web3 DefaultProvider String

data DefaultProvider

Default Web3 service provider

Instances

Provider DefaultProvider

Methods

rpcUri :: Web3 DefaultProvider String

data Web3Error

Some peace of error response

Constructors

JsonRpcFail !RpcError

JSON-RPC communication error

ParserFail !String

Error in parser state

UserFail !String

Common head for user errors

Instances

Eq Web3Error

Methods

(==) :: Web3Error -> Web3Error -> Bool

(/=) :: Web3Error -> Web3Error -> Bool

Show Web3Error

Methods

showsPrec :: Int -> Web3Error -> ShowS

show :: Web3Error -> String

showList :: [Web3Error] -> ShowS

Generic Web3Error

Associated Types

type Rep Web3Error :: * -> *

Methods

from :: Web3Error -> Rep Web3Error x

to :: Rep Web3Error x -> Web3Error

Exception Web3Error

Methods

toException :: Web3Error -> SomeException

fromException :: SomeException -> Maybe Web3Error

displayException :: Web3Error -> String

type Rep Web3Error

type Rep Web3Error = D1 (MetaData "Web3Error" "Network.Ethereum.Web3.Types" "web3-0.6.0.0-45FzcRUPCX9CwPtRdKwGnS" False) ((:+:) (C1 (MetaCons "JsonRpcFail" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RpcError))) ((:+:) (C1 (MetaCons "ParserFail" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String))) (C1 (MetaCons "UserFail" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)))))

forkWeb3 :: Web3 a () -> Web3 a ThreadId

Fork Web3 with the same Provider

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

Web3 monad runner

runWeb3 :: MonadIO m => Web3 DefaultProvider b -> m (Either Web3Error b)

Web3 runner for default provider

Contract actions

data EventAction

Event callback control response

Constructors

ContinueEvent

Continue to listen events

TerminateEvent

Terminate event listener

Instances

Eq EventAction

Methods

(==) :: EventAction -> EventAction -> Bool

(/=) :: EventAction -> EventAction -> Bool

Show EventAction

Methods

showsPrec :: Int -> EventAction -> ShowS

show :: EventAction -> String

showList :: [EventAction] -> ShowS

class ABIEncoding a => Event a where

Contract event listener

Minimal complete definition

eventFilter

Methods

eventFilter :: a -> Address -> Filter

Event filter structure used by low-level subscription methods

event :: Provider p => Address -> (a -> ReaderT Change (Web3 p) EventAction) -> Web3 p ThreadId

Start an event listener for given contract Address and callback

class ABIEncoding a => Method a where

Contract method caller

Methods

sendTx :: (Provider p, Unit b) => Address -> b -> a -> Web3 p TxHash

Send a transaction for given contract Address, value and input data

call :: (Provider p, ABIEncoding b) => Address -> DefaultBlock -> a -> Web3 p b

Constant call given contract Address in mode and given input data

Instances

Method NoMethod

Methods

sendTx :: (Provider p, Unit b) => Address -> b -> NoMethod -> Web3 p TxHash

call :: (Provider p, ABIEncoding b) => Address -> DefaultBlock -> NoMethod -> Web3 p b

data NoMethod

Dummy method for sending transaction without method call

Constructors

NoMethod

Instances

ABIEncoding NoMethod

Methods

toDataBuilder :: NoMethod -> Builder

fromDataParser :: Parser NoMethod

toData :: NoMethod -> Text

fromData :: Text -> Maybe NoMethod

Method NoMethod

Methods

sendTx :: (Provider p, Unit b) => Address -> b -> NoMethod -> Web3 p TxHash

call :: (Provider p, ABIEncoding b) => Address -> DefaultBlock -> NoMethod -> Web3 p b

nopay :: Wei

Zero value is used to send transaction without money

Ethereum data types

newtype BytesN n

Fixed length byte array

Constructors

BytesN

Fields

• unBytesN :: Bytes

Instances

Eq (BytesN n)

Methods

(==) :: BytesN n -> BytesN n -> Bool

(/=) :: BytesN n -> BytesN n -> Bool

Ord (BytesN n)

Methods

compare :: BytesN n -> BytesN n -> Ordering

(<) :: BytesN n -> BytesN n -> Bool

(<=) :: BytesN n -> BytesN n -> Bool

(>) :: BytesN n -> BytesN n -> Bool

(>=) :: BytesN n -> BytesN n -> Bool

max :: BytesN n -> BytesN n -> BytesN n

min :: BytesN n -> BytesN n -> BytesN n

KnownNat n => Show (BytesN n)

Methods

showsPrec :: Int -> BytesN n -> ShowS

show :: BytesN n -> String

showList :: [BytesN n] -> ShowS

KnownNat n => ABIEncoding (BytesN n)

Methods

toDataBuilder :: BytesN n -> Builder

fromDataParser :: Parser (BytesN n)

toData :: BytesN n -> Text

fromData :: Text -> Maybe (BytesN n)

newtype BytesD

Dynamic length byte array

Constructors

BytesD

Fields

• unBytesD :: Bytes

Instances

Eq BytesD

Methods

(==) :: BytesD -> BytesD -> Bool

(/=) :: BytesD -> BytesD -> Bool

Ord BytesD

Methods

compare :: BytesD -> BytesD -> Ordering

(<) :: BytesD -> BytesD -> Bool

(<=) :: BytesD -> BytesD -> Bool

(>) :: BytesD -> BytesD -> Bool

(>=) :: BytesD -> BytesD -> Bool

max :: BytesD -> BytesD -> BytesD

min :: BytesD -> BytesD -> BytesD

Show BytesD

Methods

showsPrec :: Int -> BytesD -> ShowS

show :: BytesD -> String

showList :: [BytesD] -> ShowS

Monoid BytesD

Methods

mempty :: BytesD

mappend :: BytesD -> BytesD -> BytesD

mconcat :: [BytesD] -> BytesD

ABIEncoding BytesD

Methods

toDataBuilder :: BytesD -> Builder

fromDataParser :: Parser BytesD

toData :: BytesD -> Text

fromData :: Text -> Maybe BytesD

data Address

Ethereum account address

Instances

Eq Address

Methods

(==) :: Address -> Address -> Bool

(/=) :: Address -> Address -> Bool

Ord Address

Methods

compare :: Address -> Address -> Ordering

(<) :: Address -> Address -> Bool

(<=) :: Address -> Address -> Bool

(>) :: Address -> Address -> Bool

(>=) :: Address -> Address -> Bool

max :: Address -> Address -> Address

min :: Address -> Address -> Address

Show Address

Methods

showsPrec :: Int -> Address -> ShowS

show :: Address -> String

showList :: [Address] -> ShowS

IsString Address

Methods

fromString :: String -> Address

Generic Address

Associated Types

type Rep Address :: * -> *

Methods

from :: Address -> Rep Address x

to :: Rep Address x -> Address

ToJSON Address

Methods

toJSON :: Address -> Value

toEncoding :: Address -> Encoding

toJSONList :: [Address] -> Value

toEncodingList :: [Address] -> Encoding

FromJSON Address

Methods

parseJSON :: Value -> Parser Address

parseJSONList :: Value -> Parser [Address]

ABIEncoding Address

Methods

toDataBuilder :: Address -> Builder

fromDataParser :: Parser Address

toData :: Address -> Text

fromData :: Text -> Maybe Address

type Rep Address

type Rep Address = D1 (MetaData "Address" "Network.Ethereum.Web3.Address" "web3-0.6.0.0-45FzcRUPCX9CwPtRdKwGnS" True) (C1 (MetaCons "Address" PrefixI True) (S1 (MetaSel (Just Symbol "unAddress") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)))

Ethereum unit conversion utils

module Network.Ethereum.Unit