data state

DELAY

DELAY is how long a ready release waits before it takes over. It is a constant so that it can never be shortened.

maxKey

Limits: every call is bounded.

maxValue

Limits: every call is bounded.

maxOps

Limits: every call is bounded.

maxPage

Limits: every call is bounded.

maxColls

// per role

maxCollName

Limits: every call is bounded.

maxPath

Limits: every call is bounded.

roles

self

// this realm's path

owner

guardian

writer

// pkgpath per role

paused

proposed

// "" = role unchanged by the release

ready

at

// when the release takes over; 0 until every proposed realm said Ready

colls

nColls

past

// address -> pkgpath of every realm that has been a writer

frozen

// seconds some role has been paused, ended pauses only

frozeAt

// when the current pause of some role began, 0 if none

nextGuardian

// the owner's replacement for the guardian, "" if none

guardianAt

// when nextGuardian takes over

init.24

start

start puts release 1 in force (gno.land/r/\<ns>/gnoradio/\<role>/v1), with the deployer as owner and guardian.

nftPath

nftPath is the permanent ticket NFT realm (phase 5). It is not a writer: it mints and transfers only for the tickets writer, and like every GnoRadio realm it never takes vault payouts.

remember

roleIndex

roleOf

roleOf is the role of a collection or vault account: its name's prefix.

noPayment

now

matured

settle

settle puts a release whose delay is over in force.

drop

drop forgets the release not yet in force.

Writer

Writer is the realm that writes a role's collections now.

gate

gate lets only the writer of a collection's or account's role through, and only while that role is not paused. The writer is the immediate caller: accounts, MsgRun and the owner never pass.

IsGnoRadio

IsGnoRadio reports whether addr is a GnoRadio realm: this one, the ticket NFT realm, or any current, proposed or past writer.

onlyOwner

checkPath

checkPath refuses anything but a plain realm path.

Propose

Propose adds a role's new writer to the next release. Any change restarts the clock. Owner only.

Ready

Ready is a proposed realm's own call (each rules realm exposes it): once every proposed realm said it, the release takes over DELAY later.

Cancel

Cancel drops the release not yet in force. Owner or guardian. It never touches a guardian replacement.

Pause

Pause stops a role's writes and vault operations at once ("" every role); reads and VaultWithdraw go on. on=false resumes the same writer. The owner pauses and resumes; the guardian only pauses, and only while there is an owner to resume.

Renounce

Renounce gives the owner role up: writers never change again and nothing can be paused. Refused while a role is paused, which could then never write again. It drops the release not yet in force.

Offer

Offer offers the owner role to an address (offering it to the owner cancels the offer); Accept takes it.

Accept

GuardianOffer

GuardianOffer and GuardianAccept pass the guardian role in two steps; the guardian offers it. The owner's only call on the role is GuardianReplace.

GuardianAccept

GuardianRenounce

GuardianRenounce gives the guardian role up. A replacement the owner already announced still takes over.

GuardianReplace

GuardianReplace is the owner's way out of a lost or stolen guardian key, which could otherwise cancel every release and pause after every resume for good: to becomes the guardian 2x DELAY (six days) later. The guardian cannot cancel it; the owner withdraws it with to = "" or announces another one, which restarts the clock. The wait outlasts a release's DELAY, so a stolen owner key that replaces the guardian is public for six days before its own release can even start its 72 hours. Owner only.

settleGuardian

settleGuardian puts a replacement whose wait is over in force: a fresh role, so any offer the old guardian left dies with it.

guardianNow

Paused

Paused reports whether a role's writes are stopped now.

anyPaused

Owner

Guardian

Writers

Writers is the state of every role, as JSON: {"owner","pendingOwner", "guardian","pendingGuardian","nextGuardian","guardianAt","at","roles": {"catalog":{"writer","paused","proposed","ready"},…}}. at is the unix time a ready release takes over, guardianAt the time nextGuardian (the owner's GuardianReplace) does.

coll

mustColl

Make

Make creates a collection under the caller's role (nothing if it exists): "\<role>/\<name>", name of a-z 0-9 \_, at most 32 bytes in all, 32 per role.

apply

apply is one write of the caller's role: Set, Remove and each op of Batch.

Set

Set writes value at key of a collection of the caller's role.

Remove

Remove deletes a key and reports whether it was there.

Batch

Batch applies up to 64 ops of four strings (store.Ops): "set" or "del", collection, key, value. It reads the strings and keeps nothing else of the caller's slice.

Get

Get returns the value at key ("" and false when absent).

Has

Size

Size is the number of keys of a collection.

Index

Index is the number of keys before key: Index(c, b) - Index(c, a) counts the keys in \[a, b) without a counter. O(log² n).

Page

Page returns up to limit (1-100) rows with start \<= key \< end ("" no bound), lowest first or highest first when reverse, as store.Row strings (store.Rows decodes them).

PageAt

PageAt returns up to limit (1-100) rows from the offset-th key, counted from the highest when reverse.

checkLimit

denom

daySecs

maxHoldDays

// a hold lapses at most this many days ahead

maxAcct

vault

// account -> store.Rec(funder, balance, holds)

vaultTotal

account

getAcct

putAcct

atoi

VaultDay

VaultDay is the UTC day of the vault's clock, which stands still while any role is paused: a pause never makes a hold lapse, it lapses that much later. The clock lags real time by every past pause, so a hold made after one also lasts that much longer.

today

held

held reads the holds still live today, and the one lapsing on day e.

hold

hold adds delta to the hold lapsing on day e and drops lapsed ones.

positive

send

send pays out of the vault: the total goes down before the coins leave.

VaultCredit

VaultCredit adds amt, which the writer has just sent to this realm, to an account funded by funder. A new funder needs an empty account (VaultRefund first).

VaultHold

VaultHold reserves amt of the free balance until the end of day on the vault's clock (from VaultDay to 31 days from now).

VaultRelease

VaultRelease gives back up to amt of the hold lapsing on day and returns what it released (less when part of it lapsed or was refunded).

VaultPay

VaultPay pays amt from the live hold lapsing on day to an account outside GnoRadio.

VaultRefund

VaultRefund pays the whole balance back to the funder and drops the holds (the profile changed hands). It returns the amount.

VaultWithdraw

VaultWithdraw pays the caller what is free in an account they funded. It works whoever the writer is, while paused and after Renounce.

VaultInfo

VaultInfo is an account's funder, balance and free part (not held).

VaultHeld

VaultHeld is the live hold of an account lapsing on day.

VaultTotal

VaultTotal is every account's balance: what this realm holds for them.