Feature: add recover IBC client

Author: aopoltorzhicky

.golangci.yml

@@ -10,7 +10,7 @@ linters:
     - errcheck
     - ineffassign
     - containedctx
-    - tenv
+    - usetesting
     - musttag
     - mirror
     - tagalign

cmd/api/docs/docs.go

@@ -61,7 +61,7 @@ func (s *ConstantTestSuite) TestEnums() {
 	var enums responses.Enums
 	err := json.NewDecoder(rec.Body).Decode(&enums)
 	s.Require().NoError(err)
-	s.Require().Len(enums.ActionType, 15)
+	s.Require().Len(enums.ActionType, 16)
 	s.Require().Len(enums.Status, 2)
 }
 

cmd/api/docs/swagger.json

@@ -4,7 +4,7 @@ go 1.23.5
 
 require (
 	buf.build/gen/go/astria/primitives/protocolbuffers/go v1.36.5-20240911152449-eeebd3decdce.1
-	buf.build/gen/go/astria/protocol-apis/protocolbuffers/go v1.36.5-20250211170247-cc9150a96f73.1
+	buf.build/gen/go/astria/protocol-apis/protocolbuffers/go v1.36.5-20250305185440-67be222cd557.1
 	cosmossdk.io/errors v1.0.1
 	github.com/cometbft/cometbft v0.38.17
 	github.com/cosmos/btcutil v1.0.5

cmd/api/docs/swagger.yaml

@@ -6,6 +6,8 @@ buf.build/gen/go/astria/protocol-apis/protocolbuffers/go v1.35.1-20241016184443-
 buf.build/gen/go/astria/protocol-apis/protocolbuffers/go v1.35.1-20241016184443-c3b7ab6e57dc.1/go.mod h1:XtXAwi+0M8MZWFDcda/0ShK1PKcFsLmdQOA6VKZdKVg=
 buf.build/gen/go/astria/protocol-apis/protocolbuffers/go v1.36.5-20250211170247-cc9150a96f73.1 h1:zinklY1DYGxWpbM+IiXrtD/xDZdZwcoZUU3y/tqiea0=
 buf.build/gen/go/astria/protocol-apis/protocolbuffers/go v1.36.5-20250211170247-cc9150a96f73.1/go.mod h1:kUAF1bkQM31JxAvOGhAEhl/0+p0AlPiAgHRbg6sbfck=
+buf.build/gen/go/astria/protocol-apis/protocolbuffers/go v1.36.5-20250305185440-67be222cd557.1 h1:rklx88gB2VhdY1QgOd5ZTNuEEzNhmno/bFFLX1E3UK8=
+buf.build/gen/go/astria/protocol-apis/protocolbuffers/go v1.36.5-20250305185440-67be222cd557.1/go.mod h1:kUAF1bkQM31JxAvOGhAEhl/0+p0AlPiAgHRbg6sbfck=
 cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
 cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
 cloud.google.com/go v0.115.0 h1:CnFSK6Xo3lDYRoBKEcAtia6VSC837/ZkJuRduSFnr14=

cmd/api/handler/constant_test.go

@@ -15,7 +15,7 @@ func init() {
 }
 
 func upAddBridgeTransfer(ctx context.Context, db *bun.DB) error {
-	_, err := db.ExecContext(ctx, `ALTER TYPE action_type ADD VALUE ? AFTER ?`, types.ActionTypeBridgeTransfer.String(), types.ActionTypeIbcSudoChangeAction.String())
+	_, err := db.ExecContext(ctx, `ALTER TYPE action_type ADD VALUE ? AFTER ?`, types.ActionTypeRecoverIbcClient.String(), types.ActionTypeBridgeTransfer.String())
 	return err
 }
 func downAddBridgeTransfer(ctx context.Context, db *bun.DB) error {

go.mod

@@ -23,7 +23,8 @@ package types
 		bridge_sudo_change_action,
 		fee_change,
 		ibc_sudo_change_action,
-		bridge_transfer
+		bridge_transfer,
+		recover_ibc_client
 	)
 */
 //go:generate go-enum --marshal --sql --values --names

go.sum

@@ -22,6 +22,7 @@ const (
 	ActionTypeFeeChangeBits
 	ActionTypeIbcSudoChangeBits
 	ActionTypeBridgeTransferBits
+	ActionTypeRecoverIbcClientBits
 )
 
 var (
@@ -41,6 +42,7 @@ var (
 		ActionTypeFeeChange:              ActionTypeFeeChangeBits,
 		ActionTypeIbcSudoChangeAction:    ActionTypeIbcSudoChangeBits,
 		ActionTypeBridgeTransfer:         ActionTypeBridgeTransferBits,
+		ActionTypeRecoverIbcClient:       ActionTypeRecoverIbcClientBits,
 	}
 )
 
@@ -82,6 +84,8 @@ func NewActionTypeMask(vals ...string) ActionTypeMask {
 			mask.Set(ActionTypeIbcSudoChangeBits)
 		case string(ActionTypeBridgeTransfer):
 			mask.Set(ActionTypeBridgeTransferBits)
+		case string(ActionTypeRecoverIbcClient):
+			mask.Set(ActionTypeRecoverIbcClientBits)
 		}
 	}
 
