-
Notifications
You must be signed in to change notification settings - Fork 180
/
side_tx_processor.go
306 lines (242 loc) · 7.95 KB
/
side_tx_processor.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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
package app
import (
"bytes"
"encoding/hex"
"fmt"
"runtime/debug"
sdk "github.com/cosmos/cosmos-sdk/types"
abci "github.com/tendermint/tendermint/abci/types"
authTypes "github.com/maticnetwork/heimdall/auth/types"
"github.com/maticnetwork/heimdall/types"
)
// PostDeliverTxHandler runs after deliver tx handler
func (app *HeimdallApp) PostDeliverTxHandler(ctx sdk.Context, tx sdk.Tx, result sdk.Result) {
height := ctx.BlockHeader().Height
if height <= 2 {
return
}
if result.IsOK() {
anySideMsg := false
for _, msg := range tx.GetMsgs() {
if _, ok := msg.(types.SideTxMsg); ok {
anySideMsg = true
break
}
}
// save tx bytes if any tx-msg is side-tx msg
if anySideMsg && ctx.TxBytes() != nil {
app.SidechannelKeeper.SetTx(ctx, ctx.BlockHeader().Height, ctx.TxBytes())
}
}
}
// BeginSideBlocker runs before side block
func (app *HeimdallApp) BeginSideBlocker(ctx sdk.Context, req abci.RequestBeginSideBlock) (res abci.ResponseBeginSideBlock) {
height := ctx.BlockHeader().Height
if height <= 2 {
return
}
targetHeight := height - 2 // sidechannel takes 2 blocks to process
// get logger
logger := app.Logger()
logger.Debug("[sidechannel] Processing side block", "height", height, "targetHeight", targetHeight)
// get all validators
// begin-block stores validators and end-block removes validators for each height - check sidechannel module.go
validators := app.SidechannelKeeper.GetValidators(ctx, height)
if len(validators) == 0 {
return
}
// calculate power
var totalPower int64
for _, v := range validators {
totalPower = totalPower + v.Power
}
// get empty events
events := sdk.EmptyEvents()
for _, sideTxResult := range req.SideTxResults {
txHash := sideTxResult.TxHash
// get tx from the store
tx := app.SidechannelKeeper.GetTx(ctx, targetHeight, txHash)
if tx != nil {
// remove tx to avoid duplicate execution
app.SidechannelKeeper.RemoveTx(ctx, targetHeight, txHash)
usedValidator := make(map[int]bool)
// signed power
signedPower := make(map[abci.SideTxResultType]int64)
signedPower[abci.SideTxResultType_Yes] = 0
signedPower[abci.SideTxResultType_Skip] = 0
signedPower[abci.SideTxResultType_No] = 0
for _, sigObj := range sideTxResult.Sigs {
// get validator by sig address
if i := getValidatorIndexByAddress(sigObj.Address, validators); i != -1 {
// check if validator already voted on tx
if _, ok := usedValidator[i]; !ok {
signedPower[sigObj.Result] = signedPower[sigObj.Result] + validators[i].Power
usedValidator[i] = true
}
}
}
var result sdk.Result
// check vote majority
if signedPower[abci.SideTxResultType_Yes] >= (totalPower*2/3 + 1) {
// approved
logger.Debug("[sidechannel] Approved side-tx", "txHash", hex.EncodeToString(tx.Hash()))
// execute tx with `yes`
result = app.runTx(ctx, tx, abci.SideTxResultType_Yes)
} else if signedPower[abci.SideTxResultType_No] >= (totalPower*2/3 + 1) {
// rejected
logger.Debug("[sidechannel] Rejected side-tx", "txHash", hex.EncodeToString(tx.Hash()))
// execute tx with `no`
result = app.runTx(ctx, tx, abci.SideTxResultType_No)
} else {
// skipped
logger.Debug("[sidechannel] Skipped side-tx", "txHash", hex.EncodeToString(tx.Hash()))
// execute tx with `skip`
result = app.runTx(ctx, tx, abci.SideTxResultType_Skip)
}
// add events
events = events.AppendEvents(result.Events)
}
}
// remove all pending txs before exiting
txs := app.SidechannelKeeper.GetTxs(ctx, targetHeight)
for _, tx := range txs {
app.SidechannelKeeper.RemoveTx(ctx, targetHeight, tx.Hash())
// skipped
logger.Debug("[sidechannel] Skipped side-tx", "txHash", hex.EncodeToString(tx.Hash()))
// execute tx with `skip`
result := app.runTx(ctx, tx, abci.SideTxResultType_Skip)
// add events
events = events.AppendEvents(result.Events)
}
// set event to response
res.Events = events.ToABCIEvents()
return res
}
// DeliverSideTxHandler runs for each side tx
func (app *HeimdallApp) DeliverSideTxHandler(ctx sdk.Context, tx sdk.Tx, req abci.RequestDeliverSideTx) (res abci.ResponseDeliverSideTx) {
var (
code uint32
codespace string
)
result := abci.SideTxResultType_Skip
data := make([]byte, 0)
for _, msg := range tx.GetMsgs() {
sideMsg, isSideTxMsg := msg.(types.SideTxMsg)
// match message route
msgRoute := msg.Route()
handlers := app.sideRouter.GetRoute(msgRoute)
if handlers != nil && handlers.SideTxHandler != nil && isSideTxMsg {
// Create a new context based off of the existing context with a cache wrapped multi-store (for state-less execution)
runMsgCtx, _ := app.cacheTxContext(ctx, req.Tx)
// execute side-tx handler
msgResult := handlers.SideTxHandler(runMsgCtx, msg)
// stop execution and return on first failed message
if msgResult.Code != uint32(sdk.CodeOK) {
// set data to empty if error
data = make([]byte, 0)
code = msgResult.Code
codespace = msgResult.Codespace
// skip side-tx if result is error
result = abci.SideTxResultType_Skip
break
}
// Each message result's Data must be length prefixed in order to separate
// each result.
data = append(data, msgResult.Data...)
result = msgResult.Result
// msg result is empty, get side sign bytes and append into data
if len(msgResult.Data) == 0 {
data = append(data, sideMsg.GetSideSignBytes()...)
}
}
}
return abci.ResponseDeliverSideTx{
Code: code,
Codespace: codespace,
Data: data,
Result: result,
}
}
//
// Internal functions
//
func (app *HeimdallApp) runTx(ctx sdk.Context, txBytes []byte, sideTxResult abci.SideTxResultType) (result sdk.Result) {
// get decoder
decoder := authTypes.DefaultTxDecoder(app.cdc)
tx, err := decoder(txBytes)
if err != nil {
return
}
// recover if runMsgs fails
defer func() {
if r := recover(); r != nil {
log := fmt.Sprintf("recovered: %v\nstack:\n%v", r, string(debug.Stack()))
result = sdk.ErrInternal(log).Result()
}
}()
// get context with tx bytes
ctx = ctx.WithTxBytes(txBytes)
// Create a new context based off of the existing context with a cache wrapped
// multi-store in case message processing fails.
runMsgCtx, msCache := app.cacheTxContext(ctx, txBytes)
result = app.runMsgs(runMsgCtx, tx.GetMsgs(), sideTxResult)
// only update state if all messages pass
if result.IsOK() {
msCache.Write()
}
return
}
// runMsgs iterates through all the messages and executes them.
func (app *HeimdallApp) runMsgs(ctx sdk.Context, msgs []sdk.Msg, sideTxResult abci.SideTxResultType) sdk.Result {
data := make([]byte, 0, len(msgs))
var (
code sdk.CodeType
codespace sdk.CodespaceType
)
// get empty events
events := sdk.EmptyEvents()
for _, msg := range msgs {
_, isSideTxMsg := msg.(types.SideTxMsg)
// match message route
msgRoute := msg.Route()
handler := app.sideRouter.GetRoute(msgRoute)
if handler != nil && handler.PostTxHandler != nil && isSideTxMsg {
msgResult := handler.PostTxHandler(ctx, msg, sideTxResult)
// Each message result's Data must be length prefixed in order to separate
// each result.
data = append(data, msgResult.Data...)
// msg events
events = events.AppendEvents(msgResult.Events)
// stop execution and return on first failed message
if !msgResult.IsOK() {
code = msgResult.Code
codespace = msgResult.Codespace
break
}
}
}
return sdk.Result{
Code: code,
Codespace: codespace,
Data: data,
Events: events,
}
}
// cacheTxContext returns a new context based off of the provided context with
// a cache wrapped multi-store.
func (app *HeimdallApp) cacheTxContext(ctx sdk.Context, _ []byte) (sdk.Context, sdk.CacheMultiStore) {
ms := ctx.MultiStore()
msCache := ms.CacheMultiStore()
return ctx.WithMultiStore(msCache), msCache
}
//
// utils
//
func getValidatorIndexByAddress(address []byte, validators []abci.Validator) int {
for i, v := range validators {
if bytes.Equal(address, v.Address) {
return i
}
}
return -1
}