This client's payouts and claims
/stats/mining/paymentsEvery payout to this client's primary mining address in retained history, newest first, each with what it was made of and the rollup it came from. Alongside them, the rollups this client has a claim in that have not paid yet, and the fraud proofs it was paid for.
Payouts break the output into reward, refunded bond and surplus. Only reward and surplus
are earnings — the bond is this client's own deposit coming back. score / rollupScore is the
share of the block this client earned, out of rollupMiners miners.
Claims follow each unpaid rollup through holding, evaluation and payout. The expected
reward is exact once the payout is ready and projected during evaluation, where a fraud proof
against another miner can still raise it. Holding has no projection. A slashed claim lost its
bond to a fraud proof and will never pay.
Bounties are fraud proofs this client submitted. Each pays the slashed miner's bond.
Payouts are paged by offset and limit in the order sort and order choose, and total
counts every retained payout. A payout confirmed between two requests shifts later pages by
one. Claims and bounties always come in full.
Query parameters
offsetinteger · int32default 0Payouts to skip, counting from the newest.
limitinteger · int32default 100Payouts per page.
sortstringdefault "paid"paid | minedpaidorders by the block that paid each payout,minedby the block its rollup was mined in. Paid time needs no option of its own: block timestamps rise with height, so it always agrees withpaid.orderstringdefault "desc"desc | ascdescputs the highest first.
Responses
200One page of payouts, with every open claim and bounty.PaymentLedgerPage▶
holdingBlocksintegerrequiredBlocks a rollup takes submissions for, counted from the block that mined it.
evaluationBlocksintegerrequiredBlocks a rollup stays open to fraud proofs, counted from the block evaluation started in.
statusstringrequiredHow far collection has got.
readymeans it reached the last checked chain tip.catching-upandrecoveringmean replay or reorg work is still running,stalemeans the last successful check is too old, andunavailablemeans collection failed. Ondisabledorloadingthe numbers are not evidence that the period was quiet.one ofdisabledloadingreadystaleunavailablecatching-uprecovering▶
sourceMiningCursorrequiredThe processed chain point a statistics result was read from.
heightintegerrequiredblockIdstringrequiredparentIdstringrequiredtimestampinteger · int64requiredThe block's own timestamp in Unix milliseconds, not the time the client read it.
retainedFromHeightintegerrequiredFirst retained height. Nothing older is listed.
▶
paymentsLocalPayment[]requiredIn the order
sortandordergive.transactionIdstringrequiredoutputIdstringrequiredpayoutBoxIdstringrequiredrollupNftstringrequiredNFT minted from the original collateral box id.
minedBlockIdstringrequiredThe block holding the rollup genesis, even when that block is older than retained history.
minedHeightintegerrequiredminedTimestampinteger · int64requiredTimestamp of
minedBlockId, in Unix milliseconds. Withtimestamp, how long the payout took.blockIdstringrequiredThe block holding this payout transaction.
heightintegerrequiredtimestampinteger · int64requiredgrossNanoErgstringrequiredExact output value, including the refunded bond and any surplus.
scorestringrequiredAn exact nonnegative integer as a decimal string. Parse it without going through a float.
decimal stringrewardNanoErgstringrequiredThis client's share of the rollup's ERG reward. Earnings.
bondNanoErgstringrequiredThe submission bond coming back. Not earnings.
surplusNanoErgstringrequiredAnything the output carried beyond reward and bond. Earnings; usually zero.
litTokenIdstringrewardLitstringrequiredLIT the protocol owed this share.
receivedLitstringrequiredLIT the output actually carried. Never less than
rewardLit.rollupScorestringrequiredThe whole rollup's score.
score / rollupScoreis this client's share.rollupMinersintegerrequiredMiners the rollup paid.
rollupRewardNanoErgstringrequiredThe ERG reward the whole rollup distributed, bonds excluded.
rollupRewardLitstringrequiredThe LIT the whole rollup distributed.
offsetintegerrequiredThe offset this page starts at.
totalintegerrequiredEvery payout in retained history. Pages end at
offset + limit >= total.sortstringrequiredThe ordering this page is in.
one ofpaidminedorderstringrequiredone ofdescasc▶
claimsPaymentClaim[]requiredUnpaid claims, newest submission first.
rollupNftstringrequiredminedBlockIdstringrequiredminedHeightintegerrequiredphasestringrequiredThe furthest transition seen.
holdingstill takes submissions,evaluationis open to fraud proofs,payouthas a fixed reward waiting to be sent.slashedwill never pay.one ofholdingevaluationpayoutslashedsubmittedHeightintegerrequiredsubmittedTimestampinteger · int64requiredsubmissionTransactionIdstringrequiredscorestringrequiredAn exact nonnegative integer as a decimal string. Parse it without going through a float.
decimal stringbondNanoErgstringrequiredThe bond this client posted. Comes back with the payout, or is lost if slashed.
phaseHeightintegerrequiredHeight of the transition that set
phase.phaseTimestampinteger · int64requiredrollupMinersintegerMiners still in the rollup. Absent while holding.
rollupScorestringThe rollup's total score. Absent while holding.
rewardNanoErgstringExpected ERG reward, bond excluded. Absent while holding or slashed.
rewardLitstringExpected LIT. Only known once the payout is ready.
rewardBasisstringexactonce the payout is ready;projectedduring evaluation.one ofexactprojectedslashedTransactionIdstringThe fraud proof that removed this client's entry.
payoutReadyFromintegerFirst height the payout can become ready. Exact during evaluation; during holding it assumes evaluation starts the moment holding ends, so it is the earliest possible. Absent once the payout is ready, and when slashed.
▶
bountiesFraudBounty[]requiredNewest first.
transactionIdstringrequiredrollupNftstringrequiredminedHeightintegerrequiredheightintegerrequiredtimestampinteger · int64requiredbondNanoErgstringrequiredThe slashed bond, paid to this client.
claimedScorestringrequiredThe score the slashed miner had claimed.
minerHashstringHash identifying the slashed entry. Not a miner address.
400`limit` is outside 1–500, `offset` is negative, or `sort` or `order` is not one of its values.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503History is loading, disabled, busy, or unreadable. Check `mining.status` in /stats before retrying.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description