Copyright	Aleksandr Krupenkin 2016-2021
License	Apache-2.0
Maintainer	mail@akru.me
Stability	experimental
Portability	noportable
Safe Haskell	None
Language	Haskell2010

Language.Solidity.Abi

Contents

Contract ABI declarations
Method/Event id encoder
Solidity type parser

Description

JSON encoded contract ABI parsers.

Synopsis

newtype ContractAbi = ContractAbi {
- unAbi :: [Declaration]
}
data Declaration
- = DConstructor {
  - conInputs :: [FunctionArg]
  }
- | DFunction {
  - funName :: Text
  - funConstant :: Bool
  - funInputs :: [FunctionArg]
  - funOutputs :: Maybe [FunctionArg]
  }
- | DEvent {
  - eveName :: Text
  - eveInputs :: [EventArg]
  - eveAnonymous :: Bool
  }
- | DFallback {
  - falPayable :: Bool
  }
data FunctionArg = FunctionArg {
- funArgName :: Text
- funArgType :: Text
- funArgComponents :: Maybe [FunctionArg]
}
data EventArg = EventArg {
- eveArgName :: Text
- eveArgType :: Text
- eveArgIndexed :: Bool
}
data StateMutability
- = SMPure
- | SMView
- | SMPayable
- | SMNonPayable
signature :: Declaration -> Text
methodId :: Declaration -> Text
eventId :: Declaration -> Text
data SolidityType
- = SolidityBool
- | SolidityAddress
- | SolidityUint Int
- | SolidityInt Int
- | SolidityString
- | SolidityBytesN Int
- | SolidityBytes
- | SolidityTuple [SolidityType]
- | SolidityVector [Int] SolidityType
- | SolidityArray SolidityType
parseSolidityFunctionArgType :: FunctionArg -> Either ParseError SolidityType
parseSolidityEventArgType :: EventArg -> Either ParseError SolidityType

Contract ABI declarations

newtype ContractAbi Source #

Contract Abi is a list of method / event declarations

Constructors

ContractAbi
Fields unAbi :: [Declaration]

Instances

Instances details

Eq ContractAbi Source #
Instance details Defined in Language.Solidity.Abi Methods (==) :: ContractAbi -> ContractAbi -> Bool # (/=) :: ContractAbi -> ContractAbi -> Bool #
Ord ContractAbi Source #
Instance details Defined in Language.Solidity.Abi Methods compare :: ContractAbi -> ContractAbi -> Ordering # (<) :: ContractAbi -> ContractAbi -> Bool # (<=) :: ContractAbi -> ContractAbi -> Bool # (>) :: ContractAbi -> ContractAbi -> Bool # (>=) :: ContractAbi -> ContractAbi -> Bool # max :: ContractAbi -> ContractAbi -> ContractAbi # min :: ContractAbi -> ContractAbi -> ContractAbi #
Show ContractAbi Source #
Instance details Defined in Language.Solidity.Abi Methods showsPrec :: Int -> ContractAbi -> ShowS # show :: ContractAbi -> String # showList :: [ContractAbi] -> ShowS #
ToJSON ContractAbi Source #
Instance details Defined in Language.Solidity.Abi Methods toJSON :: ContractAbi -> Value # toEncoding :: ContractAbi -> Encoding # toJSONList :: [ContractAbi] -> Value # toEncodingList :: [ContractAbi] -> Encoding #
FromJSON ContractAbi Source #
Instance details Defined in Language.Solidity.Abi Methods parseJSON :: Value -> Parser ContractAbi # parseJSONList :: Value -> Parser [ContractAbi] #

data Declaration Source #

Elementary contract interface item

Constructors

DConstructor
Fields conInputs :: [FunctionArg] Contract constructor
DFunction
Fields funName :: Text funConstant :: Bool funInputs :: [FunctionArg] funOutputs :: Maybe [FunctionArg] Method
DEvent
Fields eveName :: Text eveInputs :: [EventArg] eveAnonymous :: Bool Event
DFallback
Fields falPayable :: Bool Fallback function

Instances

Instances details

Eq Declaration Source #
Instance details Defined in Language.Solidity.Abi Methods (==) :: Declaration -> Declaration -> Bool # (/=) :: Declaration -> Declaration -> Bool #
Ord Declaration Source #
Instance details Defined in Language.Solidity.Abi Methods compare :: Declaration -> Declaration -> Ordering # (<) :: Declaration -> Declaration -> Bool # (<=) :: Declaration -> Declaration -> Bool # (>) :: Declaration -> Declaration -> Bool # (>=) :: Declaration -> Declaration -> Bool # max :: Declaration -> Declaration -> Declaration # min :: Declaration -> Declaration -> Declaration #
Show Declaration Source #
Instance details Defined in Language.Solidity.Abi Methods showsPrec :: Int -> Declaration -> ShowS # show :: Declaration -> String # showList :: [Declaration] -> ShowS #
ToJSON Declaration Source #
Instance details Defined in Language.Solidity.Abi Methods toJSON :: Declaration -> Value # toEncoding :: Declaration -> Encoding # toJSONList :: [Declaration] -> Value # toEncodingList :: [Declaration] -> Encoding #
FromJSON Declaration Source #
Instance details Defined in Language.Solidity.Abi Methods parseJSON :: Value -> Parser Declaration # parseJSONList :: Value -> Parser [Declaration] #

data FunctionArg Source #

Method argument

Constructors

FunctionArg
Fields funArgName :: Text Argument name funArgType :: Text Argument type funArgComponents :: Maybe [FunctionArg] Argument components for tuples

Instances

Instances details

