EPIC: Improvements needed on the event-based features

[ylembachar]

High

• The decryption key endpoint has not been updated, and does not return decryption keys for event-based identities. (High) (for now return all decryption keys for identity, later allow for identity per eon) ==> Implement GetDecryptionKey endpoint for event based decryption triggers #86

• The decrypt commitment should also be adjusted (High) ==> Implement GetDecryptionKey endpoint for event based decryption triggers #86

• /get_event_decryption_key throws a 500 error due to a nil-pointer exception (High) ==> /get_event_decryption_key throws a 500 error due to a nil-pointer exception #88

• Indexed arg filters ignore ABI position; non‑first indexed args map to wrong topic offsets (High) Indexed arg filters ignore ABI position; non‑first indexed args map to wrong topic offsets #90

• Swagger docs not generated correctly - see compile event trigger endpoint (High)

• Decouple redirects from rate limiting: Decouple redirects from rate limiting in docker compose files #98 (High)

• Fix/order triggers by identity: Fix/order triggers by identity rolling-shutter#667

• Manual padding needed for non‑indexed, non‑uint256 args: left‑pad bytes to 32 bytes (High) -> Padding does not work anymore, probably due to the issue with byte length

• Replicate this fix for non indexed params (Indexed arg filters ignore ABI position; non‑first indexed args map to wrong topic offsets #90)

• Check whether dynamic types (string, bytes, arrays) are supported for non‑indexed arguments: https://github.com/shutter-network/shutter-api/blob/main/internal/usecase/eventtrigger.go#L221 (Dynamic types are considered like static types here starting at a certain offset with a fixed length when their encoding is different, the head contains an offset to where the length and actual content is) (Medium) - if not supported, document for now

• Add bytes issue here

Medium

• Handle version differences gracefully: Handle version differences in shutter-api event trigger definitions rolling-shutter#687

• Check if this is still relevant: Event Trigger: The decrypted flag on event_trigger_registered_event does not always gets updated to true after keys are released rolling-shutter#669

• Add unit tests that cover the new endpoints

• Update the contract / potentially rolling shutter to check for duplicates:

• allow same identity registration as long as the expiration block is higher than the previous one (only API since only API using contract)

• if a user submits a registration with different event triggers, the second would take precedence over the previous registration -> Change primary key to eon, identity here: https://github.com/shutter-network/rolling-shutter/blob/main/rolling-shutter/keyperimpl/shutterservice/database/sql/migrations/V2_event_based_triggers.sql#L13C18-L13C46 as well as the update on conflict query, also in fired triggers ==> Change primary key for event_identity_registration #102

• About the ttl / expiration block, we would be returning 0 while we wait for the tx to be mined, could be updated to pending perhaps but 0 could also mean the same as pending
  See comment here: Add endpoints for event based decryption triggers #79 (comment) (Low)

• Add a documentation note to let the user know that they need to check for the transaction hash success to ensure the registration has succeeded / check endpoint behavior when transaction does not succeed (Medium)

• Design improvement: Revisit GetDataForEncryption endpoint #83

• Add a prefix for both time-based and event-based endpoints that would redirect to the same backend endpoint if needed (e.g. /time/register_identity versus /event/register_identity) - check if there is a version in the path (Medium) Add a prefix for both time-based and event-based endpoints #92

• Fix tests TestShutterServiceSuite/TestDecryptionCommitment, TestShutterServiceSuite/TestDecryptionCommitmentNotFound, TestShutterServiceSuite/TestGetDataForEncryptionInvalidSender (Medium) Fix tests and add new tests for event based #96

• Check the integration test suite still works / adapt it for the new features (Medium) -> Add live event smoke test suite for event-triggered key generation #108

• Developer documentation should include a usage example of shutter-sdk for roundtrip encrytpion decryption (head-less), to guide on how to do automated testing

Low

• TTL extension is current not possible. Users can only register an identity once with one TTL, but we would like to allow for TTL extension.

• The API can still be deployed even if the event registry contract isn’t deployed; event endpoints will just fail at runtime with a 500 error. Nice‑to‑have: add a feature flag to enable/disable event triggers while still serving endpoints. If the contract isn’t deployed, return a 503 Service Unavailable error. Not required for the upcoming deployment. (Low)

• Add intended use for /get_data_for_encryption (Low)

• Update Swagger docs description to include event-based triggers as well (Low) Update Swagger docs description to include event-based triggers as well #97

[ylembachar]

Testing on Chiado

• use any ERC20 and make sure it works (OK)
• deploy contract with different triggers and make sure they work (todo)
• behavior of ttl
• extending the ttl

Some test results here: https://github.com/shutter-network/shutter-technical-pm/issues/98

[konradkonrad]

Swagger docs not generated correctly - see compile event trigger endpoint (High)

I imported the current docs.json in https://editor.swagger.io/ and it looks okay from here. What issue did you see @ylembachar ?

[ylembachar]

Swagger docs not generated correctly - see compile event trigger endpoint (High)

I imported the current docs.json in https://editor.swagger.io/ and it looks okay from here. What issue did you see @ylembachar ?

@konradkonrad The swagger docs are not properly displaying on the deployed API instance on Chiado, even though they do have the latest endpoints. I think there is some issue with the formatting. We might need to prefix every line with @description or put the whole block in one @description and use \n for newlines. See screenshot below: