-
Notifications
You must be signed in to change notification settings - Fork 212
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
api: spacemeshos/api#247 launch standalone node > ./build/go-spacemesh --preset=standalone --genesis-time=2023-07-04T9:05:00.000Z watch events > grpcurl -plaintext 0.0.0.0:10093 spacemesh.v1.AdminService.EventsStream ``` { "timestamp": "2023-07-04T08:55:00.355785009Z", "help": "Published proposal. Rewards will be received, once proposal is included into the block.", "proposal": { "layer": 150, "proposal": "i5iBp35b53G7OdTKsd9Y1tRc5HM=" } } { "timestamp": "2023-07-04T08:55:01.025198892Z", "help": "Node started post execution for the challenge from poet.", "postStart": { "challenge": "mvy+3M6Ja2e8GWRsCP5Rqzuw+n8xIKtgnDGz296zKuU=" } } ``` admin events can be watched by subscribing to spacemesh.v1.AdminService.EventsStream. each event has 4 fields: - timestamp - failure. denotes that certain expected step has failed. we considered an alternative to provide a special failure events, but it would require maintaining a mapping on client side, and it is unclear if we need that. for now if any step has failure=true, user will be referred to logs or relevant documentation. - help. this is initial approach to communicate what each events means to facilitate integration. later smapp can write better explanation and we will deprecate help. - details. uses protobuf oneof, it enables smapp to reliably use those fields for custom representation and use this events in tests for better assertions. i considered encoding details in json, but it makes everything else worse but makes it a bit easier to add new events, which is probably not the right tradeoff
- Loading branch information
Showing
13 changed files
with
340 additions
and
20 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
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,205 @@ | ||
| package events | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| pb "github.com/spacemeshos/api/release/go/spacemesh/v1" | ||
| "google.golang.org/protobuf/types/known/durationpb" | ||
| "google.golang.org/protobuf/types/known/timestamppb" | ||
|
|
||
| "github.com/spacemeshos/go-spacemesh/common/types" | ||
| "github.com/spacemeshos/go-spacemesh/log" | ||
| ) | ||
|
|
||
| type UserEvent struct { | ||
| Event *pb.Event | ||
| } | ||
|
|
||
| func EmitBeacon(epoch types.EpochID, beacon types.Beacon) { | ||
| const help = "Node computed randomness beacon, it will be used to determine eligibility to participate in the consensus." | ||
| emitUserEvent( | ||
| help, | ||
| false, | ||
| &pb.Event_Beacon{ | ||
| Beacon: &pb.EventBeacon{ | ||
| Epoch: epoch.Uint32(), | ||
| Beacon: beacon[:], | ||
| }, | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func EmitInitStart(smesher types.NodeID, commitment types.ATXID) { | ||
| const help = "Node started post data initialization. Note that init is noop if node restarted when init was ready." | ||
| emitUserEvent( | ||
| help, | ||
| false, | ||
| &pb.Event_InitStart{ | ||
| InitStart: &pb.EventInitStart{ | ||
| Smesher: smesher[:], | ||
| Commitment: commitment[:], | ||
| }, | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func EmitInitComplete(failure bool) { | ||
| const help = "Node completed post data initialization." | ||
| emitUserEvent( | ||
| help, | ||
| failure, | ||
| &pb.Event_InitComplete{ | ||
| InitComplete: &pb.EventInitComplete{}, | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func EmitPoetWaitRound(current, publish types.EpochID, wait time.Duration) { | ||
| const help = "Node needs to wait for poet registration window in current epoch to open. " + | ||
| "Once opened it will submit challenge and wait till poet round ends in publish epoch." | ||
| emitUserEvent( | ||
| help, | ||
| false, | ||
| &pb.Event_PoetWaitRound{PoetWaitRound: &pb.EventPoetWaitRound{ | ||
| Current: current.Uint32(), | ||
| Publish: publish.Uint32(), | ||
| Wait: durationpb.New(wait), | ||
| }}, | ||
| ) | ||
| } | ||
|
|
||
| type EventPoetWaitEnd struct { | ||
| Publish types.EpochID `json:"publish"` | ||
| Target types.EpochID `json:"target"` | ||
| Wait time.Duration `json:"wait"` | ||
| } | ||
|
|
||
| func EmitPoetWaitProof(publish, target types.EpochID, wait time.Duration) { | ||
| const help = "Node needs to wait for poet to complete in publish epoch. " + | ||
| "Once completed, node fetches proof from poet and runs post on that proof. " + | ||
| "After that publish an ATX that will be eligible for rewards in target epoch." | ||
| emitUserEvent( | ||
| help, | ||
| false, | ||
| &pb.Event_PoetWaitProof{ | ||
| PoetWaitProof: &pb.EventPoetWaitProof{ | ||
| Publish: publish.Uint32(), | ||
| Target: target.Uint32(), | ||
| Wait: durationpb.New(wait), | ||
| }, | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func EmitPostStart(challenge []byte) { | ||
| const help = "Node started post execution for the challenge from poet." | ||
| emitUserEvent( | ||
| help, | ||
| false, | ||
| &pb.Event_PostStart{PostStart: &pb.EventPostStart{Challenge: challenge}}, | ||
| ) | ||
| } | ||
|
|
||
| func EmitPostComplete(challenge []byte) { | ||
| const help = "Node finished post execution for challenge." | ||
| emitUserEvent( | ||
| help, | ||
| false, | ||
| &pb.Event_PostComplete{PostComplete: &pb.EventPostComplete{Challenge: challenge}}, | ||
| ) | ||
| } | ||
|
|
||
| func EmitPostFailure() { | ||
| const help = "Node failed post execution." | ||
| emitUserEvent( | ||
| help, | ||
| true, | ||
| &pb.Event_PostComplete{PostComplete: &pb.EventPostComplete{}}, | ||
| ) | ||
| } | ||
|
|
||
| func EmitAtxPublished( | ||
| current, target types.EpochID, | ||
| id types.ATXID, | ||
| wait time.Duration, | ||
| ) { | ||
| const help = "Published activation for the current epoch. " + | ||
| "Node needs to wait till the start of the target epoch in order to be eligible for rewards." | ||
| emitUserEvent( | ||
| help, | ||
| false, | ||
| &pb.Event_AtxPublished{ | ||
| AtxPublished: &pb.EventAtxPubished{ | ||
| Current: current.Uint32(), | ||
| Target: target.Uint32(), | ||
| Id: id[:], | ||
| Wait: durationpb.New(wait), | ||
| }, | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func EmitEligibilities( | ||
| epoch types.EpochID, | ||
| beacon types.Beacon, | ||
| atx types.ATXID, | ||
| activeSetSize uint32, | ||
| eligibilities map[types.LayerID][]types.VotingEligibility, | ||
| ) { | ||
| const help = "Computed eligibilities for the epoch. " + | ||
| "Rewards will be received after publishing proposals at specified layers. " + | ||
| "Total amount of rewards in SMH will be based on other participants in the layer." | ||
| emitUserEvent( | ||
| help, | ||
| false, | ||
| &pb.Event_Eligibilities{ | ||
| Eligibilities: &pb.EventEligibilities{ | ||
| Epoch: epoch.Uint32(), | ||
| Beacon: beacon[:], | ||
| Atx: atx[:], | ||
| ActiveSetSize: activeSetSize, | ||
| Eligibilities: castEligibilities(eligibilities), | ||
| }, | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func castEligibilities(proofs map[types.LayerID][]types.VotingEligibility) []*pb.ProposalEligibility { | ||
| rst := make([]*pb.ProposalEligibility, 0, len(proofs)) | ||
| for lid, eligs := range proofs { | ||
| rst = append(rst, &pb.ProposalEligibility{ | ||
| Layer: lid.Uint32(), | ||
| Count: uint32(len(eligs)), | ||
| }) | ||
| } | ||
| return rst | ||
| } | ||
|
|
||
| func EmitProposal(layer types.LayerID, proposal types.ProposalID) { | ||
| const help = "Published proposal. Rewards will be received, once proposal is included into the block." | ||
| emitUserEvent( | ||
| help, | ||
| false, | ||
| &pb.Event_Proposal{ | ||
| Proposal: &pb.EventProposal{ | ||
| Layer: layer.Uint32(), | ||
| Proposal: proposal[:], | ||
| }, | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func emitUserEvent(help string, failure bool, details pb.IsEventDetails) { | ||
| mu.RLock() | ||
| defer mu.RUnlock() | ||
| if reporter != nil { | ||
| if err := reporter.eventsEmitter.Emit(UserEvent{Event: &pb.Event{ | ||
| Timestamp: timestamppb.New(time.Now()), | ||
| Help: help, | ||
| Failure: failure, | ||
| Details: details, | ||
| }}); err != nil { | ||
| log.With().Error("failed to emit event", log.Err(err)) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.