Commit a difficulty

post/mining/commitmentapi_key

Registers this miner with diff as its first commitment, or replaces its commitment with diff. The response gives the heights the new commitment acts at.

A registration locks 0.001 ERG in this miner's data box and pays a 0.001 ERG network fee. A change pays the network fee.

Refused with 409 while state.autoCommit is on, since it keeps the commitment at stratum.diff.

Request body

CommitmentRequest · application/json

diffstringrequired
A number and one of K, M, G, T or P, as stratum.diff is written.

Responses

200The transaction was sent. With `outcome` uncertain the node's answer was lost and it may still confirm: read `GET /mining/commitment` before sending again.CommitmentResult▶

txIdstringrequired
kindstringrequired
one ofregistrationchange
outcomestringrequired
The node's answer. uncertain means it was lost and the transaction may still confirm.
one ofaccepteduncertain
scorestringrequired
decimal string
diffstringrequired
sentAtHeightintegerrequired
The tip the transaction was built at.
declaredHeightintegerrequired
servedFromHeightintegerrequired
The first block the stratum mines at this score.
inForceFromHeightintegerrequired
The first height whose rollups judge NISPs against this commitment.
replaceableFromHeightintegerrequired
The first tip the next change can be sent from.

400Malformed body, a `diff` that does not parse, or a `diff` that is already the newest commitment.ApiError▶

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

403The api_key header is missing or wrong.ApiError▶

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

409`state.autoCommit` is on, an earlier registration or change has not settled, another request is being sent, or the chain moved between the read and the send. Read `GET /mining/commitment` and retry.ApiError▶

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

422The newest commitment cannot be replaced yet, `state.disableTransforms` is on, the wallet cannot pay, or the node refused the transaction.ApiError▶

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

503The commitment or the Miner Dictionary could not be read, or the transaction engine did not answer.ApiError▶

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

defaultErrorApiError▶

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

← PreviousGet difficulty commitment Next →Get best NISP at height