Skip to content

Latest commit

 

History

History
146 lines (107 loc) · 3.17 KB

CLASS_DIAGRAM.md

File metadata and controls

146 lines (107 loc) · 3.17 KB

Class Diagram

Simplied class diagram (with no method description) to provide an overall overview of the ssv package.

classDiagram

class DutyRunners

DutyRunners *-- "*" Runner

class Network
<<interface>> Network

class AttesterCalls
<<interface>> AttesterCalls

class ProposerCalls
<<interface>> ProposerCalls

class AggregatorCalls
<<interface>> AggregatorCalls

class SyncCommitteeCalls
<<interface>> SyncCommitteeCalls

class SyncCommitteeContributionCalls
<<interface>> SyncCommitteeContributionCalls

class ValidatorRegistrationCalls
<<interface>> ValidatorRegistrationCalls

class DomainCalls
<<interface>> DomainCalls

class BeaconNode
<<interface>> BeaconNode

BeaconNode <|.. AttesterCalls
BeaconNode <|.. ProposerCalls
BeaconNode <|.. AggregatorCalls
BeaconNode <|.. SyncCommitteeCalls
BeaconNode <|.. SyncCommitteeContributionCalls
BeaconNode <|.. ValidatorRegistrationCalls
BeaconNode <|.. DomainCalls

class Validator {
    + Share: *types.Share
    + Signer: types.KeyManager
}
Validator *-- DutyRunners
Validator *-- BeaconNode
Validator *-- Network

class PartialSigContainer

class State{
    + RunningInstance: *qbft.Instance
    + DecidedValue: *types.ConsensusData
    + StartingDuty: *types.Duty
    + Finished: bool
}
State o-- "2" PartialSigContainer: PreConsensusContainer,PostConsensusContainer

class Runner
<<interface>> Runner

class BaseRunner{
    + Share: *types.Share
    + QBFTController: *qbft.Controller
    + BeaconNetwork: types.BeaconNetwork
    + BeaconRoleType: types.BeaconRole
    - highestDecidedSlot: spec.Slot
}
BaseRunner o-- "1" State

class ValidatorRegistrationRunner {
    - signer: types.KeyManager
    - valCheck: qbft.ProposedValueCheckF
}

ValidatorRegistrationRunner *-- "1" BeaconNode
ValidatorRegistrationRunner *-- "1" Network
ValidatorRegistrationRunner o-- "1" BaseRunner
ValidatorRegistrationRunner <|.. Runner


class SyncCommitteeRunner {
    - signer: types.KeyManager
    - valCheck: qbft.ProposedValueCheckF
}

SyncCommitteeRunner *-- "1" BeaconNode
SyncCommitteeRunner *-- "1" Network
SyncCommitteeRunner o-- "1" BaseRunner
SyncCommitteeRunner <|.. Runner


class SyncCommitteeAggregatorRunner {
    - signer: types.KeyManager
    - valCheck: qbft.ProposedValueCheckF
}

SyncCommitteeAggregatorRunner *-- "1" BeaconNode
SyncCommitteeAggregatorRunner *-- "1" Network
SyncCommitteeAggregatorRunner o-- "1" BaseRunner
SyncCommitteeAggregatorRunner <|.. Runner


class ProposerRunner {
    - signer: types.KeyManager
    - valCheck: qbft.ProposedValueCheckF
}

ProposerRunner *-- "1" BeaconNode
ProposerRunner *-- "1" Network
ProposerRunner o-- "1" BaseRunner
ProposerRunner <|.. Runner

class AttesterRunner {
    - signer: types.KeyManager
    - valCheck: qbft.ProposedValueCheckF
}

AttesterRunner *-- "1" BeaconNode
AttesterRunner *-- "1" Network
AttesterRunner o-- "1" BaseRunner
AttesterRunner <|.. Runner

class AggregatorRunner {
    - signer: types.KeyManager
    - valCheck: qbft.ProposedValueCheckF
}

AggregatorRunner *-- "1" BeaconNode
AggregatorRunner *-- "1" Network
AggregatorRunner o-- "1" BaseRunner
AggregatorRunner <|.. Runner
Loading

Click here for class diagrams with divided groups for better visualization.