Rewrite README as contract usage guide#21
Merged
Conversation
Replaces the brief staking-first README with a structured usage guide organized around four top-level sections: Marketplace, Token Contracts, Infra Contracts, and Deprecated. Adds a quick-reference table and TOC, documents what each contract is for, how the Bazaar delegate-splits across SuperRareMarketplace / SuperRareAuctionHouse, the BatchOffer flow, the SovereignBatchMint vs LazySovereignBatchMint distinction (EIP-2309 visibility), and the deprecated-but-wired contracts whose addresses remain as init params on active contracts. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
… claim Audit revealed the README's "wired but inert" framing was wrong for staking and space operators — the active payout/minting paths still call into them. The deprecation is at the data layer (zeroed staking amounts, empty space-operator registry), not at the call-graph layer. Rewrote those entries to list the specific functions that still fire and explain why they're no-ops. Also dropped the per-contract primary-sale-fee claim on MarketplaceSettings — V3's `getERC721ContractPrimarySaleFeePercentage` ignores the address argument and always returns the protocol-wide default. Per-contract overrides were a V1 feature that was removed. Tightened the LazySovereignBatchMint comparison table cell on third-party marketplace listability per reviewer feedback. Co-Authored-By: Claude Opus 4.7 <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
1 participant
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.
Summary
Replaces the brief, staking-led README with a structured contract usage guide so a new dev (or auditor) can land here and quickly figure out what each contract is for, what it pairs with, and what's deprecated.
The new README is organized into four top-level sections:
SuperRareBazaar(with theSuperRareMarketplace/SuperRareAuctionHousedelegate-split explained),RareBatchListingMarketplace,RareBatchAuctionHouse,BatchOffer, andRareMinter.LazySovereignNFT,SovereignBatchMint,LazySovereignBatchMint, factories, royalty extensions, and a comparison subsection clarifying thatSovereignBatchMintemits EIP-2309 (so external indexers see the batch immediately) whileLazySovereignBatchMintemits only a custom event (visible only to indexers that watch our contracts specifically).MarketplaceSettings(incl. why V1/V2/V3 all exist),ApprovedTokenRegistry,Payments(DoS-resistant pull-payment fallback),MarketConfig/MarketUtils.RareCollectionMarket), and the registries that are still wired into active contracts but no longer functionally consulted (royalty registry replaced by the royalty engine, space operator registry zeroed out, etc.).Also includes a quick-reference table (use case → contract) and a TOC. Every claim was cross-checked against contract source via per-contract verification passes; corrections were applied where the initial draft had wrong function signatures (
prepareMintparameter order,batchMintsemantics) or stale claims (e.g.,convertOfferToAuctionis deprecated; the marketplace contracts only seeMarketplaceSettingsV3, which itself chains backward).Test plan
LazySovereignBatchMintflow → batch contracts) to confirm anchors aren't broken🤖 Generated with Claude Code