Skip to content

docs: document address outflow limit functions - #456

Merged
shakurJJ merged 2 commits into
shakurJJ:mainfrom
Tybravo:docs/document-address-outflow-limits
Aug 27, 2026
Merged

docs: document address outflow limit functions#456
shakurJJ merged 2 commits into
shakurJJ:mainfrom
Tybravo:docs/document-address-outflow-limits

Conversation

@Tybravo

@Tybravo Tybravo commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Documented the per-address outflow rate limiting functions in the README.

Changes Made

  • Documented set_address_outflow_limit().
  • Documented get_address_outflow_limit().
  • Explained how the per-address outflow limit differs from set_circuit_breaker().
  • Documented the time window over which the outflow limit applies.

Testing

  • Reviewed the documentation against the contract implementation to ensure the behavior and rate-limit window are accurately described...in prog

Closes #354

@shakurJJ
shakurJJ merged commit 3e97c01 into shakurJJ:main Aug 27, 2026
0 of 2 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.

docs: document set_address_outflow_limit()/get_address_outflow_limit() in README

2 participants