feat(bank/v2): Basic CreateDenom

x/bank/proto/cosmos/bank/v2/authorityMetadata.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+package cosmos.bank.v2;
+
+import "gogoproto/gogo.proto";
+import "cosmos/base/v1beta1/coin.proto";
+
+option go_package = "cosmossdk.io/x/bank/v2/types";
+
+// DenomAuthorityMetadata specifies metadata for addresses that have specific
+// capabilities over a token factory denom. Right now there is only one Admin
+// permission, but is planned to be extended to the future.
+message DenomAuthorityMetadata {
+  option (gogoproto.equal) = true;
+
+  // Can be empty for no admin, or a valid osmosis address
+  string admin = 1 [(gogoproto.moretags) = "yaml:\"admin\""];
+}

x/bank/proto/cosmos/bank/v2/bank.proto

@@ -1,7 +1,65 @@
 syntax = "proto3";
 package cosmos.bank.v2;
 
+import "gogoproto/gogo.proto";
+import "cosmos_proto/cosmos.proto";
+import "cosmos/base/v1beta1/coin.proto";
+
 option go_package = "cosmossdk.io/x/bank/v2/types";
 
 // Params defines the parameters for the bank/v2 module.
-message Params {}
+message Params {
+  // DenomCreationFee defines the fee to be charged on the creation of a new
+  // denom. The fee is drawn from the MsgCreateDenom's sender account, and
+  // transferred to the community pool.
+  repeated cosmos.base.v1beta1.Coin denom_creation_fee = 1 [
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+    (gogoproto.moretags)     = "yaml:\"denom_creation_fee\"",
+    (gogoproto.nullable)     = false
+  ];
+
+  // DenomCreationGasConsume defines the gas cost for creating a new denom.
+  // This is intended as a spam deterrence mechanism.
+  //
+  // See: https://github.com/CosmWasm/token-factory/issues/11
+  uint64 denom_creation_gas_consume = 2
+      [(gogoproto.moretags) = "yaml:\"denom_creation_gas_consume\"", (gogoproto.nullable) = true];
+}
+
+// DenomUnit represents a struct that describes a given
+// denomination unit of the basic token.
+message DenomUnit {
+  // denom represents the string name of the given denom unit (e.g uatom).
+  string denom = 1;
+  // exponent represents power of 10 exponent that one must
+  // raise the base_denom to in order to equal the given DenomUnit's denom
+  // 1 denom = 10^exponent base_denom
+  // (e.g. with a base_denom of uatom, one can create a DenomUnit of 'atom' with
+  // exponent = 6, thus: 1 atom = 10^6 uatom).
+  uint32 exponent = 2;
+  // aliases is a list of string aliases for the given denom
+  repeated string aliases = 3;
+}
+
+// Metadata represents a struct that describes
+// a basic token.
+message Metadata {
+  string description = 1;
+  // denom_units represents the list of DenomUnit's for a given coin
+  repeated DenomUnit denom_units = 2;
+  // base represents the base denom (should be the DenomUnit with exponent = 0).
+  string base = 3;
+  // display indicates the suggested denom that should be
+  // displayed in clients.
+  string display = 4;
+  // name defines the name of the token (eg: Cosmos Atom)
+  string name = 5 [(cosmos_proto.field_added_in) = "cosmos-sdk 0.43"];
+  // symbol is the token symbol usually shown on exchanges (eg: ATOM). This can
+  // be the same as the display.
+  string symbol = 6 [(cosmos_proto.field_added_in) = "cosmos-sdk 0.43"];
+  // URI to a document (on or off-chain) that contains additional information. Optional.
+  string uri = 7 [(gogoproto.customname) = "URI", (cosmos_proto.field_added_in) = "cosmos-sdk 0.46"];
+  // URIHash is a sha256 hash of a document pointed by URI. It's used to verify that
+  // the document didn't change. Optional.
+  string uri_hash = 8 [(gogoproto.customname) = "URIHash", (cosmos_proto.field_added_in) = "cosmos-sdk 0.46"];
+}

x/bank/proto/cosmos/bank/v2/genesis.proto

@@ -3,6 +3,7 @@ package cosmos.bank.v2;
 
 import "gogoproto/gogo.proto";
 import "cosmos/bank/v2/bank.proto";
+import "cosmos/bank/v2/authorityMetadata.proto";
 import "amino/amino.proto";
 import "cosmos/base/v1beta1/coin.proto";
 import "cosmos_proto/cosmos.proto";
@@ -25,6 +26,11 @@ message GenesisState {
     (gogoproto.nullable)     = false,
     (amino.dont_omitempty)   = true
   ];
