feat: IPRPC over IBC

app/app.go

@@ -559,6 +559,7 @@ func New(
 		authtypes.FeeCollectorName,
 		app.TimerStoreKeeper,
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
+		app.IBCKeeper.ChannelKeeper,
 	)
 	rewardsModule := rewardsmodule.NewAppModule(appCodec, app.RewardsKeeper, app.AccountKeeper, app.BankKeeper)
 
@@ -714,6 +715,7 @@ func New(
 		packetforwardkeeper.DefaultForwardTransferPacketTimeoutTimestamp, // forward timeout
 		packetforwardkeeper.DefaultRefundTransferPacketTimeoutTimestamp,  // refund timeout
 	)
+	transferStack = rewardsmodule.NewIBCMiddleware(transferStack, app.RewardsKeeper)
 	ibcRouter.AddRoute(ibctransfertypes.ModuleName, transferStack)
 
 	// this line is used by starport scaffolding # ibc/app/router

proto/lavanet/lava/rewards/iprpc.proto

@@ -17,4 +17,10 @@ message Specfund {
         (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
         (gogoproto.nullable)     = false
     ];
+}
+
+message IprpcMemo {
+    string creator = 1;
+    string spec = 2;
+    uint64 duration = 3; // Iprpc fund period in months
 }

testutil/keeper/keepers_init.go

