arr00-testing-oz-contracts 0.0.0 → 5.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (507) hide show
  1. package/README.md +121 -0
  2. package/access/AccessControl.sol +206 -0
  3. package/access/IAccessControl.sol +98 -0
  4. package/access/Ownable.sol +100 -0
  5. package/access/Ownable2Step.sol +67 -0
  6. package/access/extensions/AccessControlDefaultAdminRules.sol +372 -0
  7. package/access/extensions/AccessControlEnumerable.sol +81 -0
  8. package/access/extensions/IAccessControlDefaultAdminRules.sol +192 -0
  9. package/access/extensions/IAccessControlEnumerable.sol +31 -0
  10. package/access/manager/AccessManaged.sol +118 -0
  11. package/access/manager/AccessManager.sol +781 -0
  12. package/access/manager/AuthorityUtils.sol +36 -0
  13. package/access/manager/IAccessManaged.sol +32 -0
  14. package/access/manager/IAccessManager.sol +410 -0
  15. package/access/manager/IAuthority.sol +14 -0
  16. package/account/Account.sol +151 -0
  17. package/account/extensions/draft-AccountERC7579.sol +430 -0
  18. package/account/extensions/draft-AccountERC7579Hooked.sol +113 -0
  19. package/account/extensions/draft-ERC7821.sol +70 -0
  20. package/account/paymaster/Paymaster.sol +170 -0
  21. package/account/paymaster/extensions/PaymasterERC20.sol +394 -0
  22. package/account/paymaster/extensions/PaymasterERC20Guarantor.sol +190 -0
  23. package/account/paymaster/extensions/PaymasterERC721Owner.sol +54 -0
  24. package/account/paymaster/extensions/PaymasterSigner.sol +125 -0
  25. package/account/utils/EIP7702Utils.sol +25 -0
  26. package/account/utils/ERC4337Utils.sol +317 -0
  27. package/account/utils/draft-ERC7579Utils.sol +314 -0
  28. package/build/contracts/AbstractSigner.json +13 -0
  29. package/build/contracts/AccessControl.json +239 -0
  30. package/build/contracts/AccessControlDefaultAdminRules.json +467 -0
  31. package/build/contracts/AccessControlEnumerable.json +301 -0
  32. package/build/contracts/AccessManaged.json +104 -0
  33. package/build/contracts/AccessManager.json +1189 -0
  34. package/build/contracts/Account.json +150 -0
  35. package/build/contracts/AccountERC7579.json +515 -0
  36. package/build/contracts/AccountERC7579Hooked.json +539 -0
  37. package/build/contracts/Accumulators.json +13 -0
  38. package/build/contracts/Address.json +25 -0
  39. package/build/contracts/Arrays.json +13 -0
  40. package/build/contracts/AuthorityUtils.json +13 -0
  41. package/build/contracts/Base58.json +25 -0
  42. package/build/contracts/Base64.json +25 -0
  43. package/build/contracts/BeaconProxy.json +97 -0
  44. package/build/contracts/BitMaps.json +13 -0
  45. package/build/contracts/BlockHeader.json +25 -0
  46. package/build/contracts/Blockhash.json +13 -0
  47. package/build/contracts/BridgeERC1155.json +508 -0
  48. package/build/contracts/BridgeERC20.json +260 -0
  49. package/build/contracts/BridgeERC721.json +270 -0
  50. package/build/contracts/BridgeERC7802.json +249 -0
  51. package/build/contracts/BridgeFungible.json +236 -0
  52. package/build/contracts/BridgeMultiToken.json +236 -0
  53. package/build/contracts/BridgeNonFungible.json +212 -0
  54. package/build/contracts/Bytes.json +13 -0
  55. package/build/contracts/CAIP10.json +13 -0
  56. package/build/contracts/CAIP2.json +13 -0
  57. package/build/contracts/Calldata.json +13 -0
  58. package/build/contracts/Checkpoints.json +19 -0
  59. package/build/contracts/CircularBuffer.json +19 -0
  60. package/build/contracts/Clones.json +19 -0
  61. package/build/contracts/Comparators.json +13 -0
  62. package/build/contracts/Context.json +13 -0
  63. package/build/contracts/Create2.json +19 -0
  64. package/build/contracts/Create3.json +19 -0
  65. package/build/contracts/CrosschainLinked.json +145 -0
  66. package/build/contracts/CrosschainRemoteExecutor.json +199 -0
  67. package/build/contracts/DoubleEndedQueue.json +13 -0
  68. package/build/contracts/ECDSA.json +41 -0
  69. package/build/contracts/EIP712.json +79 -0
  70. package/build/contracts/EIP7702Utils.json +13 -0
  71. package/build/contracts/ERC1155.json +428 -0
  72. package/build/contracts/ERC1155Burnable.json +474 -0
  73. package/build/contracts/ERC1155Crosschain.json +796 -0
  74. package/build/contracts/ERC1155Holder.json +111 -0
  75. package/build/contracts/ERC1155Pausable.json +477 -0
  76. package/build/contracts/ERC1155Supply.json +479 -0
  77. package/build/contracts/ERC1155URIStorage.json +428 -0
  78. package/build/contracts/ERC1155Utils.json +13 -0
  79. package/build/contracts/ERC1363.json +585 -0
  80. package/build/contracts/ERC1363Utils.json +36 -0
  81. package/build/contracts/ERC165.json +33 -0
  82. package/build/contracts/ERC165Checker.json +13 -0
  83. package/build/contracts/ERC1967Clones.json +13 -0
  84. package/build/contracts/ERC1967Proxy.json +84 -0
  85. package/build/contracts/ERC1967Utils.json +52 -0
  86. package/build/contracts/ERC20.json +322 -0
  87. package/build/contracts/ERC20Bridgeable.json +427 -0
  88. package/build/contracts/ERC20Burnable.json +353 -0
  89. package/build/contracts/ERC20Capped.json +362 -0
  90. package/build/contracts/ERC20Crosschain.json +573 -0
  91. package/build/contracts/ERC20FlashMint.json +432 -0
  92. package/build/contracts/ERC20Pausable.json +371 -0
  93. package/build/contracts/ERC20Permit.json +532 -0
  94. package/build/contracts/ERC20TemporaryApproval.json +346 -0
  95. package/build/contracts/ERC20TransferAuthorization.json +836 -0
  96. package/build/contracts/ERC20Votes.json +781 -0
  97. package/build/contracts/ERC20Wrapper.json +405 -0
  98. package/build/contracts/ERC2771Context.json +46 -0
  99. package/build/contracts/ERC2771Forwarder.json +439 -0
  100. package/build/contracts/ERC2981.json +126 -0
  101. package/build/contracts/ERC3009.json +668 -0
  102. package/build/contracts/ERC4337Utils.json +13 -0
  103. package/build/contracts/ERC4626.json +807 -0
  104. package/build/contracts/ERC6372Utils.json +19 -0
  105. package/build/contracts/ERC6909.json +415 -0
  106. package/build/contracts/ERC6909ContentURI.json +472 -0
  107. package/build/contracts/ERC6909Metadata.json +529 -0
  108. package/build/contracts/ERC6909TokenSupply.json +434 -0
  109. package/build/contracts/ERC721.json +447 -0
  110. package/build/contracts/ERC721Burnable.json +460 -0
  111. package/build/contracts/ERC721Consecutive.json +509 -0
  112. package/build/contracts/ERC721Crosschain.json +674 -0
  113. package/build/contracts/ERC721Enumerable.json +524 -0
  114. package/build/contracts/ERC721Holder.json +48 -0
  115. package/build/contracts/ERC721Pausable.json +496 -0
  116. package/build/contracts/ERC721Royalty.json +540 -0
  117. package/build/contracts/ERC721URIStorage.json +479 -0
  118. package/build/contracts/ERC721Utils.json +13 -0
  119. package/build/contracts/ERC721Votes.json +835 -0
  120. package/build/contracts/ERC721Wrapper.json +553 -0
  121. package/build/contracts/ERC7579Utils.json +119 -0
  122. package/build/contracts/ERC7739.json +103 -0
  123. package/build/contracts/ERC7739Utils.json +13 -0
  124. package/build/contracts/ERC7786Recipient.json +59 -0
  125. package/build/contracts/ERC7821.json +112 -0
  126. package/build/contracts/ERC7913P256Verifier.json +43 -0
  127. package/build/contracts/ERC7913RSAVerifier.json +43 -0
  128. package/build/contracts/ERC7913WebAuthnVerifier.json +43 -0
  129. package/build/contracts/EnumerableMap.json +36 -0
  130. package/build/contracts/EnumerableSet.json +13 -0
  131. package/build/contracts/Errors.json +51 -0
  132. package/build/contracts/Governor.json +1381 -0
  133. package/build/contracts/GovernorCountingFractional.json +1455 -0
  134. package/build/contracts/GovernorCountingOverridable.json +1612 -0
  135. package/build/contracts/GovernorCountingSimple.json +1410 -0
  136. package/build/contracts/GovernorCrosschain.json +1409 -0
  137. package/build/contracts/GovernorNoncesKeyed.json +1405 -0
  138. package/build/contracts/GovernorPreventLateQuorum.json +1461 -0
  139. package/build/contracts/GovernorProposalGuardian.json +1426 -0
  140. package/build/contracts/GovernorSequentialProposalId.json +1399 -0
  141. package/build/contracts/GovernorSettings.json +1477 -0
  142. package/build/contracts/GovernorStorage.json +1506 -0
  143. package/build/contracts/GovernorSuperQuorum.json +1429 -0
  144. package/build/contracts/GovernorTimelockAccess.json +1582 -0
  145. package/build/contracts/GovernorTimelockCompound.json +1449 -0
  146. package/build/contracts/GovernorTimelockControl.json +1426 -0
  147. package/build/contracts/GovernorVotes.json +1399 -0
  148. package/build/contracts/GovernorVotesQuorumFraction.json +1497 -0
  149. package/build/contracts/GovernorVotesSuperQuorumFraction.json +1657 -0
  150. package/build/contracts/Hashes.json +13 -0
  151. package/build/contracts/Heap.json +13 -0
  152. package/build/contracts/IAccessControl.json +207 -0
  153. package/build/contracts/IAccessControlDefaultAdminRules.json +406 -0
  154. package/build/contracts/IAccessControlEnumerable.json +250 -0
  155. package/build/contracts/IAccessManaged.json +104 -0
  156. package/build/contracts/IAccessManager.json +1085 -0
  157. package/build/contracts/IAccount.json +90 -0
  158. package/build/contracts/IAccountExecute.json +79 -0
  159. package/build/contracts/IAggregator.json +211 -0
  160. package/build/contracts/IAuthority.json +43 -0
  161. package/build/contracts/IBeacon.json +27 -0
  162. package/build/contracts/ICompoundTimelock.json +427 -0
  163. package/build/contracts/IERC1155.json +307 -0
  164. package/build/contracts/IERC1155Errors.json +116 -0
  165. package/build/contracts/IERC1155MetadataURI.json +326 -0
  166. package/build/contracts/IERC1155Receiver.json +111 -0
  167. package/build/contracts/IERC1271.json +38 -0
  168. package/build/contracts/IERC1363.json +385 -0
  169. package/build/contracts/IERC1363Receiver.json +48 -0
  170. package/build/contracts/IERC1363Spender.json +43 -0
  171. package/build/contracts/IERC165.json +33 -0
  172. package/build/contracts/IERC1820Implementer.json +38 -0
  173. package/build/contracts/IERC1820Registry.json +227 -0
  174. package/build/contracts/IERC1822Proxiable.json +27 -0
  175. package/build/contracts/IERC1967.json +59 -0
  176. package/build/contracts/IERC20.json +197 -0
  177. package/build/contracts/IERC20Errors.json +100 -0
  178. package/build/contracts/IERC20Metadata.json +236 -0
  179. package/build/contracts/IERC20Permit.json +89 -0
  180. package/build/contracts/IERC2309.json +45 -0
  181. package/build/contracts/IERC2612.json +89 -0
  182. package/build/contracts/IERC2981.json +62 -0
  183. package/build/contracts/IERC3009.json +163 -0
  184. package/build/contracts/IERC3009Cancel.json +66 -0
  185. package/build/contracts/IERC3156FlashBorrower.json +53 -0
  186. package/build/contracts/IERC3156FlashLender.json +91 -0
  187. package/build/contracts/IERC4626.json +626 -0
  188. package/build/contracts/IERC4906.json +331 -0
  189. package/build/contracts/IERC5267.json +63 -0
  190. package/build/contracts/IERC5313.json +27 -0
  191. package/build/contracts/IERC5805.json +233 -0
  192. package/build/contracts/IERC6372.json +40 -0
  193. package/build/contracts/IERC6909.json +319 -0
  194. package/build/contracts/IERC6909ContentURI.json +351 -0
  195. package/build/contracts/IERC6909Metadata.json +376 -0
  196. package/build/contracts/IERC6909TokenSupply.json +338 -0
  197. package/build/contracts/IERC721.json +299 -0
  198. package/build/contracts/IERC721Enumerable.json +355 -0
  199. package/build/contracts/IERC721Errors.json +117 -0
  200. package/build/contracts/IERC721Metadata.json +344 -0
  201. package/build/contracts/IERC721Receiver.json +48 -0
  202. package/build/contracts/IERC7579AccountConfig.json +65 -0
  203. package/build/contracts/IERC7579Execution.json +56 -0
  204. package/build/contracts/IERC7579Hook.json +101 -0
  205. package/build/contracts/IERC7579Module.json +59 -0
  206. package/build/contracts/IERC7579ModuleConfig.json +127 -0
  207. package/build/contracts/IERC7579Validator.json +159 -0
  208. package/build/contracts/IERC7674.json +221 -0
  209. package/build/contracts/IERC7751.json +40 -0
  210. package/build/contracts/IERC777.json +405 -0
  211. package/build/contracts/IERC777Recipient.json +52 -0
  212. package/build/contracts/IERC777Sender.json +52 -0
  213. package/build/contracts/IERC7786GatewaySource.json +116 -0
  214. package/build/contracts/IERC7786Recipient.json +43 -0
  215. package/build/contracts/IERC7802.json +119 -0
  216. package/build/contracts/IERC7821.json +51 -0
  217. package/build/contracts/IERC7913SignatureVerifier.json +43 -0
  218. package/build/contracts/IEntryPoint.json +305 -0
  219. package/build/contracts/IEntryPointExtra.json +80 -0
  220. package/build/contracts/IEntryPointNonces.json +38 -0
  221. package/build/contracts/IEntryPointStake.json +97 -0
  222. package/build/contracts/IGovernor.json +1095 -0
  223. package/build/contracts/IPaymaster.json +123 -0
  224. package/build/contracts/ITransparentUpgradeableProxy.json +77 -0
  225. package/build/contracts/IVotes.json +207 -0
  226. package/build/contracts/Initializable.json +37 -0
  227. package/build/contracts/InteroperableAddress.json +30 -0
  228. package/build/contracts/LowLevelCall.json +13 -0
  229. package/build/contracts/Math.json +13 -0
  230. package/build/contracts/Memory.json +13 -0
  231. package/build/contracts/MerkleProof.json +19 -0
  232. package/build/contracts/MerkleTree.json +35 -0
  233. package/build/contracts/MessageHashUtils.json +19 -0
  234. package/build/contracts/MultiSignerERC7913.json +176 -0
  235. package/build/contracts/MultiSignerERC7913Weighted.json +264 -0
  236. package/build/contracts/Multicall.json +49 -0
  237. package/build/contracts/Nonces.json +49 -0
  238. package/build/contracts/NoncesKeyed.json +73 -0
  239. package/build/contracts/Ownable.json +88 -0
  240. package/build/contracts/Ownable2Step.json +127 -0
  241. package/build/contracts/P256.json +13 -0
  242. package/build/contracts/Packing.json +19 -0
  243. package/build/contracts/Panic.json +13 -0
  244. package/build/contracts/Pausable.json +63 -0
  245. package/build/contracts/Paymaster.json +147 -0
  246. package/build/contracts/PaymasterERC20.json +209 -0
  247. package/build/contracts/PaymasterERC20Guarantor.json +234 -0
  248. package/build/contracts/PaymasterERC721Owner.json +160 -0
  249. package/build/contracts/PaymasterSigner.json +212 -0
  250. package/build/contracts/Proxy.json +18 -0
  251. package/build/contracts/ProxyAdmin.json +135 -0
  252. package/build/contracts/RLP.json +19 -0
  253. package/build/contracts/RSA.json +13 -0
  254. package/build/contracts/RateLimiter.json +19 -0
  255. package/build/contracts/ReentrancyGuard.json +19 -0
  256. package/build/contracts/ReentrancyGuardTransient.json +19 -0
  257. package/build/contracts/RelayedCall.json +13 -0
  258. package/build/contracts/SafeCast.json +68 -0
  259. package/build/contracts/SafeERC20.json +46 -0
  260. package/build/contracts/ShortStrings.json +30 -0
  261. package/build/contracts/SignatureChecker.json +13 -0
  262. package/build/contracts/SignedMath.json +13 -0
  263. package/build/contracts/SignerECDSA.json +27 -0
  264. package/build/contracts/SignerEIP7702.json +13 -0
  265. package/build/contracts/SignerERC7913.json +27 -0
  266. package/build/contracts/SignerP256.json +48 -0
  267. package/build/contracts/SignerRSA.json +32 -0
  268. package/build/contracts/SignerWebAuthn.json +48 -0
  269. package/build/contracts/SimulateCall.json +13 -0
  270. package/build/contracts/SlotDerivation.json +13 -0
  271. package/build/contracts/StorageSlot.json +13 -0
  272. package/build/contracts/Strings.json +40 -0
  273. package/build/contracts/Time.json +13 -0
  274. package/build/contracts/TimelockController.json +1010 -0
  275. package/build/contracts/TransientSlot.json +13 -0
  276. package/build/contracts/TransparentUpgradeableProxy.json +131 -0
  277. package/build/contracts/TrieProof.json +25 -0
  278. package/build/contracts/UUPSUpgradeable.json +119 -0
  279. package/build/contracts/UpgradeableBeacon.json +154 -0
  280. package/build/contracts/VestingWallet.json +364 -0
  281. package/build/contracts/VestingWalletCliff.json +367 -0
  282. package/build/contracts/Votes.json +402 -0
  283. package/build/contracts/VotesExtended.json +450 -0
  284. package/build/contracts/WebAuthn.json +13 -0
  285. package/crosschain/CrosschainLinked.sol +114 -0
  286. package/crosschain/CrosschainRemoteExecutor.sol +99 -0
  287. package/crosschain/ERC7786Recipient.sol +66 -0
  288. package/crosschain/bridges/BridgeERC1155.sol +131 -0
  289. package/crosschain/bridges/BridgeERC20.sol +42 -0
  290. package/crosschain/bridges/BridgeERC721.sol +62 -0
  291. package/crosschain/bridges/BridgeERC7802.sol +34 -0
  292. package/crosschain/bridges/abstract/BridgeFungible.sol +86 -0
  293. package/crosschain/bridges/abstract/BridgeMultiToken.sol +99 -0
  294. package/crosschain/bridges/abstract/BridgeNonFungible.sol +79 -0
  295. package/finance/VestingWallet.sol +160 -0
  296. package/finance/VestingWalletCliff.sol +55 -0
  297. package/governance/Governor.sol +825 -0
  298. package/governance/IGovernor.sol +454 -0
  299. package/governance/TimelockController.sol +470 -0
  300. package/governance/extensions/GovernorCountingFractional.sol +190 -0
  301. package/governance/extensions/GovernorCountingOverridable.sol +226 -0
  302. package/governance/extensions/GovernorCountingSimple.sol +96 -0
  303. package/governance/extensions/GovernorCrosschain.sol +31 -0
  304. package/governance/extensions/GovernorNoncesKeyed.sol +91 -0
  305. package/governance/extensions/GovernorPreventLateQuorum.sol +119 -0
  306. package/governance/extensions/GovernorProposalGuardian.sol +59 -0
  307. package/governance/extensions/GovernorSequentialProposalId.sol +75 -0
  308. package/governance/extensions/GovernorSettings.sol +106 -0
  309. package/governance/extensions/GovernorStorage.sol +134 -0
  310. package/governance/extensions/GovernorSuperQuorum.sol +59 -0
  311. package/governance/extensions/GovernorTimelockAccess.sol +346 -0
  312. package/governance/extensions/GovernorTimelockCompound.sol +162 -0
  313. package/governance/extensions/GovernorTimelockControl.sol +167 -0
  314. package/governance/extensions/GovernorVotes.sol +64 -0
  315. package/governance/extensions/GovernorVotesQuorumFraction.sol +113 -0
  316. package/governance/extensions/GovernorVotesSuperQuorumFraction.sol +135 -0
  317. package/governance/utils/IVotes.sol +60 -0
  318. package/governance/utils/Votes.sol +245 -0
  319. package/governance/utils/VotesExtended.sol +85 -0
  320. package/interfaces/IERC1155.sol +6 -0
  321. package/interfaces/IERC1155MetadataURI.sol +6 -0
  322. package/interfaces/IERC1155Receiver.sol +6 -0
  323. package/interfaces/IERC1271.sol +17 -0
  324. package/interfaces/IERC1363.sol +86 -0
  325. package/interfaces/IERC1363Receiver.sol +32 -0
  326. package/interfaces/IERC1363Spender.sol +26 -0
  327. package/interfaces/IERC165.sol +6 -0
  328. package/interfaces/IERC1820Implementer.sol +20 -0
  329. package/interfaces/IERC1820Registry.sol +112 -0
  330. package/interfaces/IERC1967.sol +24 -0
  331. package/interfaces/IERC20.sol +6 -0
  332. package/interfaces/IERC20Metadata.sol +6 -0
  333. package/interfaces/IERC2309.sol +19 -0
  334. package/interfaces/IERC2612.sol +8 -0
  335. package/interfaces/IERC2981.sol +26 -0
  336. package/interfaces/IERC3156.sol +7 -0
  337. package/interfaces/IERC3156FlashBorrower.sol +27 -0
  338. package/interfaces/IERC3156FlashLender.sol +41 -0
  339. package/interfaces/IERC4337.sol +255 -0
  340. package/interfaces/IERC4626.sol +230 -0
  341. package/interfaces/IERC4906.sol +20 -0
  342. package/interfaces/IERC5267.sol +28 -0
  343. package/interfaces/IERC5313.sol +16 -0
  344. package/interfaces/IERC5805.sol +9 -0
  345. package/interfaces/IERC6093.sol +162 -0
  346. package/interfaces/IERC6372.sol +19 -0
  347. package/interfaces/IERC6909.sol +131 -0
  348. package/interfaces/IERC721.sol +6 -0
  349. package/interfaces/IERC721Enumerable.sol +6 -0
  350. package/interfaces/IERC721Metadata.sol +6 -0
  351. package/interfaces/IERC721Receiver.sol +6 -0
  352. package/interfaces/IERC7751.sol +12 -0
  353. package/interfaces/IERC777.sol +200 -0
  354. package/interfaces/IERC777Recipient.sol +35 -0
  355. package/interfaces/IERC777Sender.sol +35 -0
  356. package/interfaces/IERC7786.sol +64 -0
  357. package/interfaces/IERC7913.sol +18 -0
  358. package/interfaces/draft-IERC1822.sol +20 -0
  359. package/interfaces/draft-IERC3009.sol +87 -0
  360. package/interfaces/draft-IERC7579.sol +227 -0
  361. package/interfaces/draft-IERC7674.sol +17 -0
  362. package/interfaces/draft-IERC7802.sol +32 -0
  363. package/interfaces/draft-IERC7821.sol +44 -0
  364. package/metatx/ERC2771Context.sol +90 -0
  365. package/metatx/ERC2771Forwarder.sol +376 -0
  366. package/package.json +29 -1
  367. package/proxy/Clones.sol +294 -0
  368. package/proxy/ERC1967/ERC1967Clones.sol +219 -0
  369. package/proxy/ERC1967/ERC1967Proxy.sol +62 -0
  370. package/proxy/ERC1967/ERC1967Utils.sol +177 -0
  371. package/proxy/Proxy.sol +69 -0
  372. package/proxy/beacon/BeaconProxy.sol +57 -0
  373. package/proxy/beacon/IBeacon.sol +16 -0
  374. package/proxy/beacon/UpgradeableBeacon.sol +70 -0
  375. package/proxy/transparent/ProxyAdmin.sol +45 -0
  376. package/proxy/transparent/TransparentUpgradeableProxy.sol +118 -0
  377. package/proxy/utils/Initializable.sol +238 -0
  378. package/proxy/utils/UUPSUpgradeable.sol +148 -0
  379. package/token/ERC1155/ERC1155.sol +417 -0
  380. package/token/ERC1155/IERC1155.sol +123 -0
  381. package/token/ERC1155/IERC1155Receiver.sol +59 -0
  382. package/token/ERC1155/extensions/ERC1155Burnable.sol +22 -0
  383. package/token/ERC1155/extensions/ERC1155Crosschain.sol +87 -0
  384. package/token/ERC1155/extensions/ERC1155Pausable.sol +38 -0
  385. package/token/ERC1155/extensions/ERC1155Supply.sol +88 -0
  386. package/token/ERC1155/extensions/ERC1155URIStorage.sol +58 -0
  387. package/token/ERC1155/extensions/IERC1155MetadataURI.sol +20 -0
  388. package/token/ERC1155/utils/ERC1155Holder.sol +42 -0
  389. package/token/ERC1155/utils/ERC1155Utils.sol +88 -0
  390. package/token/ERC20/ERC20.sol +305 -0
  391. package/token/ERC20/IERC20.sol +79 -0
  392. package/token/ERC20/extensions/ERC1363.sol +135 -0
  393. package/token/ERC20/extensions/ERC20Burnable.sol +38 -0
  394. package/token/ERC20/extensions/ERC20Capped.sol +54 -0
  395. package/token/ERC20/extensions/ERC20Crosschain.sol +39 -0
  396. package/token/ERC20/extensions/ERC20FlashMint.sol +130 -0
  397. package/token/ERC20/extensions/ERC20Pausable.sol +33 -0
  398. package/token/ERC20/extensions/ERC20Permit.sol +77 -0
  399. package/token/ERC20/extensions/ERC20TransferAuthorization.sol +91 -0
  400. package/token/ERC20/extensions/ERC20Votes.sol +83 -0
  401. package/token/ERC20/extensions/ERC20Wrapper.sol +93 -0
  402. package/token/ERC20/extensions/ERC4626.sol +304 -0
  403. package/token/ERC20/extensions/IERC20Metadata.sol +26 -0
  404. package/token/ERC20/extensions/IERC20Permit.sol +90 -0
  405. package/token/ERC20/extensions/draft-ERC20Bridgeable.sol +51 -0
  406. package/token/ERC20/extensions/draft-ERC20TemporaryApproval.sol +119 -0
  407. package/token/ERC20/extensions/draft-ERC3009.sol +152 -0
  408. package/token/ERC20/utils/ERC1363Utils.sol +95 -0
  409. package/token/ERC20/utils/SafeERC20.sol +292 -0
  410. package/token/ERC6909/ERC6909.sol +224 -0
  411. package/token/ERC6909/extensions/ERC6909ContentURI.sol +59 -0
  412. package/token/ERC6909/extensions/ERC6909Metadata.sol +83 -0
  413. package/token/ERC6909/extensions/ERC6909TokenSupply.sol +41 -0
  414. package/token/ERC721/ERC721.sol +433 -0
  415. package/token/ERC721/IERC721.sol +135 -0
  416. package/token/ERC721/IERC721Receiver.sol +28 -0
  417. package/token/ERC721/extensions/ERC721Burnable.sol +26 -0
  418. package/token/ERC721/extensions/ERC721Consecutive.sol +176 -0
  419. package/token/ERC721/extensions/ERC721Crosschain.sol +38 -0
  420. package/token/ERC721/extensions/ERC721Enumerable.sol +165 -0
  421. package/token/ERC721/extensions/ERC721Pausable.sol +37 -0
  422. package/token/ERC721/extensions/ERC721Royalty.sol +26 -0
  423. package/token/ERC721/extensions/ERC721URIStorage.sol +62 -0
  424. package/token/ERC721/extensions/ERC721Votes.sol +47 -0
  425. package/token/ERC721/extensions/ERC721Wrapper.sol +102 -0
  426. package/token/ERC721/extensions/IERC721Enumerable.sol +29 -0
  427. package/token/ERC721/extensions/IERC721Metadata.sol +27 -0
  428. package/token/ERC721/utils/ERC721Holder.sol +26 -0
  429. package/token/ERC721/utils/ERC721Utils.sol +50 -0
  430. package/token/common/ERC2981.sol +140 -0
  431. package/utils/Address.sol +167 -0
  432. package/utils/Arrays.sol +905 -0
  433. package/utils/Base58.sol +240 -0
  434. package/utils/Base64.sol +234 -0
  435. package/utils/BlockHeader.sol +312 -0
  436. package/utils/Blockhash.sol +54 -0
  437. package/utils/Bytes.sol +329 -0
  438. package/utils/CAIP10.sol +54 -0
  439. package/utils/CAIP2.sol +51 -0
  440. package/utils/Calldata.sol +25 -0
  441. package/utils/Comparators.sol +19 -0
  442. package/utils/Context.sol +28 -0
  443. package/utils/Create2.sol +91 -0
  444. package/utils/Create3.sol +133 -0
  445. package/utils/ERC6372Utils.sol +53 -0
  446. package/utils/Errors.sol +34 -0
  447. package/utils/LowLevelCall.sol +127 -0
  448. package/utils/Memory.sol +151 -0
  449. package/utils/Multicall.sol +37 -0
  450. package/utils/Nonces.sol +47 -0
  451. package/utils/NoncesKeyed.sol +75 -0
  452. package/utils/Packing.sol +1656 -0
  453. package/utils/Panic.sol +57 -0
  454. package/utils/Pausable.sol +112 -0
  455. package/utils/RLP.sol +487 -0
  456. package/utils/RateLimiter.sol +310 -0
  457. package/utils/ReentrancyGuard.sol +119 -0
  458. package/utils/ReentrancyGuardTransient.sol +84 -0
  459. package/utils/RelayedCall.sol +145 -0
  460. package/utils/ShortStrings.sol +122 -0
  461. package/utils/SimulateCall.sol +114 -0
  462. package/utils/SlotDerivation.sol +155 -0
  463. package/utils/StorageSlot.sol +143 -0
  464. package/utils/Strings.sol +532 -0
  465. package/utils/TransientSlot.sol +183 -0
  466. package/utils/cryptography/ECDSA.sol +284 -0
  467. package/utils/cryptography/EIP712.sol +168 -0
  468. package/utils/cryptography/Hashes.sol +31 -0
  469. package/utils/cryptography/MerkleProof.sol +510 -0
  470. package/utils/cryptography/MessageHashUtils.sol +228 -0
  471. package/utils/cryptography/P256.sol +409 -0
  472. package/utils/cryptography/RSA.sol +159 -0
  473. package/utils/cryptography/SignatureChecker.sol +199 -0
  474. package/utils/cryptography/TrieProof.sol +256 -0
  475. package/utils/cryptography/WebAuthn.sol +269 -0
  476. package/utils/cryptography/draft-ERC7739Utils.sol +215 -0
  477. package/utils/cryptography/signers/AbstractSigner.sol +23 -0
  478. package/utils/cryptography/signers/MultiSignerERC7913.sol +336 -0
  479. package/utils/cryptography/signers/MultiSignerERC7913Weighted.sol +208 -0
  480. package/utils/cryptography/signers/SignerECDSA.sol +56 -0
  481. package/utils/cryptography/signers/SignerEIP7702.sol +25 -0
  482. package/utils/cryptography/signers/SignerERC7913.sol +63 -0
  483. package/utils/cryptography/signers/SignerP256.sol +64 -0
  484. package/utils/cryptography/signers/SignerRSA.sol +65 -0
  485. package/utils/cryptography/signers/SignerWebAuthn.sol +45 -0
  486. package/utils/cryptography/signers/draft-ERC7739.sol +99 -0
  487. package/utils/cryptography/verifiers/ERC7913P256Verifier.sol +29 -0
  488. package/utils/cryptography/verifiers/ERC7913RSAVerifier.sol +23 -0
  489. package/utils/cryptography/verifiers/ERC7913WebAuthnVerifier.sol +45 -0
  490. package/utils/draft-InteroperableAddress.sol +245 -0
  491. package/utils/introspection/ERC165.sol +25 -0
  492. package/utils/introspection/ERC165Checker.sol +142 -0
  493. package/utils/introspection/IERC165.sol +25 -0
  494. package/utils/math/Math.sol +763 -0
  495. package/utils/math/SafeCast.sol +1162 -0
  496. package/utils/math/SignedMath.sol +68 -0
  497. package/utils/structs/Accumulators.sol +135 -0
  498. package/utils/structs/BitMaps.sol +61 -0
  499. package/utils/structs/Checkpoints.sol +881 -0
  500. package/utils/structs/CircularBuffer.sol +152 -0
  501. package/utils/structs/DoubleEndedQueue.sol +280 -0
  502. package/utils/structs/EnumerableMap.sol +1870 -0
  503. package/utils/structs/EnumerableSet.sol +1177 -0
  504. package/utils/structs/Heap.sol +259 -0
  505. package/utils/structs/MerkleTree.sol +267 -0
  506. package/utils/types/Time.sol +133 -0
  507. package/vendor/compound/ICompoundTimelock.sol +86 -0
