Copyright	Alexander Krupenkin 2016
License	BSD3
Maintainer	mail@akru.me
Stability	experimental
Portability	unknown
Safe Haskell	None
Language	Haskell2010

Network.Ethereum.Web3

Contents

Web3 monad & runners
Contract actions
ABI encoding & data types
Ethereum unit conversion utils

Description

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.

Synopsis

Web3 monad & runners

type Web3 = ReaderT Config (ExceptT Error IO) Source #

Any communication with Ethereum node wrapped with Web3 monad

data Config Source #

Ethereum node params

Constructors

Config
Fields rpcUri :: String JSON-RPC node URI

Instances

Eq Config Source #
Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Show Config Source #
Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Default Config Source #
Methods def :: Config #

data Error Source #

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 Error Source #
Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #
Show Error Source #
Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #

runWeb3' :: MonadIO m => Config -> Web3 a -> m (Either Error a) Source #

Run Web3 monad with given configuration

runWeb3 :: MonadIO m => Web3 a -> m (Either Error a) Source #

Run Web3 monad with default config

Contract actions

data EventAction Source #

Event callback control response

Constructors

ContinueEvent	Continue to listen events
TerminateEvent	Terminate event listener

Instances

Eq EventAction Source #
Methods (==) :: EventAction -> EventAction -> Bool # (/=) :: EventAction -> EventAction -> Bool #
Show EventAction Source #
Methods showsPrec :: Int -> EventAction -> ShowS # show :: EventAction -> String # showList :: [EventAction] -> ShowS #

class ABIEncoding a => Event a where Source #

Contract event listener

Minimal complete definition

eventFilter

Methods

eventFilter :: a -> Address -> Filter Source #

Event filter structure used by low-level subscription methods

event :: Address -> (a -> IO EventAction) -> Web3 ThreadId Source #

Start an event listener for given contract Address and callback

class ABIEncoding a => Method a where Source #

Contract method caller

Methods

sendTx :: Unit b => Address -> b -> a -> Web3 TxHash Source #

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

call :: ABIEncoding b => Address -> CallMode -> a -> Web3 b Source #

Constant call given contract Address in mode and given input data

nopay :: Wei Source #

Zero value is used to send transaction without money

ABI encoding & data types

class ABIEncoding a where Source #

Contract ABI data codec

Minimal complete definition

toDataBuilder, fromDataParser

Methods

toDataBuilder :: a -> Builder Source #

fromDataParser :: Parser a Source #

toData :: a -> Text Source #

Encode value into abi-encoding represenation

fromData :: Text -> Maybe a Source #

Parse encoded value

Instances

ABIEncoding Bool Source #
Methods toDataBuilder :: Bool -> Builder Source # fromDataParser :: Parser Bool Source # toData :: Bool -> Text Source # fromData :: Text -> Maybe Bool Source #
ABIEncoding Int Source #
Methods toDataBuilder :: Int -> Builder Source # fromDataParser :: Parser Int Source # toData :: Int -> Text Source # fromData :: Text -> Maybe Int Source #
ABIEncoding Integer Source #
Methods toDataBuilder :: Integer -> Builder Source # fromDataParser :: Parser Integer Source # toData :: Integer -> Text Source # fromData :: Text -> Maybe Integer Source #
ABIEncoding Word Source #
Methods toDataBuilder :: Word -> Builder Source # fromDataParser :: Parser Word Source # toData :: Word -> Text Source # fromData :: Text -> Maybe Word Source #
ABIEncoding Text Source #
Methods toDataBuilder :: Text -> Builder Source # fromDataParser :: Parser Text Source # toData :: Text -> Text Source # fromData :: Text -> Maybe Text Source #
ABIEncoding Address Source #
Methods toDataBuilder :: Address -> Builder Source # fromDataParser :: Parser Address Source # toData :: Address -> Text Source # fromData :: Text -> Maybe Address Source #
ABIEncoding BytesD Source #
Methods toDataBuilder :: BytesD -> Builder Source # fromDataParser :: Parser BytesD Source # toData :: BytesD -> Text Source # fromData :: Text -> Maybe BytesD Source #
ABIEncoding a => ABIEncoding [a] Source #
Methods toDataBuilder :: [a] -> Builder Source # fromDataParser :: Parser [a] Source # toData :: [a] -> Text Source # fromData :: Text -> Maybe [a] Source #
KnownNat n => ABIEncoding (BytesN n) Source #
Methods toDataBuilder :: BytesN n -> Builder Source # fromDataParser :: Parser (BytesN n) Source # toData :: BytesN n -> Text Source # fromData :: Text -> Maybe (BytesN n) Source #

newtype BytesN n Source #

Fixed length byte array

Constructors

BytesN
Fields unBytesN :: Bytes

Instances

Eq (BytesN n) Source #
Methods (==) :: BytesN n -> BytesN n -> Bool # (/=) :: BytesN n -> BytesN n -> Bool #
Ord (BytesN n) Source #
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) Source #
Methods showsPrec :: Int -> BytesN n -> ShowS # show :: BytesN n -> String # showList :: [BytesN n] -> ShowS #
KnownNat n => ABIEncoding (BytesN n) Source #
Methods toDataBuilder :: BytesN n -> Builder Source # fromDataParser :: Parser (BytesN n) Source # toData :: BytesN n -> Text Source # fromData :: Text -> Maybe (BytesN n) Source #

newtype BytesD Source #

Dynamic length byte array

Constructors

BytesD
Fields unBytesD :: Bytes

Instances

Eq BytesD Source #
Methods (==) :: BytesD -> BytesD -> Bool # (/=) :: BytesD -> BytesD -> Bool #
Ord BytesD Source #
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 Source #
Methods showsPrec :: Int -> BytesD -> ShowS # show :: BytesD -> String # showList :: [BytesD] -> ShowS #
ABIEncoding BytesD Source #
Methods toDataBuilder :: BytesD -> Builder Source # fromDataParser :: Parser BytesD Source # toData :: BytesD -> Text Source # fromData :: Text -> Maybe BytesD Source #

data Address Source #

Ethereum account address

Instances

Eq Address Source #
Methods (==) :: Address -> Address -> Bool # (/=) :: Address -> Address -> Bool #
Ord Address Source #
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 Source #
Methods showsPrec :: Int -> Address -> ShowS # show :: Address -> String # showList :: [Address] -> ShowS #
IsString Address Source #
Methods fromString :: String -> Address #
ToJSON Address Source #
Methods toJSON :: Address -> Value # toEncoding :: Address -> Encoding # toJSONList :: [Address] -> Value # toEncodingList :: [Address] -> Encoding #
FromJSON Address Source #
Methods parseJSON :: Value -> Parser Address # parseJSONList :: Value -> Parser [Address] #
ABIEncoding Address Source #
Methods toDataBuilder :: Address -> Builder Source # fromDataParser :: Parser Address Source # toData :: Address -> Text Source # fromData :: Text -> Maybe Address Source #

Ethereum unit conversion utils

module Network.Ethereum.Unit