v0 state

realmPath

realmPath is this realm's own path, the one its gnomod.toml module line declares. It is written out rather than read from the frame, because a plain read exported by a realm reports the CALLER and would build every link against whoever asked.

denom

denom is the only coin this realm handles.

plans

plans holds every plan and the credit ledger. A redeploy wipes it, which is the trade \`private = true\` makes: see gnomod.toml.

Open

Open creates a plan and returns its id. Anyone may open one, and opening one costs nothing beyond gas and the storage deposit. pricePerPeriod is in ugnot and must be at least one: a free plan is a tip jar, not a subscription. periodBlocks is a period in BLOCKS, bounded both ways by the engine, because height is the clock consensus agrees on and a block timestamp is not something to build a billing cliff out of.

Subscribe

Subscribe buys whole periods on a plan with the ugnot attached to the call, and returns the caller's new paid-through height. Attach the coins with -send: a payment short of one period is refused, and the remainder under one period is credited back to the caller rather than kept, so an overpayment is change and never a silent fee. Take it back with [Withdraw](#Withdraw). ### It has to be called directly by a user, and that is not a style choice {#hdr-It_has_to_be_called_directly_by_a_user__and_that_is_not_a_style_choice} The envelope is what the SIGNER attached to the transaction. A realm the user called has already received those coins itself, and could then call in here as many times as it liked against one payment, so the caller is checked before the envelope is read. The same property means a realm cannot forward an envelope it was handed (\`NewBanker\` requires the previous frame to be a user call), and that \`maketx run\` cannot reach this function at all, because a run script is itself a code realm. Use \`maketx call -send\`.

Close

Close stops a plan taking new subscriptions. Creator only. Everything already paid for runs to its own paid-through height. Closing a plan is not a way to take a period back.

Reopen

Reopen lets a closed plan take subscriptions again. Creator only.

Withdraw

Withdraw pays the caller everything this realm owes them and returns the amount: a creator's earnings, a supporter's change, or both at once. The credit is zeroed by the engine before a coin moves, so a recipient that calls straight back in finds nothing left to take.

Get

Count

Count is how many plans exist.

IsActive

IsActive reports whether who is paid up on this plan at the current height. Active means now \< paidThrough, strictly: an address paid through height h is active at h-1 and not at h.

PaidThrough

PaidThrough is the height who stops being active at on this plan, or zero if they never paid.

SupporterCount

SupporterCount is how many distinct addresses have ever paid this plan, active or not.

Supporters

EarnedBy

EarnedBy is the lifetime ugnot credited to creator across every plan, whether or not it has been withdrawn.

CreditOf

CreditOf is what addr can withdraw right now.

TotalOwed

TotalOwed is everything this realm owes, which is what it must keep in reserve at its own address.

mustGet

mustGet reads a plan or aborts naming it.

caller

pageSize

pageSize is how many plans the index lists at once.

titleWidth

titleWidth is how much of a plan's title a listing shows.

Render

Render routes two views: the index and one plan.

renderIndex

renderPlan

planTable

planTable lists plans. The link text is the plan NUMBER and not its title, which is the one thing to copy from here. md.Link escapes its text with the inline escaper, and the inline escaper does not touch a pipe, because a pipe means nothing in a sentence: a user title carried inside a link inside a table cell therefore still opens a column. So the title gets its own cell and goes through ui.Cell, which is the escaper that knows it is in a table. It is truncated first with ui.ShortN, which does not escape, so the cut can never strand a backslash that the escaper had just inserted.

supporterTable

pageNum

pageNum reads ?page= and falls back to the first page for anything it cannot read, which is the only answer a Render can give: there is nobody to report an error to.