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

supersim admin API (read) #204

Open
jakim929 opened this issue Oct 17, 2024 · 0 comments
Open

supersim admin API (read) #204

jakim929 opened this issue Oct 17, 2024 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed unprioritized

Comments

@jakim929
Copy link
Contributor

jakim929 commented Oct 17, 2024

Useful read-only APIs for devs using supersim programmatically

write APIs out of scope

general

  • JSON RPC so it's easily usable with cast rpc

some example endpoints

  • ready(): used for checking whether the service is ready to use
  • getConfig(): returns config of the chains (RPC URLs, addresses, etc.
  • getL1Addresses(chainId): returns contract addresses for given chainId
  • getL2Addresses(chainId): same as above but for L2 contracts
  • getL2ToL2MessageByMsgHash(msgHash)
  • getL2ToL2MessageByTxHash(msgHash)
  • getL1ToL2MessageByTxHash(l1DepositTxHash)
  • listL1ToL2Messages(optional chainId)
  • listL2ToL2Messages(optional chainId)
  • getAutoRelayedMessages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed unprioritized
Projects
None yet
Development

No branches or pull requests

2 participants