permbook_demo state

PermBump

The permission names this realm gates on. They are constants rather than caller-supplied strings for the gated actions, so a typo cannot silently create an unenforced gate.

PermNotice

The permission names this realm gates on. They are constants rather than caller-supplied strings for the gated actions, so a typo cannot silently create an unenforced gate.

MaxPermissions

MaxHolders

MaxNameLen

MaxNoticeLen

MaxListed

book

book is the permission set. It is unexported and never returned: handing a \*permbook.Book across a realm boundary would hand out every mutator on it, and borrow rule #2 commits those writes under THIS realm's authority (permbook consumer contract 2).

bumps

The state the gated actions move. This is the observable evidence that a gate was open at one height and closed at another.

lastBumper

The state the gated actions move. This is the observable evidence that a gate was open at one height and closed at another.

lastBumpHeight

The state the gated actions move. This is the observable evidence that a gate was open at one height and closed at another.

notice

The state the gated actions move. This is the observable evidence that a gate was open at one height and closed at another.

noticeAuthor

The state the gated actions move. This is the observable evidence that a gate was open at one height and closed at another.

noticeSetAtBlock

The state the gated actions move. This is the observable evidence that a gate was open at one height and closed at another.

demoLimits

demoLimits are the limits every Book this realm constructs is given.

init.15

Ready

Ready reports whether init captured a deploy-time admin and constructed the book. False means the realm is inert; see the note in init.

rejectStraySend

rejectStraySend aborts if an EOA attached coins to an entrypoint that has no use for them. This realm never holds value; without this guard a mistyped send would be silently absorbed by the realm bank.

Bump

Bump increments the counter. Requires the "bump" permission. This is the experiment: call it with the permission and it succeeds; have the admin revoke, call it again in a later transaction, and it aborts.

SetNotice

SetNotice replaces the public notice. Requires the "notice" permission. It exists so the demo shows two INDEPENDENT permissions on one book: holding "bump" does not let an address set the notice, and revoking one leaves the other intact.

Grant

Grant gives addr a permission. Admin only.

Revoke

Revoke removes a permission from addr. Admin only. The revoke is committed by this transaction. Any later transaction that reaches a gate on that permission is refused — that is the claim.

RevokeAll

RevokeAll removes every permission addr holds and reports how many. Admin only.

DropPermission

DropPermission removes a permission and every grant of it. Admin only.

NominateAdmin

NominateAdmin records a nominee for the admin role. Admin only. The handoff does not take effect until the nominee calls AcceptAdmin.

CancelNomination

CancelNomination withdraws a pending nomination. Admin only.

AcceptAdmin

AcceptAdmin completes a pending handoff. Only the nominee may call it.

Height

Height returns the chain height this realm is reading as "now".

Admin

Admin returns the book's current admin.

PendingAdmin

PendingAdmin returns the nominated-but-not-yet-accepted admin, or "".

Has

Has reports whether addr holds perm. This is the primitive's core query, exposed verbatim so it can be checked from off-chain.

CanBump

CanBump reports whether addr would be allowed to call Bump right now.

PermissionsOf

PermissionsOf returns the permissions addr holds, comma-separated in lexicographic order, or "" for none. Names are restricted by permbook to lowercase alphanumerics and underscore, so a comma can never appear in one and this encoding is unambiguous.

PermissionCount

PermissionCount returns how many distinct permissions currently exist.

Permissions

Permissions returns up to MaxListed permission names, comma-separated in lexicographic order.

HolderCount

HolderCount returns how many addresses hold perm, or 0 if it does not exist.

Holders

Holders returns up to MaxListed holders of perm, comma-separated in sorted order.

Bumps

Bumps returns how many times Bump has succeeded.

LastBump

LastBump describes the most recent successful Bump, or "none".

Notice

Notice returns the current public notice, or "".

Limits

Limits reports the book's fixed limits.

realmPath

realmPath is this realm's gnoweb prefix, used to build view links.

Render

Render serves three views, selected by path. (empty) summary, the permission table, and the gated state holders every permission with its holders, up to MaxListed each about what this realm is and why it exists An inert realm (see init) reports that instead of rendering. Every view reads the book, so without this the gnoweb page would abort on a nil dereference — which is exactly the moment an operator needs it to say what is wrong. The typed read functions still abort when inert; Ready is the probe that answers the question without panicking.

renderHeader

renderPermissions

gateFor

gateFor names the entrypoint a permission opens, or says it opens none. A permission with no gate is not a bug: the admin may grant a name this realm does not read, and saying so plainly is better than implying every permission is enforced somewhere.

renderHolders

renderState

renderAbout

normalizePath

normalizePath reduces a gnoweb render path to a bare view name, so "", "/", "holders" and "/holders/" all select the same view.

join

join comma-separates names. Safe because permbook restricts permission names to lowercase alphanumerics and underscore, so no name can contain the delimiter.

itoa