.. _module-splice-dso-svstate-17621: Splice.DSO.SvState ================== Templates to track per\-sv state\. Templates --------- .. _type-splice-dso-svstate-svnodestate-44938: **template** `SvNodeState `_ State of a node managed by an SV operator party\. There is exactly one such state per SV operator party\. Even though every SV can operate at most one node at any one time, there can though be multiple SV node states per SV, as the state of offboarded nodes is kept around for debugging purposes\. Signatory\: dso .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - sv - `Party `_ - The SV operator party identifying the node\. * - svName - `Text `_ - The SV name in whose name the node is operated\. * - state - `NodeState `_ - + **Choice** Archive Controller\: dso Returns\: () (no fields) .. _type-splice-dso-svstate-svrewardstate-90395: **template** `SvRewardState `_ State of reward collection for a sv identified by their sv name\. Signatory\: dso .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - svName - `Text `_ - * - state - `RewardState `_ - + **Choice** Archive Controller\: dso Returns\: () (no fields) .. _type-splice-dso-svstate-svstatusreport-18374: **template** `SvStatusReport `_ A singleton contract per SV party that is used to regularly submit status reports\. Individual status reports serve as a heartbeat for a specific SV party and its associoated SV node ; and to distribute that SVs view on the network to all other SVs\. Signatory\: dso .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - sv - `Party `_ - The SV party that submitted this report\. * - svName - `Text `_ - The name of the SV operator whose operator party was used to submit this report\. * - number - `Int `_ - The number of this report, starting from 0\. * - status - `Optional `_ `SvStatus `_ - None is used when initially creating the contract upon sv addition\. + **Choice** Archive Controller\: dso Returns\: () (no fields) Data Types ---------- .. _type-splice-dso-svstate-forsv-86032: **data** `ForSv `_ .. _constr-splice-dso-svstate-forsv-25145: `ForSv `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - svName - `Text `_ - **instance** `Eq `_ `ForSv `_ **instance** `Show `_ `ForSv `_ **instance** `GetField `_ \"dso\" `ForSv `_ `Party `_ **instance** `GetField `_ \"svName\" `ForSv `_ `Text `_ **instance** `SetField `_ \"dso\" `ForSv `_ `Party `_ **instance** `SetField `_ \"svName\" `ForSv `_ `Text `_ **instance** HasCheckedFetch `SvRewardState `_ `ForSv `_ .. _type-splice-dso-svstate-forsvnode-12988: **data** `ForSvNode `_ .. _constr-splice-dso-svstate-forsvnode-35713: `ForSvNode `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - dso - `Party `_ - * - sv - `Party `_ - * - svName - `Text `_ - **instance** `Eq `_ `ForSvNode `_ **instance** `Show `_ `ForSvNode `_ **instance** `GetField `_ \"dso\" `ForSvNode `_ `Party `_ **instance** `GetField `_ \"sv\" `ForSvNode `_ `Party `_ **instance** `GetField `_ \"svName\" `ForSvNode `_ `Text `_ **instance** `SetField `_ \"dso\" `ForSvNode `_ `Party `_ **instance** `SetField `_ \"sv\" `ForSvNode `_ `Party `_ **instance** `SetField `_ \"svName\" `ForSvNode `_ `Text `_ **instance** HasCheckedFetch `SvNodeState `_ `ForSvNode `_ **instance** HasCheckedFetch `SvStatusReport `_ `ForSvNode `_ .. _type-splice-dso-svstate-nodestate-84781: **data** `NodeState `_ .. _constr-splice-dso-svstate-nodestate-4328: `NodeState `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - synchronizerNodes - :ref:`SynchronizerNodeConfigMap ` - The config for a synchronizer's CometBFT, sequencer, mediator and scan nodes under control of an SV party\. **instance** `Eq `_ `NodeState `_ **instance** `Show `_ `NodeState `_ **instance** `GetField `_ \"state\" `SvNodeState `_ `NodeState `_ **instance** `GetField `_ \"synchronizerNodes\" `NodeState `_ :ref:`SynchronizerNodeConfigMap ` **instance** `SetField `_ \"state\" `SvNodeState `_ `NodeState `_ **instance** `SetField `_ \"synchronizerNodes\" `NodeState `_ :ref:`SynchronizerNodeConfigMap ` .. _type-splice-dso-svstate-rewardstate-93172: **data** `RewardState `_ Reward collection state of an SV\. Note that we keep some extra aggregates in this state to make it easier to interpret it\. In principle, these could be derived from the transaction history, but that would be much more onerous to implement\. .. _constr-splice-dso-svstate-rewardstate-16777: `RewardState `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - numRoundsMissed - `Int `_ - Number of rounds for which they missed collecting coupons\. * - numRoundsCollected - `Int `_ - Number of rounds for which they collected coupons\. * - lastRoundCollected - Round - Last round for which they collected reward coupons\. * - numCouponsIssued - `Int `_ - Number of SV reward coupons issued by them for their beneficiaries\. **instance** `Eq `_ `RewardState `_ **instance** `Show `_ `RewardState `_ **instance** `GetField `_ \"lastRoundCollected\" `RewardState `_ Round **instance** `GetField `_ \"numCouponsIssued\" `RewardState `_ `Int `_ **instance** `GetField `_ \"numRoundsCollected\" `RewardState `_ `Int `_ **instance** `GetField `_ \"numRoundsMissed\" `RewardState `_ `Int `_ **instance** `GetField `_ \"state\" `SvRewardState `_ `RewardState `_ **instance** `SetField `_ \"lastRoundCollected\" `RewardState `_ Round **instance** `SetField `_ \"numCouponsIssued\" `RewardState `_ `Int `_ **instance** `SetField `_ \"numRoundsCollected\" `RewardState `_ `Int `_ **instance** `SetField `_ \"numRoundsMissed\" `RewardState `_ `Int `_ **instance** `SetField `_ \"state\" `SvRewardState `_ `RewardState `_ .. _type-splice-dso-svstate-svstatus-81954: **data** `SvStatus `_ The status of an SV as seen from their SV node's perspective\. We generally add values here that are expected to regularly increase, so that SV node operators can run alerting off of them\. .. _constr-splice-dso-svstate-svstatus-71949: `SvStatus `_ .. list-table:: :widths: 15 10 30 :header-rows: 1 * - Field - Type - Description * - createdAt - `Time `_ - The wall clock time of the SV node at the time when the SV node started to gather the data points in this report to submit them\. * - cometBftHeight - `Int `_ - The height of the CometBFT chain at the time of submission * - mediatorSynchronizerTime - `Time `_ - The latest synchronizer time observed on the mediator at the time of submission * - participantSynchronizerTime - `Time `_ - The latest synchronizer time observed on the participant at the time of submission * - latestOpenRound - Round - The maximum round number of the OpenMiningRound contracts at the time of submission **instance** `Eq `_ `SvStatus `_ **instance** `Show `_ `SvStatus `_ **instance** `GetField `_ \"cometBftHeight\" `SvStatus `_ `Int `_ **instance** `GetField `_ \"createdAt\" `SvStatus `_ `Time `_ **instance** `GetField `_ \"latestOpenRound\" `SvStatus `_ Round **instance** `GetField `_ \"mediatorSynchronizerTime\" `SvStatus `_ `Time `_ **instance** `GetField `_ \"participantSynchronizerTime\" `SvStatus `_ `Time `_ **instance** `GetField `_ \"status\" `SvStatusReport `_ (`Optional `_ `SvStatus `_) **instance** `GetField `_ \"status\" :ref:`DsoRules_SubmitStatusReport ` `SvStatus `_ **instance** `SetField `_ \"cometBftHeight\" `SvStatus `_ `Int `_ **instance** `SetField `_ \"createdAt\" `SvStatus `_ `Time `_ **instance** `SetField `_ \"latestOpenRound\" `SvStatus `_ Round **instance** `SetField `_ \"mediatorSynchronizerTime\" `SvStatus `_ `Time `_ **instance** `SetField `_ \"participantSynchronizerTime\" `SvStatus `_ `Time `_ **instance** `SetField `_ \"status\" `SvStatusReport `_ (`Optional `_ `SvStatus `_) **instance** `SetField `_ \"status\" :ref:`DsoRules_SubmitStatusReport ` `SvStatus `_