.. _module-splice-validatorlicense-59297: Splice.ValidatorLicense ======================= Templates --------- .. _type-splice-validatorlicense-validatorfaucetcoupon-19254: **template** `ValidatorFaucetCoupon `_ Signatory\: dso, validator .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - validator - `Party `_ - * - round - :ref:`Round ` - + **Choice** Archive Controller\: dso, validator Returns\: () (no fields) + .. _type-splice-validatorlicense-validatorfaucetcoupondsoexpire-65722: **Choice** `ValidatorFaucetCoupon_DsoExpire `_ Controller\: dso Returns\: `ValidatorFaucetCoupon_DsoExpireResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - closedRoundCid - `ContractId `_ :ref:`ClosedMiningRound ` - .. _type-splice-validatorlicense-validatorlicense-33456: **template** `ValidatorLicense `_ The existence of a validator license is what makes a validator an (onboarded) validator\. Signatory\: dso .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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) + .. _type-splice-validatorlicense-validatorlicensecancel-74620: **Choice** `ValidatorLicense_Cancel `_ Controller\: validator Returns\: `ValidatorLicense_CancelResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - reason - `Text `_ - + .. _type-splice-validatorlicense-validatorlicensereceivefaucetcoupon-91156: **Choice** `ValidatorLicense_ReceiveFaucetCoupon `_ Controller\: validator Returns\: `ValidatorLicense_ReceiveFaucetCouponResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - openRoundCid - `ContractId `_ :ref:`OpenMiningRound ` - + .. _type-splice-validatorlicense-validatorlicenserecordvalidatorlivenessactivity-79262: **Choice** `ValidatorLicense_RecordValidatorLivenessActivity `_ Controller\: validator Returns\: `ValidatorLicense_RecordValidatorLivenessActivityResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - openRoundCid - `ContractId `_ :ref:`OpenMiningRound ` - + .. _type-splice-validatorlicense-validatorlicensereportactive-46832: **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) + .. _type-splice-validatorlicense-validatorlicenseupdatemetadata-65458: **Choice** `ValidatorLicense_UpdateMetadata `_ Controller\: validator Returns\: `ValidatorLicense_UpdateMetadataResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - version - `Text `_ - * - contactPoint - `Text `_ - + .. _type-splice-validatorlicense-validatorlicensewithdraw-63410: **Choice** `ValidatorLicense_Withdraw `_ Controller\: dso Returns\: `ValidatorLicense_WithdrawResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - reason - `Text `_ - .. _type-splice-validatorlicense-validatorlivenessactivityrecord-17293: **template** `ValidatorLivenessActivityRecord `_ Signatory\: dso .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - validator - `Party `_ - * - round - :ref:`Round ` - + **Choice** Archive Controller\: dso Returns\: () (no fields) + .. _type-splice-validatorlicense-validatorlivenessactivityrecorddsoexpire-78737: **Choice** `ValidatorLivenessActivityRecord_DsoExpire `_ Controller\: dso Returns\: `ValidatorLivenessActivityRecord_DsoExpireResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - closedRoundCid - `ContractId `_ :ref:`ClosedMiningRound ` - Data Types ---------- .. _type-splice-validatorlicense-faucetstate-67607: **data** `FaucetState `_ .. _constr-splice-validatorlicense-faucetstate-48340: `FaucetState `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - firstReceivedFor - :ref:`Round ` - The first round for which a coupon was received\. * - lastReceivedFor - :ref:`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 `_ :ref:`Round ` **instance** `GetField `_ \"lastReceivedFor\" `FaucetState `_ :ref:`Round ` **instance** `GetField `_ \"numCouponsMissed\" `FaucetState `_ `Int `_ **instance** `SetField `_ \"faucetState\" `ValidatorLicense `_ (`Optional `_ `FaucetState `_) **instance** `SetField `_ \"firstReceivedFor\" `FaucetState `_ :ref:`Round ` **instance** `SetField `_ \"lastReceivedFor\" `FaucetState `_ :ref:`Round ` **instance** `SetField `_ \"numCouponsMissed\" `FaucetState `_ `Int `_ .. _type-splice-validatorlicense-validatorfaucetcoupondsoexpireresult-29807: **data** `ValidatorFaucetCoupon_DsoExpireResult `_ .. _constr-splice-validatorlicense-validatorfaucetcoupondsoexpireresult-83728: `ValidatorFaucetCoupon_DsoExpireResult `_ **instance** `HasExercise `_ `ValidatorFaucetCoupon `_ `ValidatorFaucetCoupon_DsoExpire `_ `ValidatorFaucetCoupon_DsoExpireResult `_ **instance** `HasFromAnyChoice `_ `ValidatorFaucetCoupon `_ `ValidatorFaucetCoupon_DsoExpire `_ `ValidatorFaucetCoupon_DsoExpireResult `_ **instance** `HasToAnyChoice `_ `ValidatorFaucetCoupon `_ `ValidatorFaucetCoupon_DsoExpire `_ `ValidatorFaucetCoupon_DsoExpireResult `_ .. _type-splice-validatorlicense-validatorlicensemetadata-6055: **data** `ValidatorLicenseMetadata `_ .. _constr-splice-validatorlicense-validatorlicensemetadata-35622: `ValidatorLicenseMetadata `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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 `_ .. _type-splice-validatorlicense-validatorlicensecancelresult-12117: **data** `ValidatorLicense_CancelResult `_ .. _constr-splice-validatorlicense-validatorlicensecancelresult-95954: `ValidatorLicense_CancelResult `_ **instance** `HasExercise `_ `ValidatorLicense `_ `ValidatorLicense_Cancel `_ `ValidatorLicense_CancelResult `_ **instance** `HasFromAnyChoice `_ `ValidatorLicense `_ `ValidatorLicense_Cancel `_ `ValidatorLicense_CancelResult `_ **instance** `HasToAnyChoice `_ `ValidatorLicense `_ `ValidatorLicense_Cancel `_ `ValidatorLicense_CancelResult `_ .. _type-splice-validatorlicense-validatorlicensereceivefaucetcouponresult-11121: **data** `ValidatorLicense_ReceiveFaucetCouponResult `_ .. _constr-splice-validatorlicense-validatorlicensereceivefaucetcouponresult-52224: `ValidatorLicense_ReceiveFaucetCouponResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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 `_ .. _type-splice-validatorlicense-validatorlicenserecordvalidatorlivenessactivityresult-68079: **data** `ValidatorLicense_RecordValidatorLivenessActivityResult `_ .. _constr-splice-validatorlicense-validatorlicenserecordvalidatorlivenessactivityresult-77154: `ValidatorLicense_RecordValidatorLivenessActivityResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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 `_ .. _type-splice-validatorlicense-validatorlicensereportactiveresult-44973: **data** `ValidatorLicense_ReportActiveResult `_ .. _constr-splice-validatorlicense-validatorlicensereportactiveresult-39594: `ValidatorLicense_ReportActiveResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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 `_ .. _type-splice-validatorlicense-validatorlicenseupdatemetadataresult-84967: **data** `ValidatorLicense_UpdateMetadataResult `_ .. _constr-splice-validatorlicense-validatorlicenseupdatemetadataresult-7568: `ValidatorLicense_UpdateMetadataResult `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - 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 `_ .. _type-splice-validatorlicense-validatorlicensewithdrawresult-32027: **data** `ValidatorLicense_WithdrawResult `_ .. _constr-splice-validatorlicense-validatorlicensewithdrawresult-54540: `ValidatorLicense_WithdrawResult `_ **instance** `HasExercise `_ `ValidatorLicense `_ `ValidatorLicense_Withdraw `_ `ValidatorLicense_WithdrawResult `_ **instance** `HasFromAnyChoice `_ `ValidatorLicense `_ `ValidatorLicense_Withdraw `_ `ValidatorLicense_WithdrawResult `_ **instance** `HasToAnyChoice `_ `ValidatorLicense `_ `ValidatorLicense_Withdraw `_ `ValidatorLicense_WithdrawResult `_ .. _type-splice-validatorlicense-validatorlivenessactivityrecorddsoexpireresult-68284: **data** `ValidatorLivenessActivityRecord_DsoExpireResult `_ .. _constr-splice-validatorlicense-validatorlivenessactivityrecorddsoexpireresult-79751: `ValidatorLivenessActivityRecord_DsoExpireResult `_ **instance** `HasExercise `_ `ValidatorLivenessActivityRecord `_ `ValidatorLivenessActivityRecord_DsoExpire `_ `ValidatorLivenessActivityRecord_DsoExpireResult `_ **instance** `HasFromAnyChoice `_ `ValidatorLivenessActivityRecord `_ `ValidatorLivenessActivityRecord_DsoExpire `_ `ValidatorLivenessActivityRecord_DsoExpireResult `_ **instance** `HasToAnyChoice `_ `ValidatorLivenessActivityRecord `_ `ValidatorLivenessActivityRecord_DsoExpire `_ `ValidatorLivenessActivityRecord_DsoExpireResult `_ Functions --------- .. _function-splice-validatorlicense-metadataupdatemininterval-59469: `metadataUpdateMinInterval `_ \: `RelTime `_ .. _function-splice-validatorlicense-activityreportmininterval-78854: `activityReportMinInterval `_ \: `RelTime `_ .. _function-splice-validatorlicense-metadataupdateallowed-42050: `metadataUpdateAllowed `_ \: `Time `_ \-\> `Time `_ \-\> `Bool `_ .. _function-splice-validatorlicense-activityreportallowed-34361: `activityReportAllowed `_ \: `Time `_ \-\> `Time `_ \-\> `Bool `_ .. _function-splice-validatorlicense-validvalidatorlicense-11839: `validValidatorLicense `_ \: `ValidatorLicense `_ \-\> `Bool `_ .. _function-splice-validatorlicense-maxidentifierlength-1659: `maxIdentifierLength `_ \: `Int `_ .. _function-splice-validatorlicense-validvalidatorlicensemetadata-75992: `validValidatorLicenseMetadata `_ \: `ValidatorLicenseMetadata `_ \-\> `Bool `_