Retry and refund flows

CONTRIBUTING.md

@@ -22,8 +22,8 @@ Contributing to this repo can mean many things such as participating in
 discussion or proposing code changes. To ensure a smooth workflow for all
 contributors, the general procedure for contributing has been established:
 
-1. Either [open](https://github.com/cosmos/ibc-go/v5/issues/new/choose) or
-   [find](https://github.com/cosmos/ibc-go/v5/issues) an issue you'd like to help with
+1. Either [open](https://github.com/cosmos/ibc-go/issues/new/choose) or
+   [find](https://github.com/cosmos/ibc-go/issues) an issue you'd like to help with
 2. Participate in thoughtful discussion on that issue
 3. If you would like to contribute:
    1. If the issue is a proposal, ensure that the proposal has been accepted

Makefile

@@ -144,7 +144,7 @@ cosmovisor:
 mocks: $(MOCKS_DIR)
 	mockgen -package=mock -destination=./test/mock/transfer_keeper.go $(GOMOD)/router/types TransferKeeper
 	mockgen -package=mock -destination=./test/mock/distribution_keeper.go $(GOMOD)/router/types DistributionKeeper
-	mockgen -package=mock -destination=./test/mock/ibc_module.go github.com/cosmos/ibc-go/v5/modules/core/05-port/types IBCModule
+	mockgen -package=mock -destination=./test/mock/ibc_module.go github.com/cosmos/ibc-go/v6/modules/core/05-port/types IBCModule
 
 .PHONY: mocks
 

go.mod

@@ -1,14 +1,14 @@
 go 1.18
 
-module github.com/strangelove-ventures/packet-forward-middleware/v2
+module github.com/strangelove-ventures/packet-forward-middleware/v6
 
 replace github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.3-alpha.regen.1
 
 require (
 	cosmossdk.io/math v1.0.0-beta.3
-	github.com/armon/go-metrics v0.4.0
+	github.com/armon/go-metrics v0.4.1
 	github.com/cosmos/cosmos-sdk v0.46.1
-	github.com/cosmos/ibc-go/v5 v5.0.0-rc1
+	github.com/cosmos/ibc-go/v6 v6.0.0
 	github.com/gogo/protobuf v1.3.3
 	github.com/golang/mock v1.6.0
 	github.com/golang/protobuf v1.5.2
@@ -77,7 +77,7 @@ require (
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/mtibben/percent v0.2.1 // indirect
 	github.com/pelletier/go-toml v1.9.5 // indirect
-	github.com/pelletier/go-toml/v2 v2.0.2 // indirect
+	github.com/pelletier/go-toml/v2 v2.0.5 // indirect
 	github.com/petermattis/goid v0.0.0-20180202154549-b0b1615b78e5 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
@@ -92,8 +92,8 @@ require (
 	github.com/spf13/cast v1.5.0 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/spf13/viper v1.12.0 // indirect
-	github.com/subosito/gotenv v1.4.0 // indirect
+	github.com/spf13/viper v1.13.0 // indirect
+	github.com/subosito/gotenv v1.4.1 // indirect
 	github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7 // indirect
 	github.com/tendermint/btcd v0.1.1 // indirect
 	github.com/tendermint/crypto v0.0.0-20191022145703-50d29ede1e15 // indirect
@@ -107,8 +107,10 @@ require (
 	golang.org/x/term v0.0.0-20220722155259-a9ba230a4035 // indirect
 	golang.org/x/text v0.3.7 // indirect
 	google.golang.org/protobuf v1.28.1 // indirect
-	gopkg.in/ini.v1 v1.66.6 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect
 )
+
+replace github.com/cosmos/ibc-go/v6 => github.com/strangelove-ventures/ibc-go/v6 v6.0.0-20220927150238-37bc0935e989

proto/router/v1/genesis.proto

@@ -2,12 +2,22 @@ syntax = "proto3";
 
 package router.v1;
 
-option go_package = "github.com/strangelove-ventures/packet-forward-middleware/v2/router/types";
+option go_package = "github.com/strangelove-ventures/packet-forward-middleware/v6/router/types";
 
 import "gogoproto/gogo.proto";
 
 // GenesisState defines the router genesis state
-message GenesisState { Params params = 1 [ (gogoproto.nullable) = false ]; }
+
+message GenesisState {
+  Params params = 1 [ (gogoproto.nullable) = false ];
+
+  // key - information about forwarded packet: src_channel (parsedReceiver.Channel), src_port (parsedReceiver.Port), sequence
+  // value - information about original packet for refunding if necessary: retries, srcPacketSender, srcPacket.DestinationChannel, srcPacket.DestinationPort
+  map<string, InFlightPacket> in_flight_packets = 2 [
+    (gogoproto.moretags) = "yaml:\"in_flight_packets\"",
+    (gogoproto.nullable) = false
+  ];
+}
 
 // Params defines the set of IBC router parameters.
 message Params {
@@ -17,3 +27,12 @@ message Params {
     (gogoproto.nullable) = false
   ];
 }
+
+// InFlightPacket contains information about original packet for refunding if necessary.
+message InFlightPacket {
+  string original_sender_address = 1;
+  string refund_channel_id = 2;
+  string refund_port_id = 3;
+  int32 retries_remaining = 4;
+  uint64 timeout = 5;
+}

proto/router/v1/query.proto

@@ -6,8 +6,7 @@ import "gogoproto/gogo.proto";
 import "router/v1/genesis.proto";
 import "google/api/annotations.proto";
 
-
-option go_package = "github.com/strangelove-ventures/packet-forward-middleware/v2/router/types";
+option go_package = "github.com/strangelove-ventures/packet-forward-middleware/v6/router/types";
 
 // Query provides defines the gRPC querier service.
 service Query {

router/client/cli/cli.go

@@ -7,7 +7,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/version"
 	"github.com/spf13/cobra"
-	"github.com/strangelove-ventures/packet-forward-middleware/v2/router/types"
+	"github.com/strangelove-ventures/packet-forward-middleware/v6/router/types"
 )
 
 // GetQueryCmd returns the query commands for router

router/keeper/genesis.go

@@ -2,15 +2,32 @@ package keeper
 
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/strangelove-ventures/packet-forward-middleware/v2/router/types"
+	"github.com/strangelove-ventures/packet-forward-middleware/v6/router/types"
 )
 
 // InitGenesis
 func (k Keeper) InitGenesis(ctx sdk.Context, state types.GenesisState) {
 	k.SetParams(ctx, state.Params)
+
+	// Initialize store refund path for forwarded packets in genesis state that have not yet been acked.
+	store := ctx.KVStore(k.storeKey)
+	for key, value := range state.InFlightPackets {
+		bz := k.cdc.MustMarshal(&value)
+		store.Set([]byte(key), bz)
+	}
 }
 
 // ExportGenesis
 func (k Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState {
-	return &types.GenesisState{Params: k.GetParams(ctx)}
+	store := ctx.KVStore(k.storeKey)
+
+	inFlightPackets := make(map[string]types.InFlightPacket)
+
+	itr := store.Iterator(nil, nil)
+	for ; itr.Valid(); itr.Next() {
+		var inFlightPacket types.InFlightPacket
+		k.cdc.MustUnmarshal(itr.Value(), &inFlightPacket)
+		inFlightPackets[string(itr.Key())] = inFlightPacket
+	}
+	return &types.GenesisState{Params: k.GetParams(ctx), InFlightPackets: inFlightPackets}
 }

router/keeper/grpc_query.go

@@ -4,7 +4,7 @@ import (
 	"context"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	"github.com/strangelove-ventures/packet-forward-middleware/v2/router/types"
+	"github.com/strangelove-ventures/packet-forward-middleware/v6/router/types"
 )
 
 var _ types.QueryServer = Keeper{}