Referencing an EIP Spec Version

An Ethereum Improvement Proposal (from ethereum/EIPs) and its SHA digest can be directly referenced within a python test module in order to check whether the test implementation could be out-dated. If the SHA of the file in the remote repo changes, the test framework will issue a warning in its summary section.

Test cases located underneath ./tests/eips/ must define a reference spec version.

The SHA value is the output from git's hash-object command, for example:

git clone git@github.com:ethereum/EIPs
git hash-object EIPS/EIPS/eip-3651.md
# output: d94c694c6f12291bb6626669c3e8587eef3adff1

and can be retrieved from the remote repo via the Github API on the command-line as following:

sudo apt install jq
curl -s -H "Accept: application/vnd.github.v3+json" \
https://api.github.com/repos/ethereum/EIPs/contents/EIPS/eip-3651.md |\
jq -r '.sha'
# output: d94c694c6f12291bb6626669c3e8587eef3adff1

How to Add a Spec Version Check

This check accomplished by adding the following two global variables anywhere in the Python source file:

Variable Name	Explanation
REFERENCE_SPEC_GIT_PATH	The relative path of the EIP markdown file in the ethereum/EIPs repository, e.g. "EIPS/eip-1234.md"
REFERENCE_SPEC_VERSION	The SHA hash of the latest version of the file retrieved from the Github API: https://api.github.com/repos/ethereum/EIPs/contents/EIPS/eip-<EIP Number>.md

Example

Here is an example from ./tests/shanghai/eip3651_warm_coinbase/test_warm_coinbase.py:

REFERENCE_SPEC_GIT_PATH = "EIPS/eip-3651.md"
REFERENCE_SPEC_VERSION = "d94c694c6f12291bb6626669c3e8587eef3adff1"

The SHA digest was retrieved from here.