@@ -98,7 +102,7 @@ func (mask ActionTypeMask) Strings() []string {
 	}
 
 	vals := make([]string, 0)
-	for val := ActionTypeTransferBits; val <= ActionTypeBridgeTransferBits; val <<= 1 {
+	for val := ActionTypeTransferBits; val <= ActionTypeRecoverIbcClientBits; val <<= 1 {
 		if !mask.Has(val) {
 			continue
 		}
@@ -133,6 +137,8 @@ func (mask ActionTypeMask) Strings() []string {
 			vals = append(vals, string(ActionTypeIbcSudoChangeAction))
 		case ActionTypeBridgeTransferBits:
 			vals = append(vals, string(ActionTypeBridgeTransfer))
+		case ActionTypeRecoverIbcClientBits:
+			vals = append(vals, string(ActionTypeRecoverIbcClient))
 		}
 	}
 

internal/storage/postgres/migrations/200220205_add_bridge_transfer.go internal/storage/postgres/migrations/15032025_add_recover_ibc_client.go

@@ -117,6 +117,13 @@ func TestActionTypeMask(t *testing.T) {
 		require.Equal(t, arr, mask.Strings())
 	})
 
+	t.Run("recover ibc client", func(t *testing.T) {
+		arr := []string{string(ActionTypeRecoverIbcClient)}
+
+		mask := NewActionTypeMask(arr...)
+		require.Equal(t, arr, mask.Strings())
+	})
+
 	t.Run("unknown", func(t *testing.T) {
 		arr := []string{"unknown"}
 

internal/storage/types/action_type.go

@@ -101,6 +101,11 @@ func parseActions(height types.Level, blockTime time.Time, from string, tx *Deco
 		case *astria.Action_BridgeTransfer:
 			tx.ActionTypes.Set(storageTypes.ActionTypeBridgeTransferBits)
 			err = parseBridgeTransfer(val, height, ctx, &actions[i])
+
+		case *astria.Action_RecoverIbcClient:
+			tx.ActionTypes.Set(storageTypes.ActionTypeRecoverIbcClientBits)
+			err = parseRecoverIbcClient(val, height, ctx, &actions[i])
+
 		default:
 			return nil, errors.Errorf(
 				"unknown action type | position = %d | block = %d: %##v",
@@ -932,3 +937,14 @@ func parseBridgeTransfer(body *astria.Action_BridgeTransfer, height types.Level,
 	}
 	return nil
 }
+
+func parseRecoverIbcClient(body *astria.Action_RecoverIbcClient, height types.Level, ctx *Context, action *storage.Action) error {
+	action.Type = storageTypes.ActionTypeRecoverIbcClient
+	action.Data = make(map[string]any)
+
+	if body.RecoverIbcClient != nil {
+		action.Data["client_id"] = body.RecoverIbcClient.GetClientId()
+		action.Data["replacement_client_id"] = body.RecoverIbcClient.GetReplacementClientId()
+	}
+	return nil
+}

internal/storage/types/action_type_enum.go

@@ -1823,4 +1823,31 @@ func TestDecodeActions(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, wantAction, action)
 	})
+
+	t.Run("recover ibc client", func(t *testing.T) {
+		decodeContext := NewContext(map[string]string{})
+
+		message := &astria.Action_RecoverIbcClient{
+			RecoverIbcClient: &astria.RecoverIbcClient{
+				ClientId:            "old_client_id",
+				ReplacementClientId: "new_client_id",
+			},
+		}
+
+		wantAction := storage.Action{
+			Type: types.ActionTypeRecoverIbcClient,
+			Data: map[string]any{
+				"client_id":             "old_client_id",
+				"replacement_client_id": "new_client_id",
+			},
+			Height: 1000,
+		}
+
+		action := storage.Action{
+			Height: 1000,
+		}
+		err := parseRecoverIbcClient(message, 1000, &decodeContext, &action)
+		require.NoError(t, err)
+		require.Equal(t, wantAction, action)
+	})
 }