Add types and assertions for Related Transactions (coinbase#289)

* update codegen file

* run codegen

* add asserter for related transactions

* add comment

* fix gen

* nits

* nits

* fix nil check

asserter/block.go

@@ -354,6 +354,60 @@ func (a *Asserter) Transaction(
 		)
 	}
 
+	if err := a.RelatedTransactions(transaction.RelatedTransactions); err != nil {
+		return fmt.Errorf(
+			"%w invalid related transaction in transaction %s",
+			err,
+			transaction.TransactionIdentifier.Hash,
+		)
+	}
+
+	return nil
+}
+
+// RelatedTransactions returns an error if the related transactions array is non-null and non-empty
+// and
+// any of the related transactions contain invalid types, invalid network identifiers,
+// invalid transaction identifiers, or a direction not defined by the enum.
+func (a *Asserter) RelatedTransactions(relatedTransactions []*types.RelatedTransaction) error {
+	for i, relatedTransaction := range relatedTransactions {
+		if relatedTransaction.NetworkIdentifier != nil {
+			if err := NetworkIdentifier(relatedTransaction.NetworkIdentifier); err != nil {
+				return fmt.Errorf(
+					"%w invalid network identifier in related transaction at index %d",
+					err,
+					i,
+				)
+			}
+		}
+
+		if err := TransactionIdentifier(relatedTransaction.TransactionIdentifier); err != nil {
+			return fmt.Errorf(
+				"%w invalid transaction identifier in related transaction at index %d",
+				err,
+				i,
+			)
+		}
+
+		if err := a.Direction(relatedTransaction.Direction); err != nil {
+			return fmt.Errorf(
+				"%w invalid direction in related transaction at index %d",
+				err,
+				i,
+			)
+		}
+	}
+
+	return nil
+}
+
+// Direction returns an error if the value passed is not types.Forward or types.Backward
+func (a *Asserter) Direction(direction types.Direction) error {
+	if direction != types.Forward &&
+		direction != types.Backward {
+		return ErrInvalidDirection
+	}
+
 	return nil
 }
 

asserter/block_test.go

@@ -553,6 +553,18 @@ func TestBlock(t *testing.T) {
 				Amount:  validAmount,
 			},
 		},
+		RelatedTransactions: []*types.RelatedTransaction{
+			{
+				NetworkIdentifier: &types.NetworkIdentifier{
+					Blockchain: "hello",
+					Network:    "world",
+				},
+				TransactionIdentifier: &types.TransactionIdentifier{
+					Hash: "blah",
+				},
+				Direction: types.Forward,
+			},
+		},
 	}
 	relatedToSelfTransaction := &types.Transaction{
 		TransactionIdentifier: &types.TransactionIdentifier{
@@ -673,6 +685,48 @@ func TestBlock(t *testing.T) {
 			},
 		},
 	}
+	invalidRelatedTransaction := &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{
+					{
+						Index: int64(0),
+					},
+				},
+				Type:    "PAYMENT",
+				Status:  types.String("SUCCESS"),
+				Account: validAccount,
+				Amount:  validAmount,
+			},
+		},
+		RelatedTransactions: []*types.RelatedTransaction{
+			{
+				NetworkIdentifier: &types.NetworkIdentifier{
+					Blockchain: "hello",
+					Network:    "world",
+				},
+				TransactionIdentifier: &types.TransactionIdentifier{
+					Hash: "blah",
+				},
+				Direction: "blah",
+			},
+		},
+	}
 	var tests = map[string]struct {
 		block        *types.Block
 		genesisIndex int64
@@ -845,6 +899,15 @@ func TestBlock(t *testing.T) {
 			},
 			err: ErrTxIdentifierIsNil,
 		},
