Skip to content

v2: Add a Mermaid diagram and bring the token docs up to date - #223

Merged
ryanio merged 6 commits into
v2from
ryan/v2/docs-diagram
Nov 9, 2026
Merged

ryanio merged 6 commits into
v2from
ryan/v2/docs-diagram

Conversation

@ryanio

@ryanio ryanio commented Nov 9, 2026 •

Copy link
Copy Markdown
Collaborator

Motivation

The v2 README had no diagram. docs/SeaDropTokenDeployment.md was 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

  • The README gets a Mermaid diagram with a short paragraph. It shows how the creator configures the token, directly or through the configurer, and how a mint works: the minter fills a CONTRACT order on Seaport, generateOrder mints to the minter, Seaport pays the fee recipient and the creator payouts, and ratifyOrder closes 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.md now matches v2, at about the same length:
    • It links both example scripts, DeployAndConfigure721ExampleToken.s.sol and DeployAndConfigure1155ExampleToken.s.sol.
    • It gives the constructor (allowedConfigurer, allowedSeaport, name, symbol).
    • It lists the v2 calls: updateCreatorPayouts, updateAllowedFeeRecipient, updateSigner, updatePayer, updatePublicDrop with an index for ERC-1155, and updateDropURI.
    • It covers the configurer's multiConfigure. The drop URI format is unchanged.
  • docs/BringYourOwnTokenContract.md mentions ERC1155SeaDrop alongside ERC721SeaDrop.
  • It removes the unused img/seadrop-diagram.png, which no v2 doc referenced.
  • The README is shorter, 96 lines. It drops the table of contents and rewrites Background as one paragraph covering ERC-721 and ERC-1155, ETH and ERC-20, and the Seaport mint flow. Install, the Seaport build, the commands and the pull request checklist move to a new docs/Development.md. The README keeps a quick start that links it, and the docs list now includes it.

Testing

  • I checked the rendered README on this branch on GitHub, and the diagram renders.
  • biome ci . passes.
  • The functions the docs name exist on v2: updateAllowList, updatePayer, updateSigner, setProvenanceHash, setMaxSupply(tokenId, …), multiConfigure and mintRecipient.

🤖 Generated with Claude Code

ryanio and others added 2 commits November 8, 2026 22:19
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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

Comment thread docs/SeaDropTokenDeployment.md Resolved

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The README diagram incorrectly shows a separate implementation contract as the delegatecall target instead of the configurer, which also serves as the implementation.

1 open issue
1 resolved since last review

Review effort: Balanced

Comment thread README.md Resolved
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ryanio
ryanio merged commit 125288d into v2 Nov 9, 2026
5 checks passed
@ryanio
ryanio deleted the ryan/v2/docs-diagram branch November 9, 2026 06:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants