Get candidate settings

get/mining/candidate

The stratum.candidate settings that decide what this client's blocks carry besides the genesis transaction, which collateral box funds them, and when a served job is replaced mid-block. Values are the ones the client started with.

Responses

200The candidate settings in forceCandidateSettings▶

blockTransactionsbooleanrequired
Whether this client's blocks carry transactions besides the genesis transaction. When false, no source is asked.
▶
sourcesCandidateSourceSettings[]required
Every transaction source, in the order candidates ask them.
- namestringrequired
  one ofrollupsemissionsrentlithosdexergodex
- enabledbooleanrequired
  The source's own enabled setting.
- activebooleanrequired
  Whether candidates ask this source for transactions: blockTransactions is on, the source is enabled with maxTxs above 0 and, for lithosdex and ergodex, the matching batching block is enabled.
- maxTxsintegerrequired
  Transactions this source may place in one block, carried ancestors included.
- maxBytesinteger · int64required
  Serialized bytes this source may claim.
- maxCostinteger · int64required
  Validation cost this source may claim.
blockSharenumber · doublerequired
Fraction of the node's block size and cost limits the whole package may claim.
waitForBlockPackagebooleanrequired
Whether the first job for a height waits, up to genesisWaitMs, for the sources before it is sent.
genesisWaitMsintegerrequired
Milliseconds to wait for the genesis transaction before a solo job is sent instead.
blockTxTimeoutintegerrequired
Milliseconds the sources have to build their transactions.
mempoolRefreshMsintegerrequired
Milliseconds between mid-block package rebuilds. 0 turns them off.
minCandidateChangeRevenueinteger · int64required
nanoERG a rebuilt package must add over the served one before the job changes mid-block.
refreshForProtocolTxsbooleanrequired
Whether a rebuilt package that adds rollup or emission transactions also changes the job mid-block.
minNewProtocolTxsintegerrequired
Rollup or emission transactions the rebuilt package must add before refreshForProtocolTxs changes the job.
collateralStrategystringrequired
How the collateral box is picked. highestFee takes the highest priority fee until a box reaches clearanceAge; random draws from every usable box.
one ofhighestFeerandom
clearanceAgeintegerrequired
With highestFee, blocks a collateral box may stay live before the oldest is taken regardless of fee. Ignored by random.
pinnedInputsintegerrequired
Wallet boxes set aside to fund transactions that need a wallet input inside this client's own block.

defaultErrorApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description

← PreviousGet Stratum information Next →Get difficulty commitment

Get candidate settings

get/mining/candidate

Responses

200The candidate settings in forceCandidateSettings▶

blockTransactionsbooleanrequired
Whether this client's blocks carry transactions besides the genesis transaction. When false, no source is asked.
▶
sourcesCandidateSourceSettings[]required
Every transaction source, in the order candidates ask them.
- namestringrequired
  one ofrollupsemissionsrentlithosdexergodex
- enabledbooleanrequired
  The source's own enabled setting.
- activebooleanrequired
  Whether candidates ask this source for transactions: blockTransactions is on, the source is enabled with maxTxs above 0 and, for lithosdex and ergodex, the matching batching block is enabled.
- maxTxsintegerrequired
  Transactions this source may place in one block, carried ancestors included.
- maxBytesinteger · int64required
  Serialized bytes this source may claim.
- maxCostinteger · int64required
  Validation cost this source may claim.
blockSharenumber · doublerequired
Fraction of the node's block size and cost limits the whole package may claim.
waitForBlockPackagebooleanrequired
Whether the first job for a height waits, up to genesisWaitMs, for the sources before it is sent.
genesisWaitMsintegerrequired
Milliseconds to wait for the genesis transaction before a solo job is sent instead.
blockTxTimeoutintegerrequired
Milliseconds the sources have to build their transactions.
mempoolRefreshMsintegerrequired
Milliseconds between mid-block package rebuilds. 0 turns them off.
minCandidateChangeRevenueinteger · int64required
nanoERG a rebuilt package must add over the served one before the job changes mid-block.
refreshForProtocolTxsbooleanrequired
Whether a rebuilt package that adds rollup or emission transactions also changes the job mid-block.
minNewProtocolTxsintegerrequired
Rollup or emission transactions the rebuilt package must add before refreshForProtocolTxs changes the job.
collateralStrategystringrequired
How the collateral box is picked. highestFee takes the highest priority fee until a box reaches clearanceAge; random draws from every usable box.
one ofhighestFeerandom
clearanceAgeintegerrequired
With highestFee, blocks a collateral box may stay live before the oldest is taken regardless of fee. Ignored by random.
pinnedInputsintegerrequired
Wallet boxes set aside to fund transactions that need a wallet input inside this client's own block.

defaultErrorApiError▶

errorintegerrequired
Error code
reasonstringrequired
Error message explaining the reason of the error
detailstringrequirednullable
Detailed error description