Splice.ValidatorLicense

Documentation for Splice.ValidatorLicense

Templates

template ValidatorFaucetCoupon

Deprecated: use ValidatorLicense_RecordValidatorLivenessActivity instead, as that one can be expired without requiring a confirmation from the validator node.

Signatory: dso, validator

Field	Type	Description
dso	Party
validator	Party
round	Round

• Choice Archive

  Controller: dso, validator

  Returns: ()

  (no fields)

• Choice ValidatorFaucetCoupon_DsoExpire

  Controller: dso

  Returns: ValidatorFaucetCoupon_DsoExpireResult

  Field	Type	Description
  closedRoundCid	ContractId ClosedMiningRound

template ValidatorLicense

The existence of a validator license is what makes a validator an (onboarded) validator.

Signatory: dso

Field	Type	Description
validator	Party	The validator (party) that this license is about.
sponsor	Party	The SV node that sponsored the onboarding.
dso	Party	The party representing the operations of the decentralized synchronizer.
faucetState	Optional FaucetState
metadata	Optional ValidatorLicenseMetadata
lastActiveAt	Optional Time	Last time this validator was active. Tracked to get a view on the set of validator nodes that are up and running.

• Choice Archive

  Controller: dso

  Returns: ()

  (no fields)

• Choice ValidatorLicense_Cancel

  Controller: validator

  Returns: ValidatorLicense_CancelResult

  Field	Type	Description
  reason	Text

• Choice ValidatorLicense_ReceiveFaucetCoupon

  Controller: validator

  Returns: ValidatorLicense_ReceiveFaucetCouponResult

  Field	Type	Description
  openRoundCid	ContractId OpenMiningRound

• Choice ValidatorLicense_RecordValidatorLivenessActivity

  Controller: validator

  Returns: ValidatorLicense_RecordValidatorLivenessActivityResult

  Field	Type	Description
  openRoundCid	ContractId OpenMiningRound

• Choice ValidatorLicense_ReportActive

  Choice for validators with disabled wallets to report themselves as active. Validators that receive amulets will report through ReceiveFaucetCoupon.

  Controller: validator

  Returns: ValidatorLicense_ReportActiveResult

  (no fields)

• Choice ValidatorLicense_UpdateMetadata

  Controller: validator

  Returns: ValidatorLicense_UpdateMetadataResult

  Field	Type	Description
  version	Text
  contactPoint	Text

• Choice ValidatorLicense_Withdraw

  Controller: dso

  Returns: ValidatorLicense_WithdrawResult

  Field	Type	Description
  reason	Text

template ValidatorLivenessActivityRecord

A copy of the ValidatorFaucetCoupon template with the only difference being that the validator is an observer instead of signatory. This is to allow to expire the coupon without the validator’s involvement.

Signatory: dso

Field	Type	Description
dso	Party
validator	Party
round	Round

• Choice Archive

  Controller: dso

  Returns: ()

  (no fields)

• Choice ValidatorLivenessActivityRecord_DsoExpire

  Controller: dso

  Returns: ValidatorLivenessActivityRecord_DsoExpireResult

  Field	Type	Description
  closedRoundCid	ContractId ClosedMiningRound

Data Types

data FaucetState

FaucetState

Field	Type	Description
firstReceivedFor	Round	The first round for which a coupon was received.
lastReceivedFor	Round	The last round for which a coupon was received.
numCouponsMissed	Int	The number of rounds for which no coupon was received.

instance Eq FaucetState

instance Show FaucetState

instance GetField “faucetState” ValidatorLicense (Optional FaucetState)

instance GetField “firstReceivedFor” FaucetState Round

instance GetField “lastReceivedFor” FaucetState Round

instance GetField “numCouponsMissed” FaucetState Int

instance SetField “faucetState” ValidatorLicense (Optional FaucetState)

instance SetField “firstReceivedFor” FaucetState Round

instance SetField “lastReceivedFor” FaucetState Round

