Related ops checks (#355)

* throw warning

* add related ops to validation file

* rename relatedops var

* fix lint errors

* reduce complexity

Author: ash-krishnan

asserter/asserter.go

@@ -46,10 +46,11 @@ type Asserter struct {
 // on the transaction. Fore more details please refer to
 // https://github.com/coinbase/rosetta-sdk-go/tree/master/asserter#readme
 type Validations struct {
-	Enabled   bool                 `json:"enabled"`
-	ChainType ChainType            `json:"chain_type"`
-	Payment   *ValidationOperation `json:"payment"`
-	Fee       *ValidationOperation `json:"fee"`
+	Enabled          bool                 `json:"enabled"`
+	RelatedOpsExists bool                 `json:"related_ops_exists"`
+	ChainType        ChainType            `json:"chain_type"`
+	Payment          *ValidationOperation `json:"payment"`
+	Fee              *ValidationOperation `json:"fee"`
 }
 
 type ValidationOperation struct {

asserter/block.go

@@ -297,6 +297,7 @@ func (a *Asserter) Operations(
 	feeTotal := big.NewInt(0)
 	paymentCount := 0
 	feeCount := 0
+	relatedOpsExists := false
 	for i, op := range operations {
 		// Ensure operations are sorted
 		if err := a.Operation(op, int64(i), construction); err != nil {
@@ -322,6 +323,7 @@ func (a *Asserter) Operations(
 		// and that there are no duplicates.
 		relatedIndexes := []int64{}
 		for _, relatedOp := range op.RelatedOperations {
+			relatedOpsExists = true
 			if relatedOp.Index >= op.OperationIdentifier.Index {
 				return fmt.Errorf(
 					"%w: related operation index %d >= operation index %d",
@@ -342,6 +344,16 @@ func (a *Asserter) Operations(
 			relatedIndexes = append(relatedIndexes, relatedOp.Index)
 		}
 	}
+	// throw an error if relatedOps is not implemented and relatedOps is supported
+	// otherwise print a warning
+	if !relatedOpsExists {
+		if a.validations.Enabled && a.validations.RelatedOpsExists {
+			return ErrRelatedOperationMissing
+		}
+		fmt.Println("Related Operations key is not implemented. " +
+			"This is fine as long as there is a distinction between " +
+			"sends and receives and no multiple outputs")
+	}
 
 	// only account based validation
 	if a.validations.Enabled && a.validations.ChainType == Account {

asserter/block_test.go

@@ -948,6 +948,42 @@ func TestBlock(t *testing.T) {
 			},
 		},
 	}
+	relatedMissingTransaction := &types.Transaction{
+		TransactionIdentifier: &types.TransactionIdentifier{
+			Hash: "blah",
+		},
+		Operations: []*types.Operation{
+			{
+				OperationIdentifier: &types.OperationIdentifier{
+					Index: int64(0),
+				},
+				Type:    "PAYMENT",
+				Status:  types.String("SUCCESS"),
+				Account: validAccount,
+				Amount:  validAmount,
+			},
+			{
+				OperationIdentifier: &types.OperationIdentifier{
+					Index: int64(1),
+				},
+				RelatedOperations: []*types.OperationIdentifier{},
+				Type:              "PAYMENT",
+				Status:            types.String("SUCCESS"),
+				Account:           validAccount,
+				Amount:            validAmount,
+			},
+			{
+				OperationIdentifier: &types.OperationIdentifier{
+					Index: int64(2),
+				},
+				RelatedOperations: []*types.OperationIdentifier{},
+				Type:              "PAYMENT",
+				Status:            types.String("SUCCESS"),
+				Account:           validAccount,
+				Amount:            validAmount,
+			},
+		},
+	}
 	invalidRelatedTransaction := &types.Transaction{
 		TransactionIdentifier: &types.TransactionIdentifier{
 			Hash: "blah",
@@ -1044,10 +1080,11 @@ func TestBlock(t *testing.T) {
 	}
 
 	var tests = map[string]struct {
-		block        *types.Block
-		genesisIndex int64
-		startIndex   *int64
-		err          error
+		block              *types.Block
+		validationFilePath string
+		genesisIndex       int64
+		startIndex         *int64
+		err                error
 	}{
 		"valid block": {
 			block: &types.Block{
@@ -1132,6 +1169,16 @@ func TestBlock(t *testing.T) {
 			},
 			err: ErrRelatedOperationIndexDuplicate,
 		},
+		"missing related transaction operations": {
+			block: &types.Block{
+				BlockIdentifier:       validBlockIdentifier,
+				ParentBlockIdentifier: validParentBlockIdentifier,
+				Timestamp:             MinUnixEpoch + 1,
+				Transactions:          []*types.Transaction{relatedMissingTransaction},
+			},
+			err:                ErrRelatedOperationMissing,
+			validationFilePath: "data/validation_balanced_related_ops.json",
+		},
 		"nil block": {
 			block: nil,
 			err:   ErrBlockIsNil,
@@ -1280,7 +1327,7 @@ func TestBlock(t *testing.T) {
 						TimestampStartIndex: test.startIndex,
 					},
 				},
-				"",
+				test.validationFilePath,
 			)
 			assert.NotNil(t, asserter)
 			assert.NoError(t, err)

asserter/data/validation_balanced_related_ops.json

@@ -0,0 +1,19 @@
+{
+  "enabled": true,
+  "related_ops_exists": true,
+  "chain_type": "account",
+  "payment": {
+    "name": "PAYMENT",
+    "operation": {
+      "count": 2,
+      "should_balance": true
+    }
+  },
+  "fee": {
+    "name": "FEE",
+    "operation": {
+      "count": 1,
+      "should_balance": false
+    }
+  }
+}

asserter/data/validation_fee_and_payment_balanced.json

@@ -1,5 +1,6 @@
 {
   "enabled": true,
+  "related_ops_exists": false,
   "chain_type": "account",
   "payment": {
     "name": "PAYMENT",
@@ -15,4 +16,4 @@
       "should_balance": false
     }
   }
-}
+}

asserter/data/validation_fee_and_payment_unbalanced.json

@@ -1,5 +1,6 @@
 {
   "enabled": true,
+  "related_ops_exists": false,
   "chain_type": "account",
   "payment": {
     "name": "PAYMENT",
@@ -15,4 +16,4 @@
       "should_balance": false
     }
   }
-}
+}

asserter/errors.go

@@ -71,6 +71,7 @@ var (
 		"related operation has index greater than operation",
 	)
 	ErrRelatedOperationIndexDuplicate     = errors.New("found duplicate related operation index")
+	ErrRelatedOperationMissing            = errors.New("related operations key is missing")
 	ErrBlockIdentifierIsNil               = errors.New("BlockIdentifier is nil")
 	ErrBlockIdentifierHashMissing         = errors.New("BlockIdentifier.Hash is missing")
 	ErrBlockIdentifierIndexIsNeg          = errors.New("BlockIdentifier.Index is negative")
@@ -119,6 +120,7 @@ var (
 		ErrOperationStatusNotEmptyForConstruction,
 		ErrRelatedOperationIndexOutOfOrder,
 		ErrRelatedOperationIndexDuplicate,
+		ErrRelatedOperationMissing,
 		ErrBlockIdentifierIsNil,
 		ErrBlockIdentifierHashMissing,
 		ErrBlockIdentifierIndexIsNeg,