Skip to content
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.

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

feat: new bridge history apis #1024

Merged
merged 63 commits into from
Dec 28, 2023
Merged

Conversation

colinlyguo
Copy link
Member

@colinlyguo colinlyguo commented Dec 3, 2023

Purpose or design rationale of this PR

  1. Supported Features:
    1. Get transactions:
      1. By address:
        1. pagination: page, pagesize.
        2. types: all txs, L2 withdrawals, unclaimed L2 withdrawals.
      2. By transaction hash.
    2. Deposit/Withdraw transaction status (terminal statuses: relayed, failed relayed, dropped):
      1. Sent (emit SentMessage event).
      2. Sent tx reverted: https://etherscan.io/tx/0xc6175136e31e01970efe5255087b6d370bec70c2b3ba21d6201ee78422e5c25f
      3. Relayed (emit RelayedMessage event).
      4. Failed Relayed (emit FailedRelayedMessage event): https://sepolia.scrollscan.com/tx/0x7323a7ba29492cb47d92206411be99b27896f2823cee0633a596b646b73f1b5b
      5. Relayed transaction reverted (only for L2 withdrawals): https://sepolia.scrollscan.com/tx/0x7323a7ba29492cb47d92206411be99b27896f2823cee0633a596b646b73f1b5b
      6. Skipped: replayMessage or dropMessage.
      7. Dropped: done, user has got the refund.
  2. APIs:
    1. Get:
      1. /txs?address=0x0&page_size=10&page=1
      2. /l2/withdrawals?address=0x0&page_size=10&page=1
      3. /l2/unclaimed/withdrawals?address=0x0&page_size=10&page=1
    2. Post:
      1. /txsbyhashes

A more detailed doc: https://www.notion.so/scrollzkp/Bridge-History-APIs-ac136e1ac51e4292a66a1153a79d79bb

PR title

Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:

  • feat: A new feature

Deployment tag versioning

Has tag in common/version.go been updated or have you added bump-version label to this PR?

  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • Yes

@colinlyguo colinlyguo added enhancement New feature or request breaking-change bump-version Bump the version tag for deployment labels Dec 3, 2023
@colinlyguo colinlyguo self-assigned this Dec 3, 2023
@colinlyguo colinlyguo force-pushed the fix-bridge-history-api-write-db branch from a8e3537 to 13208fa Compare December 3, 2023 18:22
@colinlyguo colinlyguo added enhancement New feature or request and removed enhancement New feature or request labels Dec 3, 2023
@colinlyguo colinlyguo force-pushed the fix-bridge-history-api-write-db branch 7 times, most recently from e2b5c13 to 87fa3d6 Compare December 4, 2023 07:59
@colinlyguo colinlyguo removed the bump-version Bump the version tag for deployment label Dec 4, 2023
@colinlyguo colinlyguo force-pushed the fix-bridge-history-api-write-db branch 2 times, most recently from f09f43c to a45ddd1 Compare December 4, 2023 12:08
@colinlyguo colinlyguo force-pushed the fix-bridge-history-api-write-db branch from f18eb31 to f011fd5 Compare December 6, 2023 04:32
georgehao
georgehao previously approved these changes Dec 16, 2023
@colinlyguo colinlyguo force-pushed the fix-bridge-history-api-write-db branch from 88cd3cc to fae11cc Compare December 17, 2023 10:21
@georgehao georgehao merged commit 8910699 into develop Dec 28, 2023
28 checks passed
@georgehao georgehao deleted the fix-bridge-history-api-write-db branch December 28, 2023 03:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change bump-version Bump the version tag for deployment enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants