Skip to content

[Quality][Medium] Emit settlement reconciliation events for every payout leg #2412

Description

@Baskarayelu

Objective

Add structured reconciliation events that identify each payout leg and the exact pre/post accounting context.

Why this matters

Operators and indexers need to reconcile principal, fee, refund, and default legs. A single final status event is insufficient to detect partial accounting errors.

This is a substantive production-quality improvement. It must change runtime behavior, security guarantees, correctness, reliability, or meaningful user functionality. It is not a documentation-only, formatting-only, or trivial dependency task.

Scope

Area: settlement observability

Starting points: src/events.rs, src/settlement.rs, src/profits.rs, docs/ON_CHAIN_LOGS.md

The contributor should verify the current implementation before changing it and keep the PR limited to this issue. Do not introduce unrelated refactors or weaken existing CI/security gates.

Acceptance criteria

  • Every successful settlement emits one complete reconciliation record per payout leg.
  • Event fields allow an indexer to recompute total distributed value.
  • Failed transactions do not leave misleading success events.
  • Event size and emission remain within contract budget.

Required validation

  • Add event-vector tests for paid, defaulted, refunded, and fee-only paths.

  • Test event ordering and identifier correlation.

  • Add a parser/reconciliation test that recomputes the totals.

  • The PR explains the failure mode, the chosen design, backward-compatibility impact, and rollback or migration considerations.

  • The PR includes CI evidence and does not contain secrets, generated noise, unrelated cleanup, or disabled checks.

Contributor deliverables

  • Open a focused feature branch and do not begin implementation until assigned.
  • Reference this issue with Closes #<issue-number> or Fixes #<issue-number>.
  • Check off every acceptance criterion in the PR with links to the relevant code and tests.
  • Include a security/correctness note explaining why adversarial inputs cannot bypass the new guarantee.

Maintainer quality bar

The PR must be independently reviewable, preserve existing behavior outside this scope, exercise failure paths, and pass the repository's complete required CI/CD checks. Reward eligibility is not guaranteed by this issue or by merging.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions