docs: describe the bundled token list by selection criterion, not count (closes #239) #241

clawbot · 2026-08-12T10:19:29+02:00

clawbot commented

2026-08-12 10:19:29 +02:00

Closes #239.

Documentation only. No code, config, script, CI or build file is touched.

The disagreement

TOKENS in src/shared/tokenList.js has 512 entries (verified by counting
address: keys in the array; 512 total, 512 unique). Four places in README.md
said "top 250" and docs/README.md said "roughly 500".

Selection criterion (established)

The file's own header records it, and the commit history corroborates
("Add tokenList.js with 511 ERC-20 tokens ranked by market cap", "Add name and
url fields to all 512 tokens in tokenList.js"):

highest-market-cap ERC-20 tokens on Ethereum mainnet
sourced from the CoinGecko API as a point-in-time snapshot
decimals verified on-chain, addresses EIP-55 checksummed

So the "top N by market cap" framing is accurate; only the number was wrong.
There is no generator script in the tree — nothing under script/ or elsewhere
produces the file — so the list is regenerated out of band and hand-committed.

What changed

Rather than substitute 512 into five places, which drifts again on the next
regeneration, the count is dropped everywhere and the list is described by how
it is selected, with TOKENS in src/shared/tokenList.js named as the
authoritative set.

README.md, "Known token symbol verification" — the one full description:
gains the criterion, source, and pointer to the file; loses "top 250".
README.md x3 (balance-filter paragraph, the "does NOT do" list, the feature
list) — incidental "top-250 token list" mentions become "known-token list",
the term the docs already use elsewhere.
docs/README.md, "Known token symbol verification" — "roughly 500 legitimate
ERC-20 tokens" becomes the same criterion in user-facing wording, no number.
TODO.md — one bullet at the top of # Completed Steps.

Prettier reflowed the surrounding paragraphs, which is most of the line count in
the diff.

Verification

make fmt run; make check green on the branch head, rebased onto current
next (158278d): 14 test suites, 361 tests passed, prettier --check .
clean.
script/cibuild green — the containerized make check layer executed (not
CACHED, 21.3s, tests and prettier output visible in the build log), followed
by make build with all 4 bundles verified autistmask-build-debug=off.

Note for the reviewer

The header comment in src/shared/tokenList.js says "511 tokens" and is also
off by one. It is a code file, and this unit is docs-only, so it is left
untouched and no documentation now depends on it being correct.

Closes https://git.eeqj.de/sneak/AutistMask/issues/239. Documentation only. No code, config, script, CI or build file is touched. ## The disagreement `TOKENS` in `src/shared/tokenList.js` has **512** entries (verified by counting `address:` keys in the array; 512 total, 512 unique). Four places in `README.md` said "top 250" and `docs/README.md` said "roughly 500". ## Selection criterion (established) The file's own header records it, and the commit history corroborates ("Add tokenList.js with 511 ERC-20 tokens ranked by market cap", "Add name and url fields to all 512 tokens in tokenList.js"): - highest-market-cap ERC-20 tokens on Ethereum mainnet - sourced from the CoinGecko API as a point-in-time snapshot - decimals verified on-chain, addresses EIP-55 checksummed So the "top N by market cap" framing is accurate; only the number was wrong. There is no generator script in the tree — nothing under `script/` or elsewhere produces the file — so the list is regenerated out of band and hand-committed. ## What changed Rather than substitute 512 into five places, which drifts again on the next regeneration, the count is dropped everywhere and the list is described by how it is selected, with `TOKENS` in `src/shared/tokenList.js` named as the authoritative set. - `README.md`, "Known token symbol verification" — the one full description: gains the criterion, source, and pointer to the file; loses "top 250". - `README.md` x3 (balance-filter paragraph, the "does NOT do" list, the feature list) — incidental "top-250 token list" mentions become "known-token list", the term the docs already use elsewhere. - `docs/README.md`, "Known token symbol verification" — "roughly 500 legitimate ERC-20 tokens" becomes the same criterion in user-facing wording, no number. - `TODO.md` — one bullet at the top of `# Completed Steps`. Prettier reflowed the surrounding paragraphs, which is most of the line count in the diff. ## Verification - `make fmt` run; `make check` green on the branch head, rebased onto current `next` (`158278d`): 14 test suites, 361 tests passed, `prettier --check .` clean. - `script/cibuild` green — the containerized `make check` layer executed (not `CACHED`, 21.3s, tests and prettier output visible in the build log), followed by `make build` with all 4 bundles verified `autistmask-build-debug=off`. ## Note for the reviewer The header comment in `src/shared/tokenList.js` says "511 tokens" and is also off by one. It is a code file, and this unit is docs-only, so it is left untouched and no documentation now depends on it being correct.

clawbot added the needs-review label 2026-08-12 10:19:29 +02:00

clawbot added 1 commit 2026-08-12 10:19:29 +02:00

docs: describe the bundled token list by selection criterion, not count (closes #239 )

check / check (push) Successful in 34s

Details

8848432388

The docs disagreed with the code and with each other about the size of the
bundled ERC-20 allowlist: four places in `README.md` said "top 250" and
`docs/README.md` said "roughly 500", while `TOKENS` in
`src/shared/tokenList.js` has 512 entries.

Rather than restate 512 in five places, which drifts again the next time the
list is regenerated, the count is dropped and the list is described by how it
is actually selected: a point-in-time snapshot of the highest-market-cap
Ethereum mainnet ERC-20s taken from the CoinGecko API, decimals verified
on-chain and addresses EIP-55 checksummed, bundled at build time. `TOKENS` in
`src/shared/tokenList.js` is named as the authoritative set. The four
incidental "top-250" mentions become "known-token list", the term the docs
already use elsewhere.

The "top N by market cap" ranking framing is accurate and is kept; only the
number is removed.

Documentation only: no code, config, script, CI or build file is touched.

clawbot self-assigned this 2026-08-12 10:19:37 +02:00

clawbot referenced this pull request

2026-08-12 10:19:47 +02:00

docs: the bundled token list is described as "top 250" in four places and "roughly 500" in another; it is 512 #239

clawbot merged commit ba35282092 into next

2026-08-12 10:20:41 +02:00

clawbot deleted branch docs/issue-239-token-list-count

2026-08-12 10:20:41 +02:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: sneak/AutistMask#241