Docs/production hardening and guides#1220
Merged
miss-yusrah merged 4 commits intoJun 28, 2026
Merged
Conversation
|
@jhayniffy Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
… response Covers pre-deployment checklist, secrets management, Docker Compose production override, multi-endpoint RPC failover, Prometheus/Grafana monitoring, alerting rules, SQLite/cursor backup strategy, nginx health check integration, and incident response playbook (vault pause, signer rotation, cursor reset, rollback).
…port Documents Freighter API usage (isConnected, getUserInfo, signTransaction, getNetwork), connection/signing flow diagrams (Mermaid), error handling for all edge cases (no extension, rejection, wrong network, locked wallet), Vitest mocking examples, multi-wallet adapter pattern, and security model.
… docs Module-by-module reference for all backend modules, event pipeline walkthrough (RPC polling → normalizers → consumers → WebSocket), cursor system explanation (file vs database adapters, migration path, lag measurement), job manager lifecycle, proposal consumer deep-dive (idempotency, batching, adapter pattern), and step-by-step guide for adding a new module with worked example.
…examples Expands sdk/README.md from ~2200 bytes to full integration guide covering installation, quick start, Freighter auth, proposals, voting/execution, recurring payments, streaming, escrow, templates, recovery, audit logs, WebSocket event subscription, error handling, types reference, and common mistakes. Adds 4 new example scripts: create-vault.ts, vote-proposal.ts, create-recurring.ts, listen-events.ts.
jhayniffy
force-pushed
the
docs/production-hardening-and-guides
branch
from
8c09e1e to
af14f11
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes #1181
closes #1182
closes #1184
closes #1191
Contributors working on wallet-related features must reverse-engineer the Freighter integration from WalletSwitcher.tsx and related components. Common issues (wrong network, locked wallet, user rejection) are not documented.
The deployment guide assumes a development environment. There is no production hardening guide, no backup strategy for contract state, no monitoring setup, and no incident response playbook.
sdk/examples/execute-proposal.ts is the only example. There are no examples for: creating a vault, voting, setting up recurring payments, querying audit logs, or listening to events.