NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add missing Calldata, Bytes, CAIP2 and CAIP10 API references (#5428)

Browse Source
This commit is contained in:
Hadrien Croubois
2025-01-10 17:43:28 +01:00
committed by GitHub
parent 2e27a0c74b
commit 13781c1f49
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
contracts/utils/README.adoc
View File

@ -33,8 +33,9 @@ Miscellaneous contracts and libraries containing utility functions you can use t
* {Arrays}: Collection of functions that operate on https://docs.soliditylang.org/en/latest/types.html#arrays[`arrays`]. * {Arrays}: Collection of functions that operate on https://docs.soliditylang.org/en/latest/types.html#arrays[`arrays`].
* {Base64}: On-chain base64 and base64URL encoding according to https://datatracker.ietf.org/doc/html/rfc4648[RFC-4648]. * {Base64}: On-chain base64 and base64URL encoding according to https://datatracker.ietf.org/doc/html/rfc4648[RFC-4648].
* {Bytes}: Common operations on bytes objects. * {Bytes}: Common operations on bytes objects.
* {Calldata}: Helpers for manipulating calldata.
* {Strings}: Common operations for strings formatting. * {Strings}: Common operations for strings formatting.
* {ShortString}: Library to encode (and decode) short strings into (or from) a single bytes32 slot for optimizing costs. Short strings are limited to 31 characters. * {ShortStrings}: Library to encode (and decode) short strings into (or from) a single bytes32 slot for optimizing costs. Short strings are limited to 31 characters.
* {SlotDerivation}: Methods for deriving storage slot from ERC-7201 namespaces as well as from constructions such as mapping and arrays. * {SlotDerivation}: Methods for deriving storage slot from ERC-7201 namespaces as well as from constructions such as mapping and arrays.
* {StorageSlot}: Methods for accessing specific storage slots formatted as common primitive types. * {StorageSlot}: Methods for accessing specific storage slots formatted as common primitive types.
* {TransientSlot}: Primitives for reading from and writing to transient storage (only value types are currently supported). * {TransientSlot}: Primitives for reading from and writing to transient storage (only value types are currently supported).
@ -128,6 +129,10 @@ Ethereum contracts have no native concept of an interface, so applications must
{{Base64}} {{Base64}}
{{Bytes}}
{{Calldata}}
{{Strings}} {{Strings}}
{{ShortStrings}} {{ShortStrings}}
@ -147,3 +152,7 @@ Ethereum contracts have no native concept of an interface, so applications must
{{Panic}} {{Panic}}
{{Comparators}} {{Comparators}}
{{CAIP2}}
{{CAIP10}}