Repository navigation
v2: Add a Mermaid diagram and bring the token docs up to date - #223
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟡 Changes recommended
The guide needs to distinguish ERC-1155’s irreversible lock once a nonzero provenance hash is stored from ERC-721’s first-mint restriction.
1 open issue
What changed in this PR
Updates the SeaDrop documentation for v2, covering both token standards and explaining how configuration and minting work through Seaport.
Changes:
- Adds a Mermaid diagram showing configuration, minting, payments, and implementation delegation.
- Refreshes deployment guidance with v2 scripts, constructor arguments, configuration methods, and
multiConfigure. - Adds ERC-1155 inheritance guidance and clarifies that ERC721A applies to ERC-721.
| File | Description |
|---|---|
| README.md | Adds the v2 architecture and mint-flow diagram. |
| docs/SeaDropTokenDeployment.md | Updates deployment and configuration instructions for both token standards. |
| docs/BringYourOwnTokenContract.md | Includes ERC-1155 inheritance and scopes ERC721A guidance to ERC-721. |
Review effort: Balanced
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or 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
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.

Motivation
The v2 README had no diagram.
docs/SeaDropTokenDeployment.mdwas a copy of v1's: it linked a script that doesn't exist on this branch (DeployAndConfigureExampleToken.s.sol), it gave v1's constructor and v1-only calls (updateSignedMintValidationParams,setDropURI), and it didn't mention ERC-1155 or the configurer.Solution
CONTRACTorder on Seaport,generateOrdermints to the minter, Seaport pays the fee recipient and the creator payouts, andratifyOrdercloses the call. It also shows that the configurer is the token's implementation, which the token delegatecalls, and notes that open collections only use owner mints.docs/SeaDropTokenDeployment.mdnow matches v2, at about the same length:DeployAndConfigure721ExampleToken.s.solandDeployAndConfigure1155ExampleToken.s.sol.(allowedConfigurer, allowedSeaport, name, symbol).updateCreatorPayouts,updateAllowedFeeRecipient,updateSigner,updatePayer,updatePublicDropwith an index for ERC-1155, andupdateDropURI.multiConfigure. The drop URI format is unchanged.docs/BringYourOwnTokenContract.mdmentionsERC1155SeaDropalongsideERC721SeaDrop.img/seadrop-diagram.png, which no v2 doc referenced.docs/Development.md. The README keeps a quick start that links it, and the docs list now includes it.Testing
biome ci .passes.v2:updateAllowList,updatePayer,updateSigner,setProvenanceHash,setMaxSupply(tokenId, …),multiConfigureandmintRecipient.🤖 Generated with Claude Code