Package hearth escrows a single ecosystem raise in ugnot and later splits revenue deposits across contributors by pai...
Package hearth escrows a single ecosystem raise in ugnot and later splits revenue deposits across contributors by paid share.
Contribute accepts ugnot while the raise is open. Each call must be at least MinContribute. The running total cannot pass HardCap; excess ugnot is sent back to the caller. Hitting HardCap closes the raise.
Raise principal (WithdrawRaise) and revenue (DepositRevenue) are separate ledgers. Withdrawing the raise does not change shares. After Close, DepositRevenue opens an epoch. Settle pays the next batch of unpaid wallets for that epoch. Claim pays one caller. Integer dust stays in the realm and is not withdrawable.
1const (
2 // MinContribute is the smallest ugnot a Contribute call may accept (500 GNOT).
3 MinContribute int64 = 500_000_000
4 // HardCap is the maximum ugnot the raise will accept (150_000 GNOT).
5 HardCap int64 = 150_000_000_000
6 // MaxSeats is HardCap / MinContribute. A new address past this panics.
7 MaxSeats int = 300
8 // MaxSettle is the most wallets one Settle call will pay.
9 MaxSettle int = 20
10)AdminCall reports whether the direct caller is the operator.
Claim pays the caller their unpaid share of one epoch.
ClaimReward pays the caller the ugnot already credited to them.
Claimed reports whether addr was already paid or skipped for epoch.
Close ends the raise before the cap so revenue epochs can start.
Closed reports whether new contributions are rejected.
Contribute accepts ugnot toward the raise.
DepositRevenue opens one epoch with the attached ugnot. Raise must be closed.
DepositReward takes the operator's ugnot and credits each contributor got * seat / raised. Rounding dust stays withdrawable. Principal is unchanged. MinMonthlyUgnot is the monthly floor, not a cap. A larger deposit uses the same split.
EpochAmount returns the ugnot deposited for a 1-based epoch.
EpochCount is the number of revenue deposits.
HandleOf returns the stored X handle, or empty.
Init binds the operator to the calling EOA. Once.
MinMonthlyUgnot is 5% of contributed ugnot. Deposits may be larger. A larger deposit still splits by contribution share.
PlanAccept is the contribute decision. A non-empty reason means the call must revert.
PoolShare is the ugnot still owed to addr from deposits already split.
RaiseEndUnix is the first second contributions are rejected, UTC.
RaiseStartUnix is the first second contributions are accepted, UTC.
Raised is the ugnot accepted into shares.
RaisedBank is principal still held for WithdrawRaise.
Ready reports whether Init has run.
Render shows the raise terms and totals. It does not list every seat.
RevenueBank is deposited revenue not yet paid out, including dust.
RewardBank is the operator reward pool still on the realm.
RewardOwed is ugnot credited to contributors and not yet claimed.
SeatCount is the number of contributor addresses.
SeatOf returns ugnot contributed by addr, or 0.
SetHandle records a public X handle for the caller. Same handle is a no-op.
Settle pays up to maxN unpaid seats for one epoch, in address order. Returns how many seats it marked this call.
ShareOf is the ugnot addr would receive for epoch. Zero if none.
Summary is a single line for clients: admin|raised|raisedBank|revenueBank|closed|seats|epochs|cap|min|rewardDust|rewardOwed
TransferAdmin moves the operator. The raise ledger is unchanged.
UserCall reports whether this crossing was a direct EOA MsgCall.
WithdrawRaise sends the operator the raise principal still on the realm. It does not touch revenue and does not change shares.
WithdrawReward sends unallocated rounding dust back to the operator. amt 0 withdraws all dust. Credited shares cannot be withdrawn.
