chore: disallow localhost client creation in 02-client #3114
Conversation
damiannolan
requested review from
colin-axner,
AdityaSripal,
crodriguezvega,
charleenfei and
chatton
as code owners
| "success: 06-solomachine client type supported", | ||
| solomachine.NewClientState(0, &solomachine.ConsensusState{PublicKey: suite.solomachine.ConsensusState().PublicKey, Diversifier: suite.solomachine.Diversifier, Timestamp: suite.solomachine.Time}), | ||
| &solomachine.ConsensusState{PublicKey: suite.solomachine.ConsensusState().PublicKey, Diversifier: suite.solomachine.Diversifier, Timestamp: suite.solomachine.Time}, | ||
| true, |
There was a problem hiding this comment.
I've adapted the tests here slightly. This one was actually setup incorrectly and the case was failing on clientState.Initialise() due to non-matching consensus state, rather than it being an unsupported client. Solomachine is now in the list of allowed clients so this test case should pass.
|
Initially I removed the localhost client type from |
| @@ -17,7 +17,7 @@ func (k Keeper) CreateClient( | |||
| ctx sdk.Context, clientState exported.ClientState, consensusState exported.ConsensusState, | |||
| ) (string, error) { | |||
| params := k.GetParams(ctx) | |||
| if !params.IsAllowedClient(clientState.ClientType()) { | |||
| if !params.IsAllowedClient(clientState.ClientType()) || clientState.ClientType() == exported.Localhost { | |||
| return "", sdkerrors.Wrapf( | |||
| types.ErrInvalidClientType, | |||
| "client state type %s is not registered in the allowlist", clientState.ClientType(), | |||
There was a problem hiding this comment.
Maybe a nit, but wouldn't this error be a bit misleading for localhost? I mean, the reader of the error would see that localhost is in the allow list...
There was a problem hiding this comment.
Yes, I suppose it would!
We can either change the error msg or put the localhost check in its own conditional, what do you think?
There was a problem hiding this comment.
Maybe I would prefer then to have it in its own conditional.
Description
09-localhostclients in02-clientref: #3034
Commit Message / Changelog Entry
chore: disallow localhost client creation in 02-clientsee the guidelines for commit messages. (view raw markdown for examples)
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/).godoccomments.Files changedin the Github PR explorer.Codecov Reportin the comment section below once CI passes.