+
+  // denom_metadata defines the metadata of the different coins.
+  repeated Metadata denom_metadata = 4 [(gogoproto.nullable) = false, (amino.dont_omitempty) = true];
+
+  repeated GenesisDenom factory_denoms = 5 [(gogoproto.nullable) = false];
 }
 
 // Balance defines an account address and balance pair used in the bank module's
@@ -43,4 +49,14 @@ message Balance {
     (gogoproto.nullable)     = false,
     (amino.dont_omitempty)   = true
   ];
+}
+
+// GenesisDenom defines a tokenfactory denom that is defined within genesis
+// state. The structure contains DenomAuthorityMetadata which defines the
+// denom's admin.
+message GenesisDenom {
+  option (gogoproto.equal) = true;
+
+  string                 denom              = 1;
+  DenomAuthorityMetadata authority_metadata = 2 [(gogoproto.nullable) = false];
 }

x/bank/proto/cosmos/bank/v2/tx.proto

@@ -44,6 +44,33 @@ message MsgSend {
 // MsgSendResponse defines the response structure for executing a MsgSend message.
 message MsgSendResponse {}
 
+// MsgCreateDenom represents a message to create new denom.
+message MsgCreateDenom {
+  option (cosmos.msg.v1.signer) = "sender";
+  option (amino.name)           = "cosmos-sdk/x/bank/v2/MsgCreateDenom";
+
+  string sender   = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  string subdenom = 2;
+}
+
+// MsgCreateDenomResponse defines the response structure for executing a MsgCreateDenom message.
+message MsgCreateDenomResponse {
+  string new_token_denom = 1;
+}
+
+// MsgChangeAdmin represents a message to change admin of denom.
+message MsgChangeAdmin {
+  option (cosmos.msg.v1.signer) = "sender";
+  option (amino.name)           = "cosmos-sdk/x/bank/v2/MsgChangeAdmin";
+
+  string sender    = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+  string denom     = 2;
+  string new_admin = 3 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+}
+
+// MsgChangeAdminResponse defines the response structure for executing a MsgChangeAdmin message.
+message MsgChangeAdminResponse {}
+
 // MsgMint is the Msg/Mint request type.
 message MsgMint {
   option (cosmos.msg.v1.signer) = "authority";

x/bank/v2/keeper/admins.go

@@ -0,0 +1,34 @@
+package keeper
+
+import (
+	"context"
+
+	"cosmossdk.io/x/bank/v2/types"
+)
+
+// GetAuthorityMetadata returns the authority metadata for a specific denom
+func (k Keeper) GetAuthorityMetadata(ctx context.Context, denom string) (types.DenomAuthorityMetadata, error) {
+	authority, err := k.denomAuthority.Get(ctx, denom)
+	return authority, err
+}
+
+// setAuthorityMetadata stores authority metadata for a specific denom
+func (k Keeper) setAuthorityMetadata(ctx context.Context, denom string, metadata types.DenomAuthorityMetadata) error {
+	err := metadata.Validate()
+	if err != nil {
+		return err
+	}
+
+	return k.denomAuthority.Set(ctx, denom, metadata)
+}
+
+func (k Keeper) setAdmin(ctx context.Context, denom, admin string) error {
+	metadata, err := k.GetAuthorityMetadata(ctx, denom)
+	if err != nil {
+		return err
+	}
+
+	metadata.Admin = admin
+
+	return k.setAuthorityMetadata(ctx, denom, metadata)
+}

x/bank/v2/keeper/createdenom.go

@@ -0,0 +1,111 @@
+package keeper
+
+import (
+	"context"
+	"fmt"
+
+	"cosmossdk.io/x/bank/v2/types"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/address"
+)
+
+// ConvertToBaseToken converts a fee amount in a whitelisted fee token to the base fee token amount
+func (k Keeper) CreateDenom(ctx context.Context, creatorAddr, subdenom string) (newTokenDenom string, err error) {
+	denom, err := k.validateCreateDenom(ctx, creatorAddr, subdenom)
+	if err != nil {
+		return "", err
+	}
+
+	err = k.chargeForCreateDenom(ctx, creatorAddr)
+	if err != nil {
+		return "", err
+	}
+
+	err = k.createDenomAfterValidation(ctx, creatorAddr, denom)
+	return denom, err
+}
+
+// Runs CreateDenom logic after the charge and all denom validation has been handled.
+// Made into a second function for genesis initialization.
+func (k Keeper) createDenomAfterValidation(ctx context.Context, creatorAddr, denom string) (err error) {
+	_, exists := k.GetDenomMetaData(ctx, denom)
+	if !exists {
+		denomMetaData := types.Metadata{
+			DenomUnits: []*types.DenomUnit{{
+				Denom:    denom,
+				Exponent: 0,
+			}},
+			Base:    denom,
+			Name:    denom,
+			Symbol:  denom,
+			Display: denom,
+		}
+
+		err := k.SetDenomMetaData(ctx, denomMetaData)
+		if err != nil {
+			return err
+		}
+	}
+
+	authorityMetadata := types.DenomAuthorityMetadata{
+		Admin: creatorAddr,
+	}
+	err = k.setAuthorityMetadata(ctx, denom, authorityMetadata)
+	if err != nil {
+		return err
+	}
+
+	// TODO: do we need map creator => denom
+	// k.addDenomFromCreator(ctx, creatorAddr, denom)
+	return nil
+}
+
+func (k Keeper) validateCreateDenom(ctx context.Context, creatorAddr, subdenom string) (newTokenDenom string, err error) {
+	// Temporary check until IBC bug is sorted out
+	if k.HasSupply(ctx, subdenom) {
+		return "", fmt.Errorf("temporary error until IBC bug is sorted out, " +
+			"can't create subdenoms that are the same as a native denom")
+	}
+
+	denom, err := types.GetTokenDenom(creatorAddr, subdenom)
+	if err != nil {
+		return "", err
+	}
+
+	_, found := k.GetDenomMetaData(ctx, denom)
+	if found {
+		return "", types.ErrDenomExists
+	}
+
+	return denom, nil
+}
+
+func (k Keeper) chargeForCreateDenom(ctx context.Context, creatorAddr string) (err error) {
+	params := k.GetParams(ctx)
+
+	// if DenomCreationFee is non-zero, transfer the tokens from the creator
+	// account to community pool
+	if params.DenomCreationFee != nil {
+		accAddr, err := sdk.AccAddressFromBech32(creatorAddr)
+		if err != nil {
+			return err
+		}
+
+		communityPoolAddr := address.Module("protocolpool")
+
+		if err := k.SendCoins(ctx, accAddr, communityPoolAddr, params.DenomCreationFee); err != nil {
+			return err
+		}
+	}
+
+	// if DenomCreationGasConsume is non-zero, consume the gas
+	if params.DenomCreationGasConsume != 0 {
+		err = k.Environment.GasService.GasMeter(ctx).Consume(params.DenomCreationGasConsume, "consume denom creation gas")
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}

x/bank/v2/keeper/creators.go

@@ -0,0 +1,28 @@
+package keeper
+
+// import (
+// 	storetypes "cosmossdk.io/store/types"
+// 	sdk "github.com/cosmos/cosmos-sdk/types"
+// )
+
+// func (k Keeper) addDenomFromCreator(ctx sdk.Context, creator, denom string) {
+// 	store := k.GetCreatorPrefixStore(ctx, creator)
+// 	store.Set([]byte(denom), []byte(denom))
+// }
+
+// func (k Keeper) getDenomsFromCreator(ctx sdk.Context, creator string) []string {
+// 	store := k.GetCreatorPrefixStore(ctx, creator)
+
+// 	iterator := store.Iterator(nil, nil)
+// 	defer iterator.Close()
+
+// 	denoms := []string{}
+// 	for ; iterator.Valid(); iterator.Next() {
+// 		denoms = append(denoms, string(iterator.Key()))
+// 	}
+// 	return denoms
+// }
+
+// func (k Keeper) GetAllDenomsIterator(ctx sdk.Context) storetypes.Iterator {
+// 	return k.GetCreatorsPrefixStore(ctx).Iterator(nil, nil)
+// }

x/bank/v2/keeper/genesis.go

@@ -44,6 +44,28 @@ func (k *Keeper) InitGenesis(ctx context.Context, state *types.GenesisState) err
 		k.setSupply(ctx, supply)
 	}
 
+	for _, meta := range state.DenomMetadata {
+		err := k.SetDenomMetaData(ctx, meta)
+		if err != nil {
+			return err
+		}
+	}
+
+	for _, genDenom := range state.GetFactoryDenoms() {
+		creator, _, err := types.DeconstructDenom(genDenom.GetDenom())
+		if err != nil {
+			return err
+		}
+		err = k.createDenomAfterValidation(ctx, creator, genDenom.GetDenom())
+		if err != nil {
+			return err
+		}
+		err = k.setAuthorityMetadata(ctx, genDenom.GetDenom(), genDenom.GetAuthorityMetadata())
+		if err != nil {
+			return err
+		}
+	}
+
 	return nil
 }