drng

Documentation

Index

• Constants
• Variables
• type ParametersDefinition

Constants

const (
	// Pollen defines the instance ID of the Pollen drng committee.
	Pollen = 1

	// XTeam defines the instance ID of the X-Team drng committee.
	XTeam = 1339

	// Community defines the instance ID of the Community drng committee.
	Community = 7438
)

const PluginName = "DRNG"

PluginName is the name of the DRNG plugin.

Variables

var ErrParsingCommitteeMember = errors.New("cannot parse committee member")

ErrParsingCommitteeMember is returned for an invalid committee member

var Parameters = &ParametersDefinition{}

Parameters contains the configuration parameters of the drng plugin.

var (
	// Plugin is the plugin instance of the DRNG plugin.
	Plugin *node.Plugin
)

Types

type ParametersDefinition

type ParametersDefinition struct {
	// Pollen contains the configuration parameters of GoShimmer DRNG committee.
	Pollen struct {
		// InstanceID defines the config flag of the DRNG instance ID.
		InstanceID int `default:"1" usage:"instance ID of the GoShimmer drng instance"`

		// Threshold defines the config flag of the DRNG BLS threshold.
		Threshold int `default:"3" usage:"BLS threshold of the GoShimmer drng"`

		// DistributedPubKey defines the config flag of the DRNG distributed Public Key.
		DistributedPubKey string `usage:"distributed public key of the GoShimmer committee (hex encoded)"`

		// CommitteeMembers defines the config flag of the DRNG committee members identities.
		CommitteeMembers []string `usage:"list of committee members of the GoShimmer drng"`
	}

	// XTeam contains the configuration parameters of the X-Team DRNG committee.
	XTeam struct {
		// InstanceID defines the config flag of the DRNG instance ID.
		InstanceID int `default:"1339" usage:"instance ID of the x-team drng instance"`

		// Threshold defines the config flag of the DRNG BLS threshold.
		Threshold int `default:"3" usage:"BLS threshold of the x-team drng"`

		// DistributedPubKey defines the config flag of the DRNG distributed Public Key.
		DistributedPubKey string `usage:"distributed public key of the x-team committee (hex encoded)"`

		// CommitteeMembers defines the config flag of the DRNG committee members identities.
		CommitteeMembers []string `usage:"list of committee members of the x-team drng"`
	}

	// Custom contains the configuration parameters of the custom DRNG committee.
	Custom struct {
		// InstanceID defines the config flag of the DRNG instance ID.
		InstanceID int `default:"9999" usage:"instance ID of the custom drng instance"`

		// Threshold defines the config flag of the DRNG BLS threshold.
		Threshold int `default:"3" usage:"BLS threshold of the custom drng"`

		// DistributedPubKey defines the config flag of the DRNG distributed Public Key.
		DistributedPubKey string `usage:"distributed public key of the custom committee (hex encoded)"`

		// CommitteeMembers defines the config flag of the DRNG committee members identities.
		CommitteeMembers []string `usage:"list of committee members of the custom drng"`
	}
}

ParametersDefinition contains the definition of configuration parameters used by the drng plugin.