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.

Data Types

data CometBftConfig
Config for all CometBFT nodes and keys under the control of a single SV node operator.
CometBftConfig
FieldTypeDescription
nodesMap Text CometBftNodeConfigA map from CometBft node-ids to their configuration.
governanceKeys[GovernanceKeyConfig]
sequencingKeys[SequencingKeyConfig]
instance Eq CometBftConfig instance Show CometBftConfig instance GetField “cometBft” SynchronizerNodeConfig CometBftConfig instance GetField “governanceKeys” CometBftConfig [GovernanceKeyConfig] instance GetField “nodes” CometBftConfig (Map Text CometBftNodeConfig) instance GetField “sequencingKeys” CometBftConfig [SequencingKeyConfig] instance SetField “cometBft” SynchronizerNodeConfig CometBftConfig instance SetField “governanceKeys” CometBftConfig [GovernanceKeyConfig] instance SetField “nodes” CometBftConfig (Map Text CometBftNodeConfig) instance SetField “sequencingKeys” CometBftConfig [SequencingKeyConfig] instance Patchable CometBftConfig
data CometBftConfigLimits
Limits on the configurations that SV node operators can choose for their CometBFT nodes and keys.
CometBftConfigLimits
FieldTypeDescription
maxNumCometBftNodesInt
maxNumGovernanceKeysInt
maxNumSequencingKeysInt
maxNodeIdLengthInt
maxPubKeyLengthInt
instance Eq CometBftConfigLimits instance Show CometBftConfigLimits instance GetField “cometBft” SynchronizerNodeConfigLimits CometBftConfigLimits instance GetField “maxNodeIdLength” CometBftConfigLimits Int instance GetField “maxNumCometBftNodes” CometBftConfigLimits Int instance GetField “maxNumGovernanceKeys” CometBftConfigLimits Int instance GetField “maxNumSequencingKeys” CometBftConfigLimits Int instance GetField “maxPubKeyLength” CometBftConfigLimits Int instance SetField “cometBft” SynchronizerNodeConfigLimits CometBftConfigLimits instance SetField “maxNodeIdLength” CometBftConfigLimits Int instance SetField “maxNumCometBftNodes” CometBftConfigLimits Int instance SetField “maxNumGovernanceKeys” CometBftConfigLimits Int instance SetField “maxNumSequencingKeys” CometBftConfigLimits Int instance SetField “maxPubKeyLength” CometBftConfigLimits Int instance Patchable CometBftConfigLimits
data CometBftNodeConfig
Config for a single CometBFT node.
CometBftNodeConfig
FieldTypeDescription
validatorPubKeyText
votingPowerInt
instance Eq CometBftNodeConfig instance Show CometBftNodeConfig instance GetField “nodes” CometBftConfig (Map Text CometBftNodeConfig) instance GetField “validatorPubKey” CometBftNodeConfig Text instance GetField “votingPower” CometBftNodeConfig Int instance SetField “nodes” CometBftConfig (Map Text CometBftNodeConfig) instance SetField “validatorPubKey” CometBftNodeConfig Text instance SetField “votingPower” CometBftNodeConfig Int instance Patchable CometBftNodeConfig
data GovernanceKeyConfig
Config for a key used by the SvApp to create CometBFT network governance transactions.
GovernanceKeyConfig
FieldTypeDescription
pubKeyText
instance Eq GovernanceKeyConfig instance Ord GovernanceKeyConfig instance Show GovernanceKeyConfig instance GetField “governanceKeys” CometBftConfig [GovernanceKeyConfig] instance GetField “pubKey” GovernanceKeyConfig Text instance SetField “governanceKeys” CometBftConfig [GovernanceKeyConfig] instance SetField “pubKey” GovernanceKeyConfig Text instance Patchable GovernanceKeyConfig
data SequencingKeyConfig
Config for a key used by the CometBFT Sequencer Driver to sequence messages via the CometBFT network.
SequencingKeyConfig
FieldTypeDescription
pubKeyText
instance Eq SequencingKeyConfig instance Ord SequencingKeyConfig instance Show SequencingKeyConfig instance GetField “pubKey” SequencingKeyConfig Text instance GetField “sequencingKeys” CometBftConfig [SequencingKeyConfig] instance SetField “pubKey” SequencingKeyConfig Text instance SetField “sequencingKeys” CometBftConfig [SequencingKeyConfig] instance Patchable SequencingKeyConfig

Functions

emptyCometBftConfig : CometBftConfig
defaultCometBftConfigLimits : CometBftConfigLimits
validCometBftConfig : CometBftConfigLimits -> CometBftConfig -> Bool
validCometBftNodeConfig : CometBftConfigLimits -> (Text, CometBftNodeConfig) -> Bool
totalVotingPower : CometBftConfig -> Int