construction_test.go

// Copyright 2020 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

import (
	"errors"
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"

	"github.com/coinbase/rosetta-sdk-go/types"
)

func TestConstructionPreprocessResponse(t *testing.T) {
	var tests = map[string]struct {
		response *types.ConstructionPreprocessResponse
		err      error
	}{
		"valid response": {
			response: &types.ConstructionPreprocessResponse{
				Options: map[string]interface{}{},
			},
			err: nil,
		},
		"valid response with accounts": {
			response: &types.ConstructionPreprocessResponse{
				Options: map[string]interface{}{},
				RequiredPublicKeys: []*types.AccountIdentifier{
					{
						Address: "hello",
					},
				},
			},
			err: nil,
		},
		"invalid response with accounts": {
			response: &types.ConstructionPreprocessResponse{
				Options: map[string]interface{}{},
				RequiredPublicKeys: []*types.AccountIdentifier{
					{
						Address: "",
					},
				},
			},
			err: ErrAccountAddrMissing,
		},
		"nil response": {
			err: ErrConstructionPreprocessResponseIsNil,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := ConstructionPreprocessResponse(test.response)
			if test.err != nil {
				assert.Contains(t, err.Error(), test.err.Error())
			} else {
				assert.NoError(t, err)
			}
		})
	}
}

func TestConstructionMetadataResponse(t *testing.T) {
	var tests = map[string]struct {
		response *types.ConstructionMetadataResponse
		err      error
	}{
		"valid response": {
			response: &types.ConstructionMetadataResponse{
				Metadata: map[string]interface{}{},
			},
			err: nil,
		},
		"with suggested fee": {
			response: &types.ConstructionMetadataResponse{
				Metadata: map[string]interface{}{},
				SuggestedFee: []*types.Amount{
					validAmount,
				},
			},
			err: nil,
		},
		"with duplicate suggested fee": {
			response: &types.ConstructionMetadataResponse{
				Metadata: map[string]interface{}{},
				SuggestedFee: []*types.Amount{
					validAmount,
					validAmount,
				},
			},
			err: fmt.Errorf("currency %+v used multiple times", validAmount.Currency),
		},
		"nil response": {
			err: ErrConstructionMetadataResponseIsNil,
		},
		"invalid metadata": {
			response: &types.ConstructionMetadataResponse{},
			err:      ErrConstructionMetadataResponseMetadataMissing,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := ConstructionMetadataResponse(test.response)
			if test.err != nil {
				assert.Contains(t, err.Error(), test.err.Error())
			} else {
				assert.NoError(t, err)
			}
		})
	}
}

func TestTransactionIdentifierResponse(t *testing.T) {
	var tests = map[string]struct {
		response *types.TransactionIdentifierResponse
		err      error
	}{
		"valid response": {
			response: &types.TransactionIdentifierResponse{
				TransactionIdentifier: &types.TransactionIdentifier{
					Hash: "tx1",
				},
			},
			err: nil,
		},
		"nil response": {
			err: ErrTxIdentifierResponseIsNil,
		},
		"invalid transaction identifier": {
			response: &types.TransactionIdentifierResponse{},
			err:      ErrTxIdentifierIsNil,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := TransactionIdentifierResponse(test.response)
			assert.True(t, errors.Is(err, test.err))
		})
	}
}

func TestConstructionCombineResponse(t *testing.T) {
	var tests = map[string]struct {
		response *types.ConstructionCombineResponse
		err      error
	}{
		"valid response": {
			response: &types.ConstructionCombineResponse{
				SignedTransaction: "signed tx",
			},
			err: nil,
		},
		"nil response": {
			err: ErrConstructionCombineResponseIsNil,
		},
		"empty signed transaction": {
			response: &types.ConstructionCombineResponse{},
			err:      ErrSignedTxEmpty,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := ConstructionCombineResponse(test.response)
			assert.True(t, errors.Is(err, test.err))
		})
	}
}

func TestConstructionDeriveResponse(t *testing.T) {
	var tests = map[string]struct {
		response *types.ConstructionDeriveResponse
		err      error
	}{
		"valid response": {
			response: &types.ConstructionDeriveResponse{
				AccountIdentifier: &types.AccountIdentifier{
					Address: "addr",
				},
				Metadata: map[string]interface{}{
					"name": "hello",
				},
			},
			err: nil,
		},
		"nil response": {
			err: ErrConstructionDeriveResponseIsNil,
		},
		"empty address": {
			response: &types.ConstructionDeriveResponse{
				Metadata: map[string]interface{}{
					"name": "hello",
				},
			},
			err: ErrConstructionDeriveResponseAddrEmpty,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := ConstructionDeriveResponse(test.response)
			assert.True(t, errors.Is(err, test.err))
		})
	}
}

