Skip to content

docs(traffic-shaping): Correct monthly transfer estimates#282

Merged
frbrkoala merged 1 commit into
mainfrom
docs/fix-traffic-shaping-limits
Jul 10, 2026
Merged

docs(traffic-shaping): Correct monthly transfer estimates#282
frbrkoala merged 1 commit into
mainfrom
docs/fix-traffic-shaping-limits

Conversation

@frbrkoala

@frbrkoala frbrkoala commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

The "Examples of traffic limits" section mapped each bandwidth cap to a monthly volume using TiB/month = Mbit/s / 100, which has no physical basis (the values were low by roughly 30x).

Recalculate using sustained-transfer math (~0.3 TiB/month per Mbit/s over an average 730-hour month) and add the formula inline so the numbers are reproducible. Values are framed as "up to" to reflect that they are ceilings assuming the cap is saturated continuously.

What does this PR do?

🛑 Please open an issue first to discuss any significant work and flesh out details/direction — we would hate for your time to be wasted.
Consult the CONTRIBUTING guide for submitting pull-requests.

Motivation

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • New blueprint (adding a new protocol — see checklist below)
  • Documentation update
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Testing

  • I have run npm run build successfully
  • I have run npm run test and all tests pass
  • I have run npx cdk synth with a sample .env (e.g. from blueprints/dummy/samples/) and it succeeds
  • I have run pre-commit hooks: npm run run-pre-commit

New Blueprint Checklist (if adding a protocol)

  • Blueprint follows the structure of blueprints/dummy/ (reference implementation)
  • Blueprint README follows the standard template (matches Dummy section titles and ordering)
  • Setup section points to Getting Started (not inline instructions)
  • Deployment section leads with AI-driven deployment (Option 1) and manual as Option 2
  • Sample .env files are provided for at least one network (mainnet or testnet)
  • Configuration scripts follow the install/run dispatch pattern (see blueprints/dummy/)
  • Blueprint page added to website/docs/blueprints/ (.mdx mirror importing README)
  • Client Release Channels table added to README under Additional Resources

Documentation

  • I have updated relevant documentation (if applicable)
  • I have run cd website && npm run build with no broken links (if docs changed)

License

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

The "Examples of traffic limits" section mapped each bandwidth cap to a monthly volume using TiB/month = Mbit/s / 100, which has no physical basis (the values were low by roughly 30x).

Recalculate using sustained-transfer math (~0.3 TiB/month per Mbit/s over an average 730-hour month) and add the formula inline so the numbers are reproducible. Values are framed as "up to" to reflect that they are ceilings assuming the cap is saturated continuously.
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@frbrkoala frbrkoala merged commit d00910a into main Jul 10, 2026
7 checks passed
@frbrkoala frbrkoala deleted the docs/fix-traffic-shaping-limits branch July 10, 2026 00:39
@github-actions

Copy link
Copy Markdown

Scan for commit: d6d2075 | Updated: 2026-07-10 00:42:12 UTC

🔒 Security Scan Results

Scanned files: 1

No security issues found.

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