v0 state

Denom

Path

Link

Owner

Owner funds the faucet, approves by default, and is the only account that can change who else approves or take the float back. Hardcoded rather than captured from the deployer: inside a plain \`func Test(t \*testing.T)\` the gno test runner reports OriginCaller() as the EMPTY address, so an owner seeded from it is empty in every test and something else on chain. That divergence is where an authorization bug hides, so the address is written down.

StatusPending

The three states a request can be in. A request is decided exactly once.

StatusSent

The three states a request can be in. A request is decided exactly once.

StatusDenied

The three states a request can be in. A request is decided exactly once.

DefaultMaxPerRequest

MaxReasonLen

idWidth

request

request is one ask. It is unexported because avl stores \`any\` and the readable surface of this realm is its views and its page, not a struct another realm would have to depend on.

requests

// padded id -> \*request

paid

// recipient address -> int64 ugnot received in total

approvers

// approver address -> bool

nextID

maxPerRequest

totalSent

sentCount

deniedCount

pendingN

init.20

reset

reset installs an empty faucet. Also called by the tests: realm globals persist for a whole test binary and examples run after every Test, so a pinned Render has to start from a known state.

Address

Balance

Balance is what the faucet can actually pay out right now.

NextID

NextID is the id the next [Request](#Request) will be given. Read it to build the [Approve](#Approve) half of a two-message transaction, and pass the recipient and amount to Approve so that a request landing in between fails the transaction instead of being paid by it.

MaxPerRequest

MaxPerRequest is the current cap on a single payout, in ugnot.

TotalSent

TotalSent, SentCount, DeniedCount and Pending are the running tallies.

SentCount

DeniedCount

Pending

Requests

Requests is how many requests have ever been filed.

IsApprover

IsApprover reports whether addr may approve or deny.

ReceivedBy

ReceivedBy is everything this faucet has ever paid to addr.

Status

Status is the state of request id: "pending", "sent", "denied", or "" when no such request exists.

Fund

Fund credits the ugnot sent with the call to the float. Coins sent straight to \[Address] land there too; they just do not emit an event.

Request

Request files an ask for amount ugnot to be paid to \`to\`, and returns its id. Anyone may file, for anyone, which is the point: the account that needs the coins is the one that cannot pay to ask for them. Filing costs the filer gas and nothing else, and moves no money.

Approve

Approve pays request id out of the float. Approvers only. wantTo and wantAmount are not redundant: they are what makes it safe to put Approve in the same transaction as the Request it settles. The id has to be guessed from [NextID](#NextID) before either message is signed, and this call refuses when the request sitting at that id is not the one the caller described.

Deny

Deny closes a request unpaid, with a reason that goes on the page. The reason is the whole value of denying in public rather than ignoring it.

AddApprover

AddApprover lets addr approve and deny. Owner only.

RemoveApprover

RemoveApprover revokes addr. Owner only, and the Owner cannot be removed: a faucet with no approver is a faucet with a locked float.

SetMaxPerRequest

SetMaxPerRequest changes the per-request cap, in ugnot. Owner only.

Withdraw

Withdraw returns amount ugnot of the float to the Owner. Owner only. This is what makes funding the faucet reversible, and it is deliberately not payable to an arbitrary address: an approver who wanted to move money somewhere has to file a request for it like everyone else.

mustOwn

mustApprove

find

key

key pads an id to idWidth digits so the avl tree iterates in filing order.

Render

Render shows the float, the open asks and everything already decided. Two paths: "" is the whole board, "req/\<id>" is one request. Every string on this page that a caller typed goes through sanitize before it is concatenated. A reason is arbitrary text from an arbitrary account and Render output is markdown that gnoweb parses, so an unescaped one can plant a link, an image beacon or gnoweb chrome on a page the realm is signing for. This realm's path is permanent, so that bug could only ever be fixed at a new path.

renderBoard

table

table lists requests in filing order, keeping only those in \`want\`, or everything already decided when want is empty.

renderOne

reqPath

reqPath parses "req/\<id>".

excerpt

excerpt cuts to width RUNES, never bytes: slicing a multi-byte character in half puts invalid UTF-8 on the page, and one emoji in a reason is enough. It cuts before escaping, because escaping inserts backslashes and cutting an already-escaped string can strand a lone one that escapes the chrome after it.

gnot

gnot renders ugnot as GNOT with the trailing zeros of the fraction trimmed, so 100000000 reads as 100 and 1500000 as 1.5.

intro

howto