instance SetField “numCouponsMissed” FaucetState Int

data ValidatorFaucetCoupon_DsoExpireResult

ValidatorFaucetCoupon_DsoExpireResult

instance HasExercise ValidatorFaucetCoupon ValidatorFaucetCoupon_DsoExpire ValidatorFaucetCoupon_DsoExpireResult

instance HasFromAnyChoice ValidatorFaucetCoupon ValidatorFaucetCoupon_DsoExpire ValidatorFaucetCoupon_DsoExpireResult

instance HasToAnyChoice ValidatorFaucetCoupon ValidatorFaucetCoupon_DsoExpire ValidatorFaucetCoupon_DsoExpireResult

data ValidatorLicenseMetadata

ValidatorLicenseMetadata

Field	Type	Description
lastUpdatedAt	Time	The last time the validator metadata was updated
version	Text	The version the validator is currently on
contactPoint	Text	A contact point that can be used to reach the operator of the validator in case there are issues with the validator. This can be an email address or a slack user name.

instance Eq ValidatorLicenseMetadata

instance Show ValidatorLicenseMetadata

instance GetField “contactPoint” ValidatorLicenseMetadata Text

instance GetField “lastUpdatedAt” ValidatorLicenseMetadata Time

instance GetField “metadata” ValidatorLicense (Optional ValidatorLicenseMetadata)

instance GetField “version” ValidatorLicenseMetadata Text

instance SetField “contactPoint” ValidatorLicenseMetadata Text

instance SetField “lastUpdatedAt” ValidatorLicenseMetadata Time

instance SetField “metadata” ValidatorLicense (Optional ValidatorLicenseMetadata)

instance SetField “version” ValidatorLicenseMetadata Text

data ValidatorLicense_CancelResult

ValidatorLicense_CancelResult

instance HasExercise ValidatorLicense ValidatorLicense_Cancel ValidatorLicense_CancelResult

instance HasFromAnyChoice ValidatorLicense ValidatorLicense_Cancel ValidatorLicense_CancelResult

instance HasToAnyChoice ValidatorLicense ValidatorLicense_Cancel ValidatorLicense_CancelResult

data ValidatorLicense_ReceiveFaucetCouponResult

ValidatorLicense_ReceiveFaucetCouponResult

Field	Type	Description
licenseCid	ContractId ValidatorLicense
couponCid	ContractId ValidatorFaucetCoupon

instance GetField “couponCid” ValidatorLicense_ReceiveFaucetCouponResult (ContractId ValidatorFaucetCoupon)

instance GetField “licenseCid” ValidatorLicense_ReceiveFaucetCouponResult (ContractId ValidatorLicense)

instance SetField “couponCid” ValidatorLicense_ReceiveFaucetCouponResult (ContractId ValidatorFaucetCoupon)

instance SetField “licenseCid” ValidatorLicense_ReceiveFaucetCouponResult (ContractId ValidatorLicense)

instance HasExercise ValidatorLicense ValidatorLicense_ReceiveFaucetCoupon ValidatorLicense_ReceiveFaucetCouponResult

instance HasFromAnyChoice ValidatorLicense ValidatorLicense_ReceiveFaucetCoupon ValidatorLicense_ReceiveFaucetCouponResult

instance HasToAnyChoice ValidatorLicense ValidatorLicense_ReceiveFaucetCoupon ValidatorLicense_ReceiveFaucetCouponResult

data ValidatorLicense_RecordValidatorLivenessActivityResult

ValidatorLicense_RecordValidatorLivenessActivityResult

Field	Type	Description
licenseCid	ContractId ValidatorLicense
couponCid	ContractId ValidatorLivenessActivityRecord

instance GetField “couponCid” ValidatorLicense_RecordValidatorLivenessActivityResult (ContractId ValidatorLivenessActivityRecord)

instance GetField “licenseCid” ValidatorLicense_RecordValidatorLivenessActivityResult (ContractId ValidatorLicense)

