Module

Network.Ethereum.Web3.Types

Package: purescript-web3
Repository: f-o-a-m/purescript-web3

Re-exports from Network.Ethereum.Web3.Types.BigNumber

#Radix Source

newtype Radix

The number of unique digits (including zero) used to represent integers in a specific base.

#BigNumber Source

data BigNumber :: Type

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

Instances

#Algebra Source

class (Ring r, Ring a, LeftModule a r, RightModule a r) <= Algebra a r  where

Members

embed :: r -> a

Instances

Algebra BigNumber Int

#unsafeToInt Source

unsafeToInt :: BigNumber -> Int

Unsafely coerce a BigNumber to an Int.

#toTwosComplement Source

toTwosComplement :: BigNumber -> BigNumber

Take the twos complement of a BigNumer

#toString Source

toString :: Radix -> BigNumber -> String

Convert a Big number into a string in the given base

#pow Source

pow :: BigNumber -> Int -> BigNumber

Exponentiate a BigNumber

#parseBigNumber Source

parseBigNumber :: Radix -> String -> Maybe BigNumber

Convert a string in the given base to a BigNumber

#hexadecimal Source

hexadecimal :: Radix

The base-16 system.

#floor Source

floor :: Number -> Int

Convert a Number to an Int, by taking the closest integer equal to or less than the argument. Values outside the Int range are clamped, NaN and Infinity values return 0.

#decimal Source

decimal :: Radix

The base-10 system.

#binary Source

binary :: Radix

The base-2 system.

Re-exports from Network.Ethereum.Web3.Types.EtherUnit

#Wei Source

data Wei

Instances

EtherUnitSpec Wei

#Value Source

newtype Value a

Ether value in denomination a

Instances

Eq (Value a)
Show (Value a)
Encode (Value a)
Encode (Value NoPay)
Decode (Value a)
(EtherUnitSpec a) => EtherUnit (Value a)
(EtherUnitSpec a) => Semigroup (Value a)
(EtherUnitSpec a) => Monoid (Value a)
(EtherUnitSpec a) => LeftModule (Value a) Int

#Szabo Source

data Szabo

Szabo unit type

Instances

EtherUnitSpec Szabo

#Shannon Source

data Shannon

Shannon unit type

Instances

EtherUnitSpec Shannon

#NoPay Source

data NoPay

Instances

Encode (Value NoPay)
EtherUnitSpec NoPay

#Lovelace Source

data Lovelace

Lovelace unit type

Instances

EtherUnitSpec Lovelace

#KEther Source

data KEther

KEther unit type

Instances

EtherUnitSpec KEther

#Finney Source

data Finney

Finney unit type

Instances

EtherUnitSpec Finney

#Ether Source

data Ether

Ether unit type

Instances

EtherUnitSpec Ether

#Babbage Source

data Babbage

Babbage unit type

Instances

EtherUnitSpec Babbage

#EtherUnit Source

class EtherUnit a  where

Useful for converting to and from the base denomination Wei

Members

fromWei :: BigNumber -> a
toWei :: a -> BigNumber

Instances

(EtherUnitSpec a) => EtherUnit (Value a)

#mkValue Source

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

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

#convert Source

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

Convert between two denominations

Re-exports from Network.Ethereum.Web3.Types.Sha3

#SHA3 Source

class SHA3 a  where

A class for things which you can hash. Mostly used as a utility for calculating selectors and event topics

Members

sha3 :: a -> HexString

Instances

SHA3 String
SHA3 HexString

#toSelector Source

toSelector :: String -> HexString

convert a string representing a type signature into a selector

Re-exports from Network.Ethereum.Web3.Types.Types

#Web3Error Source

data Web3Error

Constructors

Rpc RpcError
NullError

Instances

#Web3 Source

newtype Web3 e a

A monad for asynchronous Web3 actions

Constructors

Web3 (ReaderT Provider (ExceptT Web3Error (Aff (eth :: ETH | e))) a)

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 Web3Error (Web3 e)
MonadAsk Provider (Web3 e)
MonadReader Provider (Web3 e)
MonadRec (Web3 e)

#TransactionReceipt Source

newtype TransactionReceipt

Constructors

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

Instances

#TransactionOptions Source

newtype TransactionOptions u

Constructors

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

Instances

#Transaction Source

newtype Transaction

Constructors

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

Instances

#SyncStatus Source

newtype SyncStatus

Constructors

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

Instances

#Signed Source

data Signed a

Represents values that can be either positive or negative.

Constructors

