Skip to content

Build investor statement PDF generator with deterministic layout and signed hash #874

Description

@thlpkee20-wq

Summary

Build investor statement PDF generator with deterministic layout and signed hash

Why this matters

Investors need quarterly statements showing positions, distributions, fees, and tax classifications as a PDF. The generator must be deterministic so that regenerating a statement yields the same hash, enabling immutable archival and tamper detection.

Scope

Implement the requested behavior across src/services/balanceSnapshotService.ts, src/db/repositories/distributionRepository.ts. The solution must preserve existing compatibility, authorization, and production safeguards.

Priority

High

Acceptance criteria

  • The requested behavior is implemented across src/services/balanceSnapshotService.ts, src/db/repositories/distributionRepository.ts with a clear, reviewable contract.
  • Security, authorization, validation, and data-integrity requirements in the repository context are enforced and covered by tests.
  • Failure, retry, timeout, concurrency, and boundary behavior is explicit and produces safe, diagnosable outcomes where applicable.
  • Regression coverage includes empty, invalid, duplicate, and boundary inputs relevant to this flow.
  • Existing API, storage, and deployment compatibility is preserved unless a migration is explicitly documented.

Validation

Include focused tests for:

  • happy paths;
  • invalid input and authorization boundaries;
  • concurrency, retries, or failure recovery;
  • backward compatibility;
  • relevant integration or contract behavior.

The implementation must pass the repository’s existing build, lint, test, and formatting checks (use npm test where applicable).

Non-goals

  • Typo-only, formatting-only, or documentation-only changes.
  • Unrelated refactors or dependency upgrades.
  • Weakening security, authorization, CI, or production safeguards.
  • Changing public behavior outside this issue’s scope.

Contributor application

Before implementation, comment with:

  1. relevant experience;
  2. a concise implementation approach;
  3. expected files or modules affected;
  4. an estimate for opening the first PR.

Wait for maintainer assignment before coding.

PR requirements

Use a feature branch and include Closes #.

The PR must:

  • address every acceptance criterion;
  • link each criterion to code and tests;
  • explain security and failure-mode handling;
  • include meaningful regression coverage;
  • document compatibility or migration considerations;
  • pass the repository checks.

Reward-readiness

This is a substantive quality issue. Merge status does not guarantee reward eligibility; final evaluation is determined separately.

Implementation context

Description

Investors need quarterly statements showing positions, distributions, fees, and tax classifications as a PDF. The generator must be deterministic so that regenerating a statement yields the same hash, enabling immutable archival and tamper detection.

Requirements and context

  • Must be secure, tested, and documented
  • Should be efficient and easy to review
  • Relevant code: src/services/balanceSnapshotService.ts, src/db/repositories/distributionRepository.ts
  • Hash must be embedded in DB and verifiable at fetch time

Suggested execution

  • Fork the repo and create a branch
  • git checkout -b feat/investor-statement-pdf
  • Implement changes
    • Add server-side renderer using a headless engine with frozen fonts
    • Persist (statement_id, sha256, generated_at) row
    • Add fetch endpoint that re-verifies hash before serving
  • Validate security and correctness assumptions

Test and commit

  • Run tests
    • npm test
  • Cover edge cases
    • Multi-currency holdings, zero-distribution periods, mid-period transfers
  • Include test output and notes

Example commit message

feat: deterministic investor statement PDF generator

Guidelines

  • Minimum 95 percent test coverage
  • Clear documentation
  • Timeframe: 96 hours

Activity

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

Metadata

Metadata

Assignees

Labels

Stellar WaveStellar Wave issue batch

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions