ethereum-optimism / ethereum-optimism/specs

Interop Naming

Open
#477 0 comments 0 reactions 0 assignees View on GitHub
H-interop
Dominant language
Python
Stars
178
Forks
206
Avg merge
5d 2h
Merged PRs (30d)
6

Description

Opening this issue for discussion

There is often confusion around the term "message" as it is in practice it is a log. The original name was chosen to be generic over the data structure. We should consider renaming things so that its more clear exactly what data structures are used.

For example we could rename the `validateMessage` function to `validateLog` and rename `executeMessage` to `executeLog`.

We could also rename the more generic terms "initiating message" and "executing message".

This is a heavily breaking change and should be done sooner rather than later

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by locating validateMessage and executeMessage, then review the surrounding terminology for "initiating message" and "executing message." Done would require an agreed breaking rename and corresponding updates wherever these terms are used.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.