Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt

Use this file to discover all available pages before exploring further.

Templates

template ClosedMiningRound
A record that a specific mining round has been closed, which can be used to archive expired rewards. Signatory: dso
FieldTypeDescription
dsoParty
roundRound
issuancePerValidatorRewardCouponDecimal
issuancePerFeaturedAppRewardCouponDecimal
issuancePerUnfeaturedAppRewardCouponDecimal
issuancePerSvRewardCouponDecimal
optIssuancePerValidatorFaucetCouponOptional DecimalIntroduced in CIP-3
  • Choice Archive Controller: dso Returns: () (no fields)
template IssuingMiningRound
A mining round for whose rewards amulets are being issued. Signatory: dso
FieldTypeDescription
dsoParty
roundRound
issuancePerValidatorRewardCouponDecimal
issuancePerFeaturedAppRewardCouponDecimal
issuancePerUnfeaturedAppRewardCouponDecimal
issuancePerSvRewardCouponDecimal
opensAtTimeTime after which rewards from this mining round can be collected
targetClosesAtTimeTime when this round is expected to close during standard DSO. The round SHOULD NOT be archived before this time.
optIssuancePerValidatorFaucetCouponOptional DecimalIntroduced in CIP-3
  • Choice Archive Controller: dso Returns: () (no fields)
template OpenMiningRound
A mining round for which new rewards can be registered. Note that multiple mining rounds can be open at the same time to give some time for propagating a new open round, while still registering rewards against the previous open round. Signatory: dso
FieldTypeDescription
dsoParty
roundRound
amuletPriceDecimal
opensAtTimeTime after which transfers can use this mining round
targetClosesAtTimeTime when this round is expected to be closed as part of standard DSO. The round SHOULD NOT be archived before this time.
issuingForRelTimeTimepoint on the issuance curve that was used to determing the issuance configuration for this round.
transferConfigUsdTransferConfig USDConfiguration determining the fees and limits in USD for Amulet transfers
issuanceConfigIssuanceConfigConfiguration for issuance of this round.
tickDurationRelTimeDuration of a tick, which is the duration of half a round.
  • Choice Archive Controller: dso Returns: () (no fields)
  • Choice OpenMiningRound_Fetch
    Controller: p Returns: OpenMiningRound
    FieldTypeDescription
    pParty
template SummarizingMiningRound
A mining round for which the total sum of registered rewards is being computed. Rewards can no longer be registered aginst such a round. Signatory: dso
FieldTypeDescription
dsoParty
roundRound
amuletPriceDecimal
issuanceConfigIssuanceConfig
tickDurationRelTime
  • Choice Archive Controller: dso Returns: () (no fields)

Functions

getIssuingMiningRoundIssuancePerValidatorFaucetCoupon : IssuingMiningRound -> DecimalAccessor with defaulting for the optional issuancePerValidatorFaucetCoupon field
getClosedMiningRoundIssuancePerValidatorFaucetCoupon : ClosedMiningRound -> DecimalAccessor with defaulting for the optional issuancePerValidatorFaucetCoupon field