Skip to content

Add comprehensive bridge module comments and assumptions#436

Merged
Xhristin3 merged 3 commits intorinafcode:mainfrom
Joeltabe:main
Apr 28, 2026
Merged

Add comprehensive bridge module comments and assumptions#436
Xhristin3 merged 3 commits intorinafcode:mainfrom
Joeltabe:main

Conversation

@Joeltabe
Copy link
Copy Markdown
Contributor

closes #368

  • Added module-level comments for BRIDGE_TIMEOUT_SECONDS, MAX_BRIDGE_RETRY_ATTEMPTS, and BRIDGE_RETRY_DELAY_BASE_SECONDS to explain operational rationale and units in contracts/teachlink/src/bridge.rs.
  • Added function-level documentation and assumptions for mark_bridge_failed, retry_bridge, and refund_bridge_transaction explaining persisted failure indexing, exponential backoff computation (base_delay * 2^retry_count), and alias semantics.
  • Replaced speculative/noisy inline commentary in add_validator with concise authorization/role-gating comments and documented assumptions for add_supported_chain, get_token, and get_admin getter behaviors.
  • Inserted focused inline comments clarifying first-retry anchoring to the original transaction timestamp and the purpose of the instance-level failure index.

@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented Apr 25, 2026

@Joeltabe 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

@Xhristin3
Copy link
Copy Markdown
Contributor

@Joeltabe resolve conflicts.

@Joeltabe
Copy link
Copy Markdown
Contributor Author

@Joeltabe resolve conflicts.

Done

@Xhristin3 Xhristin3 merged commit 8e83522 into rinafcode:main Apr 28, 2026
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.

Add comprehensive code comments

2 participants