+		"invalid related transaction": {
+			block: &types.Block{
+				BlockIdentifier:       validBlockIdentifier,
+				ParentBlockIdentifier: validParentBlockIdentifier,
+				Timestamp:             MinUnixEpoch + 1,
+				Transactions:          []*types.Transaction{invalidRelatedTransaction},
+			},
+			err: ErrInvalidDirection,
+		},
 	}
 
 	for name, test := range tests {

asserter/errors.go

@@ -91,6 +91,7 @@ var (
 	ErrBlockIndexPrecedesParentBlockIndex = errors.New(
 		"BlockIdentifier.Index <= ParentBlockIdentifier.Index",
 	)
+	ErrInvalidDirection = errors.New("invalid direction (must be 'forward' or 'backward')")
 
 	BlockErrs = []error{
 		ErrAmountValueMissing,
@@ -125,6 +126,7 @@ var (
 		ErrBlockIsNil,
 		ErrBlockHashEqualsParentBlockHash,
 		ErrBlockIndexPrecedesParentBlockIndex,
+		ErrInvalidDirection,
 	}
 )
 

client/api_account.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2021 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 2020 Coinbase, Inc.
+// Copyright 2021 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 2020 Coinbase, Inc.
+// Copyright 2021 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 2020 Coinbase, Inc.
+// Copyright 2021 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 2020 Coinbase, Inc.
+// Copyright 2021 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 2020 Coinbase, Inc.
+// Copyright 2021 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 2020 Coinbase, Inc.
+// Copyright 2021 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 2020 Coinbase, Inc.
+// Copyright 2021 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 2020 Coinbase, Inc.
+// Copyright 2021 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -41,7 +41,7 @@ var (
 	ErrRetriable = errors.New("retriable http status code received")
 )
 
-// APIClient manages communication with the Rosetta API v1.4.9
+// APIClient manages communication with the Rosetta API v1.4.10
 // In most cases there should be only one, shared, APIClient.
 type APIClient struct {
 	cfg    *Configuration

client/configuration.go

@@ -1,4 +1,4 @@
-// Copyright 2020 Coinbase, Inc.
+// Copyright 2021 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 2020 Coinbase, Inc.
+// Copyright 2021 Coinbase, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

codegen.sh

@@ -53,7 +53,7 @@ done
 rm -rf tmp;
 
 # Download spec file from releases
-ROSETTA_SPEC_VERSION=1.4.9
+ROSETTA_SPEC_VERSION=1.4.10
 curl -L https://github.com/coinbase/rosetta-specifications/releases/download/v${ROSETTA_SPEC_VERSION}/api.json -o api.json;
 
 # Generate client + types code
@@ -120,8 +120,9 @@ sed "${SED_IFLAG[@]}" 's/*SignatureType/SignatureType/g' client/* server/*;
 sed "${SED_IFLAG[@]}" 's/*CoinAction/CoinAction/g' client/* server/*;
 sed "${SED_IFLAG[@]}" 's/*ExemptionType/ExemptionType/g' client/* server/*;
 sed "${SED_IFLAG[@]}" 's/*BlockEventType/BlockEventType/g' client/* server/*;
+sed "${SED_IFLAG[@]}" 's/*Direction/Direction/g' client/* server/*;
 
-# Fix CurveTypes, SignatureTypes, CoinActions, ExemptionTypes 
+# Fix CurveTypes, SignatureTypes, CoinActions, ExemptionTypes, Direction
 sed "${SED_IFLAG[@]}" 's/SECP256K1/Secp256k1/g' client/* server/*;
 sed "${SED_IFLAG[@]}" 's/SECP256R1/Secp256r1/g' client/* server/*;
 sed "${SED_IFLAG[@]}" 's/EDWARDS25519/Edwards25519/g' client/* server/*;
@@ -136,6 +137,8 @@ sed "${SED_IFLAG[@]}" 's/SPENT/CoinSpent/g' client/* server/*;
 sed "${SED_IFLAG[@]}" 's/GREATER_OR_EQUAL/BalanceGreaterOrEqual/g' client/* server/*;
 sed "${SED_IFLAG[@]}" 's/LESS_OR_EQUAL/BalanceLessOrEqual/g' client/* server/*;
 sed "${SED_IFLAG[@]}" 's/DYNAMIC/BalanceDynamic/g' client/* server/*;
+sed "${SED_IFLAG[@]}" 's/FORWARD/Forward/g' client/* server/*;
+sed "${SED_IFLAG[@]}" 's/BACKWARD/Backward/g' client/* server/*;
 
 # Convert HexBytes to Bytes
 sed "${SED_IFLAG[@]}" '/Hex-encoded public key bytes in the format specified by the CurveType/d' client/* server/*;

server/api.go

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

server/api_account.go

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

server/api_block.go

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

server/api_call.go

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

server/api_construction.go

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

server/api_events.go

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

server/api_mempool.go

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

server/api_network.go

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

server/api_search.go

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

server/logger.go

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

server/routers.go

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

types/account_balance_request.go

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

types/account_balance_response.go

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

types/account_coins_request.go

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

types/account_coins_response.go

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

types/account_identifier.go

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

types/allow.go

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

types/amount.go

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

types/balance_exemption.go

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

types/block.go

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

types/block_event.go

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

types/block_event_type.go

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