Merge PR #5533: Protobuf: x/auth & x/supply

simapp/codec/codec.go

@@ -0,0 +1,128 @@
+package codec
+
+import (
+	"github.com/cosmos/cosmos-sdk/codec"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/module"
+	"github.com/cosmos/cosmos-sdk/x/auth"
+	authexported "github.com/cosmos/cosmos-sdk/x/auth/exported"
+	"github.com/cosmos/cosmos-sdk/x/auth/vesting"
+	"github.com/cosmos/cosmos-sdk/x/supply"
+	"github.com/cosmos/cosmos-sdk/x/supply/exported"
+)
+
+var (
+	_ auth.Codec   = (*Codec)(nil)
+	_ supply.Codec = (*Codec)(nil)
+)
+
+// Codec defines the application-level codec. This codec contains all the
+// required module-specific codecs that are to be provided upon initialization.
+type Codec struct {
+	codec.Marshaler
+
+	// Keep reference to the amino codec to allow backwards compatibility along
+	// with type, and interface registration.
+	amino *codec.Codec
+}
+
+func NewAppCodec(amino *codec.Codec) *Codec {
+	return &Codec{Marshaler: codec.NewHybridCodec(amino), amino: amino}
+}
+
+// MarshalAccount marshals an Account interface. If the given type implements
+// the Marshaler interface, it is treated as a Proto-defined message and
+// serialized that way. Otherwise, it falls back on the internal Amino codec.
+func (c *Codec) MarshalAccount(accI authexported.Account) ([]byte, error) {
+	acc := &Account{}
+	if err := acc.SetAccount(accI); err != nil {
+		return nil, err
+	}
+
+	return c.Marshaler.MarshalBinaryLengthPrefixed(acc)
+}
+
+// UnmarshalAccount returns an Account interface from raw encoded account bytes
+// of a Proto-based Account type. An error is returned upon decoding failure.
+func (c *Codec) UnmarshalAccount(bz []byte) (authexported.Account, error) {
+	acc := &Account{}
+	if err := c.Marshaler.UnmarshalBinaryLengthPrefixed(bz, acc); err != nil {
+		return nil, err
+	}
+
+	return acc.GetAccount(), nil
+}
+
+// MarshalAccountJSON JSON encodes an account object implementing the Account
+// interface.
+func (c *Codec) MarshalAccountJSON(acc authexported.Account) ([]byte, error) {
+	return c.Marshaler.MarshalJSON(acc)
+}
+
+// UnmarshalAccountJSON returns an Account from JSON encoded bytes.
+func (c *Codec) UnmarshalAccountJSON(bz []byte) (authexported.Account, error) {
+	acc := &Account{}
+	if err := c.Marshaler.UnmarshalJSON(bz, acc); err != nil {
+		return nil, err
+	}
+
+	return acc.GetAccount(), nil
+}
+
+// MarshalSupply marshals a SupplyI interface. If the given type implements
+// the Marshaler interface, it is treated as a Proto-defined message and
+// serialized that way. Otherwise, it falls back on the internal Amino codec.
+func (c *Codec) MarshalSupply(supplyI exported.SupplyI) ([]byte, error) {
+	supply := &Supply{}
+	if err := supply.SetSupplyI(supplyI); err != nil {
+		return nil, err
+	}
+
+	return c.Marshaler.MarshalBinaryLengthPrefixed(supply)
+}
+
+// UnmarshalSupply returns a SupplyI interface from raw encoded account bytes
+// of a Proto-based SupplyI type. An error is returned upon decoding failure.
+func (c *Codec) UnmarshalSupply(bz []byte) (exported.SupplyI, error) {
+	supply := &Supply{}
+	if err := c.Marshaler.UnmarshalBinaryLengthPrefixed(bz, supply); err != nil {
+		return nil, err
+	}
+
+	return supply.GetSupplyI(), nil
+}
+
+// MarshalSupplyJSON JSON encodes a supply object implementing the SupplyI
+// interface.
+func (c *Codec) MarshalSupplyJSON(supply exported.SupplyI) ([]byte, error) {
+	return c.Marshaler.MarshalJSON(supply)
+}
+
+// UnmarshalSupplyJSON returns a SupplyI from JSON encoded bytes.
+func (c *Codec) UnmarshalSupplyJSON(bz []byte) (exported.SupplyI, error) {
+	supply := &Supply{}
+	if err := c.Marshaler.UnmarshalJSON(bz, supply); err != nil {
+		return nil, err
+	}
+
+	return supply.GetSupplyI(), nil
+}
+
+// ----------------------------------------------------------------------------
+
+// MakeCodec creates and returns a reference to an Amino codec that has all the
+// necessary types and interfaces registered. This codec is provided to all the
+// modules the application depends on.
+//
+// NOTE: This codec will be deprecated in favor of AppCodec once all modules are
+// migrated.
+func MakeCodec(bm module.BasicManager) *codec.Codec {
+	cdc := codec.New()
+
+	bm.RegisterCodec(cdc)
+	vesting.RegisterCodec(cdc)
+	sdk.RegisterCodec(cdc)
+	codec.RegisterCrypto(cdc)
+
+	return cdc
+}

simapp/codec/codec.proto

@@ -0,0 +1,33 @@
+syntax = "proto3";
+package cosmos_sdk.simapp.codec.v1;
+
+import "third_party/proto/cosmos-proto/cosmos.proto";
+import "x/auth/types/types.proto";
+import "x/auth/vesting/types/types.proto";
+import "x/supply/types/types.proto";
+
+option go_package = "github.com/cosmos/cosmos-sdk/simapp/codec";
+
+// Account defines the application-level Account type.
+message Account {
+  option (cosmos_proto.interface_type) = "*github.com/cosmos/cosmos-sdk/x/auth/exported.Account";
+
+  // sum defines a list of all acceptable concrete Account implementations.
+  oneof sum {
+    cosmos_sdk.x.auth.v1.BaseAccount                      base_account               = 1;
+    cosmos_sdk.x.auth.vesting.v1.ContinuousVestingAccount continuous_vesting_account = 2;
+    cosmos_sdk.x.auth.vesting.v1.DelayedVestingAccount    delayed_vesting_account    = 3;
+    cosmos_sdk.x.auth.vesting.v1.PeriodicVestingAccount   periodic_vesting_account   = 4;
+    cosmos_sdk.x.supply.v1.ModuleAccount                  module_account             = 5;
+  }
+}
+
+// Supply defines the application-level Supply type.
+message Supply {
+  option (cosmos_proto.interface_type) = "*github.com/cosmos/cosmos-sdk/x/supply/exported.SupplyI";
+
+  // sum defines a list of all acceptable concrete Supply implementations.
+  oneof sum {
+    cosmos_sdk.x.supply.v1.Supply supply = 1;
+  }
+}