feat: ibc testing framework

app/app.go

@@ -112,6 +112,7 @@ import (
 
 	ics20wrapper "github.com/Lorenzo-Protocol/lorenzo/x/ibctransfer"
 	ics20wrapperkeeper "github.com/Lorenzo-Protocol/lorenzo/x/ibctransfer/keeper"
+	"github.com/Lorenzo-Protocol/lorenzo/x/token"
 	tokenkeeper "github.com/Lorenzo-Protocol/lorenzo/x/token/keeper"
 	tokentypes "github.com/Lorenzo-Protocol/lorenzo/x/token/types"
 )
@@ -314,7 +315,6 @@ func NewLorenzoApp(
 	// grant capabilities for the ibc and ibc-transfer modules
 	scopedIBCKeeper := app.CapabilityKeeper.ScopeToModule(ibcexported.ModuleName)
 	scopedTransferKeeper := app.CapabilityKeeper.ScopeToModule(ibctransfertypes.ModuleName)
-	// this line is used by starport scaffolding # stargate/app/scopedKeeper
 
 	app.CapabilityKeeper.Seal()
 
@@ -516,7 +516,8 @@ func NewLorenzoApp(
 		app.TokenKeeper,
 	)
 
-	transferStack := ics20wrapper.NewIBCModule(app.ICS20WrapperKeeper)
+	ics20wrapperModule := ics20wrapper.NewIBCModule(app.ICS20WrapperKeeper)
+	transferStack := token.NewIBCMiddleware(ics20wrapperModule, app.TokenKeeper)
 
 	// Create static IBC router, add transfer route, then set and seal it
 	ibcRouter := ibcporttypes.NewRouter()

app/helpers/test_helper.go → app/test_helper.go

@@ -1,15 +1,13 @@
-package helpers
+package app
 
 import (
 	"bytes"
 	"encoding/json"
+	"math/rand"
 	"strconv"
 	"testing"
 	"time"
 
-	appparams "github.com/Lorenzo-Protocol/lorenzo/app/params"
-
-	"github.com/cosmos/cosmos-sdk/baseapp"
 	"github.com/spf13/cast"
 	"github.com/stretchr/testify/require"
 
@@ -19,6 +17,8 @@ import (
 	tmproto "github.com/cometbft/cometbft/proto/tendermint/types"
 	tmtypes "github.com/cometbft/cometbft/types"
 
+	"github.com/cosmos/cosmos-sdk/baseapp"
+	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/codec"
 	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 	cryptocodec "github.com/cosmos/cosmos-sdk/crypto/codec"
@@ -31,14 +31,16 @@ import (
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 
-	"github.com/Lorenzo-Protocol/lorenzo/app"
+	appparams "github.com/Lorenzo-Protocol/lorenzo/app/params"
 )
 
 // SimAppChainID hardcoded chainID for simulation
 const (
 	SimAppChainID = "lorenzo_8329-1"
 )
 
+var DefaultAppVersion uint64 = 1
+
 // DefaultConsensusParams defines the default Tendermint consensus params used
 // in LorenzoApp testing.
 var DefaultConsensusParams = &tmproto.ConsensusParams{
@@ -56,6 +58,7 @@ var DefaultConsensusParams = &tmproto.ConsensusParams{
 			tmtypes.ABCIPubKeyTypeEd25519,
 		},
 	},
+	Version: &tmproto.VersionParams{App: DefaultAppVersion},
 }
 
 // PV implements PrivValidator interface
@@ -75,7 +78,7 @@ func (EmptyAppOptions) Get(_ string) interface{} { return nil }
 // - t: A testing.T instance for testing purposes.
 // Returns:
 // - *app.LorenzoApp: The initialized instance of app.LorenzoApp.
-func Setup(t *testing.T) *app.LorenzoApp {
+func Setup(t *testing.T) *LorenzoApp {
 	t.Helper()
 
 	privVal := mock.NewPV()
@@ -105,7 +108,7 @@ func Setup(t *testing.T) *app.LorenzoApp {
 // - merge: A function to merge override module genesis data with the default genesis data.
 // Returns:
 // - *app.LorenzoApp: The initialized instance of app.LorenzoApp.
-func SetupWithGenesisMergeFn(t *testing.T, merge func(cdc codec.Codec, state map[string]json.RawMessage)) *app.LorenzoApp {
+func SetupWithGenesisMergeFn(t *testing.T, merge func(cdc codec.Codec, state map[string]json.RawMessage)) *LorenzoApp {
 	t.Helper()
 
 	privVal := mock.NewPV()
@@ -162,7 +165,7 @@ func SetupWithGenesisMergeFn(t *testing.T, merge func(cdc codec.Codec, state map
 // that also act as delegators. For simplicity, each validator is bonded with a delegation
 // of one consensus engine unit in the default token of the LorenzoApp from first genesis
 // account. A Nop logger is set in LorenzoApp.
-func SetupWithGenesisValSet(t *testing.T, valSet *tmtypes.ValidatorSet, genAccs []authtypes.GenesisAccount, balances ...banktypes.Balance) *app.LorenzoApp {
+func SetupWithGenesisValSet(t *testing.T, valSet *tmtypes.ValidatorSet, genAccs []authtypes.GenesisAccount, balances ...banktypes.Balance) *LorenzoApp {
 	t.Helper()
 
 	lorenzoApp, genesisState := setup()
@@ -213,35 +216,35 @@ func CreateTestAddrs(numAddrs int) []sdk.AccAddress {
 	return addresses
 }
 
-func setup() (*app.LorenzoApp, app.GenesisState) {
+func setup() (*LorenzoApp, GenesisState) {
 	db := dbm.NewMemDB()
 	appOptions := make(simtestutil.AppOptionsMap)
 	appOptions[server.FlagInvCheckPeriod] = 5
 	appOptions[server.FlagMinGasPrices] = "10alrz"
 	appOptions["btc-config.network"] = "simnet"
 
 	invCheckPeriod := cast.ToUint(appOptions.Get(server.FlagInvCheckPeriod))
-	encConfig := app.MakeEncodingConfig()
-	LorenzoApp := app.NewLorenzoApp(
+	encConfig := MakeEncodingConfig()
+	LorenzoApp := NewLorenzoApp(
 		log.NewNopLogger(),
 		db,
 		nil,
 		true,
 		map[int64]bool{},
-		app.DefaultNodeHome,
+		DefaultNodeHome,
 		invCheckPeriod,
 		encConfig,
 		appOptions,
 		baseapp.SetChainID(SimAppChainID),
 	)
-	return LorenzoApp, app.NewDefaultGenesisState(encConfig.Codec)
+	return LorenzoApp, NewDefaultGenesisState(encConfig.Codec)
 }
 
 func genesisStateWithValSet(t *testing.T,
-	app *app.LorenzoApp, genesisState app.GenesisState,
+	app *LorenzoApp, genesisState GenesisState,
 	valSet *tmtypes.ValidatorSet, genAccs []authtypes.GenesisAccount,
 	balances ...banktypes.Balance,
-) app.GenesisState {
+) GenesisState {
 	t.Helper()
 	// set genesis accounts
 	authGenesis := authtypes.NewGenesisState(authtypes.DefaultParams(), genAccs)
@@ -321,3 +324,34 @@ func testAddr(addr string, bech string) sdk.AccAddress {
 
 	return res
 }
+
+func SignAndDeliver(
+	t *testing.T, txCfg client.TxConfig, app *baseapp.BaseApp, header tmproto.Header, msgs []sdk.Msg,
+	chainID string, accNums, accSeqs []uint64, expSimPass, expPass bool, priv ...cryptotypes.PrivKey,
+) (sdk.GasInfo, *sdk.Result, error) {
+	tx, err := simtestutil.GenSignedMockTx(
+		rand.New(rand.NewSource(time.Now().UnixNano())), //nolint: gosec
+		txCfg,
+		msgs,
+		sdk.Coins{sdk.NewInt64Coin(sdk.DefaultBondDenom, 0)},
+		simtestutil.DefaultGenTxGas,
+		chainID,
+		accNums,
+		accSeqs,
+		priv...,
+	)
+	require.NoError(t, err)
+
+	// Simulate a sending a transaction
+	gInfo, res, err := app.SimDeliver(txCfg.TxEncoder(), tx)
+
+	if expPass {
+		require.NoError(t, err)
+		require.NotNil(t, res)
+	} else {
+		require.Error(t, err)
+		require.Nil(t, res)
+	}
+
+	return gInfo, res, err
+}

proto/lorenzo/token/v1/genesis.proto

@@ -14,6 +14,6 @@ message GenesisState {
 
 // Params defines the token module parameters.
 message Params {
-  bool enable_convert = 1;
+  bool enable_conversion = 1;
   bool enable_evm_hook = 2 [(gogoproto.customname) = "EnableEVMHook"];
 }

proto/lorenzo/token/v1/token.proto

@@ -6,17 +6,17 @@ import "gogoproto/gogo.proto";
 
 option go_package = "github.com/Lorenzo-Protocol/lorenzo/x/token/types";
 
-// Ownership defines the ownership of an erc20 contract, if ownership belongs to:
-// - token module: the token origin is sdk coin.
-// - external account: the token origin is erc20 contract.
-enum Ownership {
+// Source defines the source type of token asset, if source is:
+// - module: token origin is sdk module;
+// - contract: token origin is erc20 contract;
+enum Source {
   option (gogoproto.goproto_enum_prefix) = false;
-  // undefined owner
+  // undefined source
   OWNER_UNDEFINED = 0;
-  // contract owned by convert module
+  // token source is module
   OWNER_MODULE = 1;
-  // contract owned by external account
-  OWNER_EXTERNAL = 2;
+  // token source is erc20 contract
+  OWNER_CONTRACT = 2;
 }
 
 // TokenPair defines a pairing of a cosmos coin and an erc20 token
@@ -28,6 +28,6 @@ message TokenPair {
   string denom = 2;
   // allows for token conversion
   bool enabled = 3;
-  // ownership of the contract
-  Ownership ownership = 4;
+  // source of token asset
+  Source source = 4;
 }

testutil/ibc/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2022 COSMOS
+
+Copyright (c) 2024 Lorenzo Protocol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

testutil/ibc/README.md

@@ -0,0 +1,7 @@
+# IBC Testing
+
+This package contains the necessary code to test the IBC modules. It is a forked version of IBC Testing, customized for Lorenzo. 
+
+The customization aims to maximize compatibility with the original source code while ensuring it is suitably adapted for Lorenzo’s specific requirements.
+
+The maintainer must keep it updated with the currently used version of the IBC code repository to ensure ongoing compatibility and functionality.