func TestConstructionParseResponse(t *testing.T) {
	var tests = map[string]struct {
		response *types.ConstructionParseResponse
		signed   bool
		err      error
	}{
		"valid response": {
			response: &types.ConstructionParseResponse{
				Operations: []*types.Operation{
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(0),
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(1),
						},
						RelatedOperations: []*types.OperationIdentifier{
							{Index: int64(0)},
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
				},
				AccountIdentifierSigners: []*types.AccountIdentifier{
					validAccount,
				},
				Metadata: map[string]interface{}{
					"extra": "stuff",
				},
			},
			signed: true,
			err:    nil,
		},
		"duplicate signer": {
			response: &types.ConstructionParseResponse{
				Operations: []*types.Operation{
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(0),
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(1),
						},
						RelatedOperations: []*types.OperationIdentifier{
							{Index: int64(0)},
						},
						Type:    "PAYMENT",
						Account: &types.AccountIdentifier{Address: "addr 2"},
						Amount:  validAmount,
					},
				},
				AccountIdentifierSigners: []*types.AccountIdentifier{
					validAccount,
					validAccount,
				},
				Metadata: map[string]interface{}{
					"extra": "stuff",
				},
			},
			signed: true,
			err:    ErrConstructionParseResponseDuplicateSigner,
		},
		"nil response": {
			err: ErrConstructionParseResponseIsNil,
		},
		"no operations": {
			response: &types.ConstructionParseResponse{
				AccountIdentifierSigners: []*types.AccountIdentifier{
					validAccount,
				},
				Metadata: map[string]interface{}{
					"extra": "stuff",
				},
			},
			err: ErrConstructionParseResponseOperationsEmpty,
		},
		"invalid operation ordering": {
			response: &types.ConstructionParseResponse{
				Operations: []*types.Operation{
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(1),
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
				},
				AccountIdentifierSigners: []*types.AccountIdentifier{
					validAccount,
				},
				Metadata: map[string]interface{}{
					"extra": "stuff",
				},
			},
			err: ErrOperationIdentifierIndexOutOfOrder,
		},
		"no signers": {
			response: &types.ConstructionParseResponse{
				Operations: []*types.Operation{
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(0),
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(1),
						},
						RelatedOperations: []*types.OperationIdentifier{
							{Index: int64(0)},
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
				},
				Metadata: map[string]interface{}{
					"extra": "stuff",
				},
			},
			signed: true,
			err:    ErrConstructionParseResponseSignersEmptyOnSignedTx,
		},
		"empty account identifier signer": {
			response: &types.ConstructionParseResponse{
				Operations: []*types.Operation{
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(0),
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(1),
						},
						RelatedOperations: []*types.OperationIdentifier{
							{Index: int64(0)},
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
				},
				AccountIdentifierSigners: []*types.AccountIdentifier{{}},
				Metadata: map[string]interface{}{
					"extra": "stuff",
				},
			},
			signed: true,
			err:    ErrConstructionParseResponseSignerEmpty,
		},
		"invalid signer unsigned": {
			response: &types.ConstructionParseResponse{
				Operations: []*types.Operation{
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(0),
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(1),
						},
						RelatedOperations: []*types.OperationIdentifier{
							{Index: int64(0)},
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
				},
				Metadata: map[string]interface{}{
					"extra": "stuff",
				},
				AccountIdentifierSigners: []*types.AccountIdentifier{
					validAccount,
				},
			},
			signed: false,
			err:    ErrConstructionParseResponseSignersNonEmptyOnUnsignedTx,
		},
		"valid response unsigned": {
			response: &types.ConstructionParseResponse{
				Operations: []*types.Operation{
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(0),
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
					{
						OperationIdentifier: &types.OperationIdentifier{
							Index: int64(1),
						},
						RelatedOperations: []*types.OperationIdentifier{
							{Index: int64(0)},
						},
						Type:    "PAYMENT",
						Account: validAccount,
						Amount:  validAmount,
					},
				},
				Metadata: map[string]interface{}{
					"extra": "stuff",
				},
			},
			signed: false,
			err:    nil,
		},
	}

	asserter, err := NewClientWithResponses(
		&types.NetworkIdentifier{
			Blockchain: "hello",
			Network:    "world",
		},
		&types.NetworkStatusResponse{
			GenesisBlockIdentifier: &types.BlockIdentifier{
				Index: 0,
				Hash:  "block 0",
			},
			CurrentBlockIdentifier: &types.BlockIdentifier{
				Index: 100,
				Hash:  "block 100",
			},
			CurrentBlockTimestamp: MinUnixEpoch + 1,
			Peers: []*types.Peer{
				{
					PeerID: "peer 1",
				},
			},
		},
		&types.NetworkOptionsResponse{
			Version: &types.Version{
				RosettaVersion: "1.4.0",
				NodeVersion:    "1.0",
			},
			Allow: &types.Allow{
				OperationStatuses: []*types.OperationStatus{
					{
						Status:     "SUCCESS",
						Successful: true,
					},
					{
						Status:     "FAILURE",
						Successful: false,
					},
				},
				OperationTypes: []string{
					"PAYMENT",
				},
			},
		},
		"",
	)
	assert.NotNil(t, asserter)
	assert.NoError(t, err)

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := asserter.ConstructionParseResponse(test.response, test.signed)
			if test.err != nil {
				assert.Error(t, err)
				assert.True(t, errors.Is(err, test.err))
			} else {
				assert.NoError(t, err)
			}
		})
	}
}

