-
Notifications
You must be signed in to change notification settings - Fork 0
/
result.go
316 lines (268 loc) · 8.13 KB
/
result.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
307
308
309
310
311
312
313
314
315
316
package types
import (
"encoding/hex"
"encoding/json"
"fmt"
"strings"
abci "github.com/tendermint/tendermint/abci/types"
ctypes "github.com/tendermint/tendermint/rpc/core/types"
)
//
//// Result is the union of ResponseFormat and ResponseCheckTx.
//type Result struct {
// // Code is the response code, is stored back on the chain.
// Code CodeType
//
// // Codespace is the string referring to the domain of an error
// Codespace CodespaceType
//
// // Data is any data returned from the app.
// // Data has to be length prefixed in order to separate
// // results from multiple msgs executions
// Data []byte
//
// // Log contains the txs log information. NOTE: nondeterministic.
// Log string
//
// // GasWanted is the maximum units of work we allow this tx to perform.
// GasWanted uint64
//
// // GasUsed is the amount of gas actually consumed. NOTE: unimplemented
// GasUsed uint64
//
// // Events contains a slice of Event objects that were emitted during some
// // execution.
// Events Events
//}
type QureyAppResponse struct {
Code uint32 `json:"code"`
FormatData string `json:"format_data,omitempty"`
Data string `json:"data,omitempty"`
Log string `json:"log,omitempty"`
GasWanted uint64 `json:"gas_wanted,omitempty"`
GasUsed uint64 `json:"gas_used,omitempty"`
Codespace string `json:"codespace,omitempty"`
}
// TODO: In the future, more codes may be OK.
func (res Result) IsOK() bool {
return CodeType(res.Code).IsOK()
}
// ABCIMessageLogs represents a slice of ABCIMessageLog.
type ABCIMessageLogs []ABCIMessageLog
// ABCIMessageLog defines a structure containing an indexed tx ABCI message log.
type ABCIMessageLog struct {
MsgIndex uint32 `json:"msg_index"`
Success bool `json:"success"`
Log string `json:"log"`
Events StringEvents `json:"events"`
}
func NewABCIMessageLog(i uint32, success bool, log string, events []abci.Event) ABCIMessageLog {
return ABCIMessageLog{
MsgIndex: i,
Success: success,
Log: log,
Events: StringifyEvents(events),
}
}
// String implements the fmt.Stringer interface for the ABCIMessageLogs types.
func (logs ABCIMessageLogs) String() (str string) {
if logs != nil {
raw, err := json.Marshal(logs)
if err == nil {
str = string(raw)
}
}
return str
}
type TxResponse struct {
Height int64 `json:"height,omitempty"`
TxHash string `json:"txhash"`
Index uint32 `json:"index"`
Code uint32 `json:"code"`
FormatData string `json:"format_data,omitempty"`
Data string `json:"data,omitempty"`
RawLog string `json:"raw_log,omitempty"`
Logs ABCIMessageLogs `json:"logs"`
Info string `json:"info,omitempty"`
GasWanted int64 `json:"gas_wanted,omitempty"`
GasUsed int64 `json:"gas_used,omitempty"`
Events StringEvents `json:"events,omitempty"`
Codespace string `json:"codespace,omitempty"`
Tx Tx `json:"tx,omitempty"`
Timestamp string `json:"timestamp,omitempty"`
}
// Empty returns true if the response is empty
func (r TxResponse) Empty() bool {
return r.TxHash == "" && r.RawLog == ""
}
// NewResponseResultTx returns a TxResponse given a ResultTx from tendermint
func NewResponseResultTx(res *ctypes.ResultTx, tx Tx, timestamp string) TxResponse {
if res == nil {
return TxResponse{}
}
parsedLogs, err := ParseABCILogs(res.TxResult.Log)
if err != nil {
parsedLogs = []ABCIMessageLog{NewABCIMessageLog(0, false, res.TxResult.Log, nil)}
}
var code = res.TxResult.Code
return TxResponse{
TxHash: res.Hash.String(),
Height: res.Height,
Code: code,
Index: res.Index,
FormatData: string(res.TxResult.Data),
Data: strings.ToUpper(hex.EncodeToString(res.TxResult.Data)),
//FormatData: string(res.TxResult.Data),
RawLog: res.TxResult.Log,
Logs: parsedLogs,
Info: res.TxResult.Info,
GasWanted: res.TxResult.GasWanted,
GasUsed: res.TxResult.GasUsed,
Events: StringifyEvents(res.TxResult.Events),
Tx: tx,
Timestamp: timestamp,
}
}
func NewResponseFormatBroadcastTxCommit(res *ctypes.ResultBroadcastTxCommit) TxResponse {
if res == nil {
return TxResponse{}
}
if !res.CheckTx.IsOK() {
return newTxResponseCheckTx(res)
}
return newTxResponseDeliverTx(res)
}
func NewResponseFormatBroadcastTx(res *ctypes.ResultBroadcastTx) TxResponse {
if res == nil {
return TxResponse{}
}
parsedLogs, _ := ParseABCILogs(res.Log)
return TxResponse{
Code: res.Code,
Data: strings.ToUpper(hex.EncodeToString(res.Data)),
TxHash: strings.ToUpper(hex.EncodeToString(res.Hash)),
RawLog: res.Log,
Logs: parsedLogs,
}
}
func newTxResponseCheckTx(res *ctypes.ResultBroadcastTxCommit) TxResponse {
if res == nil {
return TxResponse{}
}
var txHash string
if res.Hash != nil {
txHash = res.Hash.String()
}
parsedLogs, _ := ParseABCILogs(res.CheckTx.Log)
return TxResponse{
Height: res.Height,
TxHash: txHash,
Code: res.CheckTx.Code,
Data: strings.ToUpper(hex.EncodeToString(res.CheckTx.Data)),
FormatData: string(res.CheckTx.Data),
RawLog: res.CheckTx.Log,
Logs: parsedLogs,
Info: res.CheckTx.Info,
GasWanted: res.CheckTx.GasWanted,
GasUsed: res.CheckTx.GasUsed,
Events: StringifyEvents(res.CheckTx.Events),
Codespace: res.CheckTx.Codespace,
}
}
func newTxResponseDeliverTx(res *ctypes.ResultBroadcastTxCommit) TxResponse {
if res == nil {
return TxResponse{}
}
var txHash string
if res.Hash != nil {
txHash = res.Hash.String()
}
parsedLogs, _ := ParseABCILogs(res.DeliverTx.Log)
return TxResponse{
Height: res.Height,
TxHash: txHash,
Code: res.DeliverTx.Code,
FormatData: string(res.DeliverTx.Data),
Data: strings.ToUpper(hex.EncodeToString(res.DeliverTx.Data)),
RawLog: res.DeliverTx.Log,
Logs: parsedLogs,
Info: res.DeliverTx.Info,
GasWanted: res.DeliverTx.GasWanted,
GasUsed: res.DeliverTx.GasUsed,
Events: StringifyEvents(res.DeliverTx.Events),
Codespace: res.DeliverTx.Codespace,
}
}
func (r TxResponse) String() string {
var sb strings.Builder
sb.WriteString("Response:\n")
if r.Height > 0 {
sb.WriteString(fmt.Sprintf(" Height: %d\n", r.Height))
}
if r.TxHash != "" {
sb.WriteString(fmt.Sprintf(" TxHash: %s\n", r.TxHash))
}
if r.Code > 0 {
sb.WriteString(fmt.Sprintf(" Code: %d\n", r.Code))
}
if r.Data != "" {
sb.WriteString(fmt.Sprintf(" Data: %s\n", r.Data))
}
if r.FormatData != "" {
sb.WriteString(fmt.Sprintf(" FormatData: %s\n", r.FormatData))
}
if r.RawLog != "" {
sb.WriteString(fmt.Sprintf(" Log: %s\n", r.RawLog))
}
if r.Logs != nil {
sb.WriteString(fmt.Sprintf(" Logs: %s\n", r.Logs))
}
if r.Info != "" {
sb.WriteString(fmt.Sprintf(" Info: %s\n", r.Info))
}
if r.GasWanted != 0 {
sb.WriteString(fmt.Sprintf(" GasWanted: %d\n", r.GasWanted))
}
if r.GasUsed != 0 {
sb.WriteString(fmt.Sprintf(" GasUsed: %d\n", r.GasUsed))
}
if r.Codespace != "" {
sb.WriteString(fmt.Sprintf(" Codespace: %s\n", r.Codespace))
}
if r.Timestamp != "" {
sb.WriteString(fmt.Sprintf(" Timestamp: %s\n", r.Timestamp))
}
if len(r.Events) > 0 {
sb.WriteString(fmt.Sprintf(" Events: \n%s\n", r.Events.String()))
}
return strings.TrimSpace(sb.String())
}
// ParseABCILogs attempts to parse a stringified ABCI tx log into a slice of
// ABCIMessageLog types. It returns an error upon JSON decoding failure.
func ParseABCILogs(logs string) (res ABCIMessageLogs, err error) {
err = json.Unmarshal([]byte(logs), &res)
return res, err
}
// WrapServiceResult wraps a result from a protobuf RPC service method call in
// a Result object or error. This method takes care of marshaling the res param to
// protobuf and attaching any events on the ctx.EventManager() to the Result.
func WrapServiceResult(ctx Context, res interface{}, err error) (*Result, error) {
if err != nil {
return nil, err
}
var data []byte
if res != nil {
data, err = json.Marshal(res)
if err != nil {
return nil, err
}
}
var events []abci.Event
if evtMgr := ctx.EventManager(); evtMgr != nil {
events = evtMgr.Events()
}
return &Result{
Data: data,
Events: events,
}, nil
}