ethereum-optimism/supersim

supersim admin API (read)

Ouverte

#204 ouverte le 17 oct. 2024

Voir sur GitHubGuide contributeur
 (0 commentaire) (1 réaction) (0 personne assignée)Go (116 forks)github user discovery
P0enhancementhelp wantedunprioritized

Métriques du dépôt

Stars
 (264 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Passez en revue la base de code existante pour les modèles JSON RPC et implémentez les points de terminaison d'administration en lecture seule répertoriés.
Stack technique
go
Domaine
backendapi
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GoJSON RPC
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60