Network.Ethereum.Web3.Types

newtype HexString

Represents a base16, utf8 encoded bytestring

Instances

• Show HexString
• Eq HexString
• Ord HexString
• Semigroup HexString
• Monoid HexString
• Decode HexString
• ReadForeign HexString
• WriteForeign HexString
• Encode HexString
• DecodeJson HexString
• EncodeJson HexString

data BigNumber :: Type

Large Integer, needed for handling numbers of up to 32 bytes

Instances

• Show BigNumber
• Eq BigNumber
• Ord BigNumber
• Semiring BigNumber
• Ring BigNumber
• LeftModule BigNumber Int
• RightModule BigNumber Int
• Algebra BigNumber Int
• Decode BigNumber
• ReadForeign BigNumber
• WriteForeign BigNumber
• Encode BigNumber
• DecodeJson BigNumber
• EncodeJson BigNumber

newtype Address

Represents and Ethereum address, which is a 20 byte HexString

Instances

• Show Address
• Eq Address
• Ord Address
• Encode Address
• Decode Address
• DecodeJson Address
• EncodeJson Address
• ReadForeign Address
• WriteForeign Address

unHex :: HexString -> String

unAddress :: Address -> HexString

mkHexString :: String -> Maybe HexString

mkAddress :: HexString -> Maybe Address

embed :: forall a r. Algebra a r => r -> a

type Wei = MinorUnit ETHER

type Szabo = MinorUnitE12 ETHER

type Shannon = MinorUnitE9 ETHER

type Lovelace = MinorUnitE6 ETHER

type KEther = MinorUnitE21 ETHER

type Finney = MinorUnitE15 ETHER

type Ether = MinorUnitE18 ETHER

data ETHER :: Token

type Babbage = MinorUnitE3 ETHER

newtype Value (a :: TokenUnit)

A value of some token in specific denomination

Instances

• Eq (Value a)
• Show (Value a)
• Decode (Value a)
• Encode (Value a)
• Encode (Value (NoPay t))
• (TokenUnitSpec a) => Semigroup (Value a)
• (TokenUnitSpec a) => Monoid (Value a)
• (TokenUnitSpec a) => LeftModule (Value a) Int
• (TokenUnitSpec a) => TokenUnit (Value a)

data NoPay :: Token -> TokenUnit

Instances

• Encode (Value (NoPay t))
• TokenUnitSpec (NoPay t)

class TokenUnit a  where

Useful for converting to and from the base denomination

Members

• fromMinorUnit :: BigNumber -> a
• toMinorUnit :: a -> BigNumber

Instances

• (TokenUnitSpec a) => TokenUnit (Value a)

mkValue :: forall a. TokenUnitSpec a => BigNumber -> Value a

Convert a big number into value, first using floor function to take the integer part

formatValue :: forall a. TokenUnitSpec a => Value a -> String

convert :: forall b a. TokenUnit a => TokenUnit b => a -> b

Convert between two denominations

newtype Web3Par e a

Instances

• Functor (Web3Par e)
• Apply (Web3Par e)
• Applicative (Web3Par e)
• Parallel (Web3Par e) (Web3 e)
• Alt (Web3Par e)
• Plus (Web3Par e)
• Alternative (Web3Par e)

data Web3Error

Constructors

• Rpc RpcError
• RemoteError String
• ParserError String
• NullError

Instances

• Generic Web3Error _
• Show Web3Error
• Eq Web3Error
• Decode Web3Error

newtype Web3 e a

A monad for asynchronous Web3 actions

Instances

