Add a new asserter client with ignoring rosetta spec validation. (#502)

* Add a new asserter client with ignoring rosetta spec validation.

* Run make gen to fix check gen error

* refactor asserter code

* update copyright from 2020 to 2024.

LICENSE.txt

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 Coinbase, Inc.
+   Copyright 2024 Coinbase, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

asserter/account.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/account_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/asserter.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"io/ioutil"
 	"path"
+	"strings"
 
 	"github.com/coinbase/rosetta-sdk-go/types"
 )
@@ -35,11 +36,12 @@ type Asserter struct {
 	timestampStartIndex int64
 
 	// These variables are used for request assertion.
-	historicalBalanceLookup bool
-	supportedNetworks       []*types.NetworkIdentifier
-	callMethods             map[string]struct{}
-	mempoolCoins            bool
-	validations             *Validations
+	historicalBalanceLookup     bool
+	supportedNetworks           []*types.NetworkIdentifier
+	callMethods                 map[string]struct{}
+	mempoolCoins                bool
+	validations                 *Validations
+	ignoreRosettaSpecValidation bool
 }
 
 // Validations is used to define stricter validations
@@ -292,6 +294,43 @@ func NewClientWithOptions(
 	return asserter, nil
 }
 
+// NewGenericRosettaClient constructs a new Asserter using the provided
+// arguments and without a Rosetta Spec validation. This is used to ignore rosetta spec validation
+func NewGenericRosettaClient(
+	network *types.NetworkIdentifier,
+	genesisBlockIdentifier *types.BlockIdentifier,
+) (*Asserter, error) {
+	if err := NetworkIdentifier(network); err != nil {
+		return nil, fmt.Errorf(
+			"network identifier %s is invalid: %w",
+			types.PrintStruct(network),
+			err,
+		)
+	}
+
+	if err := BlockIdentifier(genesisBlockIdentifier); err != nil {
+		return nil, fmt.Errorf(
+			"genesis block identifier %s is invalid: %w",
+			types.PrintStruct(genesisBlockIdentifier),
+			err,
+		)
+	}
+
+	asserter := &Asserter{
+		network:      network,
+		genesisBlock: genesisBlockIdentifier,
+		validations: &Validations{
+			Enabled: false,
+		},
+		ignoreRosettaSpecValidation: true,
+	}
+
+	//init default operation statuses for generic rosetta client
+	InitOperationStatus(asserter)
+
+	return asserter, nil
+}
+
 // ClientConfiguration returns all variables currently set in an Asserter.
 // This function will error if it is called on an uninitialized asserter.
 func (a *Asserter) ClientConfiguration() (*Configuration, error) {
@@ -336,7 +375,10 @@ func (a *Asserter) OperationSuccessful(operation *types.Operation) (bool, error)
 
 	val, ok := a.operationStatusMap[*operation.Status]
 	if !ok {
-		return false, fmt.Errorf("operation status %s is not found", *operation.Status)
+		val, ok = a.operationStatusMap[strings.ToUpper(*operation.Status)]
+		if !ok {
+			return false, fmt.Errorf("operation status %s is not found", *operation.Status)
+		}
 	}
 
 	return val, nil

asserter/asserter_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/block.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -160,7 +160,7 @@ func (a *Asserter) OperationStatus(status *string, construction bool) error {
 		return ErrOperationStatusNotEmptyForConstruction
 	}
 
-	if _, ok := a.operationStatusMap[*status]; !ok {
+	if _, ok := a.operationStatusMap[*status]; !a.ignoreRosettaSpecValidation && !ok {
 		return fmt.Errorf("operation status %s is invalid: %w", *status, ErrOperationStatusInvalid)
 	}
 
@@ -174,7 +174,7 @@ func (a *Asserter) OperationType(t string) error {
 		return ErrAsserterNotInitialized
 	}
 
-	if t == "" || !containsString(a.operationTypes, t) {
+	if t == "" || (!a.ignoreRosettaSpecValidation && !containsString(a.operationTypes, t)) {
 		return fmt.Errorf("operation type %s is invalid: %w", t, ErrOperationTypeInvalid)
 	}
 
@@ -610,7 +610,7 @@ func (a *Asserter) Block(
 
 	// Only check for timestamp validity if timestamp start index is <=
 	// the current block index.
-	if a.timestampStartIndex <= block.BlockIdentifier.Index {
+	if !a.ignoreRosettaSpecValidation && a.timestampStartIndex <= block.BlockIdentifier.Index {
 		if err := Timestamp(block.Timestamp); err != nil {
 			return fmt.Errorf("timestamp %d is invalid: %w", block.Timestamp, err)
 		}

asserter/block_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/coin.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/coin_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/construction.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/construction_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/error.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -33,6 +33,10 @@ func (a *Asserter) Error(
 		return err
 	}
 
+	if a.ignoreRosettaSpecValidation {
+		return nil
+	}
+
 	val, ok := a.errorTypeMap[err.Code]
 	if !ok {
 		return fmt.Errorf(

asserter/error_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/errors.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/errors_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/events.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/events_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/mempool.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/network.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/network_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/operation_status.go

@@ -0,0 +1,34 @@
+// Copyright 2024 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 asserter
+
+const (
+	OperationStatusSuccess   = "SUCCESS"
+	OperationStatusOk        = "OK"
+	OperationStatusCompleted = "COMPLETED"
+	OperationStatusFailed    = "FAILED"
+	OperationStatusFailure   = "FAILURE"
+)
+
+// InitOperationStatus initializes operation status map for a generic rosetta client
+func InitOperationStatus(asserter *Asserter) {
+	asserter.operationStatusMap = map[string]bool{
+		OperationStatusSuccess:   true,
+		OperationStatusOk:        true,
+		OperationStatusCompleted: true,
+		OperationStatusFailed:    false,
+		OperationStatusFailure:   false,
+	}
+}

asserter/search.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/search_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/server.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/server_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

asserter/utils.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/api_account.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/api_block.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/api_call.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/api_construction.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/api_events.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/api_mempool.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/api_network.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/api_search.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/client.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/configuration.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

client/response.go

@@ -1,4 +1,4 @@
-// Copyright 2023 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

constructor/coordinator/coordinator.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

constructor/coordinator/coordinator_test.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

constructor/coordinator/errors.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

constructor/coordinator/types.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2024 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.