instance SetField “couponCid” ValidatorLicense_RecordValidatorLivenessActivityResult (ContractId ValidatorLivenessActivityRecord)

instance SetField “licenseCid” ValidatorLicense_RecordValidatorLivenessActivityResult (ContractId ValidatorLicense)

instance HasExercise ValidatorLicense ValidatorLicense_RecordValidatorLivenessActivity ValidatorLicense_RecordValidatorLivenessActivityResult

instance HasFromAnyChoice ValidatorLicense ValidatorLicense_RecordValidatorLivenessActivity ValidatorLicense_RecordValidatorLivenessActivityResult

instance HasToAnyChoice ValidatorLicense ValidatorLicense_RecordValidatorLivenessActivity ValidatorLicense_RecordValidatorLivenessActivityResult

data ValidatorLicense_ReportActiveResult

ValidatorLicense_ReportActiveResult

Field	Type	Description
licenseCid	ContractId ValidatorLicense

instance GetField “licenseCid” ValidatorLicense_ReportActiveResult (ContractId ValidatorLicense)

instance SetField “licenseCid” ValidatorLicense_ReportActiveResult (ContractId ValidatorLicense)

instance HasExercise ValidatorLicense ValidatorLicense_ReportActive ValidatorLicense_ReportActiveResult

instance HasFromAnyChoice ValidatorLicense ValidatorLicense_ReportActive ValidatorLicense_ReportActiveResult

instance HasToAnyChoice ValidatorLicense ValidatorLicense_ReportActive ValidatorLicense_ReportActiveResult

data ValidatorLicense_UpdateMetadataResult

ValidatorLicense_UpdateMetadataResult

Field	Type	Description
licenseCid	ContractId ValidatorLicense

instance GetField “licenseCid” ValidatorLicense_UpdateMetadataResult (ContractId ValidatorLicense)

instance SetField “licenseCid” ValidatorLicense_UpdateMetadataResult (ContractId ValidatorLicense)

instance HasExercise ValidatorLicense ValidatorLicense_UpdateMetadata ValidatorLicense_UpdateMetadataResult

instance HasFromAnyChoice ValidatorLicense ValidatorLicense_UpdateMetadata ValidatorLicense_UpdateMetadataResult

instance HasToAnyChoice ValidatorLicense ValidatorLicense_UpdateMetadata ValidatorLicense_UpdateMetadataResult

data ValidatorLicense_WithdrawResult

ValidatorLicense_WithdrawResult

instance HasExercise ValidatorLicense ValidatorLicense_Withdraw ValidatorLicense_WithdrawResult

instance HasFromAnyChoice ValidatorLicense ValidatorLicense_Withdraw ValidatorLicense_WithdrawResult

instance HasToAnyChoice ValidatorLicense ValidatorLicense_Withdraw ValidatorLicense_WithdrawResult

data ValidatorLivenessActivityRecord_DsoExpireResult

ValidatorLivenessActivityRecord_DsoExpireResult

instance HasExercise ValidatorLivenessActivityRecord ValidatorLivenessActivityRecord_DsoExpire ValidatorLivenessActivityRecord_DsoExpireResult

instance HasFromAnyChoice ValidatorLivenessActivityRecord ValidatorLivenessActivityRecord_DsoExpire ValidatorLivenessActivityRecord_DsoExpireResult

instance HasToAnyChoice ValidatorLivenessActivityRecord ValidatorLivenessActivityRecord_DsoExpire ValidatorLivenessActivityRecord_DsoExpireResult

Functions

metadataUpdateMinInterval : RelTime

activityReportMinInterval : RelTime

metadataUpdateAllowed : Time -> Time -> Bool

activityReportAllowed : Time -> Time -> Bool

validValidatorLicense : ValidatorLicense -> Bool

maxIdentifierLength : Int

validValidatorLicenseMetadata : ValidatorLicenseMetadata -> Bool