fee_split state

Split

Split holds a fee-splitting configuration with percentage-based shares denominated in basis points (1 bp = 0.01%, 10000 bp = 100%).

MaxRecipients

MaxSplitsPerOwner

MaxRenderSplits

MaxFeeBps

MaxRecipientListLen

MaxShareListLen

Denom

MaxDepositAmount

splits

splitIDs

// insertion-ordered for deterministic Render

ownerSplits

nextID

feeBps

feeAdmin

// deployer; can set the fee and claim accrued fees

pendingFeeAdmin

// two-step handover, must AcceptFeeAdmin

feesAccrued

feesClaimed

init.18

caller

formatPct

mustGetSplit

mustGetActive

boolStr

parseBasisPoints

parseAddresses

validateRecipients

sortedBalanceAddrs

sortedBalanceAddrs returns the balance-map keys in deterministic order, so panics and renders never depend on map iteration order.

rejectStraySend

rejectStraySend aborts when coins are attached to a call that does not accept them — the abort reverts the transfer back to the sender instead of stranding the coins on the realm address (re-audit P3). Direct bank transfers to the realm address remain unrecoverable by design.

CreateSplit

CreateSplit registers a new split. The caller becomes the owner. Recipients and shares are comma-separated; shares are in basis points summing to 10000.

Deposit

Deposit distributes the coins sent with the call across recipients proportionally. DEPLOYMENT PRECONDITION (round-4 audit): on a network with restricted/token-locked ugnot transfers, the bank gate is SENDER-whitelist-based — a whitelisted user's Deposit succeeds but Claim sends FROM this realm's (non-whitelisted) address and reverts. Funds would flow in and not out until the restriction lifts. Deploy only to networks with unrestricted ugnot, or have governance whitelist this realm's address first. LIMITATION (round-3 audit, documented): only direct user calls can deposit. A DAO/realm treasury has NO deposit path — a realm-routed call is refused, and a bare banker send to this realm's address is an unrecoverable donation. Realm treasuries must route deposits through a user account. The deposit is the ACTUAL attached send — exactly one coin of Denom — so balances are always backed by funds this realm holds. Direct user calls only: a deposit routed through an intermediary realm would deliver its coins to that realm, not here, and must be rejected. Rounding dust goes to the highest-share recipient (deterministic, not order-dependent).

Claim

Claim withdraws the caller's accumulated balance and SENDS the coins to the caller's address. Balance is zeroed before the transfer. Claims remain possible on frozen splits, and by ex-recipients whose accrued balance predates a share update.

UpdateShares

UpdateShares replaces recipients and shares. Owner only. Not if frozen. Removed recipients keep any accrued balance and can still Claim it.

TransferOwnership

TransferOwnership hands control to a new owner. The per-owner split slot moves with it: the old owner's count is freed and the new owner's is consumed (and must be under the limit).

Freeze

Freeze permanently locks shares and stops further deposits. One-way, cannot be undone. Claims remain possible.

Archive

Archive marks a fully-claimed split as archived. Only the owner can archive, and only if EVERY balance — including balances held by ex-recipients removed in a share update — is zero, since archiving blocks all further claims. Cannot be undone.

SetFee

SetFee sets the protocol fee in basis points, admin only, hard-capped at MaxFeeBps. Applies to FUTURE deposits only.

ClaimFees

ClaimFees sends all accrued protocol fees to the fee admin.

NominateFeeAdmin

NominateFeeAdmin begins a two-step admin handover; the nominee must AcceptFeeAdmin. Pass "" to clear a pending nomination. Two-step because the admin address is a funds destination: a typo'd one-step transfer would strand all future fees.

AcceptFeeAdmin

AcceptFeeAdmin completes the handover; only the nominee can accept.

GetFeeInfo

GetFeeInfo returns the current fee configuration and accrued total.

GetSplitInfo

GetSplitInfo returns a human-readable summary.

GetClaimable

GetClaimable returns claimable balance for an address.

Render

Render returns a markdown overview. Never panics.