-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add PublicKeyCodec * Add tests * Remove cache codec * Remove cache codec * Revert proto changes * Revert proto changes * refactor and move docs * Lint * Apply suggestions from code review Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
- Loading branch information
Showing
4 changed files
with
146 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| package types | ||
|
|
||
| import ( | ||
| "github.com/tendermint/tendermint/crypto" | ||
| ) | ||
|
|
||
| // PublicKeyCodec defines a type which can encode and decode crypto.PubKey's | ||
| // to and from protobuf PublicKey's | ||
| type PublicKeyCodec interface { | ||
| // Encode encodes the crypto.PubKey as a protobuf PublicKey or returns an error | ||
| Encode(key crypto.PubKey) (*PublicKey, error) | ||
|
|
||
| // Decode decodes a crypto.PubKey from a protobuf PublicKey or returns an error | ||
| Decode(key *PublicKey) (crypto.PubKey, error) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| package std | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/crypto/types" | ||
| "github.com/cosmos/cosmos-sdk/crypto/types/multisig" | ||
|
|
||
| "github.com/tendermint/tendermint/crypto" | ||
| ed255192 "github.com/tendermint/tendermint/crypto/ed25519" | ||
| "github.com/tendermint/tendermint/crypto/secp256k1" | ||
| "github.com/tendermint/tendermint/crypto/sr25519" | ||
| ) | ||
|
|
||
| // DefaultPublicKeyCodec implements the standard PublicKeyCodec for the SDK which | ||
| // supports a standard set of public key types | ||
| type DefaultPublicKeyCodec struct{} | ||
|
|
||
| var _ types.PublicKeyCodec = DefaultPublicKeyCodec{} | ||
|
|
||
| // Decode implements the PublicKeyCodec.Decode method | ||
| func (cdc DefaultPublicKeyCodec) Decode(key *types.PublicKey) (crypto.PubKey, error) { | ||
| switch key := key.Sum.(type) { | ||
| case *types.PublicKey_Secp256K1: | ||
| n := len(key.Secp256K1) | ||
| if n != secp256k1.PubKeySecp256k1Size { | ||
| return nil, fmt.Errorf("wrong length %d for secp256k1 public key", n) | ||
| } | ||
| var res secp256k1.PubKeySecp256k1 | ||
| copy(res[:], key.Secp256K1) | ||
| return res, nil | ||
| case *types.PublicKey_Ed25519: | ||
| n := len(key.Ed25519) | ||
| if n != ed255192.PubKeyEd25519Size { | ||
| return nil, fmt.Errorf("wrong length %d for ed25519 public key", n) | ||
| } | ||
| var res ed255192.PubKeyEd25519 | ||
| copy(res[:], key.Ed25519) | ||
| return res, nil | ||
| case *types.PublicKey_Sr25519: | ||
| n := len(key.Sr25519) | ||
| if n != sr25519.PubKeySr25519Size { | ||
| return nil, fmt.Errorf("wrong length %d for sr25519 public key", n) | ||
| } | ||
| var res sr25519.PubKeySr25519 | ||
| copy(res[:], key.Sr25519) | ||
| return res, nil | ||
| case *types.PublicKey_Multisig: | ||
| pubKeys := key.Multisig.PubKeys | ||
| resKeys := make([]crypto.PubKey, len(pubKeys)) | ||
| for i, k := range pubKeys { | ||
| dk, err := cdc.Decode(k) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| resKeys[i] = dk | ||
| } | ||
| return multisig.NewPubKeyMultisigThreshold(int(key.Multisig.K), resKeys), nil | ||
| default: | ||
| return nil, fmt.Errorf("can't decode PubKey of type %T. Use a custom PublicKeyCodec instead", key) | ||
| } | ||
| } | ||
|
|
||
| // Encode implements the PublicKeyCodec.Encode method | ||
| func (cdc DefaultPublicKeyCodec) Encode(key crypto.PubKey) (*types.PublicKey, error) { | ||
| switch key := key.(type) { | ||
| case secp256k1.PubKeySecp256k1: | ||
| return &types.PublicKey{Sum: &types.PublicKey_Secp256K1{Secp256K1: key[:]}}, nil | ||
| case ed255192.PubKeyEd25519: | ||
| return &types.PublicKey{Sum: &types.PublicKey_Ed25519{Ed25519: key[:]}}, nil | ||
| case sr25519.PubKeySr25519: | ||
| return &types.PublicKey{Sum: &types.PublicKey_Sr25519{Sr25519: key[:]}}, nil | ||
| case multisig.PubKeyMultisigThreshold: | ||
| pubKeys := key.PubKeys | ||
| resKeys := make([]*types.PublicKey, len(pubKeys)) | ||
| for i, k := range pubKeys { | ||
| dk, err := cdc.Encode(k) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| resKeys[i] = dk | ||
| } | ||
| return &types.PublicKey{Sum: &types.PublicKey_Multisig{Multisig: &types.PubKeyMultisigThreshold{ | ||
| K: uint32(key.K), | ||
| PubKeys: resKeys, | ||
| }}}, nil | ||
| default: | ||
| return nil, fmt.Errorf("can't encode PubKey of type %T. Use a custom PublicKeyCodec instead", key) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| package std_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/std" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "github.com/tendermint/tendermint/crypto" | ||
| "github.com/tendermint/tendermint/crypto/ed25519" | ||
| "github.com/tendermint/tendermint/crypto/secp256k1" | ||
| "github.com/tendermint/tendermint/crypto/sr25519" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/crypto/types/multisig" | ||
| ) | ||
|
|
||
| func roundTripTest(t *testing.T, pubKey crypto.PubKey) { | ||
| cdc := std.DefaultPublicKeyCodec{} | ||
|
|
||
| pubKeyEnc, err := cdc.Encode(pubKey) | ||
| require.NoError(t, err) | ||
| pubKeyDec, err := cdc.Decode(pubKeyEnc) | ||
| require.NoError(t, err) | ||
| require.Equal(t, pubKey, pubKeyDec) | ||
| } | ||
|
|
||
| func TestDefaultPublicKeyCodec(t *testing.T) { | ||
| pubKeySecp256k1 := secp256k1.GenPrivKey().PubKey() | ||
| roundTripTest(t, pubKeySecp256k1) | ||
|
|
||
| pubKeyEd25519 := ed25519.GenPrivKey().PubKey() | ||
| roundTripTest(t, pubKeyEd25519) | ||
|
|
||
| pubKeySr25519 := sr25519.GenPrivKey().PubKey() | ||
| roundTripTest(t, pubKeySr25519) | ||
|
|
||
| pubKeyMultisig := multisig.NewPubKeyMultisigThreshold(2, []crypto.PubKey{ | ||
| pubKeySecp256k1, pubKeyEd25519, pubKeySr25519, | ||
| }) | ||
| roundTripTest(t, pubKeyMultisig) | ||
| } |