Skip to content

docs: add missing contract references to README files #6201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eeemmmmmm wants to merge 1 commit into
base: typo-fixes
Choose a base branch
from
+11 −0
Open

docs: add missing contract references to README files #6201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions contracts/finance/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ This directory includes primitives for financial systems:
- {VestingWallet} handles the vesting of Ether and ERC-20 tokens for a given beneficiary. Custody of multiple tokens can
be given to this contract, which will release the token to the beneficiary following a given, customizable, vesting
schedule.
- {VestingWalletCliff} is an extension of {VestingWallet} that adds a cliff to the vesting schedule.

== Contracts

{{VestingWallet}}

{{VestingWalletCliff}}
6 changes: 6 additions & 0 deletions contracts/governance/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Other extensions can customize the behavior or interface in multiple ways.

* {GovernorNoncesKeyed}: An extension of {Governor} with support for keyed nonces in addition to traditional nonces when voting by signature.

* {GovernorSequentialProposalId}: An extension of {Governor} that changes the numbering of proposal ids from the default hash-based approach to sequential ids.

In addition to modules and extensions, the core contract requires a few virtual functions to be implemented to your particular specifications:

* <<Governor-votingDelay-,`votingDelay()`>>: Delay (in ERC-6372 clock) since the proposal is submitted until voting power is fixed and voting starts. This can be used to enforce a delay after a proposal is published for users to buy tokens, or delegate their votes.
Expand Down Expand Up @@ -104,8 +106,12 @@ NOTE: Functions of the `Governor` contract do not include access control. If you

{{GovernorNoncesKeyed}}

{{GovernorSequentialProposalId}}

== Utils

{{IVotes}}

{{Votes}}

{{VotesExtended}}
Expand Down
2 changes: 2 additions & 0 deletions contracts/utils/cryptography/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ A collection of contracts and libraries that implement various signature validat

{{SignerEIP7702}}

{{SignerWebAuthn}}

{{SignerERC7913}}

{{MultiSignerERC7913}}
Expand Down
Loading