vesting state

Denom

Denom is the only asset this realm escrows.

MaxFeeBps

MaxFeeBps is the hard protocol-fee cap: 1000 bps = 10%.

StatusPending

Tranche status values. A tranche is created pending and reaches exactly one terminal state; both terminals are frozen.

StatusReleased

Tranche status values. A tranche is created pending and reaches exactly one terminal state; both terminals are frozen.

StatusRevoked

Tranche status values. A tranche is created pending and reaches exactly one terminal state; both terminals are frozen.

MinDelayBlocks

Bounds. All are compile-time constants: none is admin-mutable, so a schedule's shape cannot be changed under its funder or beneficiary.

MaxDelayBlocks

Bounds. All are compile-time constants: none is admin-mutable, so a schedule's shape cannot be changed under its funder or beneficiary.

MaxTranches

Bounds. All are compile-time constants: none is admin-mutable, so a schedule's shape cannot be changed under its funder or beneficiary.

MaxOpenTranches

Bounds. All are compile-time constants: none is admin-mutable, so a schedule's shape cannot be changed under its funder or beneficiary.

MaxOpenPerFunder

Bounds. All are compile-time constants: none is admin-mutable, so a schedule's shape cannot be changed under its funder or beneficiary.

MaxTitleLen

Bounds. All are compile-time constants: none is admin-mutable, so a schedule's shape cannot be changed under its funder or beneficiary.

MaxMemoLen

Bounds. All are compile-time constants: none is admin-mutable, so a schedule's shape cannot be changed under its funder or beneficiary.

MaxSpecLen

Bounds. All are compile-time constants: none is admin-mutable, so a schedule's shape cannot be changed under its funder or beneficiary.

MaxListed

Bounds. All are compile-time constants: none is admin-mutable, so a schedule's shape cannot be changed under its funder or beneficiary.

tranche

tranche is one dated payment. It is this realm's authoritative record; the matching duebook deferral carries only the due height and a label. Records are kept after they terminate, so history remains answerable once duebook has consumed the deferral.

schedule

schedule is one funded vesting agreement.

admin

// may set fee, fee recipient, and propose a successor

pendingAdmin

// must accept before the handover takes effect

feeRecipient

// may withdraw fees and sweep surplus

feeBps

// fee snapshotted into NEW schedules

self

// this realm's address, captured at deploy

nextScheduleID

escrowTotal

// == Σ amount over pending tranches (the E term)

schedules

// padID(scheduleID) -> \*schedule

tranches

// padU(deferralID) -> \*tranche

openByFunder

// funder.String() -> int64

ledger

book

init.28

rejectStraySend

rejectStraySend aborts if an EOA attached coins to an entrypoint that has no use for them. Only Fund accepts value; without this guard a mistyped send would be silently absorbed into surplus.

Fund

Fund creates a vesting schedule in a single transaction: it escrows the attached GNOT, registers every tranche with duebook, and returns the new schedule id. Only direct EOA calls with -send are accepted. spec lists the tranches as "delay:amount" pairs separated by commas, for example "100:500,200:500,300:1000". Delays are in BLOCKS FROM NOW and must be STRICTLY INCREASING — two payments at the same height are one tranche with the amounts added. Every amount must be positive, and the amounts must sum to EXACTLY the attached send: this realm will not silently absorb a surplus or create an underfunded schedule. revocable decides, permanently, whether the funder may reclaim not-yet-due tranches. There is no setter; an irrevocable schedule stays irrevocable. maxFeeBps is the ceiling the caller signs for. Funding is rejected if the live fee exceeds it, which closes the race where an admin sequences a fee raise ahead of this transaction. Pass MaxFeeBps to accept any legal fee.

Release

Release pays out a due tranche. ANYONE may call it: the value is credited to the schedule's RECORDED BENEFICIARY, never to the caller, so a stranger calling this gains nothing and the beneficiary needs no liveness of their own. The protocol fee snapshotted at funding is charged here. Aborts if the tranche does not exist, is not due yet, or has already been released or revoked — the last of those is duebook's guarantee, not a check written here.

Revoke

Revoke returns a NOT-YET-DUE tranche to the funder's claimable balance, fee-free. Only the funder may call it, and only on a schedule created revocable. A tranche whose due height has arrived can never be revoked, even though duebook's Cancel would consume it: that refusal is this realm's, and it is what stops a funder front-running the beneficiary's Release to claw back value already vested.

RevokeAll

RevokeAll returns every not-yet-due tranche of a schedule to the funder's claimable balance in one transaction, and returns how many were revoked. Already-due and already-settled tranches are skipped, not an error. Funder only, revocable schedules only. Aborts if nothing was revocable, so a no-op cannot be mistaken for success.

revokeOne

revokeOne cancels one pending, not-yet-due tranche and credits the funder fee-free. Callers have already verified authorization, revocability and the due-height refusal.

Withdraw

Withdraw sends amount ugnot of the caller's claimable balance (released tranches for a beneficiary, revocations for a funder) to the caller.

WithdrawAll

