Skip to content

Commit 9c5499e

Browse files
DimitrisJimDimitrisJim
authored
Add 02-client implementation for Recover client. (#4499)
* Add 02-client implementation for Recover client. * Partially address feedback. * Docu RecoverClient, add label, re-use error.
1 parent d9f6200 commit 9c5499e

File tree

6 files changed

+230
-2
lines changed

6 files changed

+230
-2
lines changed

‎modules/core/02-client/keeper/client.go

+56
Original file line numberDiff line numberDiff line change
@@ -149,3 +149,59 @@ func (k Keeper) UpgradeClient(ctx sdk.Context, clientID string, upgradedClient e
149149

150150
return nil
151151
}
152+
153+
// RecoverClient will retrieve the subject and substitute client.
154+
// A callback will occur to the subject client state with the client
155+
// prefixed store being provided for both the subject and the substitute client.
156+
// The IBC client implementations are responsible for validating the parameters of the
157+
// substitute (ensuring they match the subject's parameters) as well as copying
158+
// the necessary consensus states from the substitute to the subject client
159+
// store. The substitute must be Active and the subject must not be Active.
160+
func (k Keeper) RecoverClient(ctx sdk.Context, subjectClientID, substituteClientID string) error {
161+
subjectClientState, found := k.GetClientState(ctx, subjectClientID)
162+
if !found {
163+
return errorsmod.Wrapf(types.ErrClientNotFound, "subject client with ID %s", subjectClientID)
164+
}
165+
166+
subjectClientStore := k.ClientStore(ctx, subjectClientID)
167+
168+
if status := k.GetClientStatus(ctx, subjectClientState, subjectClientID); status == exported.Active {
169+
return errorsmod.Wrap(types.ErrInvalidRecoveryClient, "cannot recover Active subject client")
170+
}
171+
172+
substituteClientState, found := k.GetClientState(ctx, substituteClientID)
173+
if !found {
174+
return errorsmod.Wrapf(types.ErrClientNotFound, "substitute client with ID %s", substituteClientID)
175+
}
176+
177+
if subjectClientState.GetLatestHeight().GTE(substituteClientState.GetLatestHeight()) {
178+
return errorsmod.Wrapf(types.ErrInvalidHeight, "subject client state latest height is greater or equal to substitute client state latest height (%s >= %s)", subjectClientState.GetLatestHeight(), substituteClientState.GetLatestHeight())
179+
}
180+
181+
substituteClientStore := k.ClientStore(ctx, substituteClientID)
182+
183+
if status := k.GetClientStatus(ctx, substituteClientState, substituteClientID); status != exported.Active {
184+
return errorsmod.Wrapf(types.ErrClientNotActive, "substitute client is not Active, status is %s", status)
185+
}
186+
187+
if err := subjectClientState.CheckSubstituteAndUpdateState(ctx, k.cdc, subjectClientStore, substituteClientStore, substituteClientState); err != nil {
188+
return err
189+
}
190+
191+
k.Logger(ctx).Info("client recovered", "client-id", subjectClientID)
192+
193+
defer telemetry.IncrCounterWithLabels(
194+
[]string{"ibc", "client", "update"},
195+
1,
196+
[]metrics.Label{
197+
telemetry.NewLabel(types.LabelClientType, substituteClientState.ClientType()),
198+
telemetry.NewLabel(types.LabelClientID, subjectClientID),
199+
telemetry.NewLabel(types.LabelUpdateType, "recovery"),
200+
},
201+
)
202+
203+
// emitting events in the keeper for recovering clients
204+
emitRecoverClientEvent(ctx, subjectClientID, substituteClientState.ClientType())
205+
206+
return nil
207+
}

‎modules/core/02-client/keeper/client_test.go

+156
Original file line numberDiff line numberDiff line change
@@ -508,3 +508,159 @@ func (suite *KeeperTestSuite) TestUpdateClientEventEmission() {
508508
}
509509
suite.Require().True(contains)
510510
}
511+
512+
func (suite *KeeperTestSuite) TestRecoverClient() {
513+
var (
514+
subject, substitute string
515+
subjectClientState, substituteClientState exported.ClientState
516+
)
517+
518+
testCases := []struct {
519+
msg string
520+
malleate func()
521+
expErr error
522+
}{
523+
{
524+
"success",
525+
func() {},
526+
nil,
527+
},
528+
{
529+
"success, subject and substitute use different revision number",
530+
func() {
531+
tmClientState, ok := substituteClientState.(*ibctm.ClientState)
532+
suite.Require().True(ok)
533+
consState, found := suite.chainA.App.GetIBCKeeper().ClientKeeper.GetClientConsensusState(suite.chainA.GetContext(), substitute, tmClientState.LatestHeight)
534+
suite.Require().True(found)
535+
newRevisionNumber := tmClientState.GetLatestHeight().GetRevisionNumber() + 1
536+
537+
tmClientState.LatestHeight = clienttypes.NewHeight(newRevisionNumber, tmClientState.GetLatestHeight().GetRevisionHeight())
538+
539+
suite.chainA.App.GetIBCKeeper().ClientKeeper.SetClientConsensusState(suite.chainA.GetContext(), substitute, tmClientState.LatestHeight, consState)
540+
clientStore := suite.chainA.App.GetIBCKeeper().ClientKeeper.ClientStore(suite.chainA.GetContext(), substitute)
541+
ibctm.SetProcessedTime(clientStore, tmClientState.LatestHeight, 100)
542+
ibctm.SetProcessedHeight(clientStore, tmClientState.LatestHeight, clienttypes.NewHeight(0, 1))
543+
suite.chainA.App.GetIBCKeeper().ClientKeeper.SetClientState(suite.chainA.GetContext(), substitute, tmClientState)
544+
},
545+
nil,
546+
},
547+
{
548+
"subject client does not exist",
549+
func() {
550+
subject = ibctesting.InvalidID
551+
},
552+
clienttypes.ErrClientNotFound,
553+
},
554+
{
555+
"subject is Active",
556+
func() {
557+
tmClientState, ok := subjectClientState.(*ibctm.ClientState)
558+
suite.Require().True(ok)
559+
// Set FrozenHeight to zero to ensure client is reported as Active
560+
tmClientState.FrozenHeight = clienttypes.ZeroHeight()
561+
suite.chainA.App.GetIBCKeeper().ClientKeeper.SetClientState(suite.chainA.GetContext(), subject, tmClientState)
562+
},
563+
clienttypes.ErrInvalidRecoveryClient,
564+
},
565+
{
566+
"substitute client does not exist",
567+
func() {
568+
substitute = ibctesting.InvalidID
569+
},
570+
clienttypes.ErrClientNotFound,
571+
},
572+
{
573+
"subject and substitute have equal latest height",
574+
func() {
575+
tmClientState, ok := subjectClientState.(*ibctm.ClientState)
576+
suite.Require().True(ok)
577+
tmClientState.LatestHeight = substituteClientState.GetLatestHeight().(clienttypes.Height)
578+
suite.chainA.App.GetIBCKeeper().ClientKeeper.SetClientState(suite.chainA.GetContext(), subject, tmClientState)
579+
},
580+
clienttypes.ErrInvalidHeight,
581+
},
582+
{
583+
"subject height is greater than substitute height",
584+
func() {
585+
tmClientState, ok := subjectClientState.(*ibctm.ClientState)
586+
suite.Require().True(ok)
587+
tmClientState.LatestHeight = substituteClientState.GetLatestHeight().Increment().(clienttypes.Height)
588+
suite.chainA.App.GetIBCKeeper().ClientKeeper.SetClientState(suite.chainA.GetContext(), subject, tmClientState)
589+
},
590+
clienttypes.ErrInvalidHeight,
591+
},
592+
{
593+
"substitute is frozen",
594+
func() {
595+
tmClientState, ok := substituteClientState.(*ibctm.ClientState)
596+
suite.Require().True(ok)
597+
tmClientState.FrozenHeight = clienttypes.NewHeight(0, 1)
598+
suite.chainA.App.GetIBCKeeper().ClientKeeper.SetClientState(suite.chainA.GetContext(), substitute, tmClientState)
599+
},
600+
clienttypes.ErrClientNotActive,
601+
},
602+
{
603+
"CheckSubstituteAndUpdateState fails, substitute client trust level doesn't match subject client trust level",
604+
func() {
605+
tmClientState, ok := substituteClientState.(*ibctm.ClientState)
606+
suite.Require().True(ok)
607+
tmClientState.UnbondingPeriod += time.Minute
608+
suite.chainA.App.GetIBCKeeper().ClientKeeper.SetClientState(suite.chainA.GetContext(), substitute, tmClientState)
609+
},
610+
clienttypes.ErrInvalidSubstitute,
611+
},
612+
}
613+
614+
for _, tc := range testCases {
615+
tc := tc
616+
617+
suite.Run(tc.msg, func() {
618+
suite.SetupTest() // reset
619+
620+
subjectPath := ibctesting.NewPath(suite.chainA, suite.chainB)
621+
suite.coordinator.SetupClients(subjectPath)
622+
subject = subjectPath.EndpointA.ClientID
623+
subjectClientState = suite.chainA.GetClientState(subject)
624+
625+
substitutePath := ibctesting.NewPath(suite.chainA, suite.chainB)
626+
suite.coordinator.SetupClients(substitutePath)
627+
substitute = substitutePath.EndpointA.ClientID
628+
629+
// update substitute twice
630+
err := substitutePath.EndpointA.UpdateClient()
631+
suite.Require().NoError(err)
632+
err = substitutePath.EndpointA.UpdateClient()
633+
suite.Require().NoError(err)
634+
substituteClientState = suite.chainA.GetClientState(substitute)
635+
636+
tmClientState, ok := subjectClientState.(*ibctm.ClientState)
637+
suite.Require().True(ok)
638+
tmClientState.AllowUpdateAfterMisbehaviour = true
639+
tmClientState.AllowUpdateAfterExpiry = true
640+
tmClientState.FrozenHeight = tmClientState.LatestHeight
641+
suite.chainA.App.GetIBCKeeper().ClientKeeper.SetClientState(suite.chainA.GetContext(), subject, tmClientState)
642+
643+
tmClientState, ok = substituteClientState.(*ibctm.ClientState)
644+
suite.Require().True(ok)
645+
tmClientState.AllowUpdateAfterMisbehaviour = true
646+
tmClientState.AllowUpdateAfterExpiry = true
647+
648+
tc.malleate()
649+
650+
err = suite.chainA.App.GetIBCKeeper().ClientKeeper.RecoverClient(suite.chainA.GetContext(), subject, substitute)
651+
652+
expPass := tc.expErr == nil
653+
if expPass {
654+
suite.Require().NoError(err)
655+
656+
// Assert that client status is now Active
657+
clientStore := suite.chainA.App.GetIBCKeeper().ClientKeeper.ClientStore(suite.chainA.GetContext(), subjectPath.EndpointA.ClientID)
658+
tmClientState := subjectPath.EndpointA.GetClientState().(*ibctm.ClientState)
659+
suite.Require().Equal(tmClientState.Status(suite.chainA.GetContext(), clientStore, suite.chainA.App.AppCodec()), exported.Active)
660+
} else {
661+
suite.Require().Error(err)
662+
suite.Require().ErrorIs(err, tc.expErr)
663+
}
664+
})
665+
}
666+
}

