feat(warp): allow authority to create native synthetic tokens (#135)

Author: johnletey

proto/buf.yaml

@@ -17,3 +17,5 @@ lint:
     - SERVICE_SUFFIX
     - PACKAGE_VERSION_SUFFIX
     - RPC_REQUEST_STANDARD_NAME
+    - RPC_REQUEST_RESPONSE_UNIQUE
+    - RPC_RESPONSE_STANDARD_NAME

proto/hyperlane/warp/v1/tx.proto

@@ -21,6 +21,9 @@ service Msg {
   // CreateSyntheticToken ...
   rpc CreateSyntheticToken(MsgCreateSyntheticToken)
       returns (MsgCreateSyntheticTokenResponse);
+  // CreateNativeSyntheticToken ...
+  rpc CreateNativeSyntheticToken(MsgCreateNativeSyntheticToken)
+      returns (MsgCreateSyntheticTokenResponse);
 
   // SetToken ...
   rpc SetToken(MsgSetToken) returns (MsgSetTokenResponse);
@@ -77,6 +80,22 @@ message MsgCreateSyntheticToken {
   ];
 }
 
+// MsgCreateNativeSyntheticToken ...
+message MsgCreateNativeSyntheticToken {
+  option (cosmos.msg.v1.signer) = "owner";
+  option (amino.name) = "hyperlane/warp/v1/MsgCreateNativeSyntheticToken";
+
+  string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
+
+  string origin_mailbox = 2 [
+    (gogoproto.customtype) =
+        "github.com/bcp-innovations/hyperlane-cosmos/util.HexAddress",
+    (gogoproto.nullable) = false
+  ];
+
+  string origin_denom = 3;
+}
+
 // MsgCreateSyntheticTokenResponse ...
 message MsgCreateSyntheticTokenResponse {
   string id = 1 [

x/warp/keeper/msg_server.go

@@ -19,29 +19,54 @@ type msgServer struct {
 
 // CreateSyntheticToken ...
 func (ms msgServer) CreateSyntheticToken(ctx context.Context, msg *types.MsgCreateSyntheticToken) (*types.MsgCreateSyntheticTokenResponse, error) {
+	return ms.internalCreateSyntheticToken(ctx, msg.Owner, msg.OriginMailbox, "")
+}
+
+// CreateNativeSyntheticToken is an authority gated version of
+// CreateSyntheticToken that allows the module authority to specify a native
+// (custom) origin denom for the synthetic token.
+func (ms msgServer) CreateNativeSyntheticToken(ctx context.Context, msg *types.MsgCreateNativeSyntheticToken) (*types.MsgCreateSyntheticTokenResponse, error) {
+	if msg.Owner != ms.k.authority {
+		return nil, fmt.Errorf("invalid authority: expected %s, got %s", ms.k.authority, msg.Owner)
+	}
+
+	if ms.k.bankKeeper.HasSupply(ctx, msg.OriginDenom) {
+		return nil, fmt.Errorf("denom %s already exists", msg.OriginDenom)
+	}
+
+	return ms.internalCreateSyntheticToken(ctx, msg.Owner, msg.OriginMailbox, msg.OriginDenom)
+}
+
+// internalCreateSyntheticToken handles the internal logic for creating a synthetic token.
+func (ms msgServer) internalCreateSyntheticToken(ctx context.Context, owner string, originMailbox util.HexAddress, originDenom string) (*types.MsgCreateSyntheticTokenResponse, error) {
 	if !slices.Contains(ms.k.enabledTokens, int32(types.HYP_TOKEN_TYPE_SYNTHETIC)) {
 		return nil, fmt.Errorf("module disabled synthetic tokens")
 	}
 
-	has, err := ms.k.coreKeeper.MailboxIdExists(ctx, msg.OriginMailbox)
+	has, err := ms.k.coreKeeper.MailboxIdExists(ctx, originMailbox)
 	if err != nil {
 		return nil, err
 	}
 	if !has {
-		return nil, fmt.Errorf("failed to find mailbox with id: %s", msg.OriginMailbox.String())
+		return nil, fmt.Errorf("failed to find mailbox with id: %s", originMailbox.String())
 	}
 
 	tokenId, err := ms.k.coreKeeper.AppRouter().GetNextSequence(ctx, uint8(types.HYP_TOKEN_TYPE_SYNTHETIC))
 	if err != nil {
 		return nil, err
 	}
 
+	// If the originDenom is left empty, we populate it as a non-native denom.
+	if originDenom == "" {
+		originDenom = fmt.Sprintf("hyperlane/%s", tokenId.String())
+	}
+
 	newToken := types.HypToken{
 		Id:            tokenId,
-		Owner:         msg.Owner,
+		Owner:         owner,
 		TokenType:     types.HYP_TOKEN_TYPE_SYNTHETIC,
-		OriginMailbox: msg.OriginMailbox,
-		OriginDenom:   fmt.Sprintf("hyperlane/%s", tokenId.String()),
+		OriginMailbox: originMailbox,
+		OriginDenom:   originDenom,
 	}
 
 	if err = ms.k.HypTokens.Set(ctx, tokenId.GetInternalId(), newToken); err != nil {

x/warp/types/expected_keepers.go

@@ -14,6 +14,7 @@ type BankKeeper interface {
 	BurnCoins(ctx context.Context, moduleName string, amt sdk.Coins) error
 	MintCoins(ctx context.Context, moduleName string, amt sdk.Coins) error
 	GetSupply(ctx context.Context, denom string) sdk.Coin
+	HasSupply(ctx context.Context, denom string) bool
 }
 
 type CoreKeeper interface {