/v0/open-and-issuing-mining-rounds

All current open and issuing mining rounds, if the request is empty; passing contract IDs in the request can reduce the response data for polling/client-cache-update efficiency.

POST /v0/open-and-issuing-mining-rounds

/v0/open-and-issuing-mining-rounds

cURL

curl --request POST \
  --url https://example.com/api/scan/v0/open-and-issuing-mining-rounds \
  --header 'Content-Type: application/json' \
  --data '
{
  "cached_open_mining_round_contract_ids": [
    "<string>"
  ],
  "cached_issuing_round_contract_ids": [
    "<string>"
  ]
}
'

200

{
  "time_to_live_in_microseconds": 123,
  "open_mining_rounds": {},
  "issuing_mining_rounds": {}
}

Body

application/json

cached_open_mining_round_contract_ids · string[] · required

The contract IDs for open_mining_rounds in the response the caller knows about. If unsure, an empty array is fine; only a performance penalty is incurred.

cached_issuing_round_contract_ids · string[] · required

The contract IDs for issuing_mining_rounds in the response the caller knows about. If unsure, an empty array is fine; only a performance penalty is incurred.

Response

200 - application/json

ok

Daml contracts of the templates Splice.Round.OpenMiningRound and Splice.Round.IssuingMiningRound representing rounds for which rewards can be registered or are currently being computed, respectively. Contract IDs in the input serve as input sets for the two MaybeCachedContractWithStateMaps as described for that structure for open_mining_rounds and issuing_mining_rounds.

time_to_live_in_microseconds · integer · required

Suggested cache TTL for the response; this should expire before the opensAt of any open rounds that may not be in this response yet.

open_mining_rounds · object · required

Always created with respect to an input set of contract IDs. If an input contract ID is absent from the keys of this map, that contract should be considered removed by the caller; if present, contract may be empty, reflecting that the caller should already have the full contract data for that contract ID. Contracts not present in the input set will have full contract data. domain_id is always up-to-date; if undefined the contract is currently unassigned to a synchronizer, i.e. "in-flight".

Show child attributes

issuing_mining_rounds · object · required

Always created with respect to an input set of contract IDs. If an input contract ID is absent from the keys of this map, that contract should be considered removed by the caller; if present, contract may be empty, reflecting that the caller should already have the full contract data for that contract ID. Contracts not present in the input set will have full contract data. domain_id is always up-to-date; if undefined the contract is currently unassigned to a synchronizer, i.e. "in-flight".

Show child attributes