Skip to content

Fix terminology: standardize "Arkade" vs "Ark" naming#93

Merged
louisinger merged 1 commit into
masterfrom
claude/zealous-ptolemy-wbCgq
Jun 2, 2026
Merged

Fix terminology: standardize "Arkade" vs "Ark" naming#93
louisinger merged 1 commit into
masterfrom
claude/zealous-ptolemy-wbCgq

Conversation

@tiero

@tiero tiero commented Jun 1, 2026

Copy link
Copy Markdown
Member

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

  • Line 9: Changed "Ark transaction" to "Arkade transaction" for consistency with protocol naming
  • Line 35: Changed "Ark transaction" to "Arkade transaction" in SubmitTx description
  • Line 35: Changed "checkpoints" to "Arkade transaction" to clarify the context
  • Line 37: Changed "Ark PSBT" to "Arkade PSBT" to match protocol naming conventions
  • Line 176: Changed "Ark transaction's extension" to "Arkade transaction's extension" for consistency
  • Line 282: Changed "ark extension" to "ARK extension" and "ark transaction" to "Arkade transaction" to properly distinguish between the ARK extension format and Arkade transaction type

Notable Details

These changes improve documentation clarity by:

  • Consistently referring to the protocol as "Arkade" rather than mixing "Ark" and "Arkade"
  • Properly capitalizing "ARK" when referring to the extension format (TLV stream with magic bytes)
  • Ensuring technical accuracy in describing transaction types and their components

https://claude.ai/code/session_01HNmgAUg7QytNm758JxJRSN

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.
@tiero tiero marked this pull request as ready for review June 1, 2026 17:46

@arkanaai arkanaai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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" throughout
  • pkg/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:

  1. 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.
  2. 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.

@tiero tiero requested a review from louisinger June 1, 2026 17:46

@arkanaai arkanaai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 0x41524b magic bytes)
  • "Ark PSBT" → "Arkade PSBT"

Verified:

  1. No code changes — diff touches only README.md, zero risk to runtime behavior.
  2. Terminology is consistent — after this PR, "Arkade" = protocol/transaction type, "ARK" = the extension wire format. This matches the codebase conventions (ArkadeTapSighash tag, ArkScriptHash tag, ARK magic bytes).
  3. API field names left alonearkTx, signedArkTx JSON fields are correctly untouched (those are code identifiers, not prose).
  4. Tagged hash strings left alone"ArkScriptHash", "ArkWitnessHash", "ArkadeTapSighash" are consensus-level constants, correctly not modified.
  5. No cross-repo impact — documentation-only change, no API/proto/type changes.

Clean PR. Ship it.

@louisinger louisinger merged commit b23939e into master Jun 2, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants