Skip to content

Commit f9ab9ae

Browse files
docs: refresh provenance README link
1 parent cea19c9 commit f9ab9ae

1 file changed

Lines changed: 72 additions & 3 deletions

File tree

README.md

Lines changed: 72 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,28 +46,95 @@ npm install @axionvera/pocketpay-sdk
4646

4747
## Documentation
4848

49+
- [Architecture](./docs/architecture.md) - How the SDK is organized, what each module owns, and how a call flows from the package root to Horizon/Soroban
50+
- [SDK Package Boundary & Dependency Direction Map](./docs/dependency_direction_map.md) - Which module may import which, security-sensitive boundaries, and correct vs. incorrect import examples
4951
- [SDK Roadmap](./docs/roadmap.md) - Directional plans and contributor opportunities across the SDK
5052
- [Testing](./docs/testing.md) - Unit vs integration test lanes and the offline guarantee
53+
- [SDK Module Test Matrix](./docs/module-test-matrix.md) - Required unit, fixture, error-path, and integration tests per major module
54+
- [Pre-PR Verification](./docs/pre-pr-verification.md) - Run `npm run verify:pr` before opening a pull request to confirm tests, docs, CI, and issue acceptance criteria
55+
- [Pre-submission Verification](./docs/pre-submission-verification.md) - Run `npm run presubmit` before submitting a PR (lint, tests, coverage, build)
56+
- [Contribution Quality Gate](./docs/contribution-quality-gate.md) - Maintainer checklist and examples of incomplete vs acceptable issue work before approval
5157
- [Getting Started](./docs/getting-started.md) - Step-by-step guide to install, create wallets, fund accounts, check balances, and send payments
58+
- [End-to-End App Integration Blueprint](./docs/app_integration_blueprint.md) - App-level flow combining config, diagnostics, wallet, account, payments, transactions, Soroban, vault, security, and typed error handling
59+
- [Testnet Account Funding](./docs/testnet-funding.md) - Funding and activating Testnet accounts with Friendbot, confirming activation, and common unfunded-account errors
5260
- [API Reference](./docs/api-reference.md) - Full reference with parameters, return types, and usage examples for every exported function
5361
- [React Native Compatibility](./docs/react-native.md) - Integration guide for Expo and bare React Native: polyfills, Metro config, secure storage, and known limitations
62+
- [Local Mobile Consumption](./docs/local-mobile-consumption.md) - Safely test unpublished SDK changes in `pocketpay-mobile`with tarballs, links, local paths, or workspaces
5463
- [Transaction Date Formatting](./docs/transaction-timestamps.md) - Format of every `createdAt` timestamp returned by the SDK
5564
- [Network Error Handling](./docs/network-errors.md) - Retry guidance for Horizon, Friendbot, and Soroban RPC failures
65+
- [Network Resilience Layer](./docs/network-resilience.md) - The `NetworkClient` abstraction, typed timeout/rate-limit/unreachable errors, and endpoint reachability diagnostics
5666
- [Safe Retry Policy](./docs/retry-policy.md) - Classifying submission outcomes, safe retry rules, and the `withRetryPolicy` API
67+
- [Account Sequence & Concurrency Safety](./docs/sequence-safety.md) - Account sequence number handling, caching, stale sequence error classification, and in-process concurrency safety with SequenceProvider
68+
- [Meaningful Change Review Guide](./docs/meaningful-change-review.md) - what counts as real SDK work: behaviour, modules, tests, acceptance criteria + reviewer checks
5769
- [Error Handling](./docs/error-handling.md) - SDK error handling overview
5870
- [Logging Guidance](./docs/logging.md) - Safe logging practices for SDK applications
71+
- [SDK Diagnostics](./docs/diagnostics.md) - Opt-in redacted lifecycle hooks and support-safe reports
72+
- [Logging: Transaction Payloads & Debug Mode](./docs/logging-payloads-and-debug.md) - Safely logging signed transaction XDR, memos, and debug output
5973
- [Security Best Practices](./docs/security.md) - Key management and transaction safety
74+
- [SDK Security Threat Model](./docs/security_threat_model.md) - Trust boundaries, secret handling, transaction submission risks, mitigation strategies, and consumer responsibilities
75+
- [Signing Boundaries](./docs/signing-boundaries.md) - Detailed rules on secret boundaries, capability checking, and transaction signing limits
76+
- [Dependency Review](./docs/dependency-review.md) - How SDK dependencies are evaluated, added, updated, and justified
77+
- [Package Provenance](./docs/package-provenance.md) - Publishing integrity, trusted publishing options, and consumer verification guidance
6078
- [Wallet Recovery Limitations](./docs/wallet-recovery-limitations.md) - What happens when keys are lost, what the SDK does not provide, and your application's responsibilities
6179
- [Wallet Secret Export Policy](./docs/wallet-secret-export.md) - Supported local-key access, unsupported export behaviour, security risks, and consumer responsibilities
6280
- [Soroban Vault](./docs/soroban-vault.md) - Savings vault helpers, configuration, and limitations
6381
- [Trustline Validation](./docs/trustline-validation.md) - Pre-flight trustline verification and issued asset payment safety
6482
- [Issued Asset Payments](./docs/issued-asset-payments.md) - Full guide to sending issued assets: asset identifiers, trustline setup, `sendAsset`, validation rules, and error reference
65-
- [Release Checklist](./docs/release-checklist.md) - Pre-release verification steps for maintainers
66-
- [Package Provenance](./docs/package-provenance.md) - Publishing integrity, trusted publishing options, and consumer verification guidance
67-
- [Architecture Decision Records](./docs/adr/) - Records of significant SDK design decisions and their rationale
83+
- [Multi-Asset Balance Model](./docs/multi-asset-balance-model.md) - Rich balance model for native XLM and issued credit assets with reserves and status taxonomy
84+
- [Asset Formatting Rules](./docs/asset-formatting.md) - Guidance for displaying native and issued asset codes, issuers, balances, decimals, unknown assets, and UX warnings safely
85+
- [SDK Release Readiness Checklist](./docs/release-checklist.md) - Repeatable release gates covering verification, public API review, security review, documentation, migration guidance, and publishing
86+
- [SDK Migration System](./docs/sdk_migration_system.md) - Compatibility classifications, deprecation lifecycle, migration requirements, and maintainer review process
87+
- [Migration Note Template](./docs/migration-note-template.md) - Reusable template for documenting breaking, configuration, runtime, and security-sensitive migrations
88+
- [Changelog Policy](./docs/changelog-policy.md) - Rules for changelog categories, Semantic Versioning, breaking changes, security entries, and migration links
89+
- [SDK Security Readiness Review](./docs/sdk_security_readiness_review.md) - Security review gates for secrets, signing, transactions, validation, networking, logging, dependencies, and public APIs
90+
- [Transaction Lifecycle ADR](./docs/adr/0005-transaction-lifecycle.md) - Safety boundaries for preparation, signing, submission, confirmation, retries, and future transaction work
91+
- [Architecture Decision Records](./docs/adr/) - Index of significant SDK design decisions and their rationale
6892
- [Support Policy](./docs/support-policy.md) - Supported runtimes, versions, network status, and maintenance expectations
93+
- [Dependency Review Standards](./docs/dependency-review.md) - Guidelines for evaluating, adding, and updating SDK dependencies
6994
- [Changelog](./CHANGELOG.md) - Track changes across SDK versions
7095