@@ -0,0 +1,57 @@
1
+ // SPDX-License-Identifier: MIT
2
+ // OpenZeppelin Contracts (last updated v5.1.0) (utils/Panic.sol)
3
+
4
+ pragma solidity ^0.8.20;
5
+
6
+ /**
7
+ * @dev Helper library for emitting standardized panic codes.
8
+ *
9
+ * ```solidity
10
+ * contract Example {
11
+ * using Panic for uint256;
12
+ *
13
+ * // Use any of the declared internal constants
14
+ * function foo() { Panic.GENERIC.panic(); }
15
+ *
16
+ * // Alternatively
17
+ * function foo() { Panic.panic(Panic.GENERIC); }
18
+ * }
19
+ * ```
20
+ *
21
+ * Follows the list from https://github.com/ethereum/solidity/blob/v0.8.24/libsolutil/ErrorCodes.h[libsolutil].
22
+ *
23
+ * _Available since v5.1._
24
+ */
25
+ // slither-disable-next-line unused-state
26
+ library Panic {
27
+ /// @dev generic / unspecified error
28
+ uint256 internal constant GENERIC = 0x00;
29
+ /// @dev used by the assert() builtin
30
+ uint256 internal constant ASSERT = 0x01;
31
+ /// @dev arithmetic underflow or overflow
32
+ uint256 internal constant UNDER_OVERFLOW = 0x11;
33
+ /// @dev division or modulo by zero
34
+ uint256 internal constant DIVISION_BY_ZERO = 0x12;
35
+ /// @dev enum conversion error
36
+ uint256 internal constant ENUM_CONVERSION_ERROR = 0x21;
37
+ /// @dev invalid encoding in storage
38
+ uint256 internal constant STORAGE_ENCODING_ERROR = 0x22;
39
+ /// @dev empty array pop
40
+ uint256 internal constant EMPTY_ARRAY_POP = 0x31;
41
+ /// @dev array out of bounds access
42
+ uint256 internal constant ARRAY_OUT_OF_BOUNDS = 0x32;
43
+ /// @dev resource error (too large allocation or too large array)
44
+ uint256 internal constant RESOURCE_ERROR = 0x41;
45
+ /// @dev calling invalid internal function
46
+ uint256 internal constant INVALID_INTERNAL_FUNCTION = 0x51;
47
+
48
+ /// @dev Reverts with a panic code. Recommended to use with
49
+ /// the internal constants with predefined codes.
50
+ function panic(uint256 code) internal pure {
51
+ assembly ("memory-safe") {
52
+ mstore(0x00, 0x4e487b71)
53
+ mstore(0x20, code)
54
+ revert(0x1c, 0x24)
55
+ }
56
+ }
57
+ }
@@ -0,0 +1,112 @@
1
+ // SPDX-License-Identifier: MIT
2
+ // OpenZeppelin Contracts (last updated v5.8.0) (utils/Pausable.sol)
3
+
4
+ pragma solidity ^0.8.20;
5
+
6
+ import {Context} from "./Context.sol";
7
+
8
+ /**
9
+ * @dev Contract module which allows children to implement an emergency stop
10
+ * mechanism that can be triggered by an authorized account.
11
+ *
12
+ * This module is used through inheritance. It will make available the
13
+ * modifiers `whenNotPaused` and `whenPaused`, which can be applied to
14
+ * the functions of your contract. Note that they will not be pausable by
15
+ * simply including this module, only once the modifiers are put in place.
16
+ */
17
+ abstract contract Pausable is Context {
18
+ bool private _paused;
19
+
20
+ /**
21
+ * @dev Emitted when the pause is triggered by `account`.
22
+ */
23
+ event Paused(address account);
24
+
25
+ /**
26
+ * @dev Emitted when the pause is lifted by `account`.
27
+ */
28
+ event Unpaused(address account);
29
+
30
+ /**
31
+ * @dev The operation failed because the contract is paused.
32
+ */
33
+ error EnforcedPause();
34
+
35
+ /**
36
+ * @dev The operation failed because the contract is not paused.
37
+ */
38
+ error ExpectedPause();
39
+
40
+ /**
41
+ * @dev Modifier to make a function callable only when the contract is not paused.
42
+ *
43
+ * Requirements:
44
+ *
45
+ * - The contract must not be paused.
46
+ */
47
+ modifier whenNotPaused() {
48
+ _requireNotPaused();
49
+ _;
50
+ }
51
+
52
+ /**
53
+ * @dev Modifier to make a function callable only when the contract is paused.
54
+ *
55
+ * Requirements:
56
+ *
57
+ * - The contract must be paused.
58
+ */
59
+ modifier whenPaused() {
60
+ _requirePaused();
61
+ _;
62
+ }
63
+
64
+ /**
65
+ * @dev Returns true if the contract is paused, and false otherwise.
66
+ */
67
+ function paused() public view virtual returns (bool) {
68
+ return _paused;
69
+ }
70
+
71
+ /**
72
+ * @dev Throws if the contract is paused.
73
+ */
74
+ function _requireNotPaused() internal view virtual {
75
+ if (paused()) {
76
+ revert EnforcedPause();
77
+ }
78
+ }
79
+
80
+ /**
81
+ * @dev Throws if the contract is not paused.
82
+ */
83
+ function _requirePaused() internal view virtual {
84
+ if (!paused()) {
85
+ revert ExpectedPause();
86
+ }
87
+ }
88
+
89
+ /**
90
+ * @dev Triggers stopped state.
91
+ *
92
+ * Requirements:
93
+ *
94
+ * - The contract must not be paused.
95
+ */
96
+ function _pause() internal virtual whenNotPaused {
97
+ _paused = true;
98
+ emit Paused(_msgSender());
99
+ }
100
+
101
+ /**
102
+ * @dev Returns to normal state.
103
+ *
104
+ * Requirements:
105
+ *
106
+ * - The contract must be paused.
107
+ */
108
+ function _unpause() internal virtual whenPaused {
109
+ _paused = false;
110
+ emit Unpaused(_msgSender());
111
+ }
112
+ }
package/utils/RLP.sol ADDED
@@ -0,0 +1,487 @@
1
+ // SPDX-License-Identifier: MIT
2
+ // OpenZeppelin Contracts (last updated v5.8.0) (utils/RLP.sol)
3
+
4
+ pragma solidity ^0.8.26;
5
+
6
+ import {Bytes} from "./Bytes.sol";
7
+ import {Math} from "./math/Math.sol";
8
+ import {Memory} from "./Memory.sol";
9
+ import {Accumulators} from "./structs/Accumulators.sol";
10
+
11
+ /**
12
+ * @dev Library for encoding and decoding data in RLP format.
13
+ * Recursive Length Prefix (RLP) is the main encoding method used to serialize objects in Ethereum.
14
+ * It's used for encoding everything from transactions to blocks to Patricia-Merkle tries.
15
+ *
16
+ * Inspired by
17
+ *
18
+ * * https://github.com/succinctlabs/optimism-bedrock-contracts/blob/main/rlp/RLPWriter.sol
19
+ * * https://github.com/succinctlabs/optimism-bedrock-contracts/blob/main/rlp/RLPReader.sol
20
+ *
21
+ * == Canonical vs Non-Canonical Encodings
22
+ *
23
+ * According to the Ethereum Yellow Paper, a "canonical" RLP encoding is the unique, minimal
24
+ * representation of a value. For scalar values (integers), this means:
25
+ *
26
+ * * No leading zero bytes (e.g., `0x0123` should be encoded as 2 bytes, not `0x000123` as 3 bytes)
27
+ * * Single bytes less than 0x80 must be encoded directly without a prefix wrapper
28
+ * * Zero is represented as an empty byte array (prefix `0x80`)
29
+ *
30
+ * A "non-canonical" encoding represents the same value but doesn't follow these minimality rules.
31
+ * For example, encoding the integer 1234 (0x04d2) with a leading zero as `0x830004d2` instead
32
+ * of the canonical `0x8204d2`.
33
+ *
34
+ * [IMPORTANT]
35
+ * ====
36
+ * This implementation takes a permissive approach to decoding, accepting some non-canonical
37
+ * encodings (e.g., scalar values with leading zero bytes) that would be rejected by
38
+ * strict implementations like go-ethereum. This design choice prioritizes compatibility
39
+ * with diverse RLP encoders in the ecosystem over strict adherence to the Yellow Paper
40
+ * specification's canonicalization requirements.
41
+ *
42
+ * Users should be aware that:
43
+ *
44
+ * * Multiple different RLP encodings may decode to the same value (non-injective)
45
+ * * Encoding followed by decoding is guaranteed to work correctly
46
+ * * External RLP data from untrusted sources may have non-canonical encodings
47
+ * * Improperly wrapped single bytes (< 0x80) are still rejected as invalid
48
+ * ====
49
+ */
50
+ library RLP {
51
+ using Accumulators for *;
52
+ using Bytes for *;
53
+ using Memory for *;
54
+
55
+ /// @dev The item is not properly formatted and cannot be decoded.
56
+ error RLPInvalidEncoding();
57
+
58
+ enum ItemType {
59
+ Data, // Single data value
60
+ List // List of RLP encoded items
61
+ }
62
+
63
+ /**
64
+ * @dev Maximum length for data that will be encoded using the short format.
65
+ * If `data.length <= 55 bytes`, it will be encoded as: `[0x80 + length]` + data.
66
+ */
67
+ uint8 internal constant SHORT_THRESHOLD = 55;
68
+ /// @dev Single byte prefix for short strings (0-55 bytes)
69
+ uint8 internal constant SHORT_OFFSET = 0x80;
70
+ /// @dev Prefix for list items (0xC0)
71
+ uint8 internal constant LONG_OFFSET = 0xC0;
72
+
73
+ /****************************************************************************************************************
74
+ * ENCODING - ENCODER *
75
+ ****************************************************************************************************************/
76
+
77
+ struct Encoder {
78
+ Accumulators.Accumulator acc;
79
+ }
80
+
81
+ /// @dev Create an empty RLP Encoder.
82
+ function encoder() internal pure returns (Encoder memory enc) {
83
+ enc.acc = Accumulators.accumulator();
84
+ }
85
+
86
+ /// @dev Add a boolean to a given RLP Encoder.
87
+ function push(Encoder memory self, bool input) internal pure returns (Encoder memory) {
88
+ self.acc.push(encode(input));
89
+ return self;
90
+ }
91
+
92
+ /// @dev Add an address to a given RLP Encoder.
93
+ function push(Encoder memory self, address input) internal pure returns (Encoder memory) {
94
+ self.acc.push(encode(input));
95
+ return self;
96
+ }
97
+
98
+ /// @dev Add a uint256 to a given RLP Encoder.
99
+ function push(Encoder memory self, uint256 input) internal pure returns (Encoder memory) {
100
+ self.acc.push(encode(input));
101
+ return self;
102
+ }
103
+
104
+ /// @dev Add a bytes32 to a given RLP Encoder.
105
+ function push(Encoder memory self, bytes32 input) internal pure returns (Encoder memory) {
106
+ self.acc.push(encode(input));
107
+ return self;
108
+ }
109
+
110
+ /// @dev Add a bytes buffer to a given RLP Encoder.
111
+ function push(Encoder memory self, bytes memory input) internal pure returns (Encoder memory) {
112
+ self.acc.push(encode(input));
113
+ return self;
114
+ }
115
+
116
+ /// @dev Add a string to a given RLP Encoder.
117
+ function push(Encoder memory self, string memory input) internal pure returns (Encoder memory) {
118
+ self.acc.push(encode(input));
119
+ return self;
120
+ }
121
+
122
+ /// @dev Add an array of bytes to a given RLP Encoder.
123
+ function push(Encoder memory self, bytes[] memory input) internal pure returns (Encoder memory) {
124
+ self.acc.push(encode(input));
125
+ return self;
126
+ }
127
+
128
+ /// @dev Add an (input) Encoder to a (target) Encoder. The input is RLP encoded as a list of bytes, and added to the target Encoder.
129
+ function push(Encoder memory self, Encoder memory input) internal pure returns (Encoder memory) {
130
+ self.acc.push(encode(input));
131
+ return self;
132
+ }
133
+
134
+ /****************************************************************************************************************
135
+ * ENCODING - TO BYTES *
136
+ ****************************************************************************************************************/
137
+
138
+ /**
139
+ * @dev Encode a boolean as RLP.
140
+ *
141
+ * Boolean `true` is encoded as 0x01, `false` as 0x80 (equivalent to encoding integers 1 and 0).
142
+ * This follows the de facto ecosystem standard where booleans are treated as 0/1 integers.
143
+ */
144
+ function encode(bool input) internal pure returns (bytes memory result) {
145
+ assembly ("memory-safe") {
146
+ result := mload(0x40)
147
+ mstore(result, 0x01) // length of the encoded data: 1 byte
148
+ mstore8(add(result, 0x20), add(mul(iszero(input), 0x7f), 1)) // input
149
+ mstore(0x40, add(result, 0x21)) // reserve memory
150
+ }
151
+ }
152
+
153
+ /**
154
+ * @dev Encode an address as an RLP item of fixed size (20 bytes).
155
+ *
156
+ * The address is encoded with its leading zeros (if it has any). If someone wants to encode the address as a scalar,
157
+ * they can cast it to a uint256 and then call the corresponding {encode} function.
158
+ */
159
+ function encode(address input) internal pure returns (bytes memory result) {
160
+ assembly ("memory-safe") {
161
+ result := mload(0x40)
162
+ mstore(result, 0x15) // length of the encoded data: 1 (prefix) + 0x14 (address)
163
+ mstore(add(result, 0x20), or(shl(248, 0x94), shl(88, input))) // prefix (0x94 = SHORT_OFFSET + 0x14) + input
164
+ mstore(0x40, add(result, 0x35)) // reserve memory
165
+ }
166
+ }
167
+
168
+ /**
169
+ * @dev Encode a uint256 as an RLP scalar.
170
+ *
171
+ * Unlike {encode-bytes32-}, this function uses scalar encoding that removes the prefix zeros.
172
+ */
173
+ function encode(uint256 input) internal pure returns (bytes memory result) {
174
+ if (input < SHORT_OFFSET) {
175
+ assembly ("memory-safe") {
176
+ result := mload(0x40)
177
+ mstore(result, 0x01) // length of the encoded data: 1 byte
178
+ mstore8(add(result, 0x20), or(input, mul(0x80, iszero(input)))) // input (zero is encoded as 0x80)
179
+ mstore(0x40, add(result, 0x21)) // reserve memory
180
+ }
181
+ } else {
182
+ uint256 length = Math.log256(input) + 1;
183
+ assembly ("memory-safe") {
184
+ result := mload(0x40)
185
+ mstore(result, add(length, 1)) // length of the encoded data: 1 (prefix) + length
186
+ mstore8(add(result, 0x20), add(length, SHORT_OFFSET)) // prefix: SHORT_OFFSET + length
187
+ mstore(add(result, 0x21), shl(sub(256, mul(8, length)), input)) // input (aligned left)
188
+ mstore(0x40, add(result, add(length, 0x21))) // reserve memory
189
+ }
190
+ }
191
+ }
192
+
193
+ /**
194
+ * @dev Encode a bytes32 as an RLP item of fixed size (32 bytes).
195
+ *
196
+ * Unlike {encode-uint256-}, this function uses array encoding that preserves the prefix zeros.
197
+ */
198
+ function encode(bytes32 input) internal pure returns (bytes memory result) {
199
+ assembly ("memory-safe") {
200
+ result := mload(0x40)
201
+ mstore(result, 0x21) // length of the encoded data: 1 (prefix) + 0x20
202
+ mstore8(add(result, 0x20), 0xa0) // prefix: SHORT_OFFSET + 0x20
203
+ mstore(add(result, 0x21), input)
204
+ mstore(0x40, add(result, 0x41)) // reserve memory
205
+ }
206
+ }
207
+
208
+ /// @dev Encode a bytes buffer as RLP.
209
+ function encode(bytes memory input) internal pure returns (bytes memory) {
210
+ return
211
+ (input.length == 1 && uint8(input[0]) < SHORT_OFFSET) ? bytes.concat(input) : _encode(input, SHORT_OFFSET);
212
+ }
213
+
214
+ /// @dev Encode a string as RLP. Type alias for {encode-bytes-}.
215
+ function encode(string memory input) internal pure returns (bytes memory) {
216
+ return encode(bytes(input));
217
+ }
218
+
219
+ /**
220
+ * @dev Encode an array of bytes as RLP.
221
+ * This function expects an array of already encoded bytes, not raw bytes.
222
+ * Users should call {encode} on each element of the array before calling it.
223
+ */
224
+ function encode(bytes[] memory input) internal pure returns (bytes memory) {
225
+ return _encode(input.concat(), LONG_OFFSET);
226
+ }
227
+
228
+ /// @dev Encode an encoder (list of bytes) as RLP
229
+ function encode(Encoder memory self) internal pure returns (bytes memory) {
230
+ return _encode(self.acc.flatten(), LONG_OFFSET);
231
+ }
232
+
233
+ function _encode(bytes memory input, uint256 offset) private pure returns (bytes memory result) {
234
+ uint256 length = input.length;
235
+ if (length <= SHORT_THRESHOLD) {
236
+ // Encode "short-bytes" as
237
+ // [ offset + input.length | input ]
238
+ assembly ("memory-safe") {
239
+ result := mload(0x40)
240
+ mstore(result, add(length, 1)) // length of the encoded data: 1 (prefix) + input.length
241
+ mstore8(add(result, 0x20), add(length, offset)) // prefix: offset + input.length
242
+ mcopy(add(result, 0x21), add(input, 0x20), length) // input
243
+ mstore(0x40, add(result, add(length, 0x21))) // reserve memory
244
+ }
245
+ } else {
246
+ // Encode "long-bytes" as
247
+ // [ SHORT_THRESHOLD + offset + input.length.length | input.length | input ]
248
+ uint256 lenlength = Math.log256(length) + 1;
249
+ assembly ("memory-safe") {
250
+ result := mload(0x40)
251
+ mstore(result, add(add(length, lenlength), 1)) // length of the encoded data: 1 (prefix) + input.length.length + input.length
252
+ mstore8(add(result, 0x20), add(add(lenlength, offset), SHORT_THRESHOLD)) // prefix: SHORT_THRESHOLD + offset + input.length.length
253
+ mstore(add(result, 0x21), shl(sub(256, mul(8, lenlength)), length)) // input.length
254
+ mcopy(add(result, add(lenlength, 0x21)), add(input, 0x20), length) // input
255
+ mstore(0x40, add(result, add(add(length, lenlength), 0x21))) // reserve memory
256
+ }
257
+ }
258
+ }
259
+
260
+ /****************************************************************************************************************
261
+ * DECODING - READ FROM AN RLP ENCODED MEMORY SLICE *
262
+ ****************************************************************************************************************/
263
+
264
+ /**
265
+ * @dev Decode an RLP encoded bool. See {encode-bool}
266
+ *
267
+ * NOTE: This function treats any non-zero value as `true`, which is more permissive
268
+ * than some implementations (e.g., go-ethereum only accepts `0x00` for false and `0x01`
269
+ * for true). For example, `0x02`, `0x03`, etc. will all decode as `true`.
270
+ */
271
+ function readBool(Memory.Slice item) internal pure returns (bool) {
272
+ return readUint256(item) != 0;
273
+ }
274
+
275
+ /**
276
+ * @dev Decode an RLP encoded address. See {encode-address}
277
+ *
278
+ * [NOTE]
279
+ * ====
280
+ * This function accepts both single-byte encodings (for values 0-127, including
281
+ * precompile addresses like 0x01) and the standard 21-byte encoding with the `0x94` prefix.
282
+ * For example, `0x01` decodes to `0x0000000000000000000000000000000000000001`.
283
+ *
284
+ * Additionally, like {readUint256}, this function accepts non-canonical encodings with
285
+ * leading zeros. For instance, both `0x01` and `0x940000000000000000000000000000000000000001`
286
+ * decode to the same address.
287
+ * ====
288
+ */
289
+ function readAddress(Memory.Slice item) internal pure returns (address) {
290
+ uint256 length = item.length();
291
+ require(length == 1 || length == 21, RLPInvalidEncoding());
292
+ return address(uint160(readUint256(item)));
293
+ }
294
+
295
+ /**
296
+ * @dev Decode an RLP encoded uint256. See {encode-uint256}
297
+ *
298
+ * [NOTE]
299
+ * ====
300
+ * This function accepts non-canonical encodings with leading zero bytes for multi-byte values,
301
+ * which differs from the Ethereum Yellow Paper specification and some reference
302
+ * implementations like go-ethereum. For example, both `0x88ab54a98ceb1f0ad2` and
303
+ * `0x8900ab54a98ceb1f0ad2` will decode to the same uint256 value (12345678901234567890).
304
+ *
305
+ * However, single bytes less than 0x80 must NOT be wrapped with a prefix. For example,
306
+ * `0x8100` is invalid (should be `0x00`), but `0x820000` is valid (two zero bytes).
307
+ *
308
+ * This permissive behavior is intentional for compatibility with various RLP encoders
309
+ * in the ecosystem, but users should be aware that multiple RLP encodings may map
310
+ * to the same decoded value (non-injective decoding).
311
+ * ====
312
+ */
313
+ function readUint256(Memory.Slice item) internal pure returns (uint256) {
314
+ uint256 length = item.length();
315
+ require(length <= 33, RLPInvalidEncoding());
316
+
317
+ (uint256 itemOffset, uint256 itemLength, ItemType itemType) = _decodeLength(item);
318
+ require(itemType == ItemType.Data, RLPInvalidEncoding());
319
+
320
+ return itemLength == 0 ? 0 : uint256(item.load(itemOffset)) >> (256 - 8 * itemLength);
321
+ }
322
+
323
+ /**
324
+ * @dev Decode an RLP encoded bytes32. See {encode-bytes32}
325
+ *
326
+ * NOTE: Since this function delegates to {readUint256}, it inherits the non-canonical
327
+ * encoding acceptance behavior for multi-byte values. Multiple RLP encodings with different
328
+ * leading zero bytes may decode to the same bytes32 value, but single bytes < 0x80 must
329
+ * not be wrapped with a prefix (e.g., `0x820000` is valid, but `0x8100` is not).
330
+ */
331
+ function readBytes32(Memory.Slice item) internal pure returns (bytes32) {
332
+ return bytes32(readUint256(item));
333
+ }
334
+
335
+ /// @dev Decodes an RLP encoded bytes. See {encode-bytes}
336
+ function readBytes(Memory.Slice item) internal pure returns (bytes memory) {
337
+ (uint256 offset, uint256 length, ItemType itemType) = _decodeLength(item);
338
+ require(itemType == ItemType.Data, RLPInvalidEncoding());
339
+
340
+ // Length is checked by {slice}
341
+ return item.slice(offset, length).toBytes();
342
+ }
343
+
344
+ /// @dev Decodes an RLP encoded string. See {encode-string}
345
+ function readString(Memory.Slice item) internal pure returns (string memory) {
346
+ return string(readBytes(item));
347
+ }
348
+
349
+ /**
350
+ * @dev Decodes an RLP encoded list in a memory slice into an array of RLP Items.
351
+ *
352
+ * NOTE: The returned array contains slice references into the original payload, not copied bytes. Any further
353
+ * modification of the input buffer may cause the output result to become invalid.
354
+ */
355
+ function readList(Memory.Slice item) internal pure returns (Memory.Slice[] memory list) {
356
+ uint256 itemLength = item.length();
357
+
358
+ (uint256 listOffset, uint256 listLength, ItemType itemType) = _decodeLength(item);
359
+ require(itemType == ItemType.List && itemLength == listOffset + listLength, RLPInvalidEncoding());
360
+
361
+ // Start a buffer in the unallocated space
362
+ uint256 ptr;
363
+ assembly ("memory-safe") {
364
+ list := mload(0x40)
365
+ ptr := add(list, 0x20)
366
+ }
367
+
368
+ // Get all items in order, and push them to the buffer
369
+ for (uint256 currentOffset = listOffset; currentOffset < itemLength; ptr += 0x20) {
370
+ (uint256 elementOffset, uint256 elementLength, ) = _decodeLength(item.slice(currentOffset));
371
+ Memory.Slice element = item.slice(currentOffset, elementLength + elementOffset);
372
+ currentOffset += elementOffset + elementLength;
373
+
374
+ // Write item to the buffer
375
+ assembly ("memory-safe") {
376
+ mstore(ptr, element)
377
+ }
378
+ }
379
+
380
+ // write list length and reserve space
381
+ assembly ("memory-safe") {
382
+ mstore(list, div(sub(ptr, add(list, 0x20)), 0x20))
383
+ mstore(0x40, ptr)
384
+ }
385
+ }
386
+
387
+ /****************************************************************************************************************
388
+ * DECODING - FROM BYTES *
389
+ ****************************************************************************************************************/
390
+
391
+ /// @dev Decode an RLP encoded bool from bytes. See {readBool}
392
+ function decodeBool(bytes memory item) internal pure returns (bool) {
393
+ return readBool(item.asSlice());
394
+ }
395
+
396
+ /// @dev Decode an RLP encoded address from bytes. See {readAddress}
397
+ function decodeAddress(bytes memory item) internal pure returns (address) {
398
+ return readAddress(item.asSlice());
399
+ }
400
+
401
+ /// @dev Decode an RLP encoded uint256 from bytes. See {readUint256}
402
+ function decodeUint256(bytes memory item) internal pure returns (uint256) {
403
+ return readUint256(item.asSlice());
404
+ }
405
+
406
+ /// @dev Decode an RLP encoded bytes32 from bytes. See {readBytes32}
407
+ function decodeBytes32(bytes memory item) internal pure returns (bytes32) {
408
+ return readBytes32(item.asSlice());
409
+ }
410
+
411
+ /// @dev Decode an RLP encoded bytes from bytes. See {readBytes}
412
+ function decodeBytes(bytes memory item) internal pure returns (bytes memory) {
413
+ return readBytes(item.asSlice());
414
+ }
415
+
416
+ /// @dev Decode an RLP encoded string from bytes. See {readString}
417
+ function decodeString(bytes memory item) internal pure returns (string memory) {
418
+ return readString(item.asSlice());
419
+ }
420
+
421
+ /**
422
+ * @dev Decode an RLP encoded list from bytes. See {readList}
423
+ *
424
+ * NOTE: The returned array contains slice references into the original payload, not copied bytes. Any further
425
+ * modification of the input buffer may cause the output result to become invalid.
426
+ */
427
+ function decodeList(bytes memory value) internal pure returns (Memory.Slice[] memory) {
428
+ return readList(value.asSlice());
429
+ }
430
+
431
+ /**
432
+ * @dev Decodes an RLP `item`'s length and type from its prefix.
433
+ * Returns the offset, length, and type of the RLP item based on the encoding rules.
434
+ */
435
+ function _decodeLength(Memory.Slice item) private pure returns (uint256, uint256, ItemType) {
436
+ uint256 itemLength = item.length();
437
+
438
+ require(itemLength != 0, RLPInvalidEncoding());
439
+ uint8 prefix = uint8(bytes1(item.load(0)));
440
+
441
+ if (prefix < LONG_OFFSET) {
442
+ // CASE: item
443
+ if (prefix < SHORT_OFFSET) {
444
+ // Case: Single byte below 128
445
+ return (0, 1, ItemType.Data);
446
+ } else if (prefix <= SHORT_OFFSET + SHORT_THRESHOLD) {
447
+ // Case: Short string (0-55 bytes)
448
+ uint256 strLength = prefix - SHORT_OFFSET;
449
+ require(
450
+ itemLength > strLength && (strLength != 1 || bytes1(item.load(1)) >= bytes1(SHORT_OFFSET)),
451
+ RLPInvalidEncoding()
452
+ );
453
+ return (1, strLength, ItemType.Data);
454
+ } else {
455
+ // Case: Long string (>55 bytes)
456
+ uint256 lengthLength = prefix - SHORT_OFFSET - SHORT_THRESHOLD; // >=1
457
+ require(itemLength > lengthLength, RLPInvalidEncoding());
458
+ bytes32 lenChunk = item.load(1);
459
+ require(bytes1(lenChunk) != 0x00, RLPInvalidEncoding());
460
+
461
+ uint256 len = uint256(lenChunk) >> (256 - 8 * lengthLength);
462
+ require(len > SHORT_THRESHOLD && itemLength - lengthLength > len, RLPInvalidEncoding());
463
+
464
+ return (lengthLength + 1, len, ItemType.Data);
465
+ }
466
+ } else {
467
+ // Case: list
468
+ if (prefix <= LONG_OFFSET + SHORT_THRESHOLD) {
469
+ // Case: Short list
470
+ uint256 listLength = prefix - LONG_OFFSET;
471
+ require(itemLength > listLength, RLPInvalidEncoding());
472
+ return (1, listLength, ItemType.List);
473
+ } else {
474
+ // Case: Long list
475
+ uint256 lengthLength = prefix - LONG_OFFSET - SHORT_THRESHOLD; // >=1
476
+ require(itemLength > lengthLength, RLPInvalidEncoding());
477
+ bytes32 lenChunk = item.load(1);
478
+ require(bytes1(lenChunk) != 0x00, RLPInvalidEncoding());
479
+
480
+ uint256 len = uint256(lenChunk) >> (256 - 8 * lengthLength);
481
+ require(len > SHORT_THRESHOLD && itemLength - lengthLength > len, RLPInvalidEncoding());
482
+
483
+ return (lengthLength + 1, len, ItemType.List);
484
+ }
485
+ }
486
+ }
487
+ }