Skip to content

docs: update outbound throttling to reference Mimir parameters#113

Open
familiarcow wants to merge 2 commits intothorchain:masterfrom
familiarcow:docs/fix-security-delay-max-20260202
Open

docs: update outbound throttling to reference Mimir parameters#113
familiarcow wants to merge 2 commits intothorchain:masterfrom
familiarcow:docs/fix-security-delay-max-20260202

Conversation

@familiarcow
Copy link

Summary

Updates the outbound transaction throttling documentation to reference Mimir parameter names instead of hardcoded values that have changed.

Issues Fixed

  1. Per-block limit: Doc said "currently 1000 RUNE worth" but MinTxOutVolumeThreshold is now 20,000 RUNE
  2. Delay description: Doc said "720 blocks (approx one hour)" which was incorrect. The delay mechanism uses:
    • MaxTxOutOffset: Caps initial calculated delay (currently 200 blocks, ~20 mins)
    • TxOutDelayMax: Search limit for finding available slots if blocks are full

Source of Truth

Changes

  • Replaced hardcoded "1000 RUNE worth" with reference to MinTxOutVolumeThreshold
  • Replaced incorrect "720 blocks" with accurate description of MaxTxOutOffset and TxOutDelayMax interaction

Test Plan

  • Verified against thornode source code
  • Verified against live Mimir values
  • Markdown renders correctly

The security documentation stated the max outbound delay is 720 blocks
(~1 hour) but the TxOutDelayMax constant is 17,280 blocks (~1 day).

Verified against thornode commit: 83dc71a3d
Source: thornode/constants/constants_v1.go:L78
The security documentation had hardcoded values that are now outdated:
- "1000 RUNE worth" per block → now controlled by MinTxOutVolumeThreshold
- "720 blocks (approx one hour)" → incorrect; delay controlled by MaxTxOutOffset
  and TxOutDelayMax

Updated to reference the Mimir parameter names since these values are
configurable and have changed from the original documentation.

Current live Mimir values (as of verification):
- MinTxOutVolumeThreshold: 20,000 RUNE
- MaxTxOutOffset: 200 blocks (~20 minutes)
- TxOutDelayMax: 17,280 blocks (code default)

Verified against thornode commit: 83dc71a3d
Source: thornode/x/thorchain/manager_txout_current.go
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.

1 participant