Repository navigation
Redraw the README diagram in Mermaid and refresh the v1 docs - #222
Merged
Merged
Conversation
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>
There was a problem hiding this comment.
🟡 Changes recommended
The README misleadingly suggests zero-fee drops need no fee recipient, although all mint entrypoints require a nonzero address, potentially causing integrations to submit reverting mints.
1 open issue
What changed in this PR
This PR refreshes SeaDrop’s v1 documentation with an editable mint-flow diagram and clearer guidance on deployment and v2 capabilities.
Changes:
- Replaces the README’s PNG diagram with Mermaid and explains configuration, minting, and payouts.
- Links to v2 for ERC-1155 support, ERC-20 payments, and multiple public stages.
- Adds
--broadcastto the deployment example and improves heading structure and drop URI wording.
| File | Description |
|---|---|
| README.md | Adds the Mermaid diagram, mint-flow explanation, and v2 feature reference. |
| docs/SeaDropTokenDeployment.md | Updates the deployment command, heading level, and drop URI description. |
Review effort: Balanced
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 README's diagram was a PNG of ASCII art. It showed
mintAllowListwith a Merkle proof as the second mint path, and it left outmintSigned, the path OpenSea uses for allow lists. The README also said ERC-20 payments were a future idea, though v2 has them.Solution
SeaDrop, a minter payingSeaDrop, andSeaDroppaying out and callingmintSeaDrop(). A short paragraph under it names the functions.img/seadrop-diagram.pngis deleted, and nothing else links to it, opensea-docs included.docs/SeaDropTokenDeployment.md:forge createexample gets--broadcast, which Foundry 1.x needs to send the transaction.docs/Development.md, and the README keeps a three-command quick start that links it. The docs list is unchanged, so this doesn't conflict with Add an agent NFT extension with ERC-8048 onchain metadata #212's new line.Testing
biome ci .passes.🤖 Generated with Claude Code