PERMANENT COLLECTIONProtocol Reference

Events index

Every event the protocol emits, grouped by contract. Signatures and field meanings live on the per-contract pages.

PermanentCollection

AcquisitionRecorded · Emitted once per recordAcquisition.

CustodyUpdated · Emitted on every custody transition: InReturnAuction at record time, then ReturnedToMarket or Vaulted at settle, and InReturnAuction again on a re-acquisition.

Finalized · Emitted exactly once, when setWiring closes the OneTimeSetup gate.

TraitsCollected · Emitted when a bit transitions to permanently collected: exactly one bit per markCustody(punkId, Vaulted), the recorded target.

TraitsPending · Emitted alongside AcquisitionRecorded with the same single-bit pendingBits value, for indexers that key off per-bit pending state.

WiringFinalized · Emitted once at setWiring time with the four wired addresses.

Patron

AllowedSellerAdded · Emitted when the admin adds a new seller to the acceptListing allowlist.

AllowedSellerRemoved · Emitted when the admin removes an allowlisted seller.

BidAccepted · Emitted on every successful acceptBid.

Finalized · Emitted exactly once, when setWiring closes the one-shot setup gate.

ListingAccepted · Emitted on every successful acceptListing.

SurplusForwarded · Emitted when skimSurplus forwards forced/unaccounted ETH back to LiveBidAdapter.

WiringFinalized · Emitted once at setWiring with the permanently-fixed permanentCollection and returnAuctionModule addresses.

ReturnAuctionModule

BidPlaced · Emitted on every accepted bid.

LiveBidAdapterSet · Emitted exactly once, at the deployer's setLiveBidAdapter call.

PunkVaulted · Emitted on the unsold settle path.

RefundQueued · Emitted when an outbid refund couldn't push to the previous bidder within the 30k gas budget.

RefundWithdrawn · Emitted when a bidder pulls a previously queued refund.

