Skip to content Search Apps Documentation Source Content File Folder Download Copy Actions State String Boolean Number Struct Map Slice Pointer Function Closure Reference Nil Package Type Interface Unknown

Community realm. Read the code first. Community realm, deployed by its author. Read the code before you interact or send coins.

v1 state

Back to all declarations

MaxSetLen

untyped bigint

Allowlist sets (design §4.6). A phase's set is a comma-separated union of terms; an address is eligible if any term admits it: users registered in r/sys/users (live check) validators in the active validator set (live check) holders:<cid> holds a token of collection <cid> merkle:<root> in a sha256 merkle tree; the minter passes the proof A term may carry "|"-separated provenance notes for humans, e.g. "merkle:\<root>|src:\<git-sha>|data:\<sha256>"; notes never affect logic.

Value

(512 <untyped> bigint)

MaxSetTerms

untyped bigint

Allowlist sets (design §4.6). A phase's set is a comma-separated union of terms; an address is eligible if any term admits it: users registered in r/sys/users (live check) validators in the active validator set (live check) holders:<cid> holds a token of collection <cid> merkle:<root> in a sha256 merkle tree; the minter passes the proof A term may carry "|"-separated provenance notes for humans, e.g. "merkle:\<root>|src:\<git-sha>|data:\<sha256>"; notes never affect logic.

Value

(4 <untyped> bigint)

setTerm

type

Value

v1.setTerm

parseSet

func(set string) []v1.setTerm

parseSet validates a set and returns its terms; it panics on any error so AddPhase rejects a malformed set before it is ever frozen.

Open
OID
03deec…3907:3
parseSet details

Inspect func

eligible

func(cid string, set string, addr .uverse.address, proof string) (bool, string)

eligible reports whether addr may mint in a phase with this set, and why not. Live sets are evaluated at mint time, so a deleted user or a removed validator loses eligibility immediately.

Open
OID
03deec…3907:5
eligible details

Inspect func

MaxPhases

untyped bigint

Value

(3 <untyped> bigint)

sale

type

sale is this minter's per-collection state. Phases can change only while core says Draft; after Launch they are frozen with the rest (I-6).

Value

v1.sale

Create

func(name string, symbol string, description string, engineID string, params string, maxSupply int64, royaltyBps int64, primaryPayees string, royaltyPayees string, expectedCID string) string

Create opens a Draft collection for the calling wallet and pays the protocol's create fee from the attached ugnot (excess refunded). Empty payee strings default to "creator:10000". expectedCID, when set, makes the transaction fail instead of creating a different id than the frontend showed (OA B2).

Open
OID
03deec…3907:8
Create details

Inspect func

AddPhase

func(cid string, kind string, set string, startHeight int64, endHeight int64, startPrice int64, floorPrice int64, stepBlocks int64, stepAmount int64, walletCap int64)

AddPhase appends a sale phase. Phases are ordered and do not overlap. kind is "allow" (set required) or "public" (set empty); a fixed price has startPrice == floorPrice and zero steps; walletCap 0 means no cap.

Open
OID
03deec…3907:10
AddPhase details

Inspect func

ClearPhases

func(cid string)

ClearPhases removes every phase of a Draft.

Open
OID
03deec…3907:11
ClearPhases details

Inspect func

Launch

func(cid string, creatorCommit string, revealWindow int64, useBeacon bool)

Launch freezes the sale. creatorCommit is safe.Commit(chainID, cid, "creator", secret), computed off-chain — never send the secret to a node before reveal.

Open
OID
03deec…3907:12
Launch details

Inspect func

Abort

func(cid string)

Abort returns a launched collection with no mints to Draft (core rules).

Open
OID
03deec…3907:13
Abort details

Inspect func

Reserve

func(cid string, count int64) string

Reserve mints the creator's reserve to the creator before the sale.

Open
OID
03deec…3907:14
Reserve details

Inspect func

Mint

func(cid string, count int64, maxUnitPrice int64, proof string) string

Mint buys count tokens in the phase open at this block, at that block's unit price, never above maxUnitPrice (a Dutch step cannot surprise the buyer). proof is the merkle proof for merkle sets, otherwise "". Returns "first-last". Every attached unit is paid out or refunded (I-3, I-4).

Open
OID
03deec…3907:15
Mint details

Inspect func

mustSale

func(cid string) *v1.sale
Open
OID
03deec…3907:16
mustSale details

Inspect func

mustDraftSale

func(cid string) *v1.sale
Open
OID
03deec…3907:17
mustDraftSale details

Inspect func

assertCreator

func(cid string) .uverse.address
Open
OID
03deec…3907:18
assertCreator details

Inspect func

Price

func(cid string, h int64) int64

Price is the unit price at height h, or -1 when no phase covers h.

Open
OID
03deec…3907:19
Price details

Inspect func

Phases

func(cid string) string

Phases is the phase list as JSON.

Open
OID
03deec…3907:20
Phases details

Inspect func

Eligible

func(cid string, addr .uverse.address, proof string) string

Eligible answers "can addr mint now, and how many?" with the same checks Mint runs, so the UI never disagrees with the chain (OA B3). JSON: {phase, kind, eligible, reason, remainingCap (-1 = no cap), price}.

Open
OID
03deec…3907:21
Eligible details

Inspect func

received

func() int64

received returns the ugnot attached to a direct wallet call. Payments are accepted only when a wallet called us: the origin-send envelope is shared by every realm on the path, so a realm in between could have consumed it (chain/runtime/unsafe.OriginSend).

Open
OID
03deec…3907:24
received details

Inspect func

assertNoDeposit

func()

assertNoDeposit refuses coins on functions that take none (RA L-1).

Open
OID
03deec…3907:26
assertNoDeposit details

Inspect func

pay

func(to .uverse.address, amount int64)
Open
OID
03deec…3907:27
pay details

Inspect func
MaxSetLen : untyped bigint =(512 <untyped> bigint)
MaxSetTerms : untyped bigint =(4 <untyped> bigint)
setTerm : type =v1.setTerm
parseSet : func(set string) []v1.setTerm Inspect
eligible : func(cid string, set string, addr .uverse.address, proof string) (bool, string) Inspect
MaxPhases : untyped bigint =(3 <untyped> bigint)
sale : type =v1.sale
sales : v0.Tree Inspect
Create : func(name string, symbol string, description string, engineID string, params string, maxSupply int64, royaltyBps int64, primaryPayees string, royaltyPayees string, expectedCID string) string Inspect
AddPhase : func(cid string, kind string, set string, startHeight int64, endHeight int64, startPrice int64, floorPrice int64, stepBlocks int64, stepAmount int64, walletCap int64) Inspect
ClearPhases : func(cid string) Inspect
Launch : func(cid string, creatorCommit string, revealWindow int64, useBeacon bool) Inspect
Abort : func(cid string) Inspect
Reserve : func(cid string, count int64) string Inspect
Mint : func(cid string, count int64, maxUnitPrice int64, proof string) string Inspect
mustSale : func(cid string) *v1.sale Inspect
mustDraftSale : func(cid string) *v1.sale Inspect
assertCreator : func(cid string) .uverse.address Inspect
Price : func(cid string, h int64) int64 Inspect
Phases : func(cid string) string Inspect
Eligible : func(cid string, addr .uverse.address, proof string) string Inspect
Render : func(path string) string Inspect
itoa : func(n int64) string Inspect
received : func() int64 Inspect
assertNoDeposit : func() Inspect
pay : func(to .uverse.address, amount int64) Inspect