-
Notifications
You must be signed in to change notification settings - Fork 12
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 #787 from iotaledger/feat/inspection_framework
Feat: Make protocol "inspectable"
- Loading branch information
Showing
5 changed files
with
69 additions
and
2 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
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
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,64 @@ | ||
| package protocol | ||
|
|
||
| import ( | ||
| "github.com/iotaledger/hive.go/runtime/inspection" | ||
| "github.com/iotaledger/iota-core/pkg/core/promise" | ||
| iotago "github.com/iotaledger/iota.go/v4" | ||
| ) | ||
|
|
||
| // Inspect inspects the protocol and its subcomponents. | ||
| func (p *Protocol) Inspect(session ...inspection.Session) inspection.InspectedObject { | ||
| return inspection.NewInspectedObject(p, func(protocol inspection.InspectedObject) { | ||
| protocol.Add("Commitments", p.Commitments) | ||
| protocol.Add("Chains", p.Chains) | ||
| }, session...) | ||
| } | ||
|
|
||
| // Inspect inspects the Commitments and its subcomponents. | ||
| func (c *Commitments) Inspect(session ...inspection.Session) inspection.InspectedObject { | ||
| return inspection.NewInspectedObject(c, func(commitments inspection.InspectedObject) { | ||
| commitments.Add("Root", c.Root.Get()) | ||
| commitments.Add("Set", c.Set, inspection.SetInspector[*Commitment](c.Set, func(inspectedSet inspection.InspectedObject, element *Commitment) { | ||
| inspectedSet.Add(element.LogName(), element) | ||
| })) | ||
| commitments.Add("cachedRequests", c.cachedRequests, inspection.MapInspector(c.cachedRequests, func(cachedRequests inspection.InspectedObject, commitmentID iotago.CommitmentID, cachedRequest *promise.Promise[*Commitment]) { | ||
| cachedRequests.Add(commitmentID.String(), cachedRequest.Result()) | ||
| })) | ||
| }, session...) | ||
| } | ||
|
|
||
| // Inspect inspects the Commitment and its subcomponents. | ||
| func (c *Commitment) Inspect(session ...inspection.Session) inspection.InspectedObject { | ||
| return inspection.NewInspectedObject(c, func(commitment inspection.InspectedObject) { | ||
| commitment.Add("Parent", c.Parent.Get()) | ||
| commitment.Add("MainChild", c.MainChild.Get()) | ||
| commitment.Add("Chain", c.Chain.Get()) | ||
| commitment.Add("Children", c.Children, inspection.SetInspector[*Commitment](c.Children, func(children inspection.InspectedObject, child *Commitment) { | ||
| children.Add(child.LogName(), child) | ||
| })) | ||
| }, session...) | ||
| } | ||
|
|
||
| // Inspect inspects the Chains and its subcomponents. | ||
| func (c *Chains) Inspect(session ...inspection.Session) inspection.InspectedObject { | ||
| return inspection.NewInspectedObject(c, func(chains inspection.InspectedObject) { | ||
| chains.Add("Main", c.Main.Get()) | ||
| chains.Add("HeaviestClaimedCandidate", c.HeaviestClaimedCandidate.Get()) | ||
| chains.Add("HeaviestAttestedCandidate", c.HeaviestAttestedCandidate.Get()) | ||
| chains.Add("HeaviestAttestedCandidate", c.HeaviestAttestedCandidate.Get()) | ||
| chains.Add("Set", c.Set, inspection.SetInspector[*Chain](c.Set, func(set inspection.InspectedObject, chain *Chain) { | ||
| set.Add(chain.LogName(), chain) | ||
| })) | ||
| }, session...) | ||
| } | ||
|
|
||
| // Inspect inspects the Chain and its subcomponents. | ||
| func (c *Chain) Inspect(session ...inspection.Session) inspection.InspectedObject { | ||
| return inspection.NewInspectedObject(c, func(chain inspection.InspectedObject) { | ||
| chain.Add("ForkingPoint", c.ForkingPoint.Get()) | ||
| chain.Add("ParentChain", c.ParentChain.Get()) | ||
| chain.Add("ChildChains", c.ChildChains, inspection.SetInspector[*Chain](c.ChildChains, func(childChains inspection.InspectedObject, chain *Chain) { | ||
| childChains.Add(chain.LogName(), chain) | ||
| })) | ||
| }, session...) | ||
| } |
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
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