docs: add mobile vault SDK integration risk document and feature guide - #541
Merged
El-swaggerito merged 1 commit intoAug 26, 2026
Merged
Conversation
- Expand docs/vault-integration-risks.md with complete technical risk analysis, dual-mode execution model, SDK/contract assumptions, error taxonomy, and cross-repo roadmap - Add src/features/vault/README.md documenting vault architecture, components, hooks, stores, and integration boundaries - Update README.md and docs/vault-integration-assumptions.md with references to vault integration risks and feature module documentation Closes Axionvera#205
5 tasks
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
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.
Overview
Adds a comprehensive mobile vault SDK integration risk document and feature module architecture guide, detailing ecosystem boundaries, dual-mode execution (mock vs live Soroban contract), SDK/contract assumptions, error recovery models, and cross-repository handoff points.
Related Issue
Closes #205
Changes
Documentation & Specifications
docs/vault-integration-risks.mddocs/vault-integration-assumptions.mdREADME.mdFeature Module Documentation
src/features/vault/README.mdDepositPreview,WithdrawalPreview), hooks (useVaultDepositForm,useMaturedLockWithdrawal), stores (vaultStore.ts), error helpers, and dual-mode execution paths.Verification Results
docs/vault-integration-risks.mdcomprehensively documents all integration risks and operational modelsdeposit,withdraw,balance,get_locks,unlock), ledger consensus time, and SAC token custody documented