docs: fix stale receiver references in README and CLAUDE.md - #20
Merged
Conversation
The receivers-to-customers command rename shipped a while ago (customers list/get/create/update/delete/limits/rfi_get/rfi_submit, --customer-id flags, /customers paths) but README.md and CLAUDE.md still documented the old receivers commands and flags. CLAUDE.md is fed directly to the automated api-sync Claude workflow as its pattern reference, so the stale receiver_* worked example risked teaching the sync job the wrong naming convention. No source changes: the CLI has been customers-only in code and tests for a while. The remaining receiver_* wire fields (transfer_quotes create, tos initiate) and receiver_amount/sender_amount stay untouched since the deployed API does not accept their customer_* equivalents yet. Version bump to 0.5.0 since this closes out the customers migration documentation gap. Claude-Session: https://claude.ai/code/session_01F1stiNzuNtJXoXtiW9ZCbs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This CLI's command surface was already fully migrated from
receiverstocustomersin code and tests (customers list/get/create/update/delete/limits/limits_increase_requests/create_limit_increase/rfi_get/rfi_submit,--customer-idflags,/customerspaths). README.md and this repo's CLAUDE.md had not been updated to match and still documented the oldreceiverscommands,--receiver-idflags, and/receiverspaths.This matters beyond cosmetics because CLAUDE.md is fed directly to the automated
.github/workflows/api-sync.ymlClaude-driven sync job as its pattern reference. The stalesubmitReceiverRfi/receivers/${receiverId}/rfiworked example risked teaching that job the wrong naming convention on its next run.What changed
README.md: renamed the "Receivers" section to "Customers" with the accurate command list (includinglimits,limits_increase_requests,create_limit_increase,rfi_get,rfi_submit, none of which were documented before at all), and fixed--receiver-id->--customer-idin the Bank Accounts, Blockchain Wallets, Virtual Accounts and Offramp Wallets sections.CLAUDE.md: fixed the naming-convention example, the path-params guidance, the API-path-to-command naming table, the worked "dynamic request body" example (submitCustomerRfi/customerId//customers/${customerId}/rfi), and the test-placement example, all of which referencedreceivers/receiverIdinstead of the shippedcustomers/customerId.package.json: version bump0.4.0->0.5.0(minor, since this is an additive/non-breaking docs fix).Why this is safe today
Every change in this PR is documentation only, no source or test files changed. It does not touch any of the still-in-progress wave-2 renames:
transfer_quotes create(--receiver-wallet-address/--receiver-token/--receiver-network) andtos initiate(--receiver-id) still sendreceiver_wallet_address/receiver_token/receiver_network/receiver_idon the wire, deliberately unchanged, because the currently deployed API has nocustomer_*equivalent for those fields yet (only PR #1799 in blindpay-v2, not yet deployed, adds them).receiver_amount/sender_amounton quotes and transfers are untouched, confirmed present atsrc/commands/resources.ts:500,528,531,1032andsrc/__tests__/resources.test.ts:461. That field is intentionally never renamed (it means "amount the receiving side gets," not a reference to the customer resource).This CLI has no webhook event enum/constant anywhere in source (
createWebhookEndpointonly ever posts{url, description}, no--eventsflag exists), so there was nothing to addcustomer.new/customer.update/customer.deleteto and nothingreceiver.*to deprecate. Likewise there is no legacyreceiversresource, noRECEIVERS_*error codes, and no receiver_id/customer_id translation shim in this repo to remove. Confirmed by full-repo grep before making any change.Build output
Test plan
bun install --frozen-lockfile && bun run typecheck && bun run lint && bun test && bun run buildall passreceiver_amount/sender_amountexempt occurrence is untouchedreceiver_*wire fields intransfer_quotes createandtos initiateare untouchedhttps://claude.ai/code/session_01F1stiNzuNtJXoXtiW9ZCbs