gnomic_airdrop state

Ownable

Ownable holds the administrative authority over the campaign.

tokenKey

tokenKey is the key of the distributed token. It is a variable rather than a constant only so that tests can register one of their own; in production it keeps the config.gno value for the realm's whole life.

claimWindowSeconds

claimWindowSeconds is a variable for the same reason: tests shrink or widen it. In production it keeps the config.gno value for the realm's whole life.

withdrawCooldownSeconds

withdrawCooldownSeconds likewise: tests switch it off, production keeps it.

root

// Merkle root of the current campaign

leafCount

// total number of leaves (needed to verify)

endHeight

// block past which no one can claim (0 = no limit)

epoch

// bumped on every new campaign

claimed

campaignStart

outstanding

sealed

totalClaimed

// total actually paid out

totalGranted

// total granted (including what has not vested yet)

totalBurned

// total destroyed: instant exits, renunciations, settlement

settledBurned

// burned by SettleUnclaimed

settledToFund

// sent to the ecosystem fund by SettleUnclaimed

totalToFund

// sent to the ecosystem fund by voluntary forfeits

claimCount

realmAddr

grant

grant is the entitlement a beneficiary obtained in a campaign. It always holds that total == withdrawn + burned + toFund + (not yet released). Grants are keyed by address ALONE, not by "epoch:address": tying the key to the epoch made the previous campaign's grants unreachable as soon as a new one opened — the beneficiary could no longer withdraw and the tokens stayed counted in outstanding, so not even Sweep could recover them.

SealEvent

SettleEvent

ClaimEvent

WithdrawEvent

ForfeitEvent

CampaignEvent

bpsDenominator

init.28

SetCampaign

SetCampaign publishes a new campaign: rootHex is the Merkle root in hex (32 bytes), total the number of leaves in the tree, end the deadline block (0 = no deadline). Publishing a new campaign resets the claim history: whoever appears on both lists can claim again. That is deliberate — it allows recurring airdrops on the same realm without a redeploy.

CloseCampaign

CloseCampaign stops claims immediately.

SealCampaign

SealCampaign closes off the possibility of opening new campaigns forever. Irreversible: no code path sets sealed back to false. Call it once the published root is the final one. Until then the owner can fix a mistake by republishing the root; afterwards the airdrop is provably one-off and anyone can check with IsSealed().

SettleUnclaimed

SettleUnclaimed disposes of whatever was never claimed, once the claim window has elapsed: half is burned, the other half goes to the team fund. The rule is enforced here rather than promised: there is no Sweep and no BurnRemaining, so the owner cannot pocket the residue nor destroy all of it. Settlement waits for the window even if CloseCampaign stopped claims earlier, and grants already made stay untouchable — only the free part (balance minus outstanding) is settled. Anyone may call it: it is a public service, not a privilege.

TransferOwnership

TransferOwnership hands administration of the campaign over.

Claim

Claim pays amount tokens to the caller, if the Merkle proof (index, auntsHex) shows that "\<caller>|\<amount>" is a leaf of the published tree. auntsHex is the hex concatenation of the sibling hashes, 32 bytes each, just as produced by tools/merkle.

claimFor

claimFor is the body of Claim. It is unexported on purpose: a transaction can only reach exported functions, so from outside the realm the only way in is Claim, which always uses the caller's own address. The tests, being in the same package, still exercise the registration logic directly.

ClaimInstant

ClaimInstant is the first of the two alternatives to Claim: the instant share (instantBps, 30%) is paid at once and the rest (70%) is given up the same way a forfeit is — half burned, half to the ecosystem fund — whenever it is chosen, even after the whole grant would have vested. The share is larger than Claim's immediate 10% on purpose: it makes the shortcut a real choice rather than a punishment. It cannot be undone and suits someone who prefers a certain fraction today to the whole a year from now. The residue is destroyed, to every holder's benefit. Only the person concerned can choose it: there is no "on behalf of" form.

Forfeit

Forfeit is the second alternative to Claim: the beneficiary gives the grant up without taking anything. Half is burned, half goes to the ecosystem fund — the same split SettleUnclaimed applies to whoever never acted at all. The proof is still required and the grant is still recorded: without that, the same address could forfeit and then claim. The record makes it final. Only the person concerned can choose it: there is no "on behalf of" form.

immediateOf

immediateOf is the share Claim unlocks at once: immediateBps/10000 of total.

shareOf

shareOf is bps/10000 of total, in two steps to stay inside int64.

registerGrant

registerGrant checks the proof and records the grant. It transfers nothing.

Withdraw

