Collectibles V3 pack engine function reference

Computes the double-hashed leaf binding chain, engine, phase, payer, allowance and individual price. Proofs and wallet limits apply to the paying wallet, including gifts.

関数と論理を示した

allowlistLeaf(bytes32 phaseId, address wallet, uint256 allowance, uint256 price)

返品・支払い

bytes32

Returns remaining backed pack issuance capacity, or direct-item saleAvailable for content IDs. Does not apply phase timing, phase/wallet caps, allowlist proof or provider availability; use quote for purchase validation.

関数と論理を示した

availableForSale(uint256 id)

返品・支払い

uint256 available

The paired ERC-1155 collection address. Its owner controls this engine; its balances hold both cards and sealed packs.

関数と論理を示した

collection()

返品・支払い

address

The immutable factory that created this implementation and initialized its clones.

関数と論理を示した

factory()

返品・支払い

address

Returns opener, pack ID, request nonce, fixed seed, state and selected IDs. States: 0 None, 1 Requested, 2 Seeded, 3 Allocated, 4 Opened. Repeated IDs represent duplicate copies.

関数と論理を示した

getOpening(bytes32 requestId)

返品・支払い

(address opener, uint256 packId, uint256 nonce, uint256 seed, uint8 state, uint256[] tokenIds)

Returns cap, lifetime issued, opening deadline, transferability, duplicate policy, existence and slot pools. V3 openingStartsAt is a separate getter.

関数と論理を示した

getPack(uint256 id)

返品・支払い

(uint256 maxSupply, uint256 issued, uint64 openingDeadline, bool transferable, bool duplicatesAllowed, bool exists, uint256[] slotPools)

Returns sale configuration, cumulative minted units, configuration version, existence and permanent closure. Its packId field can identify a sealed pack or a directly sold collectible.

関数と論理を示した

getPhase(bytes32 phaseId)

返品・支払い

((uint256 packId, uint64 startsAt, uint64 endsAt, uint256 unitPrice, uint256 supplyCap, uint256 walletCap, bytes32 allowlistRoot, address payoutRecipient, bool paused) config, uint256 minted, uint256 version, bool exists, bool closed)

Returns the draw model, remaining contents, committed contents, token entries and existence flag. Remaining weights describe the next draw, not a whole-pack probability.

関数と論理を示した

getPool(uint256 id)

返品・支払い

uint8 model, uint256 remaining, uint256 committed, (uint256 tokenId, uint128 remaining, uint64 weight)[] entries, bool exists

Returns the immutable factory that validates public-mint fee authorizations. It does not have owner or withdrawal powers.

関数と論理を示した

mintFeeAuthority()

返品・支払い

address

Payer-specific successful purchase nonce. A request must use its current value; another payer purchasing does not change it.

関数と論理を示した

mintNonce(address)

返品・支払い

uint256

Cumulative units bought by a paying wallet in a phase, including gifts sent to other recipients.

関数と論理を示した

mintedByWallet(bytes32, address)

返品・支払い

uint256

The next sequence number eligible for allocation. An earlier request without a seed blocks later allocation.

関数と論理を示した

nextAllocationNonce()

返品・支払い

uint256

The next request sequence number. Requests are ordered globally within this engine, across pack types.

関数と論理を示した

nextOpeningNonce()

返品・支払い

uint256

Looks up a request ID by its engine sequence number.

関数と論理を示した

openingAt(uint256)

返品・支払い

bytes32

V3: earliest Unix-seconds time a pack can request opening. Zero means immediate. Does not change a request already made.

関数と論理を示した

openingStartsAt(uint256)

返品・支払い

uint64

Validates a proposed mint against current phase, version, supply, payer nonce and wallet rules and returns artwork unit and total prices. Another payer minting does not change this payer’s nonce. Does not include the platform fee or gas, reserve inventory, validate fee authorization, or guarantee a receiving contract accepts payment.

関数と論理を示した

quote((bytes32 phaseId, uint256 quantity, uint256 expectedVersion, uint256 nonce, uint256 maxUnitPrice, address recipient, uint256 allowance, uint256 allowlistPrice) request, address payer, bytes32[] proof)

返品・支払い

uint256 price, uint256 totalPrice

The immutable provider adapter used by this engine or factory. Changing Aurora configuration cannot replace it for existing engines.

関数と論理を示した

randomnessProvider()

返品・支払い

address

The permanent pool ID assigned to a content token. Releasing inventory does not clear this assignment; organizational sets are separate.

関数と論理を示した

tokenPool(uint256)

返品・支払い

uint256

