feat!: add filtering function in StargateMsg of wasm (#352)

* feat: add filtering function in StargateMsg of wasm Signed-off-by: zemyblue <[email protected]> * chore: update changelog Signed-off-by: zemyblue <[email protected]> * fix: lint errors Signed-off-by: zemyblue <[email protected]> * fix: check-format warning Signed-off-by: zemyblue <[email protected]> * chore: change `deniedModulesInStargateMsg` location. Signed-off-by: zemyblue <[email protected]> * chore: remove unnecessary encoder unittests. Signed-off-by: zemyblue <[email protected]> * chore: change error message. Signed-off-by: zemyblue <[email protected]> * chore: change error message. Signed-off-by: zemyblue <[email protected]> * chore: add CustomMsg test Signed-off-by: zemyblue <[email protected]> --------- Signed-off-by: zemyblue <[email protected]>
Finschia · May 8, 2024 · b7df20b · b7df20b
1 parent 78f9d87
commit b7df20b
Show file tree

Hide file tree

Showing 4 changed files with 179 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,6 +43,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Bug Fixes
 
 ### Breaking Changes
+* (app) [\#352](https://github.com/Finschia/finschia/pull/352) Add filtering function in StargateMsg of wasm
 
 ### Build, CI
 * (build) [\#340](https://github.com/Finschia/finschia/pull/340) Set Finschia/ostracon version

diff --git a/app/app.go b/app/app.go
@@ -437,6 +437,9 @@ func NewLinkApp(
 		panic("error while reading wasm config: " + err.Error())
 	}
 
+	// change wasm's StargateMsgEncoder to filtered encoder
+	wasmOpts = append(wasmOpts, wasmkeeper.WithMessageEncoders(filteredStargateMsgEncoders(appCodec)))
+
 	// The last arguments can contain custom message handlers, and custom query handlers,
 	// if we want to allow any custom callbacks
 	availableCapabilities := "iterator,staking,stargate,cosmwasm_1_1"

diff --git a/app/wasm_filter.go b/app/wasm_filter.go
@@ -0,0 +1,34 @@
+package app
+
+import (
+	"strings"
+
+	"github.com/Finschia/finschia-sdk/codec"
+	codectypes "github.com/Finschia/finschia-sdk/codec/types"
+	sdk "github.com/Finschia/finschia-sdk/types"
+	sdkerrors "github.com/Finschia/finschia-sdk/types/errors"
+	wasmkeeper "github.com/Finschia/wasmd/x/wasm/keeper"
+	wasmtypes "github.com/Finschia/wasmd/x/wasm/types"
+	wasmvmtypes "github.com/Finschia/wasmvm/types"
+)
+
+func filteredStargateMsgEncoders(cdc codec.Codec) *wasmkeeper.MessageEncoders {
+	return &wasmkeeper.MessageEncoders{
+		Stargate: wasmFilteredEncodeStargateMsg(cdc),
+	}
+}
+
+func wasmFilteredEncodeStargateMsg(unpakcer codectypes.AnyUnpacker) wasmkeeper.StargateEncoder {
+	// deny list in StargateMsg of wasm
+	deniedMsgInStargateMsg := []string{"/lbm.fswap.v1", "/lbm.fbridge.v1"}
+	stargateMsgEncoder := wasmkeeper.EncodeStargateMsg(unpakcer)
+	return func(sender sdk.AccAddress, msg *wasmvmtypes.StargateMsg) ([]sdk.Msg, error) {
+		for _, msgName := range deniedMsgInStargateMsg {
+			if strings.HasPrefix(msg.TypeURL, msgName) {
+				return nil, sdkerrors.Wrapf(wasmtypes.ErrUnsupportedForContract, "%s is not supported by Stargate", msg.TypeURL)
+			}
+		}
+
+		return stargateMsgEncoder(sender, msg)
+	}
+}
diff --git a/app/wasm_filter_test.go b/app/wasm_filter_test.go
@@ -0,0 +1,141 @@
+package app
+
+import (
+	"testing"
+
+	"github.com/golang/protobuf/proto" // nolint: staticcheck
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	codectypes "github.com/Finschia/finschia-sdk/codec/types"
+	sdk "github.com/Finschia/finschia-sdk/types"
+	banktypes "github.com/Finschia/finschia-sdk/x/bank/types"
+	govtypes "github.com/Finschia/finschia-sdk/x/gov/types"
+	wasmkeeper "github.com/Finschia/wasmd/x/wasm/keeper"
+	wasmtypes "github.com/Finschia/wasmd/x/wasm/types"
+	wasmvmtypes "github.com/Finschia/wasmvm/types"
+)
+
+func TestFilteredStargateMsgEncoders(t *testing.T) {
+	var (
+		addr1 = wasmkeeper.RandomAccountAddress(t)
+		addr2 = wasmkeeper.RandomAccountAddress(t)
+	)
+	valAddr := make(sdk.ValAddress, wasmtypes.SDKAddrLen)
+	valAddr[0] = 12
+	valAddr2 := make(sdk.ValAddress, wasmtypes.SDKAddrLen)
+	valAddr2[1] = 123
+
+	bankMsg := &banktypes.MsgSend{
+		FromAddress: addr2.String(),
+		ToAddress:   addr1.String(),
+		Amount: sdk.Coins{
+			sdk.NewInt64Coin("uatom", 12345),
+			sdk.NewInt64Coin("utgd", 54321),
+		},
+	}
+	bankMsgBin, err := proto.Marshal(bankMsg)
+	require.NoError(t, err)
+
+	content, err := codectypes.NewAnyWithValue(wasmtypes.StoreCodeProposalFixture())
+	require.NoError(t, err)
+
+	proposalMsg := &govtypes.MsgSubmitProposal{
+		Proposer:       addr1.String(),
+		InitialDeposit: sdk.NewCoins(sdk.NewInt64Coin("uatom", 12345)),
+		Content:        content,
+	}
+	proposalMsgBin, err := proto.Marshal(proposalMsg)
+	require.NoError(t, err)
+
+	cases := map[string]struct {
+		sender             sdk.AccAddress
+		srcMsg             wasmvmtypes.CosmosMsg
+		srcContractIBCPort string
+		transferPortSource wasmtypes.ICS20TransferPortSource
+		// set if valid
+		output []sdk.Msg
+		// set if invalid
+		isError bool
+		errMsg  string
+	}{
+		"stargate encoded bank msg": {
+			sender: addr2,
+			srcMsg: wasmvmtypes.CosmosMsg{
+				Stargate: &wasmvmtypes.StargateMsg{
+					TypeURL: "/cosmos.bank.v1beta1.MsgSend",
+					Value:   bankMsgBin,
+				},
+			},
+			output: []sdk.Msg{bankMsg},
+		},
+		"stargate encoded msg with any type": {
+			sender: addr2,
+			srcMsg: wasmvmtypes.CosmosMsg{
+				Stargate: &wasmvmtypes.StargateMsg{
+					TypeURL: "/cosmos.gov.v1beta1.MsgSubmitProposal",
+					Value:   proposalMsgBin,
+				},
+			},
+			output: []sdk.Msg{proposalMsg},
+		},
+		"stargate encoded invalid typeUrl": {
+			sender: addr2,
+			srcMsg: wasmvmtypes.CosmosMsg{
+				Stargate: &wasmvmtypes.StargateMsg{
+					TypeURL: "/cosmos.bank.v2.MsgSend",
+					Value:   bankMsgBin,
+				},
+			},
+			isError: true,
+			errMsg:  "Cannot unpack proto message with type URL: /cosmos.bank.v2.MsgSend: invalid CosmosMsg from the contract",
+		},
+		"stargate encoded filtered (fswap)": {
+			sender: addr1,
+			srcMsg: wasmvmtypes.CosmosMsg{
+				Stargate: &wasmvmtypes.StargateMsg{
+					TypeURL: "/lbm.fswap.v1.MsgSwap",
+					Value:   nil,
+				},
+			},
+			isError: true,
+			errMsg:  "/lbm.fswap.v1.MsgSwap is not supported by Stargate: unsupported for this contract",
+		},
+		"stargate encoded filtered (fbridge)": {
+			sender: addr1,
+			srcMsg: wasmvmtypes.CosmosMsg{
+				Stargate: &wasmvmtypes.StargateMsg{
+					TypeURL: "/lbm.fbridge.v1.MsgTransfer",
+					Value:   nil,
+				},
+			},
+			isError: true,
+			errMsg:  "/lbm.fbridge.v1.MsgTransfer is not supported by Stargate: unsupported for this contract",
+		},
+		"custom encoded msg": {
+			sender: addr1,
+			srcMsg: wasmvmtypes.CosmosMsg{
+				Custom: []byte(`{}`),
+			},
+			isError: true,
+			errMsg:  "custom variant not supported: unknown message from the contract",
+		},
+	}
+	encodingConfig := MakeEncodingConfig()
+	for name, tc := range cases {
+		tc := tc
+		t.Run(name, func(t *testing.T) {
+			var ctx sdk.Context
+			encoder := wasmkeeper.DefaultEncoders(encodingConfig.Marshaler, tc.transferPortSource)
+			encoder = encoder.Merge(filteredStargateMsgEncoders(encodingConfig.Marshaler))
+			res, err := encoder.Encode(ctx, tc.sender, tc.srcContractIBCPort, tc.srcMsg)
+			if tc.isError {
+				require.Error(t, err)
+				require.Equal(t, err.Error(), tc.errMsg)
+			} else {
+				require.NoError(t, err)
+				assert.Equal(t, tc.output, res)
+			}
+		})
+	}
+}