List every contract in each API doc section #4848
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Amxx
reviewed
Jan 22, 2024
Amxx
reviewed
Jan 22, 2024
Amxx
reviewed
Jan 22, 2024
Amxx
reviewed
Jan 22, 2024
contracts/utils/README.adoc
Outdated
Comment on lines
8
to
32
| * {Math}, {SignedMath}: Implementation of various arithmetic functions. | ||
| * {SafeCast}: Checked downcasting functions to avoid silent truncation. | ||
| * {ECDSA}, {MessageHashUtils}: Libraries for interacting with ECDSA signatures. | ||
| * {SignatureChecker}: A library helper to support regular ECDSA from EOAs as well as ERC-1271 signatures for smart contracts. | ||
| * {MerkleProof}: Functions for verifying https://en.wikipedia.org/wiki/Merkle_tree[Merkle Tree] proofs. | ||
| * {EIP712}: Contract with functions to allow processing signed typed structure data according to https://eips.ethereum.org/EIPS/eip-712[EIP-712]. | ||
| * {ReentrancyGuard}: A modifier that can prevent reentrancy during certain functions. | ||
| * {Pausable}: A common emergency response mechanism that can pause functionality while a remediation is pending. | ||
| * {SafeCast}: Checked downcasting functions to avoid silent truncation. | ||
| * {Math}, {SignedMath}: Implementation of various arithmetic functions. | ||
| * {Multicall}: Simple way to batch together multiple calls in a single external call. | ||
| * {Create2}: Wrapper around the https://blog.openzeppelin.com/getting-the-most-out-of-create2/[`CREATE2` EVM opcode] for safe use without having to deal with low-level assembly. | ||
| * {Nonces}: Utility for tracking and verifying address nonces that only increment. | ||
| * {ERC165, ERC165Checker}: Utilities for inspecting interfaces supported by contracts. | ||
| * {BitMaps}: A simple library to manage boolean value mapped to a numerical index in an efficient way. | ||
| * {EnumerableMap}: A type like Solidity's https://solidity.readthedocs.io/en/latest/types.html#mapping-types[`mapping`], but with key-value _enumeration_: this will let you know how many entries a mapping has, and iterate over them (which is not possible with `mapping`). | ||
| * {EnumerableSet}: Like {EnumerableMap}, but for https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets]. Can be used to store privileged accounts, issued IDs, etc. | ||
| * {DoubleEndedQueue}: An implementation of a queue (or https://en.wikipedia.org/wiki/Double-ended_queue[dequeue]) whose values can be removed added or remove from both sides. Useful for FIFO and LIFO queues. | ||
| * {Checkpoints}: A data structure to store values mapped to an strictly increasing key. Can be used for storing and accessing values over time. | ||
| * {Multicall}: Simple way to batch together multiple calls in a single external call. | ||
| * {Create2}: Wrapper around the https://blog.openzeppelin.com/getting-the-most-out-of-create2/[`CREATE2` EVM opcode] for safe use without having to deal with low-level assembly. | ||
| * {Address}: Collection of functions for overloading Solidity's https://docs.soliditylang.org/en/latest/types.html#address[`address`] type. | ||
| * {Arrays}: Similar to {Address} but for overloading 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]. | ||
| * {Strings}: Common operations for strings parsing. | ||
| * {ShortString}: Library to convert short strings (less than 31-bytes long) into a single bytes32 slot for optimizing costs. | ||
| * {StorageSlot}: Methods for accessing specific storage slots formatted as common primitive types. | ||
| * {Multicall}: Abstract contract with an utility to allow batching together multiple calls in a single transaction. Useful for allowing EOAs to perform multiple operations at once. | ||
| * {Context}: An utility for abstracting the sender and calldata in the current execution context. |
There was a problem hiding this comment.
Any reason for the ordering ? Doesn't feel consistent.
There was a problem hiding this comment.
The only reason was to match the order they're in the page. It was just easier to track what's missing if they all have the same order.
Amxx
reviewed
Jan 22, 2024
Amxx
reviewed
Jan 22, 2024
Amxx
reviewed
Jan 22, 2024
Amxx
reviewed
Jan 22, 2024
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Co-authored-by: Ernesto García <ernestognw@gmail.com>
Amxx
approved these changes
Jan 23, 2024
ernestognw
added a commit
that referenced
this pull request
Jan 23, 2024
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes sure to list the every contract in each API page introduction. Some notable examples we don't list are GovernorTimelockAccess and several utilities
Fixes LIB-1146
PR Checklist
npx changeset add)