Skip to content

fix: identity registration events to use keyper-set-index #691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blockchainluffy merged 3 commits into from
Apr 17, 2026
Merged

fix: identity registration events to use keyper-set-index #691

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cb64a4e
fix: identity registration events to use keyper-set-index
blockchainluffy Apr 3, 2026
ed614be
chore: fix lint errors in tests
blockchainluffy Apr 8, 2026
9eaeb80
chore: updated error check for GetKeyperIndex
blockchainluffy Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions rolling-shutter/keyper/database/keyper.sqlc.gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions rolling-shutter/keyper/database/sql/queries/keyper.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,3 +236,10 @@ WHERE eons.eon = @eon;
SELECT max(eons.eon)::INT
FROM eons
WHERE eons.keyper_config_index = @keyper_config_index;

-- name: GetLatestStartedEonByKeyperConfigIndex :one
SELECT *
FROM eons
WHERE keyper_config_index = $1
ORDER BY eon DESC
LIMIT 1;
140 changes: 90 additions & 50 deletions rolling-shutter/keyperimpl/shutterservice/newblock.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import (
"github.com/pkg/errors"
"github.com/rs/zerolog/log"

obskeyper "github.com/shutter-network/rolling-shutter/rolling-shutter/chainobserver/db/keyper"
corekeyperdatabase "github.com/shutter-network/rolling-shutter/rolling-shutter/keyper/database"
"github.com/shutter-network/rolling-shutter/rolling-shutter/keyper/epochkghandler"
servicedatabase "github.com/shutter-network/rolling-shutter/rolling-shutter/keyperimpl/shutterservice/database"
Expand Down Expand Up @@ -84,7 +83,10 @@ func (kpr *Keyper) prepareTimeBasedTriggers(ctx context.Context, block *synceven
for _, event := range nonTriggeredEvents {
trigger, err := kpr.shouldTriggerDecryption(ctx, event, block)
if err != nil {
return nil, errors.Wrapf(err, "failed to check if should trigger decryption for event %d", event.Eon)
return nil, errors.Wrapf(err,
"failed to check if should trigger decryption for keyper set index %d",
event.Eon,
)
}
if trigger {
eventsToDecrypt = append(eventsToDecrypt, event)
Expand All @@ -100,28 +102,17 @@ func (kpr *Keyper) shouldTriggerDecryption(
triggeredBlock *syncevent.LatestBlock,
) (bool, error) {
coreKeyperDB := corekeyperdatabase.New(kpr.dbpool)
isKeyper, err := coreKeyperDB.GetKeyperStateForEon(ctx, corekeyperdatabase.GetKeyperStateForEonParams{
Eon: event.Eon,
KeyperAddress: []string{kpr.config.GetAddress().Hex()},
})
eon, decryptable, err := kpr.resolveDecryptableEon(ctx, coreKeyperDB, event.Eon)
if err != nil {
if err == pgx.ErrNoRows {
log.Info().
Int64("eon", event.Eon).
Msg("skipping event as no eon has been found for it")
return false, nil
} else {
return false, errors.Wrapf(err, "failed to query keyper state for eon %d", event.Eon)
}
return false, errors.Wrapf(err, "failed to resolve decryptable eon for keyper set index %d", event.Eon)
}

eon, err := coreKeyperDB.GetEon(ctx, event.Eon)
if err != nil {
return false, errors.Wrapf(err, "failed to get eon %d", event.Eon)
if !decryptable {
return false, nil
}
if eon.ActivationBlockNumber > triggeredBlock.Header.Number.Int64() {
log.Info().
Int64("eon", event.Eon).
Int64("keyper-set-index", event.Eon).
Int64("resolved-eon", eon.Eon).
Int64("block-number", triggeredBlock.Header.Number.Int64()).
Msg("skipping event as eon activation block number is greater than triggered block number")
return false, nil
Expand All @@ -130,18 +121,76 @@ func (kpr *Keyper) shouldTriggerDecryption(
if event.Timestamp >= int64(triggeredBlock.Header.Time) {
return false, nil
}
return true, nil
}

// don't trigger if we're not part of the keyper set
func (kpr *Keyper) resolveDecryptableEon(
ctx context.Context,
coreKeyperDB *corekeyperdatabase.Queries,
keyperConfigIndex int64,
) (corekeyperdatabase.Eon, bool, error) {
eon, err := coreKeyperDB.GetLatestStartedEonByKeyperConfigIndex(ctx, keyperConfigIndex)
if err != nil {
if err == pgx.ErrNoRows {
log.Info().
Int64("keyper-set-index", keyperConfigIndex).
Msg("skipping event as no started eon has been found for keyper set")
return corekeyperdatabase.Eon{}, false, nil
}
return corekeyperdatabase.Eon{}, false, errors.Wrapf(
err,
"failed to get latest started eon for keyper set index %d",
keyperConfigIndex,
)
}

_, isKeyper, err := coreKeyperDB.GetKeyperIndex(ctx, keyperConfigIndex, kpr.config.GetAddress())
if err != nil {
if errors.Is(err, pgx.ErrNoRows) {
log.Info().
Int64("keyper-set-index", keyperConfigIndex).
Msg("skipping event as keyper set has not been found")
return corekeyperdatabase.Eon{}, false, nil
}
return corekeyperdatabase.Eon{}, false, errors.Wrapf(
err,
"failed to query keyper membership for keyper set index %d",
keyperConfigIndex,
)
}
if !isKeyper {
log.Info().
Int64("eon", event.Eon).
Int64("block-number", event.BlockNumber).
Str("identity", hex.EncodeToString(event.Identity)).
Int64("keyper-set-index", keyperConfigIndex).
Int64("eon", eon.Eon).
Str("address", kpr.config.GetAddress().Hex()).
Msg("skipping event as not part of keyper set")
return false, nil
return corekeyperdatabase.Eon{}, false, nil
}
return true, nil

dkgResult, err := coreKeyperDB.GetDKGResultForKeyperConfigIndex(ctx, keyperConfigIndex)
if err != nil {
if err == pgx.ErrNoRows {
log.Info().
Int64("keyper-set-index", keyperConfigIndex).
Int64("eon", eon.Eon).
Msg("skipping event as no DKG result has been found for keyper set")
return corekeyperdatabase.Eon{}, false, nil
}
return corekeyperdatabase.Eon{}, false, errors.Wrapf(
err,
"failed to query DKG result for keyper set index %d",
keyperConfigIndex,
)
}
if !dkgResult.Success {
log.Info().
Int64("keyper-set-index", keyperConfigIndex).
Int64("eon", eon.Eon).
Msg("skipping event as resolved eon is not decryptable")
return corekeyperdatabase.Eon{}, false, nil
}

return eon, true, nil
}

func (kpr *Keyper) createTriggersFromIdentityRegisteredEvents(
Expand All @@ -153,9 +202,17 @@ func (kpr *Keyper) createTriggersFromIdentityRegisteredEvents(
identityPreimages := make(map[int64][]identitypreimage.IdentityPreimage)
lastEonBlock := make(map[int64]int64)
for _, event := range triggeredEvents {
eon, err := coreKeyperDB.GetEon(ctx, event.Eon)
eon, decryptable, err := kpr.resolveDecryptableEon(ctx, coreKeyperDB, event.Eon)
if err != nil {
return nil, errors.Wrapf(err, "failed to query eon %d from db", event.Eon)
return nil, errors.Wrapf(err, "failed to resolve decryptable eon for keyper set index %d", event.Eon)
}
if !decryptable {
log.Info().
Int64("keyper-set-index", event.Eon).
Int64("block-number", event.BlockNumber).
Str("identity", hex.EncodeToString(event.Identity)).
Msg("skipping event while creating triggers as no decryptable eon could be resolved")
continue
}

if identityPreimages[event.Eon] == nil {
Expand Down Expand Up @@ -185,7 +242,6 @@ func (kpr *Keyper) createTriggersFromIdentityRegisteredEvents(
func (kpr *Keyper) prepareEventBasedTriggers(ctx context.Context) ([]epochkghandler.DecryptionTrigger, error) {
coreKeyperDB := corekeyperdatabase.New(kpr.dbpool)
serviceDB := servicedatabase.New(kpr.dbpool)
obsDB := obskeyper.New(kpr.dbpool)

firedTriggers, err := serviceDB.GetUndecryptedFiredTriggers(ctx)
if err != nil {
Expand All @@ -202,30 +258,14 @@ func (kpr *Keyper) prepareEventBasedTriggers(ctx context.Context) ([]epochkghand
if len(firedTriggers) == 0 {
continue
}
eonStruct, err := coreKeyperDB.GetEon(ctx, eon)
eonStruct, decryptable, err := kpr.resolveDecryptableEon(ctx, coreKeyperDB, eon)
Copy link
Copy Markdown
Contributor

@konradkonrad konradkonrad Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

signature is

func (kpr *Keyper) resolveDecryptableEon(
    ctx context.Context,
	coreKeyperDB *corekeyperdatabase.Queries,
	keyperConfigIndex int64
) (corekeyperdatabase.Eon, bool, error) {…}

In other words: here we implicitly cast between keyperConfigIndex and eon.

Copy link
Copy Markdown
Contributor

@konradkonrad konradkonrad Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is honestly puzzling to me, because eon is a value contained in FiredTrigger of service db and should not be a "keyperConfigIndex" kind? Or should not need resolution into a corekeyperdatabase.Eon?

Could it be that the triple return is actually superfluous, because the call does not "resolve" the eon, but only verifies "decryptability", given the current keyper and active keyper set?

Copy link
Copy Markdown
Contributor

@konradkonrad konradkonrad Apr 16, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aha, we "resolve" eon properties such as ActivationBlockNumber that we need later on. So I guess we're resolving a type.

IOW: if we want to avoid the odd cast, we might want to consider changing the argument name to eonNumber, because the value we're handling is not strictly a keyperSetIndex keyperConfigIndex but rather the numeric for a specific eon, right?

Copy link
Copy Markdown
Contributor

@ylembachar ylembachar Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t think renaming the parameter to eonNumber would be correct here. This PR is changing the semantics of the even eon field. The incoming value is no longer being treated as a real core eon number; it is being treated as the submitted keyper-set/config index from the registry event, and resolveDecryptableEon() then resolves the latest eon record for that set. So the oddity is not the function signature, it’s that the service DB field is still named Eon even though this PR changes its semantics. If we want to reduce confusion, the cleaner follow-up is to rename the internal shutter-service representation at the ingestion boundary (e.g. keyperConfigIndex / submittedKeyperConfigIndex) and keep “eon” only for the resolved corekeyperdatabase.Eon. We should do the same on the API side as well: if the API is submitting a keyper-set/config index, we should name it that way there too, rather than continuing to call it eon and relying on implicit reinterpretation downstream.

Copy link
Copy Markdown
Contributor Author

@blockchainluffy blockchainluffy Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree for renaming the eon field to keyper set index in such places, but this is not the scope of PR as the eon field in database for many tables like decryption_key and decryption_key_shares etc still correspond to keypersetindex. I believe, renaming should be part of a larger PR which handles all these mismatches

Copy link
Copy Markdown
Contributor

@ylembachar ylembachar Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please open a follow-up issue for this refactor @blockchainluffy and resolve this comment? Thank you.

if err != nil {
if err == pgx.ErrNoRows {
log.Info().
Int64("eon", eon).
Msg("ignoring fired triggers as eon not found in db")
continue
}
return nil, errors.Wrapf(err, "failed to query eon %d from db", eon)
return nil, errors.Wrapf(err,
"failed to resolve decryptable eon for fired triggers with keyper set index %d",
eon,
)
}
keyperSet, err := obsDB.GetKeyperSet(ctx, eonStruct.ActivationBlockNumber)
if err != nil {
log.Err(err).
Int64("eon", eon).
Int64("activation-block-number", eonStruct.ActivationBlockNumber).
Msg("ignoring fired triggers as keyper set not found in db")
continue
}
if !keyperSet.Contains(kpr.config.GetAddress()) {
log.Info().
Int64("eon", eon).
Int64("activation-block-number", eonStruct.ActivationBlockNumber).
Str("address", kpr.config.GetAddress().Hex()).
Msg("ignoring fired triggers as not part of keyper set")
if !decryptable {
continue
}

Expand Down
Loading