func TestConstructionPayloadsResponse(t *testing.T) {
	var tests = map[string]struct {
		response *types.ConstructionPayloadsResponse
		err      error
	}{
		"valid response": {
			response: &types.ConstructionPayloadsResponse{
				UnsignedTransaction: "tx blob",
				Payloads: []*types.SigningPayload{
					{
						AccountIdentifier: &types.AccountIdentifier{
							Address: "hello",
						},
						Bytes: []byte("48656c6c6f20476f7068657221"),
					},
				},
			},
			err: nil,
		},
		"nil response": {
			err: ErrConstructionPayloadsResponseIsNil,
		},
		"empty unsigned transaction": {
			response: &types.ConstructionPayloadsResponse{
				Payloads: []*types.SigningPayload{
					{
						AccountIdentifier: &types.AccountIdentifier{
							Address: "hello",
						},
						Bytes: []byte("48656c6c6f20476f7068657221"),
					},
				},
			},
			err: ErrConstructionPayloadsResponseUnsignedTxEmpty,
		},
		"empty signing payloads": {
			response: &types.ConstructionPayloadsResponse{
				UnsignedTransaction: "tx blob",
			},
			err: ErrConstructionPayloadsResponsePayloadsEmpty,
		},
		"invalid signing payload": {
			response: &types.ConstructionPayloadsResponse{
				UnsignedTransaction: "tx blob",
				Payloads: []*types.SigningPayload{
					{
						Bytes: []byte("48656c6c6f20476f7068657221"),
					},
				},
			},
			err: ErrSigningPayloadAddrEmpty,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := ConstructionPayloadsResponse(test.response)
			if test.err != nil {
				assert.Error(t, err)
				assert.True(t, errors.Is(err, test.err))
			} else {
				assert.NoError(t, err)
			}
		})
	}
}

func TestPublicKey(t *testing.T) {
	var tests = map[string]struct {
		publicKey *types.PublicKey
		err       error
	}{
		"valid public key": {
			publicKey: &types.PublicKey{
				Bytes:     []byte("blah"),
				CurveType: types.Secp256k1,
			},
		},
		"zero public key": {
			publicKey: &types.PublicKey{
				Bytes:     []byte{0, 0, 0, 0},
				CurveType: types.Secp256k1,
			},
			err: ErrPublicKeyBytesZero,
		},
		"nil public key": {
			err: ErrPublicKeyIsNil,
		},
		"invalid bytes": {
			publicKey: &types.PublicKey{
				CurveType: types.Secp256k1,
			},
			err: ErrPublicKeyBytesEmpty,
		},
		"invalid curve": {
			publicKey: &types.PublicKey{
				Bytes:     []byte("hello"),
				CurveType: "test",
			},
			err: ErrCurveTypeNotSupported,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := PublicKey(test.publicKey)
			if test.err != nil {
				assert.Error(t, err)
				assert.True(t, errors.Is(err, test.err))
			} else {
				assert.NoError(t, err)
			}
		})
	}
}