Withdraw transfers to the caller the vested, not-yet-withdrawn part.

WithdrawFor

WithdrawFor is like Withdraw but on another beneficiary's behalf: the tokens still go to beneficiary, whoever sends the transaction only pays the gas.

release

release transfers the vested share. It is the public form: when there is nothing to withdraw it says so, instead of silently letting through a transaction that did nothing.

releaseIfAny

releaseIfAny is the internal form: it transfers whatever has vested and returns the amount, or 0 if nothing has vested yet. It serves the paths where "nothing to withdraw" is normal rather than an error: a claim whose immediate share is zero, and a forfeit, whose point is to burn the residue rather than to collect. Payouts are rate-limited: one every withdrawCooldownSeconds per grant, the claim itself counting as the first. The very first payout is never delayed.

vestedOf

vestedOf computes how much of a grant has vested: vested = immediate + rest * elapsed / duration where immediate is immediateBps/10000 of the total. The division is done in two steps (quotient and remainder) because rest\*elapsed would overflow int64 for large amounts: 1e13 \* 3.15e7 exceeds 9.2e18.

addSat

addSat adds without ever wrapping. These counters only grow, across every campaign, and nothing bounds them to the supply: a statistic that turns negative would be bad, one that blocks a withdrawal would be worse.

grantOf

Leaf

Leaf returns the canonical Merkle-leaf encoding for the (address, amount) pair. It must match byte for byte the one used by the off-chain generator.

RealmAddress

Balance

Balance is the token balance the realm currently holds.

Root

Root returns the current Merkle root in hex.

Epoch

Epoch is the number of the current campaign.

IsSealed

IsSealed reports whether the campaign has been sealed: if true, no new campaign can ever be opened.

LeafCount

LeafCount is the number of leaves in the published tree.

EndHeight

EndHeight is the deadline block (0 = no deadline).

IsOpen

IsOpen reports whether claims are currently accepted.

HasClaimed

HasClaimed reports whether addr has already claimed in the current campaign.

HasGrant

HasGrant reports whether addr holds a grant, from this campaign or an earlier one.

GrantEpoch

GrantEpoch returns the campaign in which addr obtained its grant.

VestingStartOf

VestingStartOf returns when vesting starts for addr's grant.

ClaimedAmount

ClaimedAmount returns addr's total grant, vested or not.

Vested

Vested returns how much of addr's grant has vested so far. A closed grant (instant exit or forfeit) will never vest anything more: it reports what was paid, not where the curve would be.

InstantBps

InstantBps is the share ClaimInstant pays at once, in hundredths of a percent.

Withdrawn

Withdrawn returns how much addr has already withdrawn.

Withdrawable

Withdrawable returns how much addr can withdraw right now.

NextWithdrawAt

NextWithdrawAt returns the unix time from which addr may withdraw again (0 when there is no grant, the grant is closed, or no cooldown is running).

WithdrawCooldown

WithdrawCooldown is the minimum interval between two payouts, in seconds.

BurnedOf

BurnedOf returns how much of addr's grant was destroyed.

FundOf

FundOf returns how much of addr's grant went to the ecosystem fund.

TotalToFund

TotalToFund is what voluntary forfeits sent to the ecosystem fund.

TotalBurned

TotalBurned is the total destroyed: instant exits, renunciations and the settlement of the unclaimed residue.

ClaimWindowEnd

ClaimWindowEnd is the moment (unix) claims stop being accepted for the current campaign; SettleUnclaimed becomes callable from then on.

EcosystemFund

SettledBurned

SettledBurned and SettledToFund report what SettleUnclaimed did.

SettledToFund

Outstanding

Outstanding is the total granted and not yet withdrawn: the part of the realm's balance that Sweep cannot touch.

TotalGranted

TotalGranted is the total of all grants made, vested or not.

VestingStart

VestingStart is the moment (unix) the CURRENT campaign's linear release runs from. Grants from earlier campaigns keep their own, readable with VestingStartOf.

VestingEnd

VestingEnd is the moment (unix) at which everything granted in the current campaign counts as fully vested.

ImmediateBps

ImmediateBps is the share unlocked at once, in hundredths of a percent.

TotalClaimed

TotalClaimed is the total actually transferred to beneficiaries.

ClaimCount

ClaimCount is the number of successful claims.

isOpen

Render

sealLabel

sealLabel describes in Render whether the airdrop is provably one-off.

statusLabel

defaultTokenKey

campaignName

immediateBps

instantBps

vestingSeconds

defaultClaimWindowSeconds

defaultWithdrawCooldownSeconds

ecosystemFundAddress

adminAddress