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