-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #612 from iotaledger/feat/protocol-eviction
Feat: Protocol Eviction
- Loading branch information
Showing
11 changed files
with
472 additions
and
514 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| package protocol | ||
|
|
||
| import ( | ||
| "github.com/libp2p/go-libp2p/core/peer" | ||
|
|
||
| "github.com/iotaledger/hive.go/core/eventticker" | ||
| "github.com/iotaledger/hive.go/ds/shrinkingmap" | ||
| "github.com/iotaledger/hive.go/ierrors" | ||
| "github.com/iotaledger/hive.go/lo" | ||
| "github.com/iotaledger/hive.go/log" | ||
| "github.com/iotaledger/hive.go/runtime/workerpool" | ||
| "github.com/iotaledger/iota-core/pkg/model" | ||
| iotago "github.com/iotaledger/iota.go/v4" | ||
| "github.com/iotaledger/iota.go/v4/merklehasher" | ||
| ) | ||
|
|
||
| // Attestations is a subcomponent of the protocol that is responsible for handling attestation requests and responses. | ||
| type Attestations struct { | ||
| // protocol contains a reference to the Protocol instance that this component belongs to. | ||
| protocol *Protocol | ||
|
|
||
| // workerPool contains the worker pool that is used to process attestation requests and responses asynchronously. | ||
| workerPool *workerpool.WorkerPool | ||
|
|
||
| // requester contains the ticker that is used to send attestation requests. | ||
| requester *eventticker.EventTicker[iotago.SlotIndex, iotago.CommitmentID] | ||
|
|
||
| // commitmentVerifiers contains the commitment verifiers that are used to verify received attestations. | ||
| commitmentVerifiers *shrinkingmap.ShrinkingMap[iotago.CommitmentID, *CommitmentVerifier] | ||
|
|
||
| // Logger embeds a logger that can be used to log messages emitted by this component. | ||
| log.Logger | ||
| } | ||
|
|
||
| // newAttestations creates a new attestation protocol instance for the given protocol. | ||
| func newAttestations(protocol *Protocol) *Attestations { | ||
| a := &Attestations{ | ||
| Logger: lo.Return1(protocol.Logger.NewChildLogger("Attestations")), | ||
| protocol: protocol, | ||
| workerPool: protocol.Workers.CreatePool("Attestations"), | ||
| requester: eventticker.New[iotago.SlotIndex, iotago.CommitmentID](protocol.Options.AttestationRequesterOptions...), | ||
| commitmentVerifiers: shrinkingmap.New[iotago.CommitmentID, *CommitmentVerifier](), | ||
| } | ||
|
|
||
| protocol.Constructed.OnTrigger(func() { | ||
| shutdown := lo.Batch( | ||
| a.initCommitmentVerifiers(), | ||
| a.initRequester(), | ||
| ) | ||
|
|
||
| protocol.Shutdown.OnTrigger(shutdown) | ||
| }) | ||
|
|
||
| return a | ||
| } | ||
|
|
||
| // Get returns the commitment, and its attestations (including the corresponding merkle proof). | ||
| func (a *Attestations) Get(commitmentID iotago.CommitmentID) (commitment *model.Commitment, attestations []*iotago.Attestation, merkleProof *merklehasher.Proof[iotago.Identifier], err error) { | ||
| commitmentAPI, err := a.protocol.Commitments.API(commitmentID) | ||
| if err != nil { | ||
| return nil, nil, nil, ierrors.Wrap(err, "failed to load commitment API") | ||
| } | ||
|
|
||
| return commitmentAPI.Attestations() | ||
| } | ||
|
|
||
| // initCommitmentVerifiers initializes the commitment verifiers for all chains (once they are required). | ||
| func (a *Attestations) initCommitmentVerifiers() func() { | ||
| return a.protocol.Chains.WithElements(func(chain *Chain) (shutdown func()) { | ||
| return chain.RequestAttestations.WithNonEmptyValue(func(requestAttestations bool) (shutdown func()) { | ||
| return a.setupCommitmentVerifier(chain) | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| // initRequester initializes the ticker that is used to send commitment requests. | ||
| func (a *Attestations) initRequester() (shutdown func()) { | ||
| unsubscribeFromTicker := lo.Batch( | ||
| a.protocol.Commitments.WithElements(func(commitment *Commitment) (shutdown func()) { | ||
| return commitment.RequestAttestations.WithNonEmptyValue(func(_ bool) (teardown func()) { | ||
| if commitment.CumulativeWeight() == 0 { | ||
| commitment.IsAttested.Set(true) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| a.requester.StartTicker(commitment.ID()) | ||
|
|
||
| return func() { | ||
| a.requester.StopTicker(commitment.ID()) | ||
| } | ||
| }) | ||
| }), | ||
|
|
||
| a.requester.Events.Tick.Hook(a.sendRequest).Unhook, | ||
| ) | ||
|
|
||
| return func() { | ||
| unsubscribeFromTicker() | ||
|
|
||
| a.requester.Shutdown() | ||
| } | ||
| } | ||
|
|
||
| // setupCommitmentVerifier sets up the commitment verifier for the given chain. | ||
| func (a *Attestations) setupCommitmentVerifier(chain *Chain) (shutdown func()) { | ||
| forkingPoint := chain.ForkingPoint.Get() | ||
| if forkingPoint == nil { | ||
| a.LogError("failed to retrieve forking point", "chain", chain.LogName()) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| if forkingPoint.IsRoot.Get() { | ||
| a.LogTrace("skipping commitment verifier setup for main chain", "chain", chain.LogName()) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| parentOfForkingPoint := forkingPoint.Parent.Get() | ||
| if parentOfForkingPoint == nil { | ||
| a.LogError("failed to retrieve parent of forking point", "chain", chain.LogName()) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| a.commitmentVerifiers.GetOrCreate(forkingPoint.ID(), func() (commitmentVerifier *CommitmentVerifier) { | ||
| commitmentVerifier, err := newCommitmentVerifier(forkingPoint.Chain.Get().LatestEngine(), parentOfForkingPoint.Commitment) | ||
| if err != nil { | ||
| a.LogError("failed to create commitment verifier", "chain", chain.LogName(), "error", err) | ||
| } | ||
|
|
||
| return commitmentVerifier | ||
| }) | ||
|
|
||
| return func() { | ||
| a.commitmentVerifiers.Delete(forkingPoint.ID()) | ||
| } | ||
| } | ||
|
|
||
| // sendRequest sends an attestation request for the given commitment ID. | ||
| func (a *Attestations) sendRequest(commitmentID iotago.CommitmentID) { | ||
| a.workerPool.Submit(func() { | ||
| if commitment, err := a.protocol.Commitments.Get(commitmentID, false); err == nil { | ||
| a.protocol.Network.RequestAttestations(commitmentID) | ||
|
|
||
| a.LogDebug("request", "commitment", commitment.LogName()) | ||
| } else { | ||
| a.LogError("failed to load commitment", "commitmentID", commitmentID, "err", err) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| // processResponse processes the given attestation response. | ||
| func (a *Attestations) processResponse(commitment *model.Commitment, attestations []*iotago.Attestation, merkleProof *merklehasher.Proof[iotago.Identifier], from peer.ID) { | ||
| a.workerPool.Submit(func() { | ||
| publishedCommitment, _, err := a.protocol.Commitments.publishCommitment(commitment) | ||
| if err != nil { | ||
| a.LogDebug("failed to publish commitment when processing attestations", "commitmentID", commitment.ID(), "peer", from, "error", err) | ||
|
|
||
| return | ||
| } | ||
|
|
||
| if publishedCommitment.AttestedWeight.Compute(func(currentWeight uint64) uint64 { | ||
| if !publishedCommitment.RequestAttestations.Get() { | ||
| a.LogTrace("received attestations for previously attested commitment", "commitment", publishedCommitment.LogName()) | ||
|
|
||
| return currentWeight | ||
| } | ||
|
|
||
| chain := publishedCommitment.Chain.Get() | ||
| if chain == nil { | ||
| a.LogDebug("failed to find chain for commitment when processing attestations", "commitment", publishedCommitment.LogName()) | ||
|
|
||
| return currentWeight | ||
| } | ||
|
|
||
| commitmentVerifier, exists := a.commitmentVerifiers.Get(chain.ForkingPoint.Get().ID()) | ||
| if !exists || commitmentVerifier == nil { | ||
| a.LogDebug("failed to retrieve commitment verifier", "commitment", publishedCommitment.LogName()) | ||
|
|
||
| return currentWeight | ||
| } | ||
|
|
||
| _, actualWeight, err := commitmentVerifier.verifyCommitment(publishedCommitment, attestations, merkleProof) | ||
| if err != nil { | ||
| a.LogError("failed to verify commitment", "commitment", publishedCommitment.LogName(), "error", err) | ||
|
|
||
| return currentWeight | ||
| } | ||
|
|
||
| if actualWeight > currentWeight { | ||
| a.LogDebug("received response", "commitment", publishedCommitment.LogName(), "fromPeer", from) | ||
| } | ||
|
|
||
| return actualWeight | ||
| }) > 0 { | ||
| publishedCommitment.IsAttested.Set(true) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| // processRequest processes the given attestation request. | ||
| func (a *Attestations) processRequest(commitmentID iotago.CommitmentID, from peer.ID) { | ||
| loggedWorkerPoolTask(a.workerPool, func() error { | ||
| commitment, attestations, proof, err := a.Get(commitmentID) | ||
| if err != nil { | ||
| return ierrors.Wrap(err, "failed to load attestations") | ||
| } | ||
|
|
||
| return a.protocol.Network.SendAttestations(commitment, attestations, proof, from) | ||
| }, a, "commitmentID", commitmentID, "fromPeer", from) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.