‎modules/core/02-client/keeper/events.go

+15
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,21 @@ func emitUpdateClientProposalEvent(ctx sdk.Context, clientID, clientType string)
9696
})
9797
}
9898

99+
// emitRecoverClientEvent emits a recover client event
100+
func emitRecoverClientEvent(ctx sdk.Context, clientID, clientType string) {
101+
ctx.EventManager().EmitEvents(sdk.Events{
102+
sdk.NewEvent(
103+
types.EventTypeRecoverClient,
104+
sdk.NewAttribute(types.AttributeKeySubjectClientID, clientID),
105+
sdk.NewAttribute(types.AttributeKeyClientType, clientType),
106+
),
107+
sdk.NewEvent(
108+
sdk.EventTypeMessage,
109+
sdk.NewAttribute(sdk.AttributeKeyModule, types.AttributeValueCategory),
110+
),
111+
})
112+
}
113+
99114
// emitUpgradeClientProposalEvent emits an upgrade client proposal event
100115
func emitUpgradeClientProposalEvent(ctx sdk.Context, title string, height int64) {
101116
ctx.EventManager().EmitEvents(sdk.Events{

‎modules/core/02-client/keeper/proposal.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func (k Keeper) ClientUpdateProposal(ctx sdk.Context, p *types.ClientUpdatePropo
2828
subjectClientStore := k.ClientStore(ctx, p.SubjectClientId)
2929

3030
if status := k.GetClientStatus(ctx, subjectClientState, p.SubjectClientId); status == exported.Active {
31-
return errorsmod.Wrap(types.ErrInvalidUpdateClientProposal, "cannot update Active subject client")
31+
return errorsmod.Wrap(types.ErrInvalidRecoveryClient, "cannot update Active subject client")
3232
}
3333

3434
substituteClientState, found := k.GetClientState(ctx, p.SubstituteClientId)

‎modules/core/02-client/types/errors.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ var (
2828
ErrFailedNextSeqRecvVerification = errorsmod.Register(SubModuleName, 21, "next sequence receive verification failed")
2929
ErrSelfConsensusStateNotFound = errorsmod.Register(SubModuleName, 22, "self consensus state not found")
3030
ErrUpdateClientFailed = errorsmod.Register(SubModuleName, 23, "unable to update light client")
31-
ErrInvalidUpdateClientProposal = errorsmod.Register(SubModuleName, 24, "invalid update client proposal")
31+
ErrInvalidRecoveryClient = errorsmod.Register(SubModuleName, 24, "invalid recovery client")
3232
ErrInvalidUpgradeClient = errorsmod.Register(SubModuleName, 25, "invalid client upgrade")
3333
ErrInvalidHeight = errorsmod.Register(SubModuleName, 26, "invalid height")
3434
ErrInvalidSubstitute = errorsmod.Register(SubModuleName, 27, "invalid client state substitute")

‎modules/core/02-client/types/events.go

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ var (
2828
EventTypeUpdateClientProposal = "update_client_proposal"
2929
EventTypeUpgradeChain = "upgrade_chain"
3030
EventTypeUpgradeClientProposal = "upgrade_client_proposal"
31+
EventTypeRecoverClient = "recover_client"
3132

3233
AttributeValueCategory = fmt.Sprintf("%s_%s", ibcexported.ModuleName, SubModuleName)
3334
)

0 commit comments

Comments
 (0)