Skip to content

ocument SDK transaction lifecycle architecture#199

Merged
El-swaggerito merged 2 commits into
Axionvera:mainfrom
Johnsource-hub:docs/transaction-lifecycle-adr
Jul 23, 2026
Merged

ocument SDK transaction lifecycle architecture#199
El-swaggerito merged 2 commits into
Axionvera:mainfrom
Johnsource-hub:docs/transaction-lifecycle-adr

Conversation

@Johnsource-hub

Copy link
Copy Markdown
Contributor

#closes
#175

Summary
This PR adds a comprehensive Architecture Decision Record (ADR) detailing the PocketPay SDK’s transaction lifecycle architecture and safety assumptions. It also updates the main README.md to reference this new architectural document.

Establishing these boundaries prevents architectural drift, ensures transaction helpers evolve consistently, and provides consumers with a clear reference for error handling, retries, polling, and security responsibilities.

Key Changes
New Architecture Decision Record (docs/adr/001-transaction-lifecycle-architecture.md):

Lifecycle Stages: Documents the complete flow from preparation, client-side signing, and RPC/Horizon submission, to post-submission status verification.

Retry & Polling Strategy: Specifies explicit guidelines for safe vs. unsafe retries (e.g., handling transient network errors vs. replay prevention) and polling logic for transaction finality.

Security Boundaries: Clarifies that the SDK operates on a zero-persistence model for secret keys, emphasizing consumer responsibility for key storage, user authentication, and transaction approval.

Documentation Link Update (README.md):

Updated the Architecture Decision Records link in the README.md to point directly to the newly created ADR.

@El-swaggerito

Copy link
Copy Markdown
Contributor

This PR cannot be merged automatically because it has merge conflicts.

Please update the branch with the latest base branch and resolve the conflicts.

After the conflicts are resolved and checks pass, the automation can review it again.

@El-swaggerito
El-swaggerito merged commit 6408d7e into Axionvera:main Jul 23, 2026
1 check 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.

2 participants