core source realm

Package core is the platform's immutable ledger (design §2.5.2): every collection, its official grc721 token and roya...

Package core is the platform's immutable ledger (design §2.5.2): every collection, its official grc721 token and royalty, its provenance (commit–reveal v2), the engine registry, fees and the admin timelock.

What core guarantees, whoever holds the admin key:

I-1 admin cannot move, approve or burn a token, and holds no funds; the op list is a closed set of parameters (admin.gno).
I-2 pause only gates create, mint and trade. Transfer, burn, finalize, distribute and every cancel stay open, and a pause expires by itself after MaxPauseBlocks.
I-5 supply only grows through the collection's bound minter, never past maxSupply, and a token id is never minted twice.
I-6 after Launch the engine, params, supply, payees, sale window and commitments are frozen.
I-10/11 a collection becomes Final at most once, only with both reveals or after revealDeadline, and that deadline is bounded, so the pre-reveal transfer lock always ends.
I-12 engine code never runs on a state-changing path, except the creator's own CreateCollection (ValidateParams) and the engine's own RegisterEngine (one sample render). Every exported non-crossing function is read-only, so an engine cannot call back into a mutator.
I-13 every stored string passed safe.AssertText.

core imports no mutable realm: minters and engines are known only by package path and interface value.

 1const (
 2	OpFeeCreate       = "fee.create"       // ugnot, <= CreateFeeCap
 3	OpFeePrimary      = "fee.primary"      // bps, <= ProtocolFeeCapBps
 4	OpFeeSecondary    = "fee.secondary"    // bps, <= ProtocolFeeCapBps
 5	OpTreasury        = "treasury"         // address
 6	OpBeacon          = "beacon"           // address, or "" to disable new beacon launches
 7	OpMinterAdd       = "minter.add"       // realm pkgpath
 8	OpMinterDeprecate = "minter.deprecate" // realm pkgpath: no new collections
 9	OpEngineReview    = "engine.review"    // engine id: reviewed badge (UI only)
10	OpAdminTransfer   = "admin.transfer"   // address; the new admin must AcceptAdmin
11)

source

Ops and their argument formats.

 1const (
 2	ProtocolFeeCapBps = 500           // 5% of any sale
 3	RoyaltyCapBps     = 1000          // 10% (RA M-3)
 4	CreateFeeCap      = 1_000_000_000 // 1,000 GNOT in ugnot
 5	MaxPayees         = 4
 6	MaxSupplyCap      = 10_000
 7	MaxMintPerTx      = 10      // hypothesis: measure n=10 gas/deposit on Onyx
 8	MaxReserveBps     = 1000    // creator reserve <= 10% of supply
 9	MaxSaleBlocks     = 732_000 // ~30 days
10	RevealWindowMin   = 1_017   // ~1 hour
11	RevealWindowMax   = 170_000 // ~7 days
12	BeaconGraceBlocks = 254     // beacon may reveal first in the window's last ~15 min (< RevealWindowMin, so the creator always gets to go first)
13	TimelockBlocks    = 48_800  // ~48 hours
14	MaxPauseBlocks    = 195_000 // ~8 days
15
16	MaxNameLen        = 64
17	MaxDescriptionLen = 1024
18	MaxParamsLen      = 1024
19	MinSecretLen      = 32
20	MaxSecretLen      = 256
21	MaxPageSize       = 50
22)

source

Hard limits. They are constants on purpose: nobody, admin included, can raise them after deploy (block counts assume ~3.54 s blocks, RA M-1).

1const (
2	BadgeBoth        = "2/2"
3	BadgeCreatorOnly = "creator-only"
4	BadgeBeaconOnly  = "beacon-only"
5	BadgeFallback    = "fallback"
6)

source

Provenance badges (design §4.3).

1func AbortLaunch(cur realm, cid string)

source

AbortLaunch returns a launched collection to Draft while nothing has been minted — the way out when a beacon never commits. Used commitments stay used.

1func AcceptAdmin(cur realm)

source

1func AcceptCreator(cur realm, cid string)

source

1func Approve(cur realm, cid, tid string, to address)

source

1func BalanceOf(cid string, owner address) (int64, error)

source

1func BeaconCommit(cur realm, cid, commitHex string)

source

BeaconCommit is the beacon's commitment, before any token exists.

1func Burn(cur realm, cid, tid string)

source

Burn is owner-only. The supply gate uses nextTID, so a burn never reopens a slot (I-5).

1func CancelOp(cur realm, opID string)

source

1func ClaimEngine(cur realm, id string)

source

ClaimEngine proves the manifest author controls that address. Unclaimed engines cannot back a collection.

1func CloseMint(cur realm, cid string)

source

CloseMint materializes Closed once the sale window has passed. Anyone may call it; reveals and Finalize work without it.

1func Collection(cid string) string

source

Collection is the collection record as JSON.

1func CollectionCount() int64

source

1func Collections(offset, limit int64) string

source

1func CollectionsByCreator(creator address, offset, limit int64) string

source

1func CreateCollection(cur realm, creator address, spec types.CollectionSpec) string

source

CreateCollection stores a Draft collection and returns its id. Nobody can mint a Draft, so a creator can configure phases across several messages without a race (OA B2).

1func DeprecateEngine(cur realm, id string)

source

DeprecateEngine stops new collections; existing ones keep rendering.

1func DistributeRoyalties(cur realm, cid string) int64

source

DistributeRoyalties pushes the whole sub-treasury balance to the royalty payees. Permissionless and never paused (I-2); market/v1 calls it after every sale. Returns the amount distributed. The sub-realm banker spend is verified by spike/subtoken, core and market tests on gno v1.7.0.

1func Engine(id string) string

source

Engine is the record as JSON.

1func EngineManifest(id string) engine.Manifest

