Fix terminology: standardize "Arkade" vs "Ark" naming#93
Conversation
Disambiguate prose that said 'Ark transaction' / 'Ark PSBT' so it clearly refers to Arkade. Load-bearing names are left unchanged: the ARK magic-byte extension wire format (0x41524b), the arkd daemon, the ArkScriptHash tagged hash, and code/JSON identifiers.
There was a problem hiding this comment.
Review: terminology standardization
This PR changes README documentation only (no code), so no protocol risk. However, the rename itself introduces a new inconsistency rather than fixing one.
Finding: PR creates terminology drift between README and codebase
The PR replaces "Ark transaction" → "Arkade transaction" in the README, but the entire codebase (and arkd) consistently uses "Ark transaction" / "ark transaction":
emulator codebase (unchanged by this PR):
internal/application/tx.go:21—"arkade scripts on offchain ark transactions"pkg/arkade/script.go:74,76,77,80—"ark transactions"throughoutpkg/arkade/opcode.go:2956—"previous ark transaction"pkg/arkade/engine_test.go:2058,2069—"ark transaction"test/cross_input_script_validation_test.go:619—"ark transaction"api-spec/protobuf/emulator/v1/service.proto:16-18—"Ark transaction"/"ark transaction"- Proto field name is literally
ark_tx(service.proto:69)
arkd codebase:
service.proto:120—"signed Ark transaction"offchain-tx/build.go:93,239,348—"offchain ark transaction"offchain-tx/opts.go:19—"ark transaction"- 17 total occurrences of "ark transaction" across 9 files
After this PR, the README says "Arkade transaction" while every code comment, proto comment, and the proto field name itself say "Ark transaction" or ark_tx. That's worse than before.
Recommendation
Pick one of:
- Keep "Ark transaction" everywhere (matches current codebase reality, proto field names, and arkd). The README fix for "ARK extension" capitalization on line 282 is correct and worth keeping — but the "Ark → Arkade" transaction renames should be reverted.
- Rename across the entire codebase in both emulator and arkd if "Arkade transaction" is the desired canonical term. That's a much bigger PR and should be coordinated.
The line 282 change ("ark extension" → "ARK extension") is a legitimate fix — "ARK" is the magic byte prefix and should be caps. I'd keep that one.
There was a problem hiding this comment.
Review: APPROVE ✅
Scope: README.md only — 5 lines changed (terminology fixes in prose).
What it does: Standardizes naming convention:
- "Ark transaction" → "Arkade transaction" (the protocol/tx type)
- "ark extension" → "ARK extension" (the TLV format with
0x41524bmagic bytes) - "Ark PSBT" → "Arkade PSBT"
Verified:
- No code changes — diff touches only
README.md, zero risk to runtime behavior. - Terminology is consistent — after this PR, "Arkade" = protocol/transaction type, "ARK" = the extension wire format. This matches the codebase conventions (
ArkadeTapSighashtag,ArkScriptHashtag,ARKmagic bytes). - API field names left alone —
arkTx,signedArkTxJSON fields are correctly untouched (those are code identifiers, not prose). - Tagged hash strings left alone —
"ArkScriptHash","ArkWitnessHash","ArkadeTapSighash"are consensus-level constants, correctly not modified. - No cross-repo impact — documentation-only change, no API/proto/type changes.
Clean PR. Ship it.
Summary
This PR corrects inconsistent terminology throughout the README documentation, standardizing the use of "Arkade" for the protocol/transaction type and "ARK" for the extension format, while fixing several capitalization and naming inconsistencies.
Changes Made
Notable Details
These changes improve documentation clarity by:
https://claude.ai/code/session_01HNmgAUg7QytNm758JxJRSN