func TestSigningPayload(t *testing.T) {
	var tests = map[string]struct {
		signingPayload *types.SigningPayload
		err            error
	}{
		"valid signing payload": {
			signingPayload: &types.SigningPayload{
				AccountIdentifier: &types.AccountIdentifier{
					Address: "hello",
				},
				Bytes: []byte("blah"),
			},
		},
		"valid signing payload with signature type": {
			signingPayload: &types.SigningPayload{
				AccountIdentifier: &types.AccountIdentifier{
					Address: "hello",
				},
				Bytes:         []byte("blah"),
				SignatureType: types.Ed25519,
			},
		},
		"nil signing payload": {
			err: ErrSigningPayloadIsNil,
		},
		"empty address": {
			signingPayload: &types.SigningPayload{
				Bytes: []byte("blah"),
			},
			err: ErrSigningPayloadAddrEmpty,
		},
		"zero signing payload": {
			signingPayload: &types.SigningPayload{
				AccountIdentifier: &types.AccountIdentifier{
					Address: "hello",
				},
				Bytes: []byte{0, 0, 0, 0},
			},
			err: ErrSigningPayloadBytesZero,
		},
		"empty bytes": {
			signingPayload: &types.SigningPayload{
				AccountIdentifier: &types.AccountIdentifier{
					Address: "hello",
				},
			},
			err: ErrSigningPayloadBytesEmpty,
		},
		"invalid signature": {
			signingPayload: &types.SigningPayload{
				AccountIdentifier: &types.AccountIdentifier{
					Address: "hello",
				},
				Bytes:         []byte("blah"),
				SignatureType: "blah",
			},
			err: ErrSignatureTypeNotSupported,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := SigningPayload(test.signingPayload)
			if test.err != nil {
				assert.Error(t, err)
				assert.True(t, errors.Is(err, test.err))
			} else {
				assert.NoError(t, err)
			}
		})
	}
}

func TestSignatures(t *testing.T) {
	var tests = map[string]struct {
		signatures []*types.Signature
		err        error
	}{
		"valid signatures": {
			signatures: []*types.Signature{
				{
					SigningPayload: &types.SigningPayload{
						AccountIdentifier: validAccount,
						Bytes:             []byte("blah"),
					},
					PublicKey:     validPublicKey,
					SignatureType: types.Ed25519,
					Bytes:         []byte("hello"),
				},
				{
					SigningPayload: &types.SigningPayload{
						AccountIdentifier: validAccount,
						Bytes:             []byte("blah"),
					},
					PublicKey:     validPublicKey,
					SignatureType: types.EcdsaRecovery,
					Bytes:         []byte("hello"),
				},
			},
		},
		"signature type match": {
			signatures: []*types.Signature{
				{
					SigningPayload: &types.SigningPayload{
						AccountIdentifier: validAccount,
						Bytes:             []byte("blah"),
						SignatureType:     types.Ed25519,
					},
					PublicKey:     validPublicKey,
					SignatureType: types.Ed25519,
					Bytes:         []byte("hello"),
				},
			},
		},
		"nil signatures": {
			err: ErrSignaturesEmpty,
		},
		"empty signature": {
			signatures: []*types.Signature{
				{
					SigningPayload: &types.SigningPayload{
						AccountIdentifier: validAccount,
						Bytes:             []byte("blah"),
					},
					PublicKey:     validPublicKey,
					SignatureType: types.EcdsaRecovery,
					Bytes:         []byte("hello"),
				},
				{
					SigningPayload: &types.SigningPayload{
						AccountIdentifier: validAccount,
						Bytes:             []byte("blah"),
						SignatureType:     types.Ed25519,
					},
					PublicKey:     validPublicKey,
					SignatureType: types.Ed25519,
				},
			},
			err: ErrSignatureBytesEmpty,
		},
		"signature zero bytes": {
			signatures: []*types.Signature{
				{
					SigningPayload: &types.SigningPayload{
						AccountIdentifier: validAccount,
						Bytes:             []byte("blah"),
						SignatureType:     types.Ed25519,
					},
					PublicKey:     validPublicKey,
					SignatureType: types.Ed25519,
					Bytes:         []byte{0},
				},
			},
			err: ErrSignatureBytesZero,
		},
		"signature type mismatch": {
			signatures: []*types.Signature{
				{
					SigningPayload: &types.SigningPayload{
						AccountIdentifier: validAccount,
						Bytes:             []byte("blah"),
						SignatureType:     types.EcdsaRecovery,
					},
					PublicKey:     validPublicKey,
					SignatureType: types.Ed25519,
					Bytes:         []byte("hello"),
				},
			},
			err: ErrSignaturesReturnedSigMismatch,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			err := Signatures(test.signatures)
			if test.err != nil {
				assert.Error(t, err)
				assert.True(t, errors.Is(err, test.err))
			} else {
				assert.NoError(t, err)
			}
		})
	}
}