1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
"""
Types for Contract ABIs and related components.
"""
from typing import (
Any,
Literal,
Sequence,
Tuple,
TypedDict,
Union,
)
from typing_extensions import (
NotRequired,
)
from eth_typing.encoding import (
HexStr,
)
TypeStr = str
"""String representation of a data type."""
Decodable = Union[bytes, bytearray]
"""Binary data to be decoded."""
class ABIComponent(TypedDict):
"""
TypedDict representing an `ABIElement` component.
"""
type: str
"""Type of the component."""
name: NotRequired[str]
"""Name of the component."""
components: NotRequired[Sequence["ABIComponent"]]
"""List of nested `ABI` components for ABI types."""
class ABIComponentIndexed(ABIComponent):
"""
TypedDict representing an indexed `ABIElement` component.
"""
indexed: bool
"""If True, component can be used as a topic filter."""
class ABIEvent(TypedDict):
"""
TypedDict to represent the `ABI` for an event.
"""
name: str
"""Event name identifier."""
type: Literal["event"]
"""Event ABI type."""
anonymous: NotRequired[bool]
"""If True, event is anonymous. Cannot filter the event by name."""
inputs: NotRequired[Sequence["ABIComponentIndexed"]]
"""Input components for the event."""
class ABIFunctionType(TypedDict, total=False):
"""
TypedDict representing the `ABI` for all function types.
This is the base type for functions.
Please use ABIFunction, ABIConstructor, ABIFallback or ABIReceive instead.
"""
stateMutability: Literal["pure", "view", "nonpayable", "payable"]
"""State mutability of the constructor."""
payable: bool
"""
Contract is payable to receive ether on deployment.
Deprecated in favor of stateMutability payable and nonpayable.
"""
constant: bool
"""
Function is constant and does not change state.
Deprecated in favor of stateMutability pure and view.
"""
class ABIFunction(ABIFunctionType):
"""
TypedDict representing the `ABI` for a function.
"""
type: Literal["function"]
"""Type of the function."""
name: str
"""Name of the function."""
inputs: NotRequired[Sequence["ABIComponent"]]
"""Function input components."""
outputs: NotRequired[Sequence["ABIComponent"]]
"""Function output components."""
class ABIConstructor(ABIFunctionType):
"""
TypedDict representing the `ABI` for a constructor function.
"""
type: Literal["constructor"]
"""Type of the constructor function."""
inputs: NotRequired[Sequence["ABIComponent"]]
"""Function input components."""
class ABIFallback(ABIFunctionType):
"""
TypedDict representing the `ABI` for a fallback function.
"""
type: Literal["fallback"]
"""Type of the fallback function."""
class ABIReceive(ABIFunctionType):
"""
TypedDict representing the `ABI` for a receive function.
"""
type: Literal["receive"]
"""Type of the receive function."""
class ABIError(TypedDict):
"""
TypedDict representing the `ABI` for an error.
"""
type: Literal["error"]
"""Type of the error."""
name: str
"""Name of the error."""
inputs: NotRequired[Sequence["ABIComponent"]]
"""Error input components."""
ABICallable = Union[ABIFunction, ABIConstructor, ABIFallback, ABIReceive]
"""
A `Union` type consisting of `ABIFunction`, `ABIConstructor`, `ABIFallback` and
`ABIReceive` types.
"""
ABIElement = Union[ABICallable, ABIEvent, ABIError]
"""A `Union` type consisting of `ABICallable`, `ABIEvent`, and `ABIError` types."""
class ABIElementInfo(TypedDict):
"""
TypedDict to represent properties of an `ABIElement`, including the abi,
selector and arguments.
"""
abi: ABIElement
"""ABI for any `ABIElement` type."""
selector: HexStr
"""Solidity `ABIElement` selector sighash."""
arguments: Tuple[Any, ...]
"""`ABIElement` input components."""
ABI = Sequence[ABIElement]
"""
List of components representing function and event interfaces
(elements of an ABI).
"""
|
