From 8761b274896861aef79cd3341a84a65bfd905f44 Mon Sep 17 00:00:00 2001 From: Dev Ojha Date: Tue, 9 Oct 2018 05:41:33 -0700 Subject: [PATCH] crypto: Add a way to go from pubkey to route (#2574) This is intended for use in a future PR for #2414 --- crypto/encoding/amino/amino.go | 23 ++++++++++++++++++++++- crypto/encoding/amino/encode_test.go | 22 ++++++++++++++++++++++ 2 files changed, 44 insertions(+), 1 deletion(-) diff --git a/crypto/encoding/amino/amino.go b/crypto/encoding/amino/amino.go index 7728e6afb..d0ae8ebf0 100644 --- a/crypto/encoding/amino/amino.go +++ b/crypto/encoding/amino/amino.go @@ -1,8 +1,11 @@ package cryptoAmino import ( - amino "github.com/tendermint/go-amino" + "errors" + + "reflect" + amino "github.com/tendermint/go-amino" "github.com/tendermint/tendermint/crypto" "github.com/tendermint/tendermint/crypto/ed25519" "github.com/tendermint/tendermint/crypto/multisig" @@ -10,6 +13,7 @@ import ( ) var cdc = amino.NewCodec() +var routeTable = make(map[reflect.Type]string, 3) func init() { // NOTE: It's important that there be no conflicts here, @@ -19,6 +23,23 @@ func init() { // https://github.com/tendermint/go-amino/issues/9 // is resolved RegisterAmino(cdc) + + // TODO: Have amino provide a way to go from concrete struct to route directly. + // Its currently a private API + routeTable[reflect.TypeOf(ed25519.PubKeyEd25519{})] = ed25519.PubKeyAminoRoute + routeTable[reflect.TypeOf(secp256k1.PubKeySecp256k1{})] = secp256k1.PubKeyAminoRoute + routeTable[reflect.TypeOf(&multisig.PubKeyMultisigThreshold{})] = multisig.PubKeyMultisigThresholdAminoRoute +} + +// PubkeyAminoRoute returns the amino route of a pubkey +// cdc is currently passed in, as eventually this will not be using +// a package level codec. +func PubkeyAminoRoute(cdc *amino.Codec, key crypto.PubKey) (string, error) { + route, ok := routeTable[reflect.TypeOf(key)] + if !ok { + return "", errors.New("Pubkey type not known") + } + return route, nil } // RegisterAmino registers all crypto related types in the given (amino) codec. diff --git a/crypto/encoding/amino/encode_test.go b/crypto/encoding/amino/encode_test.go index 7235ba694..80ed71459 100644 --- a/crypto/encoding/amino/encode_test.go +++ b/crypto/encoding/amino/encode_test.go @@ -8,6 +8,7 @@ import ( "github.com/stretchr/testify/require" "github.com/tendermint/tendermint/crypto" "github.com/tendermint/tendermint/crypto/ed25519" + "github.com/tendermint/tendermint/crypto/multisig" "github.com/tendermint/tendermint/crypto/secp256k1" ) @@ -127,3 +128,24 @@ func TestPubKeyInvalidDataProperReturnsEmpty(t *testing.T) { require.NotNil(t, err, "expecting a non-nil error") require.Nil(t, pk, "expecting an empty public key on error") } + +func TestPubkeyAminoRoute(t *testing.T) { + tests := []struct { + key crypto.PubKey + want string + wantErr bool + }{ + {ed25519.PubKeyEd25519{}, ed25519.PubKeyAminoRoute, false}, + {secp256k1.PubKeySecp256k1{}, secp256k1.PubKeyAminoRoute, false}, + {&multisig.PubKeyMultisigThreshold{}, multisig.PubKeyMultisigThresholdAminoRoute, false}, + } + for i, tc := range tests { + got, err := PubkeyAminoRoute(cdc, tc.key) + if tc.wantErr { + require.Error(t, err, "tc %d", i) + } else { + require.NoError(t, err, "tc %d", i) + require.Equal(t, tc.want, got, "tc %d", i) + } + } +}