Skip to content

docs: add CURRENCY_WHITELIST.md contributor guide#1666

Open
tebney wants to merge 1 commit into
QuickLendX:mainfrom
tebney:docs/currency-whitelist
Open

docs: add CURRENCY_WHITELIST.md contributor guide#1666
tebney wants to merge 1 commit into
QuickLendX:mainfrom
tebney:docs/currency-whitelist

Conversation

@tebney

@tebney tebney commented Jun 26, 2026

Copy link
Copy Markdown

Summary

Adds docs/CURRENCY_WHITELIST.md — a contributor-focused guide explaining how tokens are added to and removed from the currency whitelist.

Closes #1549

What's included

  • Explains the empty-list / allow-all mode and when it becomes restrictive
  • Documents all 10 contract entrypoints with auth requirements and return types
  • Covers the two enforcement points (store_invoice/upload_invoice and place_bid)
  • Describes the two-layer auth model (storage check + require_auth)
  • Provides a concrete test helper pattern using soroban_sdk primitives (no std::)
  • Step-by-step production add/remove workflow
  • Cross-links to docs/contracts/currency-whitelist.md, source, and tests

Acceptance criteria checklist

  • Matches the summary (how tokens are added/removed from the whitelist)
  • Linked from README.md Documentation section
  • No compiled examples (doc-only change; no code added to contract crate)
  • CI will skip Soroban contract build for this docs-only PR (paths-filter in ci.yml)
  • References Closes #1549

Testing

Docs-only change — no contract source modified. The CI paths-filter skips the Soroban build/test steps for PRs that don't touch quicklendx-contracts/.

- Documents entrypoints, auth model, enforcement points, and test
  patterns for the currency whitelist (src/currency.rs)
- Links from README.md

Closes QuickLendX#1549
@drips-wave

drips-wave Bot commented Jun 26, 2026

Copy link
Copy Markdown

@tebney Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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.

Add docs/CURRENCY_WHITELIST.md

1 participant