Skip to content

Docs: architecture diagram of stream accrual and cascade routing #15

Open

Description

@SYMBAxx

Add docs/architecture.md with diagrams (Mermaid is fine) for the accrual formula/checkpointing and the recursive route in CascadeSplitter, linked from README.

Acceptance: accurate to the code; rendered correctly on GitHub.

Activity

  1. NePreby commented on Nov 6, 2026

    @NePreby

    I have completed the technical architecture documentation and Mermaid diagrams in PR #19 (#19).

    • Added docs/architecture.md containing complete Mermaid diagrams for system overview, StreamRouter accrual & top-up checkpointing, CascadeSplitter recursive routing & cycle handling, and JCS audit receipts.
    • Linked docs/architecture.md from README.md.
    • All diagrams and formulas verified against Soroban contract code.

    Payout Address (Binance TRC20):
    TMqmJjRgVS21NL2eFtfyHciTxvE4BqGmEv

  2. NePreby commented on Nov 9, 2026

    @NePreby

    I have authored the architecture documentation and diagrams for FlowPulse:

    Summary of Documentation

    1. System Architecture Overview:
      • Multi-layer component diagram mapping sponsors, maintainers, dependency trees, Soroban smart contracts (StreamRouter, CascadeSplitter), and client-side RFC-8785 receipt verifiers.
    2. StreamRouter Accrual & Dry Checkpointing:
      • Mathematical formulation of linear time-based accrual against ledger close timestamps.
      • Accrual timeline illustrating zero-accrual idle runway gaps and checkpoint restarts upon top_up.
      • Comprehensive Mermaid sequence diagram for full stream lifecycles.
    3. CascadeSplitter Recursive Routing & Invariants:
      • Flowchart of the recursive route() algorithm.
      • Mathematical proofs for fund conservation ($\sum ext{payouts} = ext{amount}$) via dust aggregation and cycle termination within $\le 3$ hops (MAX_DEPTH).
    4. Cryptographic Audit Receipts:
      • JCS canonicalization + SHA-256 digest + Ed25519 signature verification sequence diagram.
    5. README Integration:
      • Linked from README under # How it works and updated the repository layout tree.

    Payout Details

    • Network: TRX Tron (TRC20)
    • Address: TMqmJjRgVS21NL2eFtfyHciTxvE4BqGmEv
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions