vesting state

pkgPath

// must match gnomod.toml

day

GNOT

BUBBLE

MaxDays

// a term, and a cliff, of at most a hundred years: the arithmetic below counts on it

maxNote

listMax

// grants the front page lists

kind

kindNative

kindBubble

kindRegistry

Grant

Grant is one schedule. The fields are read through Get; only this realm writes them.

grants

// key(id) → \*Grant

last

init.14

Count

Get

Get is a copy of the grant.

Address

Balance

Balance is what the grant's address holds of its token.

Vested

Vested is what the schedule has released by now — or by the revoke, if there was one. Never above Total.

Claimable

Claimable is what Claim would pay now: the vested part not yet paid, as far as the balance goes.

subpath

key

get

balance

vested

vestedAt

vestedAt is the schedule itself. The split of rest\*d/Days into a quotient and a remainder part keeps every intermediate inside int64 for any Total and a term under MaxDays, and equals the exact floor.

claimable

kindOf

canon

canon names the token as the realm stores it: GNOT and BUBBLE by their constants, anything else by its registry key, which must resolve.

caller

mustBeOwner

Create

Create opens a grant and returns its id. owner may revoke it ("" makes it irrevocable); the tokens are sent to Address(id) afterwards, by anyone. token: "gnot", "bubble" or a registry key. start 0 is now; a past start is allowed, a future one up to a hundred years out. days 0 vests everything at start. note is a label of up to 120 plain characters (no markup: the pages render it).

Claim

Claim pays the beneficiary everything claimable and returns the amount. Anyone may call it.

Revoke

Revoke ends the schedule where it stands (the first time) and returns to the owner everything the grant holds beyond what has vested and is still the beneficiary's to claim. Before the up-front share has arrived, counting what was already paid out as arrived, it voids the grant instead: nothing vests, ever — so a unit of dust sent ahead of the owner's revoke, claimed or not, cannot turn a void into a freeze that keeps the up-front share. (A grant with no up-front share measures against what the schedule had released by the revoke.) Returns what went back; 0 when nothing did.

Sweep

Sweep returns to the owner what the schedule can never owe the beneficiary — above the unpaid rest of the grant while it runs, above what is still claimable once revoked — without ending anything. Owner only; on a grant with no owner the excess is the beneficiary's, and anyone may send it there.

sweep

sweepTo

send

send moves n of the grant's token out of the grant's own address: the sub-realm is the sender, so one grant can never pay from another's balance.

SetOwner

SetOwner names the next owner; nothing moves until they AcceptOwner. Naming "" withdraws the offer.

AcceptOwner

AcceptOwner takes the owner role of a grant, by the one named.

Render

Render: "" the newest grants; "\<id>" one grant; "json/\<id>" its figures in base units; "by/\<address>" the grants an address owns or receives.

home

page

by

json

state

date

amount

amount prints base units in the token's own unit, trailing zeros dropped.