@@ -264,7 +264,7 @@ func InitAllKeepers(t testing.TB) (*Servers, *Keepers, context.Context) {
 	ks.Projects = *projectskeeper.NewKeeper(cdc, projectsStoreKey, projectsMemStoreKey, projectsparamsSubspace, ks.Epochstorage, ks.FixationStoreKeeper)
 	ks.Protocol = *protocolkeeper.NewKeeper(cdc, protocolStoreKey, protocolMemStoreKey, protocolparamsSubspace, authtypes.NewModuleAddress(govtypes.ModuleName).String())
 	ks.Downtime = downtimekeeper.NewKeeper(cdc, downtimeKey, downtimeParamsSubspace, ks.Epochstorage)
-	ks.Rewards = *rewardskeeper.NewKeeper(cdc, rewardsStoreKey, rewardsMemStoreKey, rewardsparamsSubspace, ks.BankKeeper, ks.AccountKeeper, ks.Spec, ks.Epochstorage, ks.Downtime, ks.StakingKeeper, ks.Dualstaking, ks.Distribution, authtypes.FeeCollectorName, ks.TimerStoreKeeper, authtypes.NewModuleAddress(govtypes.ModuleName).String())
+	ks.Rewards = *rewardskeeper.NewKeeper(cdc, rewardsStoreKey, rewardsMemStoreKey, rewardsparamsSubspace, ks.BankKeeper, ks.AccountKeeper, ks.Spec, ks.Epochstorage, ks.Downtime, ks.StakingKeeper, ks.Dualstaking, ks.Distribution, authtypes.FeeCollectorName, ks.TimerStoreKeeper, authtypes.NewModuleAddress(govtypes.ModuleName).String(), nil)
 	ks.Subscription = *subscriptionkeeper.NewKeeper(cdc, subscriptionStoreKey, subscriptionMemStoreKey, subscriptionparamsSubspace, &ks.BankKeeper, &ks.AccountKeeper, &ks.Epochstorage, ks.Projects, ks.Plans, ks.Dualstaking, ks.Rewards, ks.FixationStoreKeeper, ks.TimerStoreKeeper, ks.StakingKeeper)
 	ks.Pairing = *pairingkeeper.NewKeeper(cdc, pairingStoreKey, pairingMemStoreKey, pairingparamsSubspace, &ks.BankKeeper, &ks.AccountKeeper, ks.Spec, &ks.Epochstorage, ks.Projects, ks.Subscription, ks.Plans, ks.Downtime, ks.Dualstaking, &ks.StakingKeeper, ks.FixationStoreKeeper, ks.TimerStoreKeeper)
 	ks.ParamsKeeper = paramsKeeper

testutil/keeper/rewards.go

@@ -94,6 +94,7 @@ func RewardsKeeper(t testing.TB) (*keeper.Keeper, sdk.Context) {
 		authtypes.FeeCollectorName,
 		timerstorekeeper.NewKeeper(cdc),
 		authtypes.NewModuleAddress(govtypes.ModuleName).String(),
+		nil,
 	)
 
 	// Initialize params

testutil/sample/sample.go

@@ -13,6 +13,13 @@ func AccAddress() string {
 	return sdk.AccAddress(addr).String()
 }
 
+// AccAddress returns a sample account address of type sdk.AccAddress
+func AccAddressObject() sdk.AccAddress {
+	pk := ed25519.GenPrivKey().PubKey()
+	addr := pk.Address()
+	return sdk.AccAddress(addr)
+}
+
 // ValAddress returns a sample validator account address
 func ValAddress() string {
 	pk := ed25519.GenPrivKey().PubKey()

x/rewards/ibc_middleware.go

@@ -0,0 +1,174 @@
+package rewards
+
+import (
+	"errors"
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	capabilitytypes "github.com/cosmos/cosmos-sdk/x/capability/types"
+	transfertypes "github.com/cosmos/ibc-go/v7/modules/apps/transfer/types"
+	clienttypes "github.com/cosmos/ibc-go/v7/modules/core/02-client/types"
+	channeltypes "github.com/cosmos/ibc-go/v7/modules/core/04-channel/types"
+	porttypes "github.com/cosmos/ibc-go/v7/modules/core/05-port/types"
+	"github.com/cosmos/ibc-go/v7/modules/core/exported"
+	"github.com/lavanet/lava/utils"
+	"github.com/lavanet/lava/x/rewards/keeper"
+	"github.com/lavanet/lava/x/rewards/types"
+)
+
+var _ porttypes.Middleware = &IBCMiddleware{}
+
+// IBCMiddleware implements the ICS26 callbacks for the transfer middleware given
+// the rewards keeper and the underlying application.
+type IBCMiddleware struct {
+	app    porttypes.IBCModule // transfer stack
+	keeper keeper.Keeper
+}
+
+// NewIBCMiddleware creates a new IBCMiddleware given the keeper and underlying application
+func NewIBCMiddleware(app porttypes.IBCModule, k keeper.Keeper) IBCMiddleware {
+	return IBCMiddleware{
+		app:    app,
+		keeper: k,
+	}
+}
+
+// IBCModule interface implementation. Only OnRecvPacket() calls a callback from the keeper. The rest have default implementations
+
+func (im IBCMiddleware) OnChanOpenInit(ctx sdk.Context, order channeltypes.Order, connectionHops []string, portID string,
+	channelID string,
+	chanCap *capabilitytypes.Capability,
+	counterparty channeltypes.Counterparty,
+	version string,
+) (string, error) {
+	return im.app.OnChanOpenInit(ctx, order, connectionHops, portID, channelID, chanCap, counterparty, version)
+}
+
+func (im IBCMiddleware) OnChanOpenTry(
+	ctx sdk.Context,
+	order channeltypes.Order,
+	connectionHops []string,
+	portID, channelID string,
+	chanCap *capabilitytypes.Capability,
+	counterparty channeltypes.Counterparty,
+	counterpartyVersion string,
+) (version string, err error) {
+	return im.app.OnChanOpenTry(ctx, order, connectionHops, portID, channelID, chanCap, counterparty, counterpartyVersion)
+}
+
+func (im IBCMiddleware) OnChanOpenAck(
+	ctx sdk.Context,
+	portID, channelID string,
+	counterpartyChannelID string,
+	counterpartyVersion string,
+) error {
+	return im.app.OnChanOpenAck(ctx, portID, channelID, counterpartyChannelID, counterpartyVersion)
+}
+
+func (im IBCMiddleware) OnChanOpenConfirm(ctx sdk.Context, portID, channelID string) error {
+	return im.app.OnChanOpenConfirm(ctx, portID, channelID)
+}
+
+func (im IBCMiddleware) OnChanCloseInit(ctx sdk.Context, portID, channelID string) error {
+	return im.app.OnChanCloseInit(ctx, portID, channelID)
+}
+
+func (im IBCMiddleware) OnChanCloseConfirm(ctx sdk.Context, portID, channelID string) error {
+	return im.app.OnChanCloseConfirm(ctx, portID, channelID)
+}
+
+// OnRecvPacket checks the packet's memo and funds the IPRPC pool accordingly. If the memo is not the expected JSON,
+// the packet is transferred normally to the next IBC module in the transfer stack
+func (im IBCMiddleware) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet, relayer sdk.AccAddress) exported.Acknowledgement {
+	// unmarshal the packet's data with the transfer module codec (expect an ibc-transfer packet)
+	var data transfertypes.FungibleTokenPacketData
+	if err := transfertypes.ModuleCdc.UnmarshalJSON(packet.GetData(), &data); err != nil {
+		return channeltypes.NewErrorAcknowledgement(err)
+	}
+
+	// extract the packet's memo
+	memo, err := im.keeper.ExtractIprpcMemoFromPacket(ctx, data)
+	if errors.Is(err, types.ErrMemoNotIprpcOverIbc) {
+		// not a packet that should be handled as IPRPC over IBC (not considered as error)
+		utils.LavaFormatDebug("rewards module IBC middleware processing skipped, memo is invalid for IPRPC over IBC funding",
+			utils.LogAttr("memo", memo),
+		)
+		return im.app.OnRecvPacket(ctx, packet, relayer)
+	} else if errors.Is(err, types.ErrIprpcMemoInvalid) {
+		// memo is in the right format of IPRPC over IBC but the data is invalid
+		utils.LavaFormatWarning("rewards module IBC middleware processing failed, memo data is invalid", err,
+			utils.LogAttr("memo", memo))
+		return channeltypes.NewErrorAcknowledgement(err)
+	}
+
+	// change the ibc-transfer packet receiver address to be the rewards module address and empty the memo
+	data.Receiver = im.keeper.GetModuleAddress()
+	data.Memo = ""
+	marshelledData, err := transfertypes.ModuleCdc.MarshalJSON(&data)
+	if err != nil {
+		utils.LavaFormatError("rewards module IBC middleware processing failed, cannot marshal packet data", err,
+			utils.LogAttr("data", data))
+		return channeltypes.NewErrorAcknowledgement(err)
+	}
+	packet.Data = marshelledData
+
+	// call the next OnRecvPacket() of the transfer stack to make the rewards module get the IBC tokens
+	ack := im.app.OnRecvPacket(ctx, packet, relayer)
+	if ack == nil || !ack.Success() {
+		// we check for ack == nil because it means that IBC transfer module did not return an acknowledgement.
+		// This isn't necessarily an error, but it could indicate unexpected behavior or asynchronous processing
+		// on the IBC transfer module's side (which returns a non-nil ack when executed without errors). Asynchronous
+		// processing can be queued processing of packets, interacting with external APIs and more. These can cause
+		// delays in the IBC-transfer's processing which will make the module return a nil ack until the processing is done.
+		return ack
+	}
+
+	// set pending IPRPC over IBC requests on-chain
+	amountInt, ok := sdk.NewIntFromString(data.Amount)
+	if !ok {
+		utils.LavaFormatError("rewards module IBC middleware processing failed", fmt.Errorf("cannot decode coin amount"),
+			utils.LogAttr("data", data))
+		return channeltypes.NewErrorAcknowledgement(err)
+	}
+	amount := sdk.NewCoin(data.Denom, amountInt)
+	err = im.keeper.SetPendingIprpcOverIbcFunds(ctx, memo, amount)
+	if err != nil {
+		return channeltypes.NewErrorAcknowledgement(err)
+	}
+
+	return channeltypes.NewResultAcknowledgement([]byte{byte(1)})
+}
+
+func (im IBCMiddleware) OnAcknowledgementPacket(
+	ctx sdk.Context,
+	packet channeltypes.Packet,
+	acknowledgement []byte,
+	relayer sdk.AccAddress,
+) error {
+	return im.app.OnAcknowledgementPacket(ctx, packet, acknowledgement, relayer)
+}
+
+func (im IBCMiddleware) OnTimeoutPacket(
+	ctx sdk.Context,
+	packet channeltypes.Packet,
+	relayer sdk.AccAddress,
+) error {
+	return im.app.OnTimeoutPacket(ctx, packet, relayer)
+}
+
+// ICS4Wrapper interface (default implementations)
+func (im IBCMiddleware) SendPacket(ctx sdk.Context, chanCap *capabilitytypes.Capability, sourcePort string, sourceChannel string,
+	timeoutHeight clienttypes.Height, timeoutTimestamp uint64, data []byte,
+) (sequence uint64, err error) {
+	return im.keeper.SendPacket(ctx, chanCap, sourcePort, sourceChannel, timeoutHeight, timeoutTimestamp, data)
+}
+
+func (im IBCMiddleware) WriteAcknowledgement(ctx sdk.Context, chanCap *capabilitytypes.Capability, packet exported.PacketI,
+	ack exported.Acknowledgement,
+) error {
+	return im.keeper.WriteAcknowledgement(ctx, chanCap, packet, ack)
+}
+
+func (im IBCMiddleware) GetAppVersion(ctx sdk.Context, portID, channelID string) (string, bool) {
+	return im.keeper.GetAppVersion(ctx, portID, channelID)
+}

x/rewards/keeper/helpers_test.go

@@ -9,8 +9,10 @@ import (
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
+	transfertypes "github.com/cosmos/ibc-go/v7/modules/apps/transfer/types"
 	"github.com/lavanet/lava/testutil/common"
 	testkeeper "github.com/lavanet/lava/testutil/keeper"
+	"github.com/lavanet/lava/testutil/sample"
 	commontypes "github.com/lavanet/lava/utils/common/types"
 	"github.com/lavanet/lava/utils/sigs"
 	planstypes "github.com/lavanet/lava/x/plans/types"
@@ -140,6 +142,10 @@ func (ts *tester) setupForIprpcTests(fundIprpcPool bool) {
 	}
 }
 
+func (ts *tester) createIbcTransferPacketData(memo string) transfertypes.FungibleTokenPacketData {
+	return transfertypes.NewFungibleTokenPacketData(ts.TokenDenom(), "100000", sample.AccAddress(), sample.AccAddress(), memo)
+}
+
 // getConsumersForIprpcSubTest is a helper function specifically for the TestIprpcEligibleSubscriptions unit test
 // this function returns two consumer addresses to test depending on the input mode:
 //

x/rewards/keeper/ibc_iprpc.go

@@ -0,0 +1,79 @@
+package keeper
+
+import (
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	transfertypes "github.com/cosmos/ibc-go/v7/modules/apps/transfer/types"
+	"github.com/lavanet/lava/utils"
+	"github.com/lavanet/lava/utils/decoder"
+	"github.com/lavanet/lava/x/rewards/types"
+)
+
+/*
+
+The rewards module (which acts as an IBC middleware) analyzes incoming ibc-transfer packets and checks their memo field.
+If the memo field is in the IPRPC over IBC format, it uses the tokens from the packet and saves them for a future fund to
+the IPRPC pool.
+
+An example of the expected IPRPC over IBC memo field:
+{
+  "iprpc": {
+    "creator": "my-moniker",
+    "spec": "ETH1",
+    "duration": 3
+  }
+}
+
+The tokens will be transferred to the pool once the minimum IPRPC funding fee is paid. In the meantime, the IPRPC over IBC
+funds are saved in the IbcIprpcFund scaffolded map.
+
+*/
+
+// ExtractIprpcMemoFromPacket extracts the memo field from an ibc-transfer packet and verifies that it's in the right format
+// and holds valid values. If the memo is not in the right format, a custom error is returned so the packet will be skipped and
+// passed to the next IBC module in the transfer stack normally (and not return an error ack)
+func (k Keeper) ExtractIprpcMemoFromPacket(ctx sdk.Context, transferData transfertypes.FungibleTokenPacketData) (types.IprpcMemo, error) {
+	var memo types.IprpcMemo
+	err := decoder.Decode(transferData.Memo, "iprpc", &memo, nil, nil, nil)
+	if err != nil {
+		// memo is not for IPRPC over IBC, return custom error to skip processing for this packet
+		return types.IprpcMemo{}, types.ErrMemoNotIprpcOverIbc
+	}
+	err = k.validateIprpcMemo(ctx, memo)
+	if err != nil {
+		return types.IprpcMemo{}, err
+	}
+
+	return memo, nil
+}
+
+func (k Keeper) validateIprpcMemo(ctx sdk.Context, memo types.IprpcMemo) error {
+	if _, found := k.specKeeper.GetSpec(ctx, memo.Spec); !found {
+		return printInvalidMemoWarning(memo, "memo's spec does not exist on chain")
+	}
+
+	if memo.Creator == "" {
+		return printInvalidMemoWarning(memo, "memo's creator cannot be empty")
+	} else if _, found := k.specKeeper.GetSpec(ctx, memo.Creator); found {
+		return printInvalidMemoWarning(memo, "memo's creator cannot be an on-chain spec index")
+	}
+
+	if memo.Duration == uint64(0) {
+		return printInvalidMemoWarning(memo, "memo's duration cannot be zero")
+	}
+
+	return nil
+}
+
+func printInvalidMemoWarning(memo types.IprpcMemo, description string) error {
+	utils.LavaFormatWarning("invalid ibc over iprpc memo", fmt.Errorf(description),
+		utils.LogAttr("memo", memo.String()),
+	)
+	return types.ErrIprpcMemoInvalid
+}
+
+func (k Keeper) SetPendingIprpcOverIbcFunds(ctx sdk.Context, memo types.IprpcMemo, amount sdk.Coin) error {
+	// TODO: implement
+	return nil
+}