WithdrawAll sends the caller's entire claimable balance to the caller. Aborts if there is nothing to withdraw.

WithdrawFees

WithdrawFees sends the accrued fee pot to the fee recipient. Only the fee recipient may call it.

SweepDenom

SweepDenom sends the surplus of a single denomination to the fee recipient. For ugnot only the excess over Liabilities() moves — escrowed tranches and claimable balances are untouchable by construction. Other denominations move wholly. Only the fee recipient may call it.

SetFeeBps

SetFeeBps sets the protocol fee snapshotted into FUTURE schedules at funding. Existing schedules keep the fee they were funded under, so an in-flight schedule's economics cannot be changed. Admin only.

SetFeeRecipient

SetFeeRecipient re-points the fee/surplus role. The pot accrued under the OUTGOING recipient is settled to that recipient's own claimable balance first, so the successor inherits the role and not the earnings. Admin only; the zero address is rejected.

ProposeAdmin

ProposeAdmin nominates a successor admin. The handover takes effect only when that account calls AcceptAdmin, so a typo cannot strand the role. Admin only; the zero address clears a pending proposal.

AcceptAdmin

AcceptAdmin completes a handover. Only the proposed account may call it.

ScheduleInfo

Memo

Memo returns a schedule's raw memo text.

TrancheInfo

TrancheInfo returns one tranche's fields by value. It answers for settled tranches too, after duebook has consumed the deferral.

TranchesOf

TranchesOf lists a schedule's tranches, newline-separated, one per line as "id seq amount dueAt status".

VestedOf

VestedOf returns, for a schedule, the amount whose due height has arrived and which is therefore no longer revocable — whether or not it has been released yet — alongside the amount still revocable by the funder.

ReleasableNow

ReleasableNow lists tranche ids that are due and still pending, up to MaxListed, newline-separated. Anyone may Release each of them.

Admin

PendingAdmin

FeeRecipient

FeeBps

FeeBps returns the fee that will be snapshotted into newly funded schedules. Existing schedules keep their own snapshot.

FeeOn

FeeOn previews the fee and net credit for a tranche of amount at the CURRENT FeeBps.

NumSchedules

NumSchedules returns how many schedules have ever been funded.

OpenTrancheCount

OpenTrancheCount returns how many tranches are pending across the whole realm, against the MaxOpenTranches cap.

OpenTranchesOfFunder

OpenTranchesOfFunder returns how many tranches funder currently holds pending, against the MaxOpenPerFunder cap. A funder can read this before funding to see the headroom they have left.

FundersWithOpenTranches

FundersWithOpenTranches returns how many distinct funders hold at least one pending tranche. It is the width of the per-funder cap: exhausting MaxOpenTranches requires this to reach ceil(MaxOpenTranches/MaxOpenPerFunder).

EscrowTotal

EscrowTotal returns the escrow held by pending tranches (the E term).

BalanceOf

BalanceOf returns addr's claimable balance (released tranches for a beneficiary, revocations for a funder).

UsersTotal

UsersTotal returns the sum of all claimable balances (the U term).

FeesAccrued

FeesAccrued returns the fee pot (the F term).

Liabilities

Liabilities returns everything this realm owes: EscrowTotal + UsersTotal + FeesAccrued.

Held

Held returns the ugnot actually held at this realm's address (H).

Surplus

Surplus returns Held() - Liabilities() (the S term).

Address

Height

Height returns the current chain height. Delays in Fund's spec are relative to the height at which Fund executes, so this is an aid for composing a spec, not an input to one.

Render

Render shows the realm at "" and a schedule detail at "\<id>". Free text (titles are charset-restricted; memos are not) passes through the ecosystem sanitizer before it reaches markdown.

renderSchedule

assertAdmin

assertRevocableBy

assertRevocableBy checks both halves of the revocation authority: the schedule must have been funded revocable, and the caller must be its funder.

mustSchedule

mustTranche

openOf

openOf reports how many tranches funder currently holds pending. A missing key means zero, which is the same thing: addOpen removes the entry when the count reaches zero.

addOpen

addOpen adjusts funder's pending-tranche count by delta, which may be negative. Every increment happens in Fund and every decrement is paired with a pending -> terminal transition, so the count tracks exactly the tranches openOf claims.

mustID

mustID converts an entrypoint's int64 tranche id to duebook's uint64, rejecting the non-positive values duebook never issues.

parseSpec

parseSpec parses "delay:amount,delay:amount,…" into parallel slices, enforcing every bound before any state is touched. Delays must be strictly increasing; amounts must be positive. Nothing here consults or mutates realm state, so a malformed spec is rejected with the escrow still untouched (the whole transaction aborts regardless).

assertValidTitle

assertValidTitle bounds length and restricts the charset so titles are list-safe in Render without escaping.

padID

padID renders a schedule id as a fixed-width key so avl iteration order is numeric order.

padU

padU renders a deferral id as a fixed-width key. 20 digits covers the whole uint64 range, so tranche iteration is numeric order too.

itoa

utoa

btoa

checkedAdd