feat: added ics27-2 gmp application

go.mod

@@ -6,6 +6,7 @@ replace github.com/syndtr/goleveldb => github.com/syndtr/goleveldb v1.0.1-0.2021
 
 require (
 	cosmossdk.io/api v0.9.2
+	cosmossdk.io/collections v1.3.1
 	cosmossdk.io/core v0.11.3
 	cosmossdk.io/errors v1.0.2
 	cosmossdk.io/log v1.6.0
@@ -41,7 +42,6 @@ require (
 	cloud.google.com/go/iam v1.2.2 // indirect
 	cloud.google.com/go/monitoring v1.21.2 // indirect
 	cloud.google.com/go/storage v1.49.0 // indirect
-	cosmossdk.io/collections v1.3.1 // indirect
 	cosmossdk.io/depinject v1.2.1 // indirect
 	cosmossdk.io/schema v1.1.0 // indirect
 	filippo.io/edwards25519 v1.1.0 // indirect
@@ -66,7 +66,6 @@ require (
 	github.com/chzyer/readline v1.5.1 // indirect
 	github.com/cloudwego/base64x v0.1.5 // indirect
 	github.com/cncf/xds/go v0.0.0-20250326154945-ae57f3c0d45f // indirect
-	github.com/cockroachdb/apd/v2 v2.0.2 // indirect
 	github.com/cockroachdb/errors v1.12.0 // indirect
 	github.com/cockroachdb/fifo v0.0.0-20240616162244-4768e80dfb9a // indirect
 	github.com/cockroachdb/logtags v0.0.0-20241215232642-bb51bb14a506 // indirect

modules/apps/27-gmp/PICKUP.md

@@ -0,0 +1,8 @@
+# GMP pickup document
+
+`27-gmp` application is feature complete, however, it is not yet production ready. This document outlines the remaining tasks to make it production ready.
+
+- `BuildAddressPredictable` should be audited and tested for security. Specifcally, what happens if the address was created by sending the address some coins first?
+- `DeserializeCosmosTx` supports both protobuf encoding and protojson encoding. However, the support for this is hacky since it tries to decode the tx using both methods and returns the one that works. It would be better to have a more robust way to determine the encoding of the tx.
+- Add unit tests and integration tests for the `27-gmp` module. Right now, there are no tests for this module.
+- End to end tests should be added to ensure the entire flow works as expected. End to end tests should be added to this repository if Cosmos to Cosmos calls are to be supported, otherwise, the end to end tests in the `solidity-ibc-go` repository should be sufficient.

modules/apps/27-gmp/ibc_module.go

@@ -0,0 +1,130 @@
+package gmp
+
+import (
+	"fmt"
+
+	errorsmod "cosmossdk.io/errors"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/cosmos/ibc-go/v10/modules/apps/27-gmp/keeper"
+	"github.com/cosmos/ibc-go/v10/modules/apps/27-gmp/types"
+	clienttypes "github.com/cosmos/ibc-go/v10/modules/core/02-client/types"
+	channeltypesv2 "github.com/cosmos/ibc-go/v10/modules/core/04-channel/v2/types"
+	"github.com/cosmos/ibc-go/v10/modules/core/api"
+	ibcerrors "github.com/cosmos/ibc-go/v10/modules/core/errors"
+)
+
+var _ api.IBCModule = (*IBCModule)(nil)
+
+// IBCModule implements the ICS26 interface for transfer given the transfer keeper.
+type IBCModule struct {
+	keeper *keeper.Keeper
+}
+
+// NewIBCModule creates a new IBCModule given the keeper
+func NewIBCModule(k *keeper.Keeper) *IBCModule {
+	return &IBCModule{
+		keeper: k,
+	}
+}
+
+func (*IBCModule) OnSendPacket(ctx sdk.Context, sourceChannel string, destinationChannel string, sequence uint64, payload channeltypesv2.Payload, signer sdk.AccAddress) error {
+	if payload.SourcePort != types.PortID || payload.DestinationPort != types.PortID {
+		return errorsmod.Wrapf(channeltypesv2.ErrInvalidPacket, "payload port ID is invalid: expected %s, got sourcePort: %s destPort: %s", types.PortID, payload.SourcePort, payload.DestinationPort)
+	}
+	if !clienttypes.IsValidClientID(sourceChannel) || !clienttypes.IsValidClientID(destinationChannel) {
+		return errorsmod.Wrapf(channeltypesv2.ErrInvalidPacket, "client IDs must be in valid format: {string}-{number}")
+	}
+
+	data, err := types.UnmarshalPacketData(payload.Value, payload.Version, payload.Encoding)
+	if err != nil {
+		return err
+	}
+
+	if err := data.ValidateBasic(); err != nil {
+		return errorsmod.Wrapf(err, "failed to validate %s packet data", types.Version)
+	}
+
+	sender, err := sdk.AccAddressFromBech32(data.Sender)
+	if err != nil {
+		return err
+	}
+
+	if !signer.Equals(sender) {
+		return errorsmod.Wrapf(ibcerrors.ErrUnauthorized, "sender %s is different from signer %s", sender, signer)
+	}
+
+	// TODO: emit event and telemetry
+
+	return nil
+}
+
+func (im *IBCModule) OnRecvPacket(ctx sdk.Context, sourceChannel, destinationChannel string, sequence uint64, payload channeltypesv2.Payload, relayer sdk.AccAddress) channeltypesv2.RecvPacketResult {
+	if payload.SourcePort != types.PortID || payload.DestinationPort != types.PortID {
+		return channeltypesv2.RecvPacketResult{
+			Status: channeltypesv2.PacketStatus_Failure,
+		}
+	}
+	if payload.Version != types.Version {
+		return channeltypesv2.RecvPacketResult{
+			Status: channeltypesv2.PacketStatus_Failure,
+		}
+	}
+
+	packetData, ackErr := types.UnmarshalPacketData(payload.Value, payload.Version, payload.Encoding)
+	if ackErr != nil {
+		im.keeper.Logger(ctx).Error(fmt.Sprintf("%s sequence %d", ackErr.Error(), sequence))
+		return channeltypesv2.RecvPacketResult{
+			Status: channeltypesv2.PacketStatus_Failure,
+		}
+	}
+
+	if ackErr := packetData.ValidateBasic(); ackErr != nil {
+		im.keeper.Logger(ctx).Error(fmt.Sprintf("%s sequence %d", ackErr.Error(), sequence))
+		return channeltypesv2.RecvPacketResult{
+			Status: channeltypesv2.PacketStatus_Failure,
+		}
+	}
+
+	result, ackErr := im.keeper.OnRecvPacket(
+		ctx,
+		packetData,
+		payload.SourcePort,
+		sourceChannel,
+		payload.DestinationPort,
+		destinationChannel,
+	)
+	if ackErr != nil {
+		im.keeper.Logger(ctx).Error(fmt.Sprintf("%s sequence %d", ackErr.Error(), sequence))
+		return channeltypesv2.RecvPacketResult{
+			Status: channeltypesv2.PacketStatus_Failure,
+		}
+	}
+
+	ack := types.NewAcknowledgement(result)
+	ackBz, ackErr := types.MarshalAcknowledgement(&ack, types.Version, payload.Encoding)
+	if ackErr != nil {
+		im.keeper.Logger(ctx).Error(fmt.Sprintf("%s sequence %d", ackErr.Error(), sequence))
+		return channeltypesv2.RecvPacketResult{
+			Status: channeltypesv2.PacketStatus_Failure,
+		}
+	}
+
+	im.keeper.Logger(ctx).Info("successfully handled ICS-27 GMP packet", "sequence", sequence)
+
+	// TODO: implement telemetry
+
+	return channeltypesv2.RecvPacketResult{
+		Status:          channeltypesv2.PacketStatus_Success,
+		Acknowledgement: ackBz,
+	}
+}
+
+func (*IBCModule) OnTimeoutPacket(_ sdk.Context, _, _ string, _ uint64, _ channeltypesv2.Payload, _ sdk.AccAddress) error {
+	return nil
+}
+
+func (*IBCModule) OnAcknowledgementPacket(_ sdk.Context, _, _ string, _ uint64, _ []byte, _ channeltypesv2.Payload, _ sdk.AccAddress) error {
+	return nil
+}

modules/apps/27-gmp/keeper/account.go

@@ -0,0 +1,66 @@
+package keeper
+
+import (
+	"context"
+
+	"cosmossdk.io/collections"
+	errorsmod "cosmossdk.io/errors"
+
+	"github.com/cosmos/ibc-go/v10/modules/apps/27-gmp/types"
+)
+
+// getOrCreateICS27Account retrieves an existing ICS27 account or creates a new one if it doesn't exist.
+func (k *Keeper) getOrCreateICS27Account(ctx context.Context, accountID *types.AccountIdentifier) (*types.ICS27Account, error) {
+	existingIcs27Account, err := k.Accounts.Get(ctx, collections.Join3(accountID.ClientId, accountID.Sender, accountID.Salt))
+	if err == nil {
+		return &existingIcs27Account, nil
+	} else if !errorsmod.IsOf(err, collections.ErrNotFound) {
+		return nil, err
+	}
+
+	// Create a new account
+	newAddr, err := types.BuildAddressPredictable(accountID)
+	if err != nil {
+		return nil, err
+	}
+
+	existingAcc := k.accountKeeper.GetAccount(ctx, newAddr)
+	if existingAcc != nil {
+		// TODO: ensure this cannot be abused (refactor after this is resolved)
+		ics27Account := types.NewICS27Account(existingAcc.GetAddress().String(), accountID)
+		if err := k.Accounts.Set(ctx, collections.Join3(accountID.ClientId, accountID.Sender, accountID.Salt), ics27Account); err != nil {
+			return nil, errorsmod.Wrapf(err, "failed to set account %s in store", ics27Account)
+		}
+
+		return &ics27Account, nil
+	}
+
+	newAcc := k.accountKeeper.NewAccountWithAddress(ctx, newAddr)
+	k.accountKeeper.SetAccount(ctx, newAcc)
+
+	ics27Account := types.NewICS27Account(newAcc.GetAddress().String(), accountID)
+	if err := k.Accounts.Set(ctx, collections.Join3(accountID.ClientId, accountID.Sender, accountID.Salt), ics27Account); err != nil {
+		return nil, errorsmod.Wrapf(err, "failed to set account %s in store", ics27Account)
+	}
+
+	k.Logger(ctx).Info("Created new ICS27 account", "account", ics27Account)
+	return &ics27Account, nil
+}
+
+// getOrComputeICS27Adderss retrieves an existing ICS27 account address or computes it if it doesn't exist. This doesn't modify the store.
+func (k *Keeper) getOrComputeICS27Address(ctx context.Context, accountID *types.AccountIdentifier) (string, error) {
+	existingIcs27Account, err := k.Accounts.Get(ctx, collections.Join3(accountID.ClientId, accountID.Sender, accountID.Salt))
+	if err == nil {
+		return existingIcs27Account.Address, nil
+	} else if !errorsmod.IsOf(err, collections.ErrNotFound) {
+		return "", err
+	}
+
+	// Compute a new address
+	newAddr, err := types.BuildAddressPredictable(accountID)
+	if err != nil {
+		return "", err
+	}
+
+	return newAddr.String(), nil
+}

modules/apps/27-gmp/keeper/genesis.go

@@ -0,0 +1,53 @@
+package keeper
+
+import (
+	"context"
+
+	"cosmossdk.io/collections"
+	errorsmod "cosmossdk.io/errors"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/cosmos/ibc-go/v10/modules/apps/27-gmp/types"
+	ibcerrors "github.com/cosmos/ibc-go/v10/modules/core/errors"
+)
+
+// InitGenesis initializes the module state from a genesis state.
+func (k *Keeper) InitGenesis(ctx context.Context, data *types.GenesisState) error {
+	for _, account := range data.Ics27Accounts {
+		if _, err := sdk.AccAddressFromBech32(account.AccountAddress); err != nil {
+			return errorsmod.Wrapf(ibcerrors.ErrInvalidAddress, "string could not be parsed as address: %v", err)
+		}
+		if _, err := sdk.AccAddressFromBech32(account.AccountId.Sender); err != nil {
+			return errorsmod.Wrapf(ibcerrors.ErrInvalidAddress, "string could not be parsed as address: %v", err)
+		}
+
+		if err := k.Accounts.Set(ctx, collections.Join3(account.AccountId.ClientId, account.AccountId.Sender, account.AccountId.Salt), types.ICS27Account{
+			Address:   account.AccountAddress,
+			AccountId: &account.AccountId,
+		}); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+// ExportGenesis exports the module state to a genesis state.
+func (k *Keeper) ExportGenesis(ctx context.Context) (*types.GenesisState, error) {
+	var accounts []types.RegisteredICS27Account
+	if err := k.Accounts.Walk(ctx, nil, func(key collections.Triple[string, string, []byte], value types.ICS27Account) (bool, error) {
+		accounts = append(accounts, types.RegisteredICS27Account{
+			AccountAddress: value.Address,
+			AccountId:      *value.AccountId,
+		})
+
+		return false, nil
+	}); err != nil {
+		return nil, err
+	}
+
+	return &types.GenesisState{
+		Ics27Accounts: accounts,
+	}, nil
+}

modules/apps/27-gmp/keeper/keeper.go

@@ -0,0 +1,74 @@
+package keeper
+
+import (
+	"context"
+	"errors"
+	"strings"
+
+	"cosmossdk.io/collections"
+	storetypes "cosmossdk.io/core/store"
+	"cosmossdk.io/log"
+
+	"github.com/cosmos/cosmos-sdk/codec"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/cosmos/ibc-go/v10/modules/apps/27-gmp/types"
+	"github.com/cosmos/ibc-go/v10/modules/core/exported"
+)
+
+// Keeper defines the IBC fungible transfer keeper
+type Keeper struct {
+	cdc codec.Codec
+
+	msgRouter types.MessageRouter
+
+	accountKeeper types.AccountKeeper
+
+	// the address capable of executing a MsgUpdateParams message. Typically, this
+	// should be the x/gov module account.
+	authority string
+
+	// state management
+	Schema collections.Schema
+	// Accounts is a map of  (ClientID, Sender, Salt) to ICS27Account
+	Accounts collections.Map[collections.Triple[string, string, []byte], types.ICS27Account]
+}
+
+// NewKeeper creates a new Keeper instance
+func NewKeeper(
+	cdc codec.Codec, storeService storetypes.KVStoreService,
+	accountKeeper types.AccountKeeper, msgRouter types.MessageRouter,
+	authority string,
+) *Keeper {
+	if strings.TrimSpace(authority) == "" {
+		panic(errors.New("authority must be non-empty"))
+	}
+
+	sb := collections.NewSchemaBuilder(storeService)
+	k := Keeper{
+		cdc:           cdc,
+		msgRouter:     msgRouter,
+		accountKeeper: accountKeeper,
+		authority:     authority,
+		Accounts:      collections.NewMap(sb, types.AccountsKey, "accounts", collections.TripleKeyCodec(collections.StringKey, collections.StringKey, collections.BytesKey), codec.CollValue[types.ICS27Account](cdc)),
+	}
+
+	schema, err := sb.Build()
+	if err != nil {
+		panic(err)
+	}
+
+	k.Schema = schema
+
+	return &k
+}
+
+// GetAuthority returns the module's authority.
+func (k *Keeper) GetAuthority() string {
+	return k.authority
+}
+
+// Logger returns a module-specific logger.
+func (*Keeper) Logger(goCtx context.Context) log.Logger {
+	return sdk.UnwrapSDKContext(goCtx).Logger().With("module", "x/"+exported.ModuleName+"-"+types.ModuleName)
+}