Skip to content

Explain Stellar network selection and deposit preparation #1347

Description

@greatest0fallt1me

Summary

docs/deposit-transaction-builder.md and docs/network-configuration.md describe TransactionBuilderService, but omit that DepositController rejects networks different from config.stellar.network, that vaults must exist first, and that fees and timeouts come from specific env variables.

Why this matters

Frontend integrators receive INVALID_NETWORK or vault-not-found errors without understanding why.

Scope

Document the end-to-end deposit flow: vault registration, POST /api/vault/deposit/prepare body, network rules, returned XDR fields, simulation diagnostics redaction and signing responsibilities.

Relevant code in CalloraOrg/Callora-Backend:

  • docs/deposit-transaction-builder.md
  • docs/network-configuration.md
  • src/controllers/depositController.ts

Priority

Low

Acceptance criteria

  • The request and response schemas match DepositPrepareRequest/Response
  • Network mismatch behaviour is described
  • Env variables for fee and timeout are listed
  • An example XDR signing snippet is included

Validation

Verify examples against npm test -- src/controllers/depositController.test.ts.

Non-goals

  • Typo-only, formatting-only, or cosmetic changes.
  • Unrelated refactors, dependency upgrades, or broad rewrites.
  • Removing safeguards or weakening validation to make tests pass.

Contributor application

Before coding, describe the affected modules, proposed state/invariant changes, test strategy, compatibility considerations, and an estimate. Wait for assignment before starting implementation.

PR requirements

Use a feature branch and include Closes #<issue-number>. Address every criterion, map criteria to code and tests, explain security and failure-mode handling, and ensure CI passes.

Quality review

A maintainer will assess correctness, completeness, test depth, compatibility, observability, and adverse-case handling. A substantive implementation is required; merge or CI status alone does not guarantee reward eligibility.


Generated by Claude Code

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 Program issue

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions