179 lines
6.1 KiB
Go
179 lines
6.1 KiB
Go
package keeper
|
|
|
|
import (
|
|
"github.com/armon/go-metrics"
|
|
|
|
"github.com/cosmos/cosmos-sdk/telemetry"
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
|
|
"github.com/cosmos/cosmos-sdk/x/ibc/core/02-client/types"
|
|
"github.com/cosmos/cosmos-sdk/x/ibc/core/exported"
|
|
)
|
|
|
|
// CreateClient creates a new client state and populates it with a given consensus
|
|
// state as defined in https://github.com/cosmos/ics/tree/master/spec/ics-002-client-semantics#create
|
|
//
|
|
// CONTRACT: ClientState was constructed correctly from given initial consensusState
|
|
func (k Keeper) CreateClient(
|
|
ctx sdk.Context, clientID string, clientState exported.ClientState, consensusState exported.ConsensusState,
|
|
) error {
|
|
_, found := k.GetClientState(ctx, clientID)
|
|
if found {
|
|
return sdkerrors.Wrapf(types.ErrClientExists, "cannot create client with ID %s", clientID)
|
|
}
|
|
|
|
if consensusState != nil {
|
|
k.SetClientConsensusState(ctx, clientID, clientState.GetLatestHeight(), consensusState)
|
|
}
|
|
|
|
k.SetClientState(ctx, clientID, clientState)
|
|
k.Logger(ctx).Info("client created at height", "client-id", clientID, "height", clientState.GetLatestHeight().String())
|
|
|
|
defer func() {
|
|
telemetry.IncrCounterWithLabels(
|
|
[]string{"ibc", "client", "create"},
|
|
1,
|
|
[]metrics.Label{telemetry.NewLabel("client-type", clientState.ClientType())},
|
|
)
|
|
}()
|
|
|
|
return nil
|
|
}
|
|
|
|
// UpdateClient updates the consensus state and the state root from a provided header.
|
|
func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.Header) error {
|
|
clientState, found := k.GetClientState(ctx, clientID)
|
|
if !found {
|
|
return sdkerrors.Wrapf(types.ErrClientNotFound, "cannot update client with ID %s", clientID)
|
|
}
|
|
|
|
// prevent update if the client is frozen before or at header height
|
|
if clientState.IsFrozen() && clientState.GetFrozenHeight().LTE(header.GetHeight()) {
|
|
return sdkerrors.Wrapf(types.ErrClientFrozen, "cannot update client with ID %s", clientID)
|
|
}
|
|
|
|
var (
|
|
consensusState exported.ConsensusState
|
|
consensusHeight exported.Height
|
|
err error
|
|
)
|
|
|
|
clientState, consensusState, err = clientState.CheckHeaderAndUpdateState(ctx, k.cdc, k.ClientStore(ctx, clientID), header)
|
|
|
|
if err != nil {
|
|
return sdkerrors.Wrapf(err, "cannot update client with ID %s", clientID)
|
|
}
|
|
|
|
k.SetClientState(ctx, clientID, clientState)
|
|
|
|
// we don't set consensus state for localhost client
|
|
if header != nil && clientID != exported.Localhost {
|
|
k.SetClientConsensusState(ctx, clientID, header.GetHeight(), consensusState)
|
|
consensusHeight = header.GetHeight()
|
|
} else {
|
|
consensusHeight = types.GetSelfHeight(ctx)
|
|
}
|
|
|
|
k.Logger(ctx).Info("client state updated", "client-id", clientID, "height", consensusHeight.String())
|
|
|
|
defer func() {
|
|
telemetry.IncrCounterWithLabels(
|
|
[]string{"ibc", "client", "update"},
|
|
1,
|
|
[]metrics.Label{
|
|
telemetry.NewLabel("client-type", clientState.ClientType()),
|
|
telemetry.NewLabel("client-id", clientID),
|
|
telemetry.NewLabel("update-type", "msg"),
|
|
},
|
|
)
|
|
}()
|
|
|
|
// emitting events in the keeper emits for both begin block and handler client updates
|
|
ctx.EventManager().EmitEvent(
|
|
sdk.NewEvent(
|
|
types.EventTypeUpdateClient,
|
|
sdk.NewAttribute(types.AttributeKeyClientID, clientID),
|
|
sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
|
|
sdk.NewAttribute(types.AttributeKeyConsensusHeight, consensusHeight.String()),
|
|
),
|
|
)
|
|
|
|
return nil
|
|
}
|
|
|
|
// UpgradeClient upgrades the client to a new client state if this new client was committed to
|
|
// by the old client at the specified upgrade height
|
|
func (k Keeper) UpgradeClient(ctx sdk.Context, clientID string, upgradedClient exported.ClientState, upgradeHeight exported.Height, proofUpgrade []byte) error {
|
|
clientState, found := k.GetClientState(ctx, clientID)
|
|
if !found {
|
|
return sdkerrors.Wrapf(types.ErrClientNotFound, "cannot update client with ID %s", clientID)
|
|
}
|
|
|
|
// prevent upgrade if current client is frozen
|
|
if clientState.IsFrozen() {
|
|
return sdkerrors.Wrapf(types.ErrClientFrozen, "cannot update client with ID %s", clientID)
|
|
}
|
|
|
|
err := clientState.VerifyUpgrade(ctx, k.cdc, k.ClientStore(ctx, clientID), upgradedClient, upgradeHeight, proofUpgrade)
|
|
if err != nil {
|
|
return sdkerrors.Wrapf(err, "cannot upgrade client with ID: %s", clientID)
|
|
}
|
|
|
|
k.SetClientState(ctx, clientID, upgradedClient)
|
|
|
|
k.Logger(ctx).Info("client state upgraded", "client-id", clientID, "height", upgradedClient.GetLatestHeight().String())
|
|
|
|
defer func() {
|
|
telemetry.IncrCounterWithLabels(
|
|
[]string{"ibc", "client", "upgrade"},
|
|
1,
|
|
[]metrics.Label{
|
|
telemetry.NewLabel("client-type", clientState.ClientType()),
|
|
telemetry.NewLabel("client-id", clientID),
|
|
},
|
|
)
|
|
}()
|
|
|
|
// emitting events in the keeper emits for client upgrades
|
|
ctx.EventManager().EmitEvent(
|
|
sdk.NewEvent(
|
|
types.EventTypeUpgradeClient,
|
|
sdk.NewAttribute(types.AttributeKeyClientID, clientID),
|
|
sdk.NewAttribute(types.AttributeKeyClientType, clientState.ClientType()),
|
|
sdk.NewAttribute(types.AttributeKeyConsensusHeight, upgradedClient.GetLatestHeight().String()),
|
|
),
|
|
)
|
|
|
|
return nil
|
|
}
|
|
|
|
// CheckMisbehaviourAndUpdateState checks for client misbehaviour and freezes the
|
|
// client if so.
|
|
func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, misbehaviour exported.Misbehaviour) error {
|
|
clientState, found := k.GetClientState(ctx, misbehaviour.GetClientID())
|
|
if !found {
|
|
return sdkerrors.Wrapf(types.ErrClientNotFound, "cannot check misbehaviour for client with ID %s", misbehaviour.GetClientID())
|
|
}
|
|
|
|
clientState, err := clientState.CheckMisbehaviourAndUpdateState(ctx, k.cdc, k.ClientStore(ctx, misbehaviour.GetClientID()), misbehaviour)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
k.SetClientState(ctx, misbehaviour.GetClientID(), clientState)
|
|
k.Logger(ctx).Info("client frozen due to misbehaviour", "client-id", misbehaviour.GetClientID(), "height", misbehaviour.GetHeight().String())
|
|
|
|
defer func() {
|
|
telemetry.IncrCounterWithLabels(
|
|
[]string{"ibc", "client", "misbehaviour"},
|
|
1,
|
|
[]metrics.Label{
|
|
telemetry.NewLabel("client-type", misbehaviour.ClientType()),
|
|
telemetry.NewLabel("client-id", misbehaviour.GetClientID()),
|
|
},
|
|
)
|
|
}()
|
|
|
|
return nil
|
|
}
|