-
Notifications
You must be signed in to change notification settings - Fork 5
/
AERC5453.sol
287 lines (260 loc) · 9.26 KB
/
AERC5453.sol
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
// SPDX-License-Identifier: Apache-2.0
// Author: Zainan Victor Zhou <zzn-ercref@zzn.im>
pragma solidity ^0.8.9;
import "@openzeppelin/contracts/utils/cryptography/SignatureChecker.sol";
import "@openzeppelin/contracts/utils/cryptography/EIP712.sol";
import "./IERC5453.sol";
// add hardhat log
import "hardhat/console.sol";
abstract contract AERC5453Endorsible is EIP712,
IERC5453EndorsementCore, IERC5453EndorsementDigest, IERC5453EndorsementDataTypeA, IERC5453EndorsementDataTypeB {
uint256 private threshold;
uint256 private currentNonce = 0;
bytes32 constant MAGIC_WORD = keccak256("ERC5453-ENDORSEMENT"); // ASCII of "ENDORSED"
uint256 constant ERC5453_TYPE_A = 1;
uint256 constant ERC5453_TYPE_B = 2;
constructor(
string memory _name,
string memory _erc712Version
) EIP712(_name, _erc712Version) {}
function _validateSignatureFromEndorsement(
bytes32 msgDigest,
SingleEndorsementData memory endersement
) internal view virtual {
require(
endersement.sig.length == 65,
"AERC5453Endorsible: wrong signature length"
);
require(
SignatureChecker.isValidSignatureNow(
endersement.endorserAddress,
msgDigest,
endersement.sig
),
"AERC5453Endorsible: invalid signature"
);
}
function _extractEndorsersFromFinalDigest(
bytes32 digest,
GeneralExtensionDataStruct memory data
) internal view virtual returns (address[] memory endorsers) {
if (data.erc5453Type == ERC5453_TYPE_A) {
SingleEndorsementData memory endersement = abi.decode(
data.endorsementPayload,
(SingleEndorsementData)
);
endorsers = new address[](1);
endorsers[0] = endersement.endorserAddress;
_validateSignatureFromEndorsement(digest, endersement);
} else if (data.erc5453Type == ERC5453_TYPE_B) {
SingleEndorsementData[] memory endorsements = abi.decode(
data.endorsementPayload,
(SingleEndorsementData[])
);
endorsers = new address[](endorsements.length);
for (uint256 i = 0; i < endorsements.length; ++i) {
endorsers[i] = endorsements[i].endorserAddress;
_validateSignatureFromEndorsement(digest, endorsements[i]);
}
return endorsers;
}
}
function _decodeExtensionData(
bytes memory extensionData
) internal pure virtual returns (GeneralExtensionDataStruct memory) {
return abi.decode(extensionData, (GeneralExtensionDataStruct));
}
// Well, I know this is epensive. Let's improve it later.
function _noRepeat(address[] memory _owners) internal pure returns (bool) {
for (uint256 i = 0; i < _owners.length; i++) {
for (uint256 j = i + 1; j < _owners.length; j++) {
if (_owners[i] == _owners[j]) {
return false;
}
}
}
return true;
}
// TODO consider per-Endorser validSince, validBy, nonce
function _checkTimeValidity(GeneralExtensionDataStruct memory _data) internal view {
require(_data.erc5453MagicWord == MAGIC_WORD, "AERC5453Endorsible: MagicWord not matched");
require(_data.validSince <= block.number, "AERC5453Endorsible: Not valid yet");
require(_data.validBy >= block.number, "AERC5453Endorsible: Expired");
}
function _extractEndorsers(
bytes32 _functionParamStructHash,
bytes calldata _extraData
) internal view returns(
address[] memory _endorsers,
bytes32 _finalDigest,
GeneralExtensionDataStruct memory _structureData) {
_structureData = _decodeExtensionData(
_extraData
);
_finalDigest = _computeValidityDigest(
_functionParamStructHash,
_structureData.validSince,
_structureData.validBy,
_structureData.nonce
);
_endorsers = _extractEndorsersFromFinalDigest(_finalDigest, _structureData);
return (_endorsers, _finalDigest, _structureData);
}
function _checkEndorsementAndUpdateNonce(
bytes32 _functionParamStructHash,
bytes calldata _extraData
) internal returns (bool) {
(
address[] memory endorsers,
bytes32 finalDigest,
GeneralExtensionDataStruct memory structureData
) = _extractEndorsers(_functionParamStructHash, _extraData);
_checkTimeValidity(structureData);
// TODO: avoid replay attack
require(currentNonce == structureData.nonce, "AERC5453Endorsible: Nonce not matched");
currentNonce += 1;
require(
endorsers.length >= threshold,
"AERC5453Endorsable: not enough endorsers"
);
require(_noRepeat(endorsers));
for (uint256 i = 0; i < endorsers.length; i++) {
require(
_isEligibleEndorser(endorsers[i]),
"AERC5453Endorsable: not eligible endorsers"
); // everyone must be a legit endorser
}
return true;
}
function _isEligibleEndorser(
address /*_endorser*/
) internal view virtual returns (bool);
modifier onlyEndorsed(
bytes32 _functionParamStructHash,
bytes calldata _extensionData
) {
require(_checkEndorsementAndUpdateNonce(_functionParamStructHash, _extensionData));
_;
}
function _computeValidityDigest(
bytes32 _functionParamStructHash,
uint256 _validSince,
uint256 _validBy,
uint256 _nonce
) internal view returns (bytes32) {
return
super._hashTypedDataV4(
keccak256(
abi.encode(
keccak256(
"ValidityBound(bytes32 functionParamStructHash,uint256 validSince,uint256 validBy,uint256 nonce)"
),
_functionParamStructHash,
_validSince,
_validBy,
_nonce
)
)
);
}
function _computeFunctionParamHash(
string memory _functionStructure,
bytes memory _functionParamPacked
) internal pure returns (bytes32) {
bytes32 functionParamStructHash = keccak256(
abi.encodePacked(
keccak256(bytes(_functionStructure)),
_functionParamPacked
)
);
return functionParamStructHash;
}
function _setThreshold(uint256 _threshold) internal virtual {
threshold = _threshold;
}
function computeValidityDigest(
bytes32 _functionParamStructHash,
uint256 _validSince,
uint256 _validBy,
uint256 _nonce
) external view override returns (bytes32) {
return
_computeValidityDigest(
_functionParamStructHash,
_validSince,
_validBy,
_nonce
);
}
function computeFunctionParamHash(
string memory _functionName,
bytes memory _functionParamPacked
) external pure override returns (bytes32) {
return
_computeFunctionParamHash(
_functionName,
_functionParamPacked
);
}
function eip5453Nonce(address addr) external view override returns (uint256) {
require(address(this) == addr, "AERC5453Endorsable: not self");
return currentNonce;
}
function isEligibleEndorser(address _endorser)
external
view
override
returns (bool)
{
return _isEligibleEndorser(_endorser);
}
function computeExtensionDataTypeA(
uint256 nonce,
uint256 validSince,
uint256 validBy,
address endorserAddress,
bytes calldata sig
) external pure override returns (bytes memory) {
return
abi.encode(
GeneralExtensionDataStruct(
MAGIC_WORD,
ERC5453_TYPE_A,
nonce,
validSince,
validBy,
abi.encode(SingleEndorsementData(endorserAddress, sig))
)
);
}
function computeExtensionDataTypeB(
uint256 nonce,
uint256 validSince,
uint256 validBy,
address[] calldata endorserAddress,
bytes[] calldata sigs
) external pure override returns (bytes memory) {
require(endorserAddress.length == sigs.length);
SingleEndorsementData[]
memory endorsements = new SingleEndorsementData[](
endorserAddress.length
);
for (uint256 i = 0; i < endorserAddress.length; ++i) {
endorsements[i] = SingleEndorsementData(
endorserAddress[i],
sigs[i]
);
}
return
abi.encode(
GeneralExtensionDataStruct(
MAGIC_WORD,
ERC5453_TYPE_B,
nonce,
validSince,
validBy,
abi.encode(endorsements)
)
);
}
}