ethereum-optimism/contracts

Improve clarity of chainID recovery logic

Open

#243 opened on Feb 23, 2021

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)Solidity (124 forks)github user discovery
Category: EnhancementGood First Issue

Repository metrics

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

Description

It's currently non-obvious where the chainID gets populated / decoded. We should make sure that that tx flow is as simple as possible / at minimum add better comments for how it works.

Contributor guide

Research direction
Inspect the chainID recovery logic in the contracts; trace how chainID is populated and consider adding comments to clarify the flow.
Tech stack
None
Domain
blockchain
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
SolidityGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80