Allocates the next Seeded request in FIFO order from remaining pool inventory, records exact contents and advances the allocation queue. Cannot choose a seed or recipient. Useful if an opener receiver rejects delivery.

関数と論理を示した

allocate(bytes32 requestId)

返品・支払い

No return value

V3: allocates the next Seeded request and delivers to the opener-chosen recipient in one transaction. Failed delivery rolls back allocation too, preserving the seed and request for retry or separate allocate/deliver.

関数と論理を示した

allocateAndDeliver(bytes32 requestId, address recipient)

返品・支払い

No return value

Purchases 1–20 sealed packs or directly sold items, as selected by the phase. Exact native payment equals sale price plus signed platform fee. The recipient receives tokens; payer allowance and nonce are consumed. Failed payout or receiver callbacks revert the purchase.

関数と論理を示した

buyPack((bytes32 phaseId, uint256 quantity, uint256 expectedVersion, uint256 nonce, uint256 maxUnitPrice, address recipient, uint256 allowance, uint256 allowlistPrice) request, bytes32[] proof, uint256 fee, bytes authorization)

返品・支払い

No return value · PAYABLE

Permanently closes one sale and increments its version. Does not cancel issued packs or close the entire collection.

関数と論理を示した

closePhase(bytes32 phaseId)

返品・支払い

No return value

Creates a sealed wrapper with 1–20 pool slots, positive lifetime issuance cap, transferability and optional Unix-seconds opening deadline. Duplicate-free packs require distinct pools. Boxes use card slots, not nested packs.

関数と論理を示した

configurePack(uint256 packId, string tokenURI, uint256 maxSupply, bool transferable, uint64 openingDeadline, bool duplicatesAllowed, uint256[] slotPools)

返品・支払い

No return value

Creates or edits a sale for a configured pack or direct item. Cannot change the token ID of an existing phase or reopen a closed phase. Requires a nonzero direct payout recipient; version increments invalidate old quotes.

関数と論理を示した

configurePhase(bytes32 phaseId, (uint256 packId, uint64 startsAt, uint64 endsAt, uint256 unitPrice, uint256 supplyCap, uint256 walletCap, bytes32 allowlistRoot, address payoutRecipient, bool paused) config)

返品・支払い

No return value

Creates an immutable pool with 1–128 entries. Model 0 draws among remaining copies; model 1 uses fixed positive weights for nonempty entries. Quantities fit uint128; weighted values fit uint64. Each token ID may belong to only one on-chain pool.

関数と論理を示した

configurePool(uint256 poolId, uint8 model, uint256[] tokenIds, uint256[] quantities, uint256[] weights)

返品・支払い

No return value

Delivers an Allocated opening to the original opener chosen nonzero recipient. Burns the wrapper only on successful delivery. Retry with the same contents or a compatible recipient after receiver failure.

関数と論理を示した

deliver(bytes32 requestId, address recipient)

返品・支払い

No return value

V3: extends an existing deadline or clears it with zero. Cannot shorten it or add expiry where none exists. Zero permanently removes the deadline.

関数と論理を示した

extendOpeningDeadline(uint256 id, uint64 next)

返品・支払い

No return value

Saves the provider result only for a Requested opening. Zero is a valid seed. Does not allocate inventory or invoke token receivers.

関数と論理を示した

fulfillRandomness(bytes32 requestId, uint256 seed)

返品・支払い

No return value

Binds the clone to its collection or engine during factory deployment. A second initialization or direct implementation initialization is rejected.

関数と論理を示した

initialize(address collection_)

返品・支払い

No return value

Issues 1–20 backed packs to a recipient, reserves pool contents and provider capacity, and mints sealed wrappers. Pack caps and expiry apply; no sale payment is collected.

関数と論理を示した

issuePack(uint256 packId, uint256 quantity, address recipient)

返品・支払い

No return value

Releases only uncommitted surplus while no opening awaits allocation. retire=true permanently removes capacity; false makes it available for direct minting. Pool membership and commitments remain protected.

関数と論理を示した

releasePool(uint256 poolId, uint256 entryIndex, uint256 quantity, bool retire)

返品・支払い

No return value

Locks one held pack, records a permanent request in FIFO order and requests randomness from the fixed provider. Send the provider-required fee. Opening start/deadline rules apply. There is no cancel or reroll.

関数と論理を示した

requestOpen(uint256 packId)

返品・支払い

bytes32 requestId · PAYABLE

V3: changes or clears the opening start before issued packs have gained opening access. Once issued packs can open, they cannot be locked again. A configured deadline must remain later than the start.

関数と論理を示した

setOpeningStartsAt(uint256 id, uint64 next)

返品・支払い

No return value