96+
## Local Development
97+
98+
When developing the SDK and
99+
[`Axionvera/pocketpay-mobile`](https://github.com/Axionvera/pocketpay-mobile)
100+
side by side, follow the
101+
[local mobile consumption guide](./docs/local-mobile-consumption.md). It
102+
recommends testing a locally packed tarball so Metro sees the same package
103+
layout that npm users receive, and also documents faster symlink-based
104+
alternatives and their cleanup steps.
105+
106+
## Local Verification
107+
108+
Before submitting a pull request, run the pre-submission command:
109+
110+
```bash
111+
npm run presubmit
112+
```
113+
114+
This is the contributor-facing pre-submission command. It runs the same
115+
CI-parity pipeline as `npm run verify`: **lint****circular-dependency check**
116+
**unit tests****coverage****build**, stops at the first failure, and
117+
prints fix guidance.
118+
119+
See [Pre-submission Verification](./docs/pre-submission-verification.md) for
120+
usage and failure guidance. Details of each pipeline step also live in
121+
[Local Verification Workflow](./docs/local-verification.md).
122+
123+
```bash
124+
npm run verify # same checks without step banners
125+
```
126+
127+
## Pull Request Expectations
128+
129+
Every PR uses the
130+
[PR template](./.github/PULL_REQUEST_TEMPLATE.md), which requires you to state
131+
the related issue, implementation scope, **tests added** (or why tests don't
132+
apply), the **`npm run verify` / `npm run presubmit`** output you ran locally, CI status, and
133+
acceptance-criteria coverage. A merged PR is not automatically payment-approved;
134+
reward eligibility is assessed separately. See [CONTRIBUTING.md](./CONTRIBUTING.md)
135+
for the full checklist.
136+
137+
71138
## Package Root Imports
72139

73140
Everything the SDK exposes is available from the package root — this is the
@@ -129,3 +196,5 @@ compatibility.
129196

130197
import { PocketPay } from '@axionvera/pocketpay-sdk';
131198
const sdk = new PocketPay({ network: 'testnet' });
199+
200+
==================================================

0 commit comments

Comments
 (0)