ethereum-optimism/supersim

supersim admin API (read)

Open

#204 opened on Oct 17, 2024

View on GitHubContributor guide
 (0 comments) (1 reaction) (0 assignees)Go (116 forks)github user discovery
P0enhancementhelp wantedunprioritized

Repository metrics

Stars
 (264 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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

Contributor guide

Research direction
Review existing codebase for JSON RPC patterns, implement read only admin endpoints as listed.
Tech stack
go
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoJSON RPC
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60