Glossary and Name Mapping
This glossary standardizes naming across product, docs, and API usage.
Core Entity Terms
| Use in product/docs | Canonical API term | Where in schema |
|---|---|---|
| Series | Collection | Collection type |
| Release (human language) | Artwork | Artwork type |
| NFT / token / edition | Edition | Edition type |
| Primary sale | PrimaryMarketListing | Artwork.primaryMarketListing |
| Secondary listing | SecondaryMarketListing | Edition.smListing / marketplace queries |
Release Model Terms
| Use in product/docs | API representation | Notes |
|---|---|---|
| Generative | GenerativeProjectArtworkKind | On Artwork.artworkKind |
| Artist Curated | ProjectArtworkKind | Curated item set with optional user selection |
| Collector Curated | Generative + bookmark purchase input | Uses Elements createBookmark() and $user_hash |
| Edition | Artwork + strategy-driven listing | Sale behavior comes from strategy type |
| Unique 1/1 | Artwork + strategy-driven listing | Usually single edition supply |
Sale Mechanic Terms
| Use in product/docs | Canonical API term |
|---|---|
| Limited Edition | PMBuyNowLimitedEditionStrategy |
| Open Edition | PMBuyNowOpenEditionStrategy |
| Auction / 1:1 Auction | PMAuctionStrategy |
| Ranked Auction | PMAuctionStrategy + RankedAuctionSettings |
| Dutch Auction | DutchAuctionSettings on buy-now strategies |
| Decreasing Supply | DecreasingSupplySettings on limited edition strategy |
Access and Eligibility Terms
| Use in product/docs | API / SDK term | Notes |
|---|---|---|
| Reserve List | checkReserves() | Elements authenticated check for reserve gating |
| Mint Pass | mintPassConfiguration(pmListingId) | Query-level configuration for pass-gated access |
| User can choose curated item | allowUserSelection | If true, pass $curated_project:item_id in purchase payload |
| User-saved generative output | $user_hash | Value comes from createBookmark().signedToken |
Contract Terms
| Use in product/docs | API field/enum | Notes |
|---|---|---|
| Standard Verse contract | ContractType values like ERC_721, ERC_721v3 | Product versioning may vary by deployment generation |
| On-chain contract | ERC_721v3_ON_CHAIN | Media + metadata stored on chain |
| Custom contract integration | ERC_721v3_CUSTOM_v1 | Bring-your-own contract with Verse minting manager permissions |
| External platform integration | ARTBLOCKS, TEZOS_FXHASH, TEZOS_OBJKT | Indexed/surfaced alongside Verse-native data |
Naming Conventions For Integrations
- Use business labels in UI, but enforce branching with API type checks.
- Keep internal constants aligned to schema names (for example
PMAuctionStrategy). - For any curated flow, treat payload keys (
$curated_project:item_id,$user_hash) as required protocol inputs. - Recheck this glossary when schema changes to avoid drift between product copy and integration logic.