Signed Sign a

Instances

(Show a) => Show (Signed a)
(Eq a) => Eq (Signed a)
Functor Signed

#Sign Source

data Sign

Constructors

Pos
Neg

Instances

Eq Sign

#RpcError Source

newtype RpcError

Constructors

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

Instances

#Response Source

newtype Response a

Constructors

Response (Either Web3Error a)

Instances

(Decode a) => Decode (Response a)

#Request Source

newtype Request

Instances

Generic Request _
Encode Request

#MethodName Source

type MethodName = String

Web3 RPC

#HexString Source

newtype HexString

Represents a base16, utf8 encoded bytestring

Instances

#FilterId Source

newtype FilterId

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

Instances

#Filter Source

newtype Filter

Low-level event filter data structure

Instances

#FalseOrObject Source

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)

#EventAction Source

data EventAction

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

Constructors

ContinueEvent
TerminateEvent

Instances

#ETH Source

data ETH :: Effect

Instances

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

#Change Source

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 :: HexString, topics :: Array HexString, transactionHash :: HexString, transactionIndex :: HexString }

Instances

#ChainCursor Source

data ChainCursor

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

Constructors

Instances

#CallError Source

data CallError

Constructors

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

Instances

#BlockNumber Source

newtype BlockNumber

Constructors

BlockNumber BigNumber

Instances

#Block Source

newtype Block

Constructors

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

Instances

#Address Source

newtype Address

Represents and Ethereum address, which is a 20 byte HexString

Instances

#unHex Source

unHex :: HexString -> String

#unAddress Source

unAddress :: Address -> HexString

#throwWeb3 Source

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

#runWeb3 Source

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

Run an asynchronous ETH action

#nullWord Source

nullWord :: HexString

#mkRequest Source

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

#mkHexString Source

mkHexString :: String -> Maybe HexString

#mkAddress Source

mkAddress :: HexString -> Maybe Address

#hexLength Source

hexLength :: HexString -> Int

Compute the length of the hex string, which is twice the number of bytes it represents

#forkWeb3' Source

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 Source

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 Source

defaultTransactionOptions :: TransactionOptions NoPay

#defaultFilter Source

defaultFilter :: Filter

#asSigned Source

asSigned :: forall a. a -> Signed a

Coerce a value into a positive signed value

#_value Source

_value :: forall u. EtherUnit (Value u) => Lens (TransactionOptions u) (TransactionOptions Wei) (Maybe (Value u)) (Maybe (Value Wei))

#_topics Source

_topics :: Lens' Filter (Maybe (Array (Maybe HexString)))

#_toBlock Source

_toBlock :: Lens' Filter ChainCursor

#_to Source

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

#_nonce Source

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

#_gasPrice Source

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

#_gas Source

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

#_fromBlock Source

_fromBlock :: Lens' Filter ChainCursor

#_from Source

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

#_data Source

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

#_address Source

_address :: Lens' Filter (Maybe Address)

Re-exports from Network.Ethereum.Web3.Types.Utils

#toUtf8 Source

toUtf8 :: HexString -> String

Takes a hex string and produces the corresponding UTF8-decoded string. This breaks at the first null octet, following the web3 function toUft8.

#toSignedHexString Source

toSignedHexString :: BigNumber -> Signed HexString

#toHexString Source

toHexString :: BigNumber -> HexString

#toAscii Source

toAscii :: HexString -> String

Takes a hex string and produces the corresponding ASCII decoded string.

#padRightSigned Source

padRightSigned :: Signed HexString -> HexString

Pad a Signed HexString on the right until it has length 0 mod 64.

#padRight Source

padRight :: HexString -> HexString

Pad a HexString on the right with 0's until it has length 0 mod 64.

#padLeftSigned Source

padLeftSigned :: Signed HexString -> HexString

Pad a Signed HexString on the left until it has length == 0 mod 64.

#padLeft Source

padLeft :: HexString -> HexString

Pad a HexString on the left with '0's until it has length == 0 mod 64.

#getPadLength Source

getPadLength :: Int -> Int

Computes the number of 0s needed to pad a bytestring of the input length

#fromUtf8 Source

fromUtf8 :: String -> HexString

Get the 'HexString' corresponding to the UTF8 encoding.

#fromHexStringSigned Source

fromHexStringSigned :: HexString -> BigNumber

#fromHexString Source

fromHexString :: HexString -> BigNumber

#fromAscii Source

fromAscii :: String -> HexString

Get the 'HexString' corresponding to the ASCII encoding.