ethereum-optimism/supersim

supersim admin API (read)

Aperta

#204 aperta il 17 ott 2024

Vedi su GitHubGuida contributor
 (0 commenti) (1 reazione) (0 assegnatari)Go (116 fork)github user discovery
P0enhancementhelp wantedunprioritized

Metriche repository

Star
 (264 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina il codebase esistente per i pattern JSON RPC e implementa gli endpoint di amministrazione di sola lettura come elencati.
Tech stack
go
Dominio
backendapi
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GoJSON RPC
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60