types/events.go

   1 package types
   2
   3 import (
   4         // for registering TMEventData as events.EventData
   5         abci "github.com/tendermint/abci/types"
   6         "github.com/tendermint/go-wire/data"
   7         //cmn "github.com/tendermint/tmlibs/common"
   8         "github.com/tendermint/tmlibs/events"
   9 )
  10
  11 // Functions to generate eventId strings
  12
  13 // Reserved
  14 func EventStringBond() string    { return "Bond" }
  15 func EventStringUnbond() string  { return "Unbond" }
  16 func EventStringRebond() string  { return "Rebond" }
  17 func EventStringDupeout() string { return "Dupeout" }
  18 func EventStringFork() string    { return "Fork" }
  19
  20 //func EventStringTx(tx Tx) string { return cmn.Fmt("Tx:%X", tx.Hash()) }
  21
  22 func EventStringNewBlock() string         { return "NewBlock" }
  23 func EventStringNewBlockHeader() string   { return "NewBlockHeader" }
  24 func EventStringNewRound() string         { return "NewRound" }
  25 func EventStringNewRoundStep() string     { return "NewRoundStep" }
  26 func EventStringTimeoutPropose() string   { return "TimeoutPropose" }
  27 func EventStringCompleteProposal() string { return "CompleteProposal" }
  28 func EventStringPolka() string            { return "Polka" }
  29 func EventStringUnlock() string           { return "Unlock" }
  30 func EventStringLock() string             { return "Lock" }
  31 func EventStringRelock() string           { return "Relock" }
  32 func EventStringTimeoutWait() string      { return "TimeoutWait" }
  33 func EventStringVote() string             { return "Vote" }
  34
  35 //----------------------------------------
  36
  37 var (
  38         EventDataNameNewBlock       = "new_block"
  39         EventDataNameNewBlockHeader = "new_block_header"
  40         EventDataNameTx             = "tx"
  41         EventDataNameRoundState     = "round_state"
  42         EventDataNameVote           = "vote"
  43 )
  44
  45 //----------------------------------------
  46
  47 // implements events.EventData
  48 type TMEventDataInner interface {
  49         events.EventData
  50 }
  51
  52 type TMEventData struct {
  53         TMEventDataInner `json:"unwrap"`
  54 }
  55
  56 func (tmr TMEventData) MarshalJSON() ([]byte, error) {
  57         return tmEventDataMapper.ToJSON(tmr.TMEventDataInner)
  58 }
  59
  60 func (tmr *TMEventData) UnmarshalJSON(data []byte) (err error) {
  61         parsed, err := tmEventDataMapper.FromJSON(data)
  62         if err == nil && parsed != nil {
  63                 tmr.TMEventDataInner = parsed.(TMEventDataInner)
  64         }
  65         return
  66 }
  67
  68 func (tmr TMEventData) Unwrap() TMEventDataInner {
  69         tmrI := tmr.TMEventDataInner
  70         for wrap, ok := tmrI.(TMEventData); ok; wrap, ok = tmrI.(TMEventData) {
  71                 tmrI = wrap.TMEventDataInner
  72         }
  73         return tmrI
  74 }
  75
  76 func (tmr TMEventData) Empty() bool {
  77         return tmr.TMEventDataInner == nil
  78 }
  79
  80 const (
  81         EventDataTypeNewBlock       = byte(0x01)
  82         EventDataTypeFork           = byte(0x02)
  83         EventDataTypeTx             = byte(0x03)
  84         EventDataTypeNewBlockHeader = byte(0x04)
  85
  86         EventDataTypeRoundState = byte(0x11)
  87         EventDataTypeVote       = byte(0x12)
  88 )
  89
  90 var tmEventDataMapper = data.NewMapper(TMEventData{}).
  91         RegisterImplementation(EventDataNewBlock{}, EventDataNameNewBlock, EventDataTypeNewBlock).
  92         RegisterImplementation(EventDataNewBlockHeader{}, EventDataNameNewBlockHeader, EventDataTypeNewBlockHeader).
  93         RegisterImplementation(EventDataTx{}, EventDataNameTx, EventDataTypeTx).
  94         RegisterImplementation(EventDataRoundState{}, EventDataNameRoundState, EventDataTypeRoundState).
  95         RegisterImplementation(EventDataVote{}, EventDataNameVote, EventDataTypeVote)
  96
  97 // Most event messages are basic types (a block, a transaction)
  98 // but some (an input to a call tx or a receive) are more exotic
  99
 100 type EventDataNewBlock struct {
 101         //Block *Block `json:"block"`
 102 }
 103
 104 // light weight event for benchmarking
 105 type EventDataNewBlockHeader struct {
 106         //Header *Header `json:"header"`
 107 }
 108
 109 // All txs fire EventDataTx
 110 type EventDataTx struct {
 111         Height int `json:"height"`
 112         //Tx     Tx            `json:"tx"`
 113         Data  data.Bytes    `json:"data"`
 114         Log   string        `json:"log"`
 115         Code  abci.CodeType `json:"code"`
 116         Error string        `json:"error"` // this is redundant information for now
 117 }
 118
 119 // NOTE: This goes into the replay WAL
 120 type EventDataRoundState struct {
 121         Height int    `json:"height"`
 122         Round  int    `json:"round"`
 123         Step   string `json:"step"`
 124
 125         // private, not exposed to websockets
 126         RoundState interface{} `json:"-"`
 127 }
 128
 129 type EventDataVote struct {
 130         //Vote *Vote
 131 }
 132
 133 func (_ EventDataNewBlock) AssertIsTMEventData()       {}
 134 func (_ EventDataNewBlockHeader) AssertIsTMEventData() {}
 135 func (_ EventDataTx) AssertIsTMEventData()             {}
 136 func (_ EventDataRoundState) AssertIsTMEventData()     {}
 137 func (_ EventDataVote) AssertIsTMEventData()           {}
 138
 139 //----------------------------------------
 140 // Wrappers for type safety
 141
 142 type Fireable interface {
 143         events.Fireable
 144 }
 145
 146 type Eventable interface {
 147         SetEventSwitch(EventSwitch)
 148 }
 149
 150 type EventSwitch interface {
 151         events.EventSwitch
 152 }
 153
 154 type EventCache interface {
 155         Fireable
 156         Flush()
 157 }
 158
 159 func NewEventSwitch() EventSwitch {
 160         return events.NewEventSwitch()
 161 }
 162
 163 func NewEventCache(evsw EventSwitch) EventCache {
 164         return events.NewEventCache(evsw)
 165 }
 166
 167 // All events should be based on this FireEvent to ensure they are TMEventData
 168 func fireEvent(fireable events.Fireable, event string, data TMEventData) {
 169         if fireable != nil {
 170                 fireable.FireEvent(event, data)
 171         }
 172 }
 173
 174 func AddListenerForEvent(evsw EventSwitch, id, event string, cb func(data TMEventData)) {
 175         evsw.AddListenerForEvent(id, event, func(data events.EventData) {
 176                 cb(data.(TMEventData))
 177         })
 178
 179 }
 180
 181 //--- block, tx, and vote events
 182
 183 func FireEventNewBlock(fireable events.Fireable, block EventDataNewBlock) {
 184         fireEvent(fireable, EventStringNewBlock(), TMEventData{block})
 185 }
 186
 187 func FireEventNewBlockHeader(fireable events.Fireable, header EventDataNewBlockHeader) {
 188         fireEvent(fireable, EventStringNewBlockHeader(), TMEventData{header})
 189 }
 190
 191 func FireEventVote(fireable events.Fireable, vote EventDataVote) {
 192         fireEvent(fireable, EventStringVote(), TMEventData{vote})
 193 }
 194
 195 /*
 196 func FireEventTx(fireable events.Fireable, tx EventDataTx) {
 197         fireEvent(fireable, EventStringTx(tx.Tx), TMEventData{tx})
 198 }
 199 */
 200
 201 //--- EventDataRoundState events
 202
 203 func FireEventNewRoundStep(fireable events.Fireable, rs EventDataRoundState) {
 204         fireEvent(fireable, EventStringNewRoundStep(), TMEventData{rs})
 205 }
 206
 207 func FireEventTimeoutPropose(fireable events.Fireable, rs EventDataRoundState) {
 208         fireEvent(fireable, EventStringTimeoutPropose(), TMEventData{rs})
 209 }
 210
 211 func FireEventTimeoutWait(fireable events.Fireable, rs EventDataRoundState) {
 212         fireEvent(fireable, EventStringTimeoutWait(), TMEventData{rs})
 213 }
 214
 215 func FireEventNewRound(fireable events.Fireable, rs EventDataRoundState) {
 216         fireEvent(fireable, EventStringNewRound(), TMEventData{rs})
 217 }
 218
 219 func FireEventCompleteProposal(fireable events.Fireable, rs EventDataRoundState) {
 220         fireEvent(fireable, EventStringCompleteProposal(), TMEventData{rs})
 221 }
 222
 223 func FireEventPolka(fireable events.Fireable, rs EventDataRoundState) {
 224         fireEvent(fireable, EventStringPolka(), TMEventData{rs})
 225 }
 226
 227 func FireEventUnlock(fireable events.Fireable, rs EventDataRoundState) {
 228         fireEvent(fireable, EventStringUnlock(), TMEventData{rs})
 229 }
 230
 231 func FireEventRelock(fireable events.Fireable, rs EventDataRoundState) {
 232         fireEvent(fireable, EventStringRelock(), TMEventData{rs})
 233 }
 234
 235 func FireEventLock(fireable events.Fireable, rs EventDataRoundState) {
 236         fireEvent(fireable, EventStringLock(), TMEventData{rs})
 237 }