Eq FunctionArg Source #
Instance details Defined in Language.Solidity.Abi Methods (==) :: FunctionArg -> FunctionArg -> Bool # (/=) :: FunctionArg -> FunctionArg -> Bool #
Ord FunctionArg Source #
Instance details Defined in Language.Solidity.Abi Methods compare :: FunctionArg -> FunctionArg -> Ordering # (<) :: FunctionArg -> FunctionArg -> Bool # (<=) :: FunctionArg -> FunctionArg -> Bool # (>) :: FunctionArg -> FunctionArg -> Bool # (>=) :: FunctionArg -> FunctionArg -> Bool # max :: FunctionArg -> FunctionArg -> FunctionArg # min :: FunctionArg -> FunctionArg -> FunctionArg #
Show FunctionArg Source #
Instance details Defined in Language.Solidity.Abi Methods showsPrec :: Int -> FunctionArg -> ShowS # show :: FunctionArg -> String # showList :: [FunctionArg] -> ShowS #
ToJSON FunctionArg Source #
Instance details Defined in Language.Solidity.Abi Methods toJSON :: FunctionArg -> Value # toEncoding :: FunctionArg -> Encoding # toJSONList :: [FunctionArg] -> Value # toEncodingList :: [FunctionArg] -> Encoding #
FromJSON FunctionArg Source #
Instance details Defined in Language.Solidity.Abi Methods parseJSON :: Value -> Parser FunctionArg # parseJSONList :: Value -> Parser [FunctionArg] #

data EventArg Source #

Event argument

Constructors

EventArg
Fields eveArgName :: Text Argument name eveArgType :: Text Argument type eveArgIndexed :: Bool Argument is indexed (e.g. placed on topics of event)

Instances

Instances details

Eq EventArg Source #
Instance details Defined in Language.Solidity.Abi Methods (==) :: EventArg -> EventArg -> Bool # (/=) :: EventArg -> EventArg -> Bool #
Ord EventArg Source #
Instance details Defined in Language.Solidity.Abi Methods compare :: EventArg -> EventArg -> Ordering # (<) :: EventArg -> EventArg -> Bool # (<=) :: EventArg -> EventArg -> Bool # (>) :: EventArg -> EventArg -> Bool # (>=) :: EventArg -> EventArg -> Bool # max :: EventArg -> EventArg -> EventArg # min :: EventArg -> EventArg -> EventArg #
Show EventArg Source #
Instance details Defined in Language.Solidity.Abi Methods showsPrec :: Int -> EventArg -> ShowS # show :: EventArg -> String # showList :: [EventArg] -> ShowS #
ToJSON EventArg Source #
Instance details Defined in Language.Solidity.Abi Methods toJSON :: EventArg -> Value # toEncoding :: EventArg -> Encoding # toJSONList :: [EventArg] -> Value # toEncodingList :: [EventArg] -> Encoding #
FromJSON EventArg Source #
Instance details Defined in Language.Solidity.Abi Methods parseJSON :: Value -> Parser EventArg # parseJSONList :: Value -> Parser [EventArg] #

data StateMutability Source #

Constructors

SMPure
SMView
SMPayable
SMNonPayable

Instances

Instances details

Eq StateMutability Source #
Instance details Defined in Language.Solidity.Abi Methods (==) :: StateMutability -> StateMutability -> Bool # (/=) :: StateMutability -> StateMutability -> Bool #
Ord StateMutability Source #
Instance details Defined in Language.Solidity.Abi Methods compare :: StateMutability -> StateMutability -> Ordering # (<) :: StateMutability -> StateMutability -> Bool # (<=) :: StateMutability -> StateMutability -> Bool # (>) :: StateMutability -> StateMutability -> Bool # (>=) :: StateMutability -> StateMutability -> Bool # max :: StateMutability -> StateMutability -> StateMutability # min :: StateMutability -> StateMutability -> StateMutability #
Show StateMutability Source #
Instance details Defined in Language.Solidity.Abi Methods showsPrec :: Int -> StateMutability -> ShowS # show :: StateMutability -> String # showList :: [StateMutability] -> ShowS #
ToJSON StateMutability Source #
Instance details Defined in Language.Solidity.Abi Methods toJSON :: StateMutability -> Value # toEncoding :: StateMutability -> Encoding # toJSONList :: [StateMutability] -> Value # toEncodingList :: [StateMutability] -> Encoding #
FromJSON StateMutability Source #
Instance details Defined in Language.Solidity.Abi Methods parseJSON :: Value -> Parser StateMutability # parseJSONList :: Value -> Parser [StateMutability] #

Method/Event id encoder

signature :: Declaration -> Text Source #

Take a signature by given decl, e.g. foo(uint,string)

methodId :: Declaration -> Text Source #

Generate method selector by given method Delcaration

eventId :: Declaration -> Text Source #

Generate event topic0 hash by givent event Delcaration

Solidity type parser

data SolidityType Source #

Solidity types and parsers

Constructors

SolidityBool
SolidityAddress
SolidityUint Int
SolidityInt Int
SolidityString
SolidityBytesN Int
SolidityBytes
SolidityTuple [SolidityType]
SolidityVector [Int] SolidityType
SolidityArray SolidityType

Instances

Instances details

Eq SolidityType Source #
Instance details Defined in Language.Solidity.Abi Methods (==) :: SolidityType -> SolidityType -> Bool # (/=) :: SolidityType -> SolidityType -> Bool #
Show SolidityType Source #
Instance details Defined in Language.Solidity.Abi Methods showsPrec :: Int -> SolidityType -> ShowS # show :: SolidityType -> String # showList :: [SolidityType] -> ShowS #

parseSolidityFunctionArgType :: FunctionArg -> Either ParseError SolidityType Source #

parseSolidityEventArgType :: EventArg -> Either ParseError SolidityType Source #