feat(relayer): ListOperations api endpoint

[daniel-savu]

Description

Adds a list_operations API endpoint to the relayer, which returns all operations in its prepare queue.

Example output from GET http://0.0.0.0:9092/list_operations?destination_domain=13371

[
  {
    "app_context": null,
    "message": {
      "body": [
        18,
        52
      ],
      "destination": 13371,
      "nonce": 1,
      "origin": 13373,
      "recipient": "0x000000000000000000000000927b167526babb9be047421db732c663a0b77b11",
      "sender": "0x000000000000000000000000927b167526babb9be047421db732c663a0b77b11",
      "version": 3
    },
    "num_retries": 13,
    "status": {
      "Retry": "CouldNotFetchMetadata"
    },
    "submitted": false,
    "type": "PendingMessage"
  },
  {
    "app_context": null,
    "message": {
      "body": [
        18,
        52
      ],
      "destination": 13371,
      "nonce": 2,
      "origin": 13372,
      "recipient": "0x000000000000000000000000927b167526babb9be047421db732c663a0b77b11",
      "sender": "0x000000000000000000000000927b167526babb9be047421db732c663a0b77b11",
      "version": 3
    },
    "num_retries": 13,
    "status": {
      "Retry": "CouldNotFetchMetadata"
    },
    "submitted": false,
    "type": "PendingMessage"
  }
]

Drive-by changes

Makes PendingOperation serializable, which means switching from JSON format to e.g. CSV (for easily filtering / aggregating in excel) should be very easy.

Related issues

Backward compatibility

Yes

Testing

Manual and Unit Tests

[changeset-bot]

⚠️ No Changeset found

Latest commit: f62d687

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (befc38d) to head (f62d687).
Report is 18 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (befc38d) and HEAD (f62d687). Click for more details.

HEAD has 1 upload less than BASE

Flag	BASE (befc38d)	HEAD (f62d687)
	2	1

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #4089       +/-   ##
==========================================
- Coverage   60.56%   0.00%   -60.57%     
==========================================
  Files         129       1      -128     
  Lines        1656      14     -1642     
  Branches      176       0      -176     
==========================================
- Hits         1003       0     -1003     
+ Misses        626      14      -612     
+ Partials       27       0       -27     

Components	Coverage Δ
core	∅ <ø> (∅)
hooks	∅ <ø> (∅)
isms	∅ <ø> (∅)
token	∅ <ø> (∅)
middlewares	∅ <ø> (∅)

[daniel-savu]

Slightly annoying how the operation status is serialized:

    "status": {
      "Retry": "CouldNotFetchMetadata"
    },

whereas I would've wanted the value to have no nesting: status: "Retry(CouldNotFetchMetadata)", because in csv you get a new column for each nested field within status, e.g. status/Retry and status/FirstPrepareAttempt. Not that big of a deal though

[tkporter]

@daniel-savu are there any alternative enum representations https://serde.rs/enum-representations.html that would help? maybe the internal one where we can have "type": "Retry" instead?

[tkporter]

nice 🔥

might be nice in the future to include gas payments but for now I think this is sufficient

[daniel-savu]

@daniel-savu are there any alternative enum representations https://serde.rs/enum-representations.html that would help? maybe the internal one where we can have "type": "Retry" instead?

turns out there is a way, since individual enum member can be untagged (serde-rs/serde#2403), and for Retry(ReprepareReason) it wouldn't matter if retry isn't part of the serialization. But this actually breaks DB storage so we may want to think about this twice - probably still ok to do now, while we don't have that many GBs of messages