-
Notifications
You must be signed in to change notification settings - Fork 94
/
check_spec.go
449 lines (385 loc) · 13.1 KB
/
check_spec.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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
// Copyright 2022 Coinbase, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd
import (
"context"
"fmt"
"time"
"github.com/coinbase/rosetta-cli/pkg/results"
"github.com/coinbase/rosetta-sdk-go/fetcher"
"github.com/coinbase/rosetta-sdk-go/types"
"github.com/spf13/cobra"
cliErrs "github.com/coinbase/rosetta-cli/pkg/errors"
)
var (
checkSpecCmd = &cobra.Command{
Use: "check:spec",
Short: "Check that a Rosetta implementation satisfies Rosetta spec",
Long: `Check:spec checks whether a Rosetta implementation satisfies either Coinbase-specific requirements or
minimum requirements specified in rosetta-api.org.
By default, check:spec will verify only Coinbase spec requirements. To verify the minimum requirements as well,
add the --all flag to the check:spec command:
rosetta-cli check:spec --all --configuration-file [filepath]
The minimum requirements verify whether an API response contains the required fields, and that the fields are
correctly formatted with proper values. For example, it would check whether the response of /network/list
contains a list of network identifiers.
The Coinbase specific requirements are not documented in rosetta-api.org. However, we highly recommend that your
implementation satisfies them. This ensures that, when you want to integrate your asset into the Coinbase platform,
you can limit or eliminate implementation issues.
Here are a few examples of Coinbase spec requirements:
1. The network_identifier in Rosetta configuration should be static. Network upgrade shouldn't change its value.
2. When block_identifier is not specified, the call to /block endpoint should return the tip block.
3. The online_url and offline_url should be different.`,
RunE: runCheckSpecCmd,
}
)
type checkSpec struct {
onlineFetcher *fetcher.Fetcher
offlineFetcher *fetcher.Fetcher
}
func newCheckSpec(ctx context.Context) (*checkSpec, error) {
if Config.Construction == nil {
return nil, cliErrs.ErrConstructionConfigMissing
}
onlineFetcherOpts := []fetcher.Option{
fetcher.WithMaxConnections(Config.MaxOnlineConnections),
fetcher.WithRetryElapsedTime(time.Duration(Config.RetryElapsedTime) * time.Second),
fetcher.WithTimeout(time.Duration(Config.HTTPTimeout) * time.Second),
fetcher.WithMaxRetries(Config.MaxRetries),
}
offlineFetcherOpts := []fetcher.Option{
fetcher.WithMaxConnections(Config.Construction.MaxOfflineConnections),
fetcher.WithRetryElapsedTime(time.Duration(Config.RetryElapsedTime) * time.Second),
fetcher.WithTimeout(time.Duration(Config.HTTPTimeout) * time.Second),
fetcher.WithMaxRetries(Config.MaxRetries),
}
if Config.ForceRetry {
onlineFetcherOpts = append(onlineFetcherOpts, fetcher.WithForceRetry())
offlineFetcherOpts = append(offlineFetcherOpts, fetcher.WithForceRetry())
}
onlineFetcher := fetcher.New(
Config.OnlineURL,
onlineFetcherOpts...,
)
offlineFetcher := fetcher.New(
Config.Construction.OfflineURL,
offlineFetcherOpts...,
)
_, _, fetchErr := onlineFetcher.InitializeAsserter(ctx, Config.Network, Config.ValidationFile)
if fetchErr != nil {
return nil, results.ExitData(
Config,
nil,
nil,
fmt.Errorf("unable to initialize asserter for online fetcher: %w", fetchErr.Err),
"",
"",
)
}
return &checkSpec{
onlineFetcher: onlineFetcher,
offlineFetcher: offlineFetcher,
}, nil
}
func (cs *checkSpec) networkOptions(ctx context.Context) checkSpecOutput {
if checkAllSpecs {
printInfo("validating /network/options ...\n")
output := checkSpecOutput{
api: networkOptions,
validation: map[checkSpecRequirement]checkSpecStatus{
version: {
status: checkSpecSuccess,
},
allow: {
status: checkSpecSuccess,
},
offlineMode: {
status: checkSpecSuccess,
},
},
}
defer printInfo("/network/options validated\n")
// NetworkOptionsRetry handles validation of /network/options response
// This is an endpoint for offline mode
_, err := cs.offlineFetcher.NetworkOptionsRetry(ctx, Config.Network, nil)
if err != nil {
printError("unable to fetch network options: %v\n", err.Err)
markAllValidationsFailed(output)
return output
}
return output
}
return checkSpecOutput{}
}
func (cs *checkSpec) networkList(ctx context.Context) checkSpecOutput {
printInfo("validating /network/list ...\n")
output := checkSpecOutput{
api: networkList,
validation: map[checkSpecRequirement]checkSpecStatus{
staticNetworkID: {
status: checkSpecSuccess,
coinbaseSpec: true,
},
},
}
if checkAllSpecs {
output.validation[networkIDs] = checkSpecStatus{
status: checkSpecSuccess,
}
output.validation[offlineMode] = checkSpecStatus{
status: checkSpecSuccess,
}
}
defer printInfo("/network/list validated\n")
networks, err := cs.offlineFetcher.NetworkListRetry(ctx, nil)
// endpoint for offline mode
if err != nil {
printError("unable to fetch network list: %v\n", err.Err)
markAllValidationsFailed(output)
return output
}
if checkAllSpecs && len(networks.NetworkIdentifiers) == 0 {
printError("network_identifiers is required")
setValidationStatusFailed(output, networkIDs)
}
// static network ID
for _, network := range networks.NetworkIdentifiers {
if isEqual(network.Network, Config.Network.Network) &&
isEqual(network.Blockchain, Config.Network.Blockchain) {
return output
}
}
printError("network_identifier in configuration file is not returned by /network/list")
setValidationStatusFailed(output, staticNetworkID)
return output
}
func (cs *checkSpec) accountCoins(ctx context.Context) checkSpecOutput {
if checkAllSpecs {
printInfo("validating /account/coins ...\n")
output := checkSpecOutput{
api: accountCoins,
validation: map[checkSpecRequirement]checkSpecStatus{
blockID: {
status: checkSpecSuccess,
},
coins: {
status: checkSpecSuccess,
},
},
}
defer printInfo("/account/coins validated\n")
if isUTXO() {
acct, _, currencies, err := cs.getAccount(ctx)
if err != nil {
printError("unable to get an account: %v\n", err)
markAllValidationsFailed(output)
return output
}
if acct == nil {
printError("%v\n", cliErrs.ErrAccountNullPointer)
markAllValidationsFailed(output)
return output
}
_, _, _, fetchErr := cs.onlineFetcher.AccountCoinsRetry(
ctx,
Config.Network,
acct,
false,
currencies)
if fetchErr != nil {
printError("unable to get coins for account %s: %v\n", types.PrintStruct(acct), fetchErr.Err)
markAllValidationsFailed(output)
return output
}
}
return output
}
return checkSpecOutput{}
}
func (cs *checkSpec) block(ctx context.Context) checkSpecOutput {
printInfo("validating /block ...\n")
output := checkSpecOutput{
api: block,
validation: map[checkSpecRequirement]checkSpecStatus{
defaultTip: {
status: checkSpecSuccess,
coinbaseSpec: true,
},
},
}
defer printInfo("/block validated\n")
if checkAllSpecs {
output.validation[idempotent] = checkSpecStatus{
status: checkSpecSuccess,
}
}
res, fetchErr := cs.onlineFetcher.NetworkStatusRetry(ctx, Config.Network, nil)
if fetchErr != nil {
printError("unable to get network status: %v\n", fetchErr.Err)
markAllValidationsFailed(output)
return output
}
if checkAllSpecs {
// multiple calls with the same hash should return the same block
var block *types.Block
tip := res.CurrentBlockIdentifier
callTimes := 3
for i := 0; i < callTimes; i++ {
blockID := types.PartialBlockIdentifier{
Hash: &tip.Hash,
}
b, fetchErr := cs.onlineFetcher.BlockRetry(ctx, Config.Network, &blockID)
if fetchErr != nil {
printError("unable to fetch block %s: %v\n", types.PrintStruct(blockID), fetchErr.Err)
markAllValidationsFailed(output)
return output
}
if block == nil {
block = b
} else if !isEqual(types.Hash(*block), types.Hash(*b)) {
printError("%v\n", cliErrs.ErrBlockNotIdempotent)
setValidationStatusFailed(output, idempotent)
}
}
}
// fetch the tip block again
res, fetchErr = cs.onlineFetcher.NetworkStatusRetry(ctx, Config.Network, nil)
if fetchErr != nil {
printError("unable to get network status: %v\n", fetchErr.Err)
setValidationStatusFailed(output, defaultTip)
return output
}
tip := res.CurrentBlockIdentifier
// tip should be returned if block_identifier is not specified
emptyBlockID := &types.PartialBlockIdentifier{}
block, fetchErr := cs.onlineFetcher.BlockRetry(ctx, Config.Network, emptyBlockID)
if fetchErr != nil {
printError("unable to fetch tip block: %v\n", fetchErr.Err)
setValidationStatusFailed(output, defaultTip)
return output
}
// block index returned from /block should be >= the index returned by /network/status
if isNegative(block.BlockIdentifier.Index - tip.Index) {
printError("%v\n", cliErrs.ErrBlockTip)
setValidationStatusFailed(output, defaultTip)
}
return output
}
func (cs *checkSpec) errorObject(ctx context.Context) checkSpecOutput {
if checkAllSpecs {
printInfo("validating error object ...\n")
output := checkSpecOutput{
api: errorObject,
validation: map[checkSpecRequirement]checkSpecStatus{
errorCode: {
status: checkSpecSuccess,
},
errorMessage: {
status: checkSpecSuccess,
},
},
}
defer printInfo("error object validated\n")
printInfo("%v\n", "sending request to /network/status ...")
emptyNetwork := &types.NetworkIdentifier{}
_, err := cs.onlineFetcher.NetworkStatusRetry(ctx, emptyNetwork, nil)
validateErrorObject(err, output)
printInfo("%v\n", "sending request to /network/options ...")
_, err = cs.onlineFetcher.NetworkOptionsRetry(ctx, emptyNetwork, nil)
validateErrorObject(err, output)
printInfo("%v\n", "sending request to /account/balance ...")
emptyAcct := &types.AccountIdentifier{}
emptyPartBlock := &types.PartialBlockIdentifier{}
emptyCur := []*types.Currency{}
_, _, _, err = cs.onlineFetcher.AccountBalanceRetry(ctx, emptyNetwork, emptyAcct, emptyPartBlock, emptyCur)
validateErrorObject(err, output)
if isUTXO() {
printInfo("%v\n", "sending request to /account/coins ...")
_, _, _, err = cs.onlineFetcher.AccountCoinsRetry(ctx, emptyNetwork, emptyAcct, false, emptyCur)
validateErrorObject(err, output)
} else {
printInfo("%v\n", "skip /account/coins for account based chain")
}
printInfo("%v\n", "sending request to /block ...")
_, err = cs.onlineFetcher.BlockRetry(ctx, emptyNetwork, emptyPartBlock)
validateErrorObject(err, output)
printInfo("%v\n", "sending request to /block/transaction ...")
emptyTx := []*types.TransactionIdentifier{}
emptyBlock := &types.BlockIdentifier{}
_, err = cs.onlineFetcher.UnsafeTransactions(ctx, emptyNetwork, emptyBlock, emptyTx)
validateErrorObject(err, output)
return output
}
return checkSpecOutput{}
}
// Searching for an account backwards from the tip
func (cs *checkSpec) getAccount(ctx context.Context) (
*types.AccountIdentifier,
*types.PartialBlockIdentifier,
[]*types.Currency,
error) {
res, err := cs.onlineFetcher.NetworkStatusRetry(ctx, Config.Network, nil)
if err != nil {
return nil, nil, nil, fmt.Errorf("unable to get network status of network %s: %w", types.PrintStruct(Config.Network), err.Err)
}
var acct *types.AccountIdentifier
var blockID *types.PartialBlockIdentifier
tip := res.CurrentBlockIdentifier.Index
genesis := res.GenesisBlockIdentifier.Index
currencies := []*types.Currency{}
for i := tip; i >= genesis && acct == nil; i-- {
blockID = &types.PartialBlockIdentifier{
Index: &i,
}
block, err := cs.onlineFetcher.BlockRetry(ctx, Config.Network, blockID)
if err != nil {
return nil, nil, nil, fmt.Errorf("unable to fetch block at index %d: %w", i, err.Err)
}
// looking for an account in block transactions
for _, tx := range block.Transactions {
for _, op := range tx.Operations {
if op.Account != nil && op.Amount.Currency != nil {
acct = op.Account
currencies = append(currencies, op.Amount.Currency)
break
}
}
if acct != nil {
break
}
}
}
return acct, blockID, currencies, nil
}
func runCheckSpecCmd(_ *cobra.Command, _ []string) error {
ctx := context.Background()
cs, err := newCheckSpec(ctx)
if err != nil {
return fmt.Errorf("unable to create checkSpec object with online URL: %w", err)
}
output := []checkSpecOutput{}
// validate api endpoints
output = append(output, cs.networkList(ctx))
output = append(output, cs.networkOptions(ctx))
output = append(output, cs.accountCoins(ctx))
output = append(output, cs.block(ctx))
output = append(output, cs.errorObject(ctx))
output = append(output, twoModes())
printInfo("check:spec is complete\n")
printCheckSpecOutputHeader()
for _, o := range output {
printCheckSpecOutputBody(o)
}
return nil
}