Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v1.3.0
type Config struct {
// GroupSize is the size of a group in the threshold relay.
GroupSize int
// HonestThreshold is the minimum number of active participants behaving
// according to the protocol needed to generate a new relay entry.
HonestThreshold int
// TicketSubmissionTimeout is the duration (in blocks) the staker has to
// submit any tickets to candidate to a new group.
TicketSubmissionTimeout uint64
// ResultPublicationBlockStep is the duration (in blocks) that has to pass
// before group member with the given index is eligible to submit the
// result.
// Nth player becomes eligible to submit the result after
// T_dkg + (N-1) * T_step
// where T_dkg is time for phases 1-12 to complete and T_step is the result
// publication block step.
ResultPublicationBlockStep uint64
// RelayEntryTimeout is a timeout in blocks on-chain for a relay
// entry to be published by the selected group. Blocks are
// counted from the moment relay request occur.
RelayEntryTimeout uint64
}
Config contains the config data needed for the relay to operate.
func (*Config) DishonestThreshold ¶ added in v1.3.0
DishonestThreshold is the maximum number of misbehaving participants for which it is still possible to generate a new relay entry. Misbehaviour is any misconduct to the protocol, including inactivity.
type DKGResult ¶
type DKGResult struct {
// Group public key generated by the protocol execution, empty if the protocol failed.
GroupPublicKey []byte
// Misbehaved members are all members either inactive or disqualified.
// Misbehaved members are represented as a slice of bytes for optimizing
// on-chain storage. Each byte is an inactive or disqualified member index.
Misbehaved []byte
}
DKGResult is a result of distributed key generation protocol.
If the protocol execution finishes with an acceptable number of disqualified or inactive members, the group with remaining list of honest members will be added to the signing groups list for the threshold relay.
Otherwise, group creation will not finish, which will be due to either the number of inactive or disqualified participants, or the results (signatures) being disputed in a way where the correct outcome cannot be ascertained.
type DKGResultHash ¶
type DKGResultHash [hashByteSize]byte
DKGResultHash is a 256-bit hash of DKG Result. The hashing algorithm should be the same as the one used on-chain.
func DKGResultHashFromBytes ¶
func DKGResultHashFromBytes(bytes []byte) (DKGResultHash, error)
DKGResultHashFromBytes converts bytes slice to DKG Result Hash. It requires provided bytes slice size to be exactly 32 bytes.
type DKGResultsVotes ¶
type DKGResultsVotes map[DKGResultHash]int
DKGResultsVotes is a map of votes for each DKG Result.
type DistributedKeyGenerationInterface ¶
type DistributedKeyGenerationInterface interface {
// SubmitDKGResult sends DKG result to a chain, along with signatures over
// result hash from group participants supporting the result.
// Signatures over DKG result hash are collected in a map keyed by signer's
// member index.
SubmitDKGResult(
participantIndex GroupMemberIndex,
dkgResult *DKGResult,
signatures map[GroupMemberIndex][]byte,
) *async.EventDKGResultSubmissionPromise
// OnDKGResultSubmitted registers a callback that is invoked when an on-chain
// notification of a new, valid submitted result is seen.
OnDKGResultSubmitted(
func(event *event.DKGResultSubmission),
) subscription.EventSubscription
// IsGroupRegistered checks if group with the given public key is registered
// on-chain.
IsGroupRegistered(groupPublicKey []byte) (bool, error)
// CalculateDKGResultHash calculates 256-bit hash of DKG result in standard
// specific for the chain. Operation is performed off-chain.
CalculateDKGResultHash(dkgResult *DKGResult) (DKGResultHash, error)
}
DistributedKeyGenerationInterface defines the subset of the relay chain interface that pertains specifically to group formation's distributed key generation process.
type GroupInterface ¶
type GroupInterface interface {
GroupSelectionInterface
GroupRegistrationInterface
}
GroupInterface defines the subset of the relay chain interface that pertains specifically to relay group management.
type GroupMemberIndex ¶
type GroupMemberIndex = uint8
GroupMemberIndex is an index of a threshold relay group member. Maximum value accepted by the chain is 255.
type GroupRegistrationInterface ¶
type GroupRegistrationInterface interface {
// OnGroupRegistered is a callback that is invoked when an on-chain
// notification of a new, valid group being registered is seen.
OnGroupRegistered(
func(groupRegistration *event.GroupRegistration),
) subscription.EventSubscription
// Checks if a group with the given public key is considered as
// stale on-chain. Group is considered as stale if it is expired and when
// its expiration time and potentially executed operation timeout are both
// in the past. Stale group is never selected by the chain to any new
// operation.
IsStaleGroup(groupPublicKey []byte) (bool, error)
// GetGroupMembers returns `GroupSize` slice of addresses of
// participants which have been selected to the group with given public key.
GetGroupMembers(groupPublicKey []byte) ([]StakerAddress, error)
}
GroupRegistrationInterface defines the subset of the relay chain interface that pertains to relay group registration activities.
type GroupSelectionInterface ¶
type GroupSelectionInterface interface {
// OnGroupSelectionStarted is a callback that is invoked when an on-chain
// group selection started and the contract is ready to accept tickets.
OnGroupSelectionStarted(
func(groupSelectionStarted *event.GroupSelectionStart),
) subscription.EventSubscription
// SubmitTicket submits a ticket corresponding to the virtual staker to
// the chain, and returns a promise to track the submission. The promise
// is fulfilled with the entry as seen on-chain, or failed if there is an
// error submitting the entry.
SubmitTicket(ticket *Ticket) *async.EventGroupTicketSubmissionPromise
// GetSubmittedTickets gets the submitted group candidate tickets so far.
GetSubmittedTickets() ([]uint64, error)
// GetSelectedParticipants returns `GroupSize` slice of addresses of
// candidates which have been selected to the currently assembling group.
GetSelectedParticipants() ([]StakerAddress, error)
}
GroupSelectionInterface defines the subset of the relay chain interface that pertains to relay group selection activities.
type Interface ¶
type Interface interface {
// GetConfig returns the expected configuration of the threshold relay.
GetConfig() *Config
// GetKeys returns the key pair used to attest for messages being sent to
// the chain.
GetKeys() (*operator.PrivateKey, *operator.PublicKey)
// MinimumStake returns the current on-chain value representing the minimum
// necessary amount of KEEP a client must lock up to participate in the
// threshold relay. This value can change over time according to the minimum
// stake schedule.
MinimumStake() (*big.Int, error)
GroupInterface
RelayEntryInterface
DistributedKeyGenerationInterface
}
Interface represents the interface that the relay expects to interact with the anchoring blockchain on.
type RelayEntryInterface ¶
type RelayEntryInterface interface {
// SubmitRelayEntry submits an entry in the threshold relay and returns a
// promise to track the submission progress. The promise is fulfilled when
// the entry has been successfully submitted to the on-chain, or failed if
// the entry submission failed.
SubmitRelayEntry(entry []byte) *async.EventEntrySubmittedPromise
// OnRelayEntrySubmitted is a callback that is invoked when an on-chain
// notification of a new, valid relay entry is seen.
OnRelayEntrySubmitted(
func(entry *event.EntrySubmitted),
) subscription.EventSubscription
// OnRelayEntryRequested is a callback that is invoked when an on-chain
// notification of a new, valid relay request is seen.
OnRelayEntryRequested(
func(request *event.Request),
) subscription.EventSubscription
// ReportRelayEntryTimeout notifies the chain when a selected group which was
// supposed to submit a relay entry, did not deliver it within a specified
// time frame (relayEntryTimeout) counted in blocks.
ReportRelayEntryTimeout() error
// IsEntryInProgress checks if a new relay entry is currently in progress.
IsEntryInProgress() (bool, error)
// CurrentRequestStartBlock returns a start block of a current entry.
CurrentRequestStartBlock() (*big.Int, error)
// CurrentRequestPreviousEntry returns previous entry of a current request.
CurrentRequestPreviousEntry() ([]byte, error)
// CurrentRequestGroupPublicKey returns group public key for the current request.
CurrentRequestGroupPublicKey() ([]byte, error)
}
RelayEntryInterface defines the subset of the relay chain interface that pertains specifically to submission and retrieval of relay requests and entries.
type StakerAddress ¶
type StakerAddress []byte
StakerAddress represents chain-specific address of the staker.
type Ticket ¶
type Ticket struct {
Value [8]byte // W_k
Proof *TicketProof
}
Ticket represents group selection ticket as seen on-chain.
Source Files