source

EngineManifest is the typed read for other realms (gallery).

1func EngineStatus(id string) string

source

EngineStatus is "unclaimed", "unverified", "reviewed" or "deprecated".

1func EngineTraits(id, params, seed string) []engine.Trait

source

EngineTraits returns a core-owned copy of the engine's traits for seed.

1func Engines(offset, limit int64) string

source

1func ExecuteOp(cur realm, opID string)

source

ExecuteOp applies a proposed op once its timelock has passed. The delay is judged at execution, so an op proposed during bootstrap still waits the full timelock if a collection appeared in the meantime.

1func FeeConfig() types.Fees

source

FeeConfig is the typed fee view minters and markets settle with.

1func Fees() string

source

Fees is the fee configuration and its hard caps as JSON.

1func Finalize(cur realm, cid string)

source

Finalize is permissionless and never paused (I-2): immediately once every expected secret is revealed, otherwise after revealDeadline (fallback).

1func Info(cid string) types.CollectionInfo

source

Info is the typed collection view for other realms.

1func IsMinter(path string) bool

source

1func Launch(cur realm, cid string, l types.LaunchSpec)

source

Launch freezes the configuration (I-6): sale window, reveal window and the creator's commitment. The sale must start in the future so a beacon can commit before the first mint.

1func MintTo(cur realm, cid string, to address, n int64) (first, last int64)

source

MintTo mints n tokens during the sale. The minter has already checked phase, price, allowlist and wallet cap; core re-checks only what it owns: state, supply, beacon commitment, and the lifetime counter (I-5, I-9).

1func MintedBy(cid string, addr address) int64

source

MintedBy is the lifetime mint counter of addr in cid (OA B3, I-9).

1func MintedTotal(cid string) int64

source

MintedTotal counts every token ever minted, burned ones included (OA B4).

1func Pause(cur realm, scope string)

source

Pause stops new activity in one scope for at most MaxPauseBlocks. It never blocks exits (I-2).

1func Paused(scope string) bool

source

Paused reports whether scope ("create", "mint", "trade") is paused now.

1func PendingOps() string

source

PendingOps is the timelock queue as JSON.

1func PrimaryPayees(cid string) []types.Payee

source

PrimaryPayees returns a copy of the frozen primary-sale split.

1func ProposeOp(cur realm, op, arg string) string

source

1func Provenance(cid string) string

source

Provenance is the whole record as JSON; secrets and salt stay "" until revealed / final.

1func RegisterEngine(cur realm, e engine.Engine) string

source

RegisterEngine stores the calling realm's engine (I-12 exception: one sample render in the engine's own registration transaction). The record is immutable afterwards except for the claim/deprecate/review flags.

1func Render(path string) string

source

Render stays minimal in the immutable realm; the browsable gallery is the private, re-deployable gallery realm (design §2.5.7).

1func RenderWith(id, params, seed string) string

source

RenderWith renders any registered engine for arbitrary params and seed as a data URI — Studio previews and the Verify button.

1func ReserveTo(cur realm, cid string, to address, n int64) (first, last int64)

source

ReserveTo mints the creator's reserve before the sale starts. Reserve mints feed the entropy like any mint, appear in Provenance, and do not count toward wallet caps.

1func RevealBeaconSecret(cur realm, cid, secret string)

source

1func RevealCreatorSecret(cur realm, cid, secret string)

source

1func Royalty(cid string) *royalty.Royalty

source

Royalty publishes the read-only royalty view (EIP-2981 RoyaltyInfo).

1func SetApprovalForAll(cur realm, cid string, operator address, approved bool)

source

1func SetPayees(cur realm, cid, payees string)

source

SetPayees changes the royalty split after Final. The primary-sale split is frozen with the sale (I-6); the royalty receiver stays the collection's sub-treasury, so third-party markets are unaffected.

1func Token(cid string) *grc721.Token

source

Token publishes the collection's official *grc721.Token. Its exported methods are reads or teller factories that need the caller's live realm; the ledger itself is never published.

1func TokenMetadata(cid, tid string) string

source

TokenMetadata is OpenSea-style metadata JSON.

1func TokenMoves(cid, tid string) int64

source

TokenMoves is the transfer counter market/v1 pins in a listing (H-2).

1func TokenSeed(cid, tid string) string

source

TokenSeed is "" until the collection is Final: no read path can leak the rarity map early.

1func TokenState(cid, tid string) string

source

TokenState is {mintHeight, lastMoveHeight, moves} as JSON.

1func TokenTraitList(cid, tid string) []engine.Trait

source

TokenTraitList is the typed form of TokenTraits for other realms (a copy).

1func TokenTraits(cid, tid string) string

source

TokenTraits is [{"trait_type":…,"value":…}] JSON.

1func TokenURI(cid, tid string) (string, error)

source

TokenURI is a base64 SVG data URI. Before Final every token shows core's neutral placeholder, never engine output (design §4.2).

1func TraitsWith(id, params, seed string) string

source

1func TransferCreator(cur realm, cid string, to address)

source

TransferCreator starts a two-step handover (RA M-11).

1func TransferFrom(cur realm, cid, tid string, from, to address)

source

1func Unpause(cur realm, scope string)

source

1func VerifyEngine(id string) bool

source

VerifyEngine re-renders the sample and compares it with the fingerprint stored at registration.

1func VerifyProvenance(cid string) bool

source

VerifyProvenance recomputes every commitment and the salt from public data. True only for a Final collection whose record is consistent.

Imports 15

/r/g19dzk54hhsdc3gllpksuj6gu4a3e6fl8cr6rn4w/minhwa/core

Imported by indexer

Find the packages that import it

Overview

Constants 3

Functions 61

Dependencies

Imports 15

Imported by indexer

Source Files 9