Skip to content

Fix README and .env.example accuracy#6

Open
gyorgybalazsi wants to merge 1 commit intomainfrom
fix/readme-and-env-example-accuracy
Open

Fix README and .env.example accuracy#6
gyorgybalazsi wants to merge 1 commit intomainfrom
fix/readme-and-env-example-accuracy

Conversation

@gyorgybalazsi
Copy link

Summary

  • Fix 3 incorrect API function names in README's ledger API reference section (getget_by_party, streamsubscribe, submitwait_for_transaction_tree)
  • Add missing ledgrpc crate to crates table and installation snippet; add cryptography to installation snippet
  • Fix typo DeafultDefault in breaking changes section
  • Remove 8 phantom env vars from .env.example that aren't used anywhere in the codebase (ATTESTOR_URL, CANTON_NETWORK, DESTINATION_BTC_ADDRESS, TRANSFER_AMOUNT, RECIPIENTS_CSV, RECEIVER_PARTY, TRANSFER_COUNT, LIB_TEST_TRANSFER_OFFER_CID)
  • Add 6 missing env vars used by delete_executed_transfers example (KEYCLOAK_CLIENT_SECRET, CHOICE_CONTRACT_TEMPLATE_ID, CHOICE_CONTRACT_ID, DISCLOSED_CONTRACT_TEMPLATE_ID, DISCLOSED_CONTRACT_BLOB, plus optional ones)

Test plan

  • Verify README API reference function names match actual code signatures
  • Verify all env vars in .env.example are referenced in code
  • Verify no env vars used in code are missing from .env.example

🤖 Generated with Claude Code

README:
- Fix incorrect API function names in ledger API reference
  (get -> get_by_party, stream -> subscribe, submit -> wait_for_transaction_tree)
- Add missing ledgrpc crate to crates table
- Add cryptography and canton-proto-rs to installation snippet
- Fix "Deafult" typo in breaking changes section

.env.example:
- Remove 8 phantom variables not used in any code
  (ATTESTOR_URL, CANTON_NETWORK, DESTINATION_BTC_ADDRESS, TRANSFER_AMOUNT,
   RECIPIENTS_CSV, RECEIVER_PARTY, TRANSFER_COUNT, LIB_TEST_TRANSFER_OFFER_CID)
- Add 6 missing variables used by delete_executed_transfers example
  (KEYCLOAK_CLIENT_SECRET, CHOICE_CONTRACT_TEMPLATE_ID, CHOICE_CONTRACT_ID,
   DISCLOSED_CONTRACT_TEMPLATE_ID, DISCLOSED_CONTRACT_BLOB, plus optional ones)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

2 participants