-
Notifications
You must be signed in to change notification settings - Fork 211
/
events.go
212 lines (177 loc) · 5.24 KB
/
events.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
// Package events defines events published by go-spacemsh node using nodes pubsub
package events
import (
"fmt"
"github.com/spacemeshos/go-spacemesh/common/types"
"github.com/spacemeshos/go-spacemesh/log"
)
// These consts are used as prefixes for different messages in pubsub.
const (
EventNewBlock ChannelID = 1 + iota
EventBlockValid
EventNewAtx
EventAtxValid
EventNewTx
EventTxValid
EventRewardReceived
EventCreatedBlock
EventCreatedAtx
EventCalculatedTortoiseBeacon
)
// publisher is the event publisher singleton.
var publisher *EventPublisher
// Publish publishes an event on the pubsub singleton.
func Publish(event Event) {
if publisher != nil {
if err := publisher.PublishEvent(event); err != nil {
log.Error("pubsub error: %v", err)
}
}
}
// InitializeEventPubsub initializes the global pubsub broadcaster server.
func InitializeEventPubsub(ur string) error {
var err error
publisher, err = NewEventPublisher(ur)
return err
}
// CloseEventPubSub closes events pubsub and destroys it.
func CloseEventPubSub() {
if publisher != nil {
publisher.Close()
publisher = nil
}
}
// EventPublisher is the struct that publishes events to subscribers by topics.
type EventPublisher struct {
*Publisher
}
// Event defines the interface that each message sent by the EventPublisher needs to implement for it to correctly
// be routed by topic.
type Event interface {
// GetChannel returns the channel on which this message will be published.
GetChannel() ChannelID
}
// NewEventPublisher is a constructor for the event publisher, it received a url string in format of tcp://localhost:56565 to start
// listening for connections.
func NewEventPublisher(eventURL string) (*EventPublisher, error) {
p, err := newPublisher(eventURL)
if err != nil {
return nil, err
}
return &EventPublisher{p}, nil
}
// PublishEvent publishes the provided event on pubsub infra.
func (p *EventPublisher) PublishEvent(event Event) error {
bytes, err := types.InterfaceToBytes(event)
if err != nil {
return fmt.Errorf("serialize: %w", err)
}
if err := p.publish(event.GetChannel(), bytes); err != nil {
return fmt.Errorf("publish: %w", err)
}
return nil
}
// Close closes the published internal socket.
func (p *EventPublisher) Close() error {
if err := p.sock.Close(); err != nil {
return fmt.Errorf("close socket: %w", err)
}
return nil
}
// NewBlock is sent when a new block is created by this miner.
type NewBlock struct {
ID string
Layer uint32
Atx string
}
// GetChannel gets the message type which means on which this message should be sent.
func (NewBlock) GetChannel() ChannelID {
return EventNewBlock
}
// DoneCreatingBlock signals that this miner has created a block.
type DoneCreatingBlock struct {
Eligible bool
Layer uint32
Error string
}
// GetChannel gets the message type which means on which this message should be sent.
func (DoneCreatingBlock) GetChannel() ChannelID {
return EventCreatedBlock
}
// ValidBlock signals that block with id ID has been validated.
type ValidBlock struct {
ID string
Valid bool
}
// GetChannel gets the message type which means on which this message should be sent.
func (ValidBlock) GetChannel() ChannelID {
return EventBlockValid
}
// NewAtx signals that a new ATX has been received.
type NewAtx struct {
ID string
EpochID uint32
}
// GetChannel gets the message type which means on which this message should be sent.
func (NewAtx) GetChannel() ChannelID {
return EventNewAtx
}
// ValidAtx signals that an activation transaction with id ID has been validated.
type ValidAtx struct {
ID string
Valid bool
}
// GetChannel gets the message type which means on which this message should be sent.
func (ValidAtx) GetChannel() ChannelID {
return EventAtxValid
}
// NewTx signals that a new transaction has been received and not yet validated.
type NewTx struct {
ID string
Origin string
Destination string
Amount uint64
Fee uint64
}
// GetChannel gets the message type which means on which this message should be sent.
func (NewTx) GetChannel() ChannelID {
return EventNewTx
}
// ValidTx signals that the transaction with id ID has been validated.
type ValidTx struct {
ID string
Valid bool
}
// GetChannel gets the message type which means on which this message should be sent.
func (ValidTx) GetChannel() ChannelID {
return EventTxValid
}
// RewardReceived signals reward has been received.
type RewardReceived struct {
Coinbase string
Amount uint64
SmesherID []byte
}
// GetChannel gets the message type which means on which this message should be sent.
func (RewardReceived) GetChannel() ChannelID {
return EventRewardReceived
}
// AtxCreated signals this miner has created an activation transaction.
type AtxCreated struct {
Created bool
ID string
Epoch uint32
}
// GetChannel gets the message type which means on which this message should be sent.
func (AtxCreated) GetChannel() ChannelID {
return EventCreatedAtx
}
// TortoiseBeaconCalculated signals this miner has calculated a tortoise beacon.
type TortoiseBeaconCalculated struct {
Epoch types.EpochID
Beacon string
}
// GetChannel gets the message type which means on which this message should be sent.
func (TortoiseBeaconCalculated) GetChannel() ChannelID {
return EventCalculatedTortoiseBeacon
}