Token Integration Points
Status: foreclosed as of v3.2 — the slots below were removed from the
contracts. The v3.2 redesign deleted the module slots, their setters, and
the role registry that gated them: the marketplace has a single fixed keeper,
no role granting, and every network deploys unsealed under a single admin whose
only powers are instant upgrades, keeper replacement and its own rotation or
renunciation — sealing (renounceAdmin()) is a later, explicit per-network step.
Any future token architecture would ship as a new contract generation, not by
wiring these slots. This page is retained as that future generation’s design
record.
Where the hooks live
| Hook | Location | Set by | Purpose when a native token ships |
|---|---|---|---|
setTokenAddress(address) |
MarketplaceManager.sol |
DEFAULT_ADMIN_ROLE |
Registers the marketplace token. Single discovery point for every other module and for the backend indexer. |
setFeeDistributor(address) |
MarketplaceManager.sol |
DEFAULT_ADMIN_ROLE |
Token-based fee rebates. The core 2 % fee is immutable (1.5 % to feeRecipient, 0.5 % to the keeper); a FeeDistributor would sit behind that address (deploy the distributor, point feeRecipient of the next core version at it, or have the fee wallet forward). FEE_MANAGER_ROLE is pre-defined for its operators. |
setStakingModule(address) |
MarketplaceManager.sol |
DEFAULT_ADMIN_ROLE |
Token utility (e.g. staked-tier perks). Reads manager.token(); cores stay untouched. |
setGovernanceModule(address) |
MarketplaceManager.sol |
DEFAULT_ADMIN_ROLE |
On-chain governance. Recommended end-state: transfer DEFAULT_ADMIN_ROLE to this module (or a timelock in front of it). |
Invariants any future token module MUST respect
- Cores are immutable. Token features integrate by reading the manager registry, never by modifying Marketplace/AuctionHouse/OfferBook. New behavior requiring core changes = new core version +
setCoreContractsre-point. - Exits stay unstoppable. No module may sit between a user and
settle/refundLosers/withdrawRefund/rejectOffer/refundExpiredOffer/cancel*. - The 2 % fee is fixed. Rebates are paid from collected fees by the FeeDistributor, never by changing
PLATFORM_FEE_BPS. - The manager holds no funds (no payable surface — enforced by test
test_managerHoldsNoFundsPath).
Off-chain integration points
MANAGER_ADDRis exported by both deploy scripts; add tobackend/.envwhen the backend needs role introspection (e.g. checkinghasRole(KEEPER_ROLE, addr)). There is no pause state to surface — nothing on the protocol is pausable.- Indexer:
ModuleSet/AuditLogevents are uniform and indexed — extendcoreTopics()inbackend/internal/indexer/abis.gowhen token modules ship.