ReturnAuctionCleared · Emitted on the cleared settle path with the full proceeds split: liveBidShare (65% of cost, to LiveBidAdapter), burnShare (25% of cost, to BuybackBurner), vaultBurnShare (10% of cost plus the premium remainder, to VaultBurnPool), and referrerShare (paid to referrer, 0 when unattributed or when the send…

ReturnAuctionExtended · Emitted when an anti-snipe extension has moved endsAt further into the future.

ReturnAuctionStarted · Emitted once per startSale.

VaultBurnPoolSet · Emitted exactly once, at the deployer's setVaultBurnPool call.

PunkVault

Approval · Standard ERC721 single-token approval event for Proofs and the Title.

ApprovalForAll · Standard ERC721 operator-approval event.

ContractURIUpdated · ERC-7572 collection-metadata refresh hint.

MetadataUpdate · EIP-4906 per-token metadata refresh hint.

OwnershipTransferred · ERC-173 ownership transition.

ProofMinted · Emitted once per Proof, alongside the ERC721 Transfer from address(0).

PunkLocked · Emitted exactly once per Punk that enters the vault.

RendererRegistrySet · Emitted once, at the one-shot setRendererRegistry wiring.

TitleAuctionSet · Emitted once, at the one-shot setTitleAuction wiring.

TitleMinted · Emitted once, at Title mint time, with the title auction contract as to.

Transfer · Standard ERC721 transfer event for Proofs and the Title, including the mint-time transfers from address(0).

LiveBidAdapter

ActivationThresholdSynced · Emitted when the auto-sync inside sweep() processes a new acceptBid acquisition.

BareTopUp · Emitted on every direct ETH send into receive(): the hook's bid-leg skim, the locker's LP-fee forwards, and unattributed top-ups.

Contribution · Emitted on every contribute() call.

KeeperReward · Emitted when the sweep() caller's reward send succeeds.

KeeperRewardFailed · Emitted when the reward send fails (the caller can't receive ETH).

ParameterChanged · Emitted by the three setters.

PoolReplenished · Emitted when the return-auction module routes a cleared auction's live-bid share into the buffer via poolReplenish.

Swept · Emitted on every non-zero forward, from sweep() and streamForward() alike.

ThresholdCrossed · Emitted exactly when a forward takes Patron's balance from below activationThreshold to at or above it.

BuybackBurner

BurnEthDeposited · Emitted on every ETH inflow through receive().

ExecutionRewardFailed · Emitted when the caller-reward send fails.

ExecutionRewardPaid · Emitted when the caller reward is sent successfully.

Finalized · Emitted exactly once, when setup completes and permanently closes the one-shot wiring gate.

ParameterChanged · Emitted by both setters.

TokensBurned · Emitted on every successful step.

VaultBurnPool

Finalized · Emitted exactly once, by the successful setup call.

SidePoolTaxBurned · Emitted on each sweep that burned a non-zero accrued $111 balance, with the amount burned.

Swept · Emitted on each sweep whose ETH forward to BuybackBurner succeeded, with the amount forwarded.

ProtocolFeePhaseAdapter

ClaimFailed · Emitted when the escrow claim inside sweep reverts, with the escrow address.

Forwarded · Emitted on every successful sweep, with the recipient (the controller, indexed) and the amount forwarded.

ReferralPayout

ReferralClaimed · Emitted on every successful claim/claimFor with the referrer (indexed) and the amount paid out.

ReferralCredited · Emitted on every hook notify credit with the referrer (indexed) and the amount added to their balance.

PunkVaultTitleAuction

Bid · Emitted on every accepted bid.

Extended · Emitted when an anti-snipe extension moved endsAt further into the future, alongside the Bid event that triggered it.

Kickoff · Emitted when the auction clock (re)starts: once from kickoff(), and again from every no-bid settle() restart.

ProceedsQueued · Emitted at a winning settle when 100% of the high bid is credited to payoutRecipient in the pull queue.

ProceedsWithdrawn · Emitted when a queued proceeds credit was successfully pulled via withdrawProceeds.

RefundQueued · Emitted during bid() when the 30,000-gas refund push to the outbid bidder failed and the amount was queued in pendingRefund instead.

RefundWithdrawn · Emitted when a queued refund was successfully pulled via withdrawRefund().

Settled · Emitted on the winning settle path: the Title transferred to winner and highBid was credited to payoutRecipient.

SettledNoBidder · Emitted on the no-bidder settle path.

PCSwapContext

AuthorizedExtensionLocked · Emitted exactly once, on lockAuthorizedExtension.

AuthorizedExtensionSet · Emitted on every setAuthorizedExtension with the new extension (indexed).

OwnershipTransferred · Emitted at construction (from address(0)) and on every transferOwnership.

SwapEntered · Emitted on every enterSwap.

SwapExited · Emitted on every exitSwap, closing the window opened by the matching SwapEntered in the same transaction.

TokenAdminPoker

ExtensionBound · Emitted on every bindExtension with the hook (indexed) and the extension (indexed).

ExtensionLocked · Emitted once, on lockExtension, with the hook (indexed).

MaxReferralBpsSet · Emitted on every setHookMaxReferralBps with the hook (indexed) and the new cap.

OwnershipTransferred · Emitted at construction (from address(0)) and on every transferOwnership.

TokenTaxBpsSet · Emitted on every setTokenTaxBps with the token (indexed) and the new rate in bps.

ProtocolAdmin

AdminBurned · Emitted exactly once, on transferAdmin(address(0)).

AdminTransferred · Emitted at construction (with previousAdmin = address(0)) and on every renewal or rotation.

RendererRegistry

Frozen · Emitted exactly once, when freeze() is called, with the block number.

ImplementationUpdated · Emitted at deployment (with previous == address(0)) and on every successful setImplementation, with the previous and next implementation addresses, both indexed.

PunkSvgFragmentCache

PunkCached · Emitted exactly once per Punk, on its first successful cachePunk, with the Punk id (indexed), the SSTORE2 pointer address (indexed), and the fragment byte length.

TraitIconCache

TraitCached · Emitted exactly once per trait, on its first successful cacheTrait, with the trait id (indexed), the SSTORE2 pointer address (indexed), and the fragment byte length.

Events index · Permanent Collection