Improve ICA error management and code comments

x/millions/keeper/callbacks_bank_send.go

@@ -44,6 +44,9 @@ func BankSendCallback(k Keeper, ctx sdk.Context, packet channeltypes.Packet, ack
 		return err
 	}
 
+	// Scenarios:
+	// - Timeout: Does nothing, handled when restoring the ICA channel
+	// - Error: Put entity in error state to allow users to retry
 	if ackResponse.Status == icacallbackstypes.AckResponseStatus_TIMEOUT {
 		k.Logger(ctx).Debug("Received timeout for a bank send to native packet")
 	} else if ackResponse.Status == icacallbackstypes.AckResponseStatus_FAILURE {

x/millions/keeper/callbacks_claim.go

@@ -39,8 +39,9 @@ func ClaimCallback(k Keeper, ctx sdk.Context, packet channeltypes.Packet, ackRes
 		return errorsmod.Wrapf(types.ErrUnmarshalFailure, fmt.Sprintf("Unable to unmarshal claim callback args: %s", err.Error()))
 	}
 
-	// If the response status is a timeout, that's not an "error" since the relayer will retry then fail or succeed.
-	// We just log it out and return no error
+	// Scenarios:
+	// - Timeout: Does nothing, handled when restoring the ICA channel
+	// - Error: Put entity in error state to allow users to retry
 	if ackResponse.Status == icacallbackstypes.AckResponseStatus_TIMEOUT {
 		k.Logger(ctx).Debug("Received timeout for a claim packet")
 	} else if ackResponse.Status == icacallbackstypes.AckResponseStatus_FAILURE {

x/millions/keeper/callbacks_delegate.go

@@ -39,8 +39,9 @@ func DelegateCallback(k Keeper, ctx sdk.Context, packet channeltypes.Packet, ack
 		return errorsmod.Wrapf(types.ErrUnmarshalFailure, fmt.Sprintf("Unable to unmarshal delegate callback args: %s", err.Error()))
 	}
 
-	// If the response status is a timeout, that's not an "error" since the relayer will retry then fail or succeed.
-	// We just log it out and return no error
+	// Scenarios:
+	// - Timeout: Does nothing, handled when restoring the ICA channel
+	// - Error: Put entity in error state to allow users to retry
 	if ackResponse.Status == icacallbackstypes.AckResponseStatus_TIMEOUT {
 		k.Logger(ctx).Debug("Received timeout for a delegate packet")
 	} else if ackResponse.Status == icacallbackstypes.AckResponseStatus_FAILURE {

x/millions/keeper/callbacks_redelegate.go

@@ -45,10 +45,12 @@ func RedelegateCallback(k Keeper, ctx sdk.Context, packet channeltypes.Packet, a
 		return err
 	}
 
-	// If the response status is a timeout, that's not an "error" since the relayer will retry then fail or succeed.
-	// We just log it out and return no error
+	// Scenarios:
+	// - Timeout: Treated as an error (see below)
+	// - Error: Revert Pool validator set known split
 	if ackResponse.Status == icacallbackstypes.AckResponseStatus_TIMEOUT {
 		k.Logger(ctx).Debug("Received timeout for a redelegate packet")
+		return k.OnRedelegateToActiveValidatorsOnRemoteZoneCompleted(ctx, redelegateCallback.GetPoolId(), redelegateCallback.GetOperatorAddress(), redelegateCallback.GetSplitDelegations(), true)
 	} else if ackResponse.Status == icacallbackstypes.AckResponseStatus_FAILURE {
 		k.Logger(ctx).Debug("Received failure for a redelegate packet")
 		return k.OnRedelegateToActiveValidatorsOnRemoteZoneCompleted(ctx, redelegateCallback.GetPoolId(), redelegateCallback.GetOperatorAddress(), redelegateCallback.GetSplitDelegations(), true)

x/millions/keeper/callbacks_set_withdraw_address.go

@@ -45,8 +45,10 @@ func SetWithdrawAddressCallback(k Keeper, ctx sdk.Context, packet channeltypes.P
 		return err
 	}
 
-	// If the response status is a timeout, that's not an "error" since the relayer will retry then fail or succeed.
-	// We just log it out and return no error
+	// Scenarios:
+	// This operation is done right after the ICA channel open procedure
+	// - Timeout: Does nothing - fix may be needed manually
+	// - Error: Does nothing - fix may be needed manually
 	if ackResponse.Status == icacallbackstypes.AckResponseStatus_TIMEOUT {
 		k.Logger(ctx).Debug("Received timeout for a set withdraw address packet")
 	} else if ackResponse.Status == icacallbackstypes.AckResponseStatus_FAILURE {

x/millions/keeper/callbacks_transfer_from_native.go

@@ -45,8 +45,9 @@ func TransferFromNativeCallback(k Keeper, ctx sdk.Context, packet channeltypes.P
 		return err
 	}
 
-	// If the response status is a timeout, that's not an "error" since the relayer will retry then fail or succeed.
-	// We just log it out and return no error
+	// Scenarios:
+	// - Timeout: Does nothing, handled when restoring the ICA channel
+	// - Error: Put entity in error state to allow users to retry
 	if ackResponse.Status == icacallbackstypes.AckResponseStatus_TIMEOUT {
 		k.Logger(ctx).Debug("Received timeout for a transfer from native packet")
 	} else if ackResponse.Status == icacallbackstypes.AckResponseStatus_FAILURE {

x/millions/keeper/callbacks_transfer_to_native.go

@@ -39,8 +39,10 @@ func TransferToNativeCallback(k Keeper, ctx sdk.Context, packet channeltypes.Pac
 		return errorsmod.Wrapf(types.ErrUnmarshalFailure, fmt.Sprintf("Unable to unmarshal transfer to native callback args: %s", err.Error()))
 	}
 
+	// Scenarios:
+	// - Timeout: Treated as an error (see below)
+	// - Error: Put entity in error state to allow users to retry
 	if ackResponse.Status == icacallbackstypes.AckResponseStatus_TIMEOUT {
-		// Timeout is considered a failure on IBC transfers
 		k.Logger(ctx).Debug("Received timeout for a transfer to native packet")
 		return k.OnTransferDepositToRemoteZoneCompleted(ctx, transferCallback.GetPoolId(), transferCallback.GetDepositId(), true)
 	} else if ackResponse.Status == icacallbackstypes.AckResponseStatus_FAILURE {

x/millions/keeper/callbacks_undelegate.go

@@ -69,13 +69,13 @@ func UndelegateCallback(k Keeper, ctx sdk.Context, packet channeltypes.Packet, a
 		return err
 	}
 
-	// If the response status is a timeout, that's not an "error" since the relayer will retry then fail or succeed.
-	// We just log it out and return no error
+	// Scenarios:
+	// - Timeout: Does nothing, handled when restoring the ICA channel
+	// - Error: Put back entities in the queue automatically
 	if ackResponse.Status == icacallbackstypes.AckResponseStatus_TIMEOUT {
 		k.Logger(ctx).Debug("Received timeout for an undelegate packet")
 	} else if ackResponse.Status == icacallbackstypes.AckResponseStatus_FAILURE {
 		k.Logger(ctx).Debug("Received failure for an undelegate packet")
-		// Failed OnUndelegateEpochUnbondingOnRemoteZoneCompleted
 		return k.OnUndelegateWithdrawalsOnRemoteZoneCompleted(
 			ctx,
 			undelegateCallback.PoolId,

x/millions/keeper/msg_server_pool.go

@@ -88,7 +88,7 @@ func (k msgServer) restoreICADepositEntities(ctx sdk.Context, poolID uint64) {
 	// Restore withdrawals ICA locked operations on ICADeposit account
 	withdrawals := k.Keeper.ListPoolWithdrawals(ctx, poolID)
 	for _, w := range withdrawals {
-		if w.State == types.WithdrawalState_IcaUndelegate {
+		if w.State == types.WithdrawalState_IcaUndelegate || w.State == types.WithdrawalState_IbcTransfer {
 			w.ErrorState = w.State
 			w.State = types.WithdrawalState_Failure
 			k.Keeper.setPoolWithdrawal(ctx, w)
@@ -98,7 +98,7 @@ func (k msgServer) restoreICADepositEntities(ctx sdk.Context, poolID uint64) {
 	// Restore draws ICA locked operations on ICADeposit account
 	draws := k.Keeper.ListPoolDraws(ctx, poolID)
 	for _, d := range draws {
-		if d.State == types.DrawState_IcaWithdrawRewards {
+		if d.State == types.DrawState_IcaWithdrawRewards || d.State == types.DrawState_IbcTransfer {
 			d.ErrorState = d.State
 			d.State = types.DrawState_Failure
 			k.Keeper.SetPoolDraw(ctx, d)

x/millions/keeper/queries_balance.go

@@ -39,7 +39,9 @@ func BalanceCallback(k Keeper, ctx sdk.Context, args []byte, query icqueriestype
 		return errorsmod.Wrapf(types.ErrPoolNotFound, "no registered draw %d for pool %d", drawID, poolID)
 	}
 
-	// Based on type, we want different processing
+	// Scenarios:
+	// - Timeout: Treated as an error (see below)
+	// - Error: Put entity in error state to allow users to retry
 	if status == icqueriestypes.QueryResponseStatus_TIMEOUT {
 		k.Logger(ctx).Error(fmt.Sprintf("QUERY TIMEOUT - QueryId: %s, TTL: %d, BlockTime: %d", query.Id, query.TimeoutTimestamp, ctx.BlockHeader().Time.UnixNano()))
 		_, err := k.OnQueryFreshPrizePoolCoinsOnRemoteZoneCompleted(ctx, pool.GetPoolId(), draw.GetDrawId(), sdk.NewCoins(), true)