v1 state

KindFixed

// one price, open to every wallet

KindAllowlist

// only addresses under a Merkle root, each with its own allowance

KindHolder

// one mint per token held in another collection

KindDutch

// the price falls in a straight line until the stage ends

maxPrimaryFeeBPS

// 5% of a mint price

maxStages

maxStageSeconds

maxPerWallet

stage

stage is one mint window of a collection, open during \[Start, End).

stages

// collection ID -> \[]stage, at most maxStages

minted

// "\<collection>/\<stage>/\<address>" -> int64

gated

// "\<collection>/\<stage>/\<gate token number>" -> true

directCaller

CreateCollection

CreateCollection registers the caller's collection in the NFT ledger and pays the collection fee to the treasury. maxFee is the highest fee the caller accepts: a fee above it aborts before anything is taken, whatever the caller's allowance. Native coins are attached for exactly the fee; a token is pulled for exactly the fee. The collection terms are documented on nft.Create.

stagesOf

requireCreator

requireCreator aborts unless the caller is the collection's creator. The creator may be a realm, a DAO for instance: what it signs here moves no funds. Coins attached to a user's call would stay in this realm, so they are refused; coins a realm's transaction carries belong to that realm.

emitStage

emitStage publishes every term of a stage, so a reader of events alone knows what each stage sells.

validRoot

newStage

newStage validates a stage of collection id that has not started. Fields a kind does not use must be zero, so a stage reads the same to everyone. A holder stage is gated on another collection, and only on the tokens that collection had minted when the stage was placed: gated on its own, or on a collection gated on it in turn, every token minted would open one more mint.

place

place writes s at index (len(list) appends) after checking that the caller is the collection's creator, the mint lane accepts the currency, the protocol fee is within what the creator accepts and no other stage overlaps. The fee is pinned on the stage: a later change does not reach it.

AddStage

AddStage schedules a mint window and returns its index. The arguments are the terms of the stage, then the highest protocol fee the creator accepts. A collection has ten stages for its whole life: a stage that ended keeps its slot.

EditStage

EditStage replaces a stage that has not started. Once a stage has opened its terms are final, whatever the replacement would have been: it can only be ended.

EndStage

EndStage closes an open stage at once and for good. It asks no lane: a creator stops its own sale whatever is paused.

priceAt

priceAt is the stage price at a time inside its window.

stageKey

AllowlistLeaf

AllowlistLeaf is the Merkle leaf that lets who mint up to allowance tokens in one stage: sha256(0x00 || "launchpad-drop-v1|\<collection>|\<stage>|\<address>|\<allowance>"). Only the chain's spelling of an address makes a leaf: a list written in capitals would name accounts that can never claim.

entitled

entitled checks what the stage's kind requires of the buyer and returns how many tokens that wallet may mint in the stage. For a holder stage it also returns the key under which the gate token must be recorded as used.

Mint

Mint sells the caller one token of an open stage and returns its number. currencyKey and offered are what the caller accepts to pay: the stage must be priced in that currency, and offered is the most it will take. Native coins are attached for exactly offered and the difference with the price comes back, which is what makes a falling price payable; a token is pulled for exactly the price. The price is split between the treasury (the fee pinned on the stage) and the creator. allowance and proof are for an allowlist stage, gateNumber for a holder stage; elsewhere they are zero and empty.

Render

terms

terms is what this realm needs from config.

termsOf

termsOf reads the terms in force. The collection fee is -1 for a currency that has none.

policy

policy returns the terms in force after checking that the lane is open for the currency. It is a variable only so that unit tests can stand in for the config realm, whose admin cannot be set from another package's tests.

balance

balance reads one denomination, so coins of other denominations sent to the realm never add to the cost of a payment.

take

take collects price from the direct caller and returns what the realm held before. Native coins come attached: the caller attaches exactly offered, at least the price, and the difference goes straight back. A token is pulled for exactly the price.

pay

settled

settled aborts the transaction unless everything taken has been paid out: the realm must hold exactly what it held before the call.

num

StagesJSON

StagesJSON lists a collection's stages in index order. "currentPrice" is the price a mint would pay now, and is only meaningful while "open" is true.

MintedBy

MintedBy is how many tokens who has minted in a stage. Only the chain's spelling of an address is an account: any other is refused, never read as 0.

GateUsed

GateUsed reports whether a gate token has already paid for a mint in a holder stage.

TermsJSON

TermsJSON is what creating a collection and scheduling a stage cost now: the collection fee in a currency and the protocol fee a new stage would pin. A value of -1 means the lane is closed; config's ActionStatusJSON tells whether a lane accepts new actions right now.