• Functor (Web3 e)
• Apply (Web3 e)
• Applicative (Web3 e)
• Bind (Web3 e)
• Monad (Web3 e)
• MonadEff (eth :: ETH | e) (Web3 e)
• MonadAff (eth :: ETH | e) (Web3 e)
• MonadThrow Error (Web3 e)
• MonadError Error (Web3 e)
• MonadAsk Provider (Web3 e)
• MonadReader Provider (Web3 e)
• MonadRec (Web3 e)
• (EffectRowEquals eff (eth :: ETH | eff')) => MonadFork (Fiber eff) (Web3 eff')
• (EffectRowEquals eff (eth :: ETH | eff')) => MonadKill Error (Fiber eff) (Web3 eff')
• (EffectRowEquals eff (eth :: ETH | eff')) => MonadBracket Error (Fiber eff) (Web3 eff')
• Parallel (Web3Par e) (Web3 e)

data TransactionStatus

Constructors

• Succeeded
• Failed

Instances

• Generic TransactionStatus _
• Eq TransactionStatus
• Show TransactionStatus
• Decode TransactionStatus

newtype TransactionReceipt

Constructors

• TransactionReceipt { blockHash :: HexString, blockNumber :: BlockNumber, contractAddress :: Maybe Address, cumulativeGasUsed :: BigNumber, gasUsed :: BigNumber, logs :: Array Change, status :: TransactionStatus, transactionHash :: HexString, transactionIndex :: BigNumber }

Instances

• Generic TransactionReceipt _
• Newtype TransactionReceipt _
• Eq TransactionReceipt
• Show TransactionReceipt
• Decode TransactionReceipt

newtype TransactionOptions u

Constructors

• TransactionOptions { data :: Maybe HexString, from :: Maybe Address, gas :: Maybe BigNumber, gasPrice :: Maybe BigNumber, nonce :: Maybe BigNumber, to :: Maybe Address, value :: Maybe (Value (u ETHER)) }

Instances

• Generic (TransactionOptions u) _
• Newtype (TransactionOptions u) _
• Eq (TransactionOptions u)
• Show (TransactionOptions u)
• Encode (TransactionOptions u)

newtype Transaction

Constructors

• Transaction { blockHash :: Maybe HexString, blockNumber :: Maybe BlockNumber, from :: Address, gas :: BigNumber, gasPrice :: BigNumber, hash :: HexString, input :: HexString, nonce :: BigNumber, to :: Maybe Address, transactionIndex :: Maybe BigNumber, value :: Value Wei }

Instances

• Generic Transaction _
• Newtype Transaction _
• Eq Transaction
• Show Transaction
• Decode Transaction

newtype SyncStatus

Constructors

• SyncStatus { currentBlock :: BigNumber, highestBlock :: BigNumber, startingBlock :: BigNumber }

Instances

• Generic SyncStatus _
• Newtype SyncStatus _
• Eq SyncStatus
• Decode SyncStatus
• Show SyncStatus

newtype RpcError

Constructors

• RpcError { code :: Int, message :: String }

Instances

• Newtype RpcError _
• Generic RpcError _
• Show RpcError
• Eq RpcError
• Decode RpcError
• Encode RpcError

newtype Response a

Constructors

• Response (Either Web3Error a)

Instances

• (Decode a) => Decode (Response a)

newtype Request

Instances

• Generic Request _
• Encode Request

type MethodName = String

Web3 RPC

newtype FilterId

Used by the ethereum client to identify the filter you are querying

Instances

• Generic FilterId _
• Show FilterId
• Eq FilterId
• Encode FilterId
• Decode FilterId

newtype Filter a

Low-level event filter data structure

Instances

• Generic (Filter a) _
• Newtype (Filter a) _
• Show (Filter a)
• Eq (Filter a)
• Encode (Filter a)

newtype FalseOrObject a

Newtype wrapper around Maybe to handle cases where Web3 passes back either false or some data type

Constructors

• FalseOrObject (Maybe a)

Instances

• Newtype (FalseOrObject a) _
• (Eq a) => Eq (FalseOrObject a)
• (Ord a) => Ord (FalseOrObject a)
• Generic (FalseOrObject a) _
• (Show a) => Show (FalseOrObject a)
• (Decode a) => Decode (FalseOrObject a)

data EventAction

EventAction Represents a flag to continue or discontinue listening to the filter

Constructors

• ContinueEvent
• TerminateEvent

Instances

• Generic EventAction _
• Show EventAction
• Eq EventAction

data ETH :: Effect

Instances

• MonadEff (eth :: ETH | e) (Web3 e)
• MonadAff (eth :: ETH | e) (Web3 e)

newtype Change

Changes pulled by low-level call 'eth_getFilterChanges', 'eth_getLogs', and 'eth_getFilterLogs'

Constructors

• Change { address :: Address, blockHash :: HexString, blockNumber :: BlockNumber, data :: HexString, logIndex :: BigNumber, removed :: Boolean, topics :: Array HexString, transactionHash :: HexString, transactionIndex :: BigNumber }

Instances

• Generic Change _
• Newtype Change _
• Show Change
• Eq Change
• Decode Change

data ChainCursor

Refers to a particular block time, used when making calls, transactions, or watching for events.

Constructors

• Latest
• Pending
• Earliest
• BN BlockNumber

Instances

• Generic ChainCursor _
• Eq ChainCursor
• Show ChainCursor
• Ord ChainCursor
• Encode ChainCursor

data CallError

Constructors

• NullStorageError { _data :: HexString, signature :: String }

Instances

• Generic CallError _
• Show CallError
• Eq CallError

newtype BlockNumber

Constructors

• BlockNumber BigNumber

Instances

• Generic BlockNumber _
• Show BlockNumber
• Eq BlockNumber
• Ord BlockNumber
• Decode BlockNumber
• Encode BlockNumber
• Newtype BlockNumber _
• EncodeJson BlockNumber
• DecodeJson BlockNumber
• ReadForeign BlockNumber
• WriteForeign BlockNumber

newtype Block

Constructors

• Block { difficulty :: BigNumber, extraData :: HexString, gasLimit :: BigNumber, gasUsed :: BigNumber, hash :: Maybe HexString, logsBloom :: Maybe HexString, miner :: HexString, nonce :: Maybe HexString, number :: Maybe BigNumber, parentHash :: HexString, receiptsRoot :: HexString, sha3Uncles :: HexString, size :: BigNumber, stateRoot :: HexString, timestamp :: BigNumber, totalDifficulty :: BigNumber, transactions :: Array HexString, transactionsRoot :: HexString, uncles :: Array HexString }

Instances

• Generic Block _
• Newtype Block _
• Eq Block
• Show Block
• Decode Block

throwWeb3 :: forall a e. Error -> Web3 e a

runWeb3 :: forall a e. Provider -> Web3 e a -> Aff (eth :: ETH | e) (Either Web3Error a)

Run an asynchronous ETH action

mkRequest :: MethodName -> Int -> Array Foreign -> Request

forkWeb3' :: forall a e. Web3 e a -> Web3 e (Fiber (eth :: ETH | e) (Either Web3Error a))

Fork an asynchronous ETH action inside Web3 monad

forkWeb3 :: forall a e. Provider -> Web3 e a -> Aff (eth :: ETH | e) (Fiber (eth :: ETH | e) (Either Web3Error a))

Fork an asynchronous ETH action

defaultTransactionOptions :: TransactionOptions NoPay

defaultFilter :: forall a. Filter a

_value :: forall u. TokenUnit (Value (u ETHER)) => Lens (TransactionOptions u) (TransactionOptions MinorUnit) (Maybe (Value (u ETHER))) (Maybe (Value Wei))

_topics :: forall a. Lens' (Filter a) (Maybe (Array (Maybe HexString)))

_toBlock :: forall a. Lens' (Filter a) ChainCursor

_to :: forall u. Lens' (TransactionOptions u) (Maybe Address)

_nonce :: forall u. Lens' (TransactionOptions u) (Maybe BigNumber)

_gasPrice :: forall u. Lens' (TransactionOptions u) (Maybe BigNumber)

_gas :: forall u. Lens' (TransactionOptions u) (Maybe BigNumber)

_fromBlock :: forall a. Lens' (Filter a) ChainCursor

_from :: forall u. Lens' (TransactionOptions u) (Maybe Address)

_data :: forall u. Lens' (TransactionOptions u) (Maybe HexString)

_address :: forall a. Lens' (Filter a) (Maybe Address)