vault state

Denom

Denom is the only asset this vault accepts.

MaxFeeBps

MaxFeeBps is the hard protocol-fee cap: 1000 bps = 10%. Nobody can configure a higher fee; changing this requires deploying a new realm.

admin

// may set fee, fee recipient, and successor admin

feeRecipient

// may withdraw the fee pot and sweep surplus

feeBps

// current protocol fee in basis points

self

// this realm's own address, captured at deploy

ledger

init.7

Deposit

Deposit credits the caller with the attached GNOT minus the current protocol fee. Only direct EOA calls (maketx call with -send) are accepted: that is the only shape where the chain guarantees the send envelope landed at this realm's address before the body runs. The envelope must be exactly one coin of denom ugnot with positive amount.

Claim

Claim sends amount ugnot of the caller's balance back to the caller. Fails if amount is not positive or exceeds the caller's balance.

ClaimAll

ClaimAll sends the caller's entire balance back to the caller. Fails if the caller has no balance.

WithdrawFees

WithdrawFees sends the entire accrued fee pot to the fee recipient. Only the fee recipient may call it. Fails if the pot is empty.

SweepSurplus

SweepSurplus sends coins that sit at the realm address ABOVE the ledger's liabilities (ugnot force-sent outside Deposit, or any other denomination) to the fee recipient. Only the fee recipient may call it. User balances and the fee pot are untouchable by construction: only the excess over Liabilities() moves. Fails if there is no surplus.

SweepDenom

SweepDenom sends the surplus of a single denomination to the fee recipient. This is the bounded escape hatch for when SweepSurplus would exceed gas because a third party force-sent many junk denominations to the realm address: each call touches exactly one denomination, so ugnot surplus can always be recovered regardless of how many foreign denoms accumulate. For ugnot only the excess over Liabilities() moves; any other denom moves wholly. Only the fee recipient may call it.

SetFeeBps

SetFeeBps sets the protocol fee for FUTURE deposits. Admin only; bounded by \[0, MaxFeeBps].

SetFeeRecipient

SetFeeRecipient re-points who may withdraw the fee pot (including fees accrued before the change) and sweep surplus. Admin only; the zero address is rejected.

TransferAdmin

TransferAdmin hands the admin role to next. Admin only; the zero address is rejected. One-step: a transfer to a wrong-but-valid address permanently loses fee administration (deposits and claims keep working).

Admin

FeeRecipient

FeeBps

FeeBps returns the protocol fee applied to future deposits, in basis points of the deposit amount.

FeeOn

FeeOn previews the fee and credited amount for a deposit of amount at the CURRENT FeeBps.

BalanceOf

BalanceOf returns addr's claimable balance.

UsersTotal

UsersTotal returns the sum of all user balances.

FeesAccrued

FeesAccrued returns the fee pot awaiting withdrawal.

Liabilities

Liabilities returns UsersTotal() + FeesAccrued().

Held

Held returns the ugnot actually held at the realm address.

Surplus

Surplus returns Held() - Liabilities(): ugnot at the realm address that the ledger does not owe to anyone. Negative would indicate a conservation bug (see the invariant in the package doc).

Address

Render

Render shows configuration, totals, and the live conservation check.

assertAdmin

assertAdmin gates admin-only entrypoints; callers resolve identity at the crossing boundary and pass the address down.

send

send moves amount ugnot from the realm to \`to\`. Callers must have debited the ledger first (checks-effects-interactions); a panic here aborts the transaction, reverting the debit with it.

itoa