diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e8236ab --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,35 @@ +# Changelog + +All notable changes to `@fundable/sdk` are documented here. + +## 0.1.0 + +First stable Fundable SDK release. + +### Added + +- chain-neutral Flow, Lockup, token, amount, status, and error types; +- Stellar Flow client reads and lifecycle transactions; +- Stellar Router Flow and Lockup creation plus NFT-backed withdrawals; +- Stream NFT ownership, metadata, balance, and transfer operations; +- Paymaster fee-token checks and bounded forwarding transactions; +- generated Soroban bindings with recorded contract provenance; +- exact `bigint` unit conversion helpers; +- runnable Stellar examples and clean-consumer package verification; +- public GitBook documentation and backend-indexing guidance. + +### Compatibility + +- Node.js 20 or newer; +- `@stellar/stellar-sdk` 14.4.3 or compatible 14.x release; +- Fundable Soroban contract release `contracts-v0.1.0-alpha.2`; +- generated binding provenance recorded in + `docs/generated-bindings.md`. + +### Known limitations + +- Stellar is the only implemented chain adapter; +- EVM is represented in the shared architecture but is not implemented; +- the Paymaster forwarding API expects reviewed raw Soroban arguments; +- backend transaction completeness requires chain event indexing and cannot + rely on SDK telemetry. diff --git a/README.md b/README.md index 1d5e2f8..6d494c2 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,10 @@ distributions. Stellar is the first implemented chain adapter; the public domain types intentionally contain no Soroban-specific values so an EVM adapter can be added without changing application code. -> The `0.x` API is under active development. +**Documentation:** [Fundable SDK on GitBook](https://fundable-finance.gitbook.io/fundable-finance-docs/) + +> The `0.x` API remains under active development. Review release notes before +> upgrading between minor versions. Detailed, GitBook-ready guides live in [`docs/`](./docs): diff --git a/docs/README.md b/docs/README.md index 90752cf..2b7eb59 100644 --- a/docs/README.md +++ b/docs/README.md @@ -30,6 +30,5 @@ code. 6. Review [Generated bindings](generated-bindings.md) when validating contract and SDK release provenance. -The package is currently a prerelease. Review the -[delivery checklist](delivery-checklist.md) for the remaining work required -before the SDK is promoted to a stable release. +Review the [release process](releasing.md) for version compatibility and the +[delivery checklist](delivery-checklist.md) for release acceptance evidence. diff --git a/docs/delivery-checklist.md b/docs/delivery-checklist.md index a1a8f4e..30a54c4 100644 --- a/docs/delivery-checklist.md +++ b/docs/delivery-checklist.md @@ -35,7 +35,7 @@ artifact, an automated check, or a public URL that proves completion. - [x] Versioning, generated-binding provenance, and troubleshooting are documented. - [x] All internal documentation links pass an automated check. -- [ ] The GitBook space is connected to this repository and its public URL is +- [x] The GitBook space is connected to this repository and its public URL is added to `package.json` and the repository README. ## 3. Example readiness @@ -61,7 +61,8 @@ artifact, an automated check, or a public URL that proves completion. - [x] A clean project can install the packed SDK and compile a representative consumer. - [x] A testnet smoke test verifies documented read and simulation workflows. -- [ ] GitBook pages render correctly on desktop and mobile. +- [x] GitBook pages render correctly on desktop. +- [ ] GitBook pages render correctly on mobile. - [ ] The stable npm package, GitBook URL, examples, source tag, and contract provenance all cross-link to one another. diff --git a/docs/troubleshooting-and-versioning.md b/docs/troubleshooting-and-versioning.md index b479d83..d15735e 100644 --- a/docs/troubleshooting-and-versioning.md +++ b/docs/troubleshooting-and-versioning.md @@ -46,16 +46,16 @@ The SDK follows semantic versioning: - minor releases add backward-compatible capabilities; - major releases may change public types or behavior. -Until `1.0.0`, minor `0.x` releases may contain breaking changes. Prerelease -versions such as `0.1.0-alpha.3` are published under npm's `next` tag and must -not be treated as stable. +Until `1.0.0`, minor `0.x` releases may contain breaking changes. Stable +versions are published under npm's `latest` tag. Prerelease versions containing +a hyphen are published under `next` and must not be treated as stable. -Pin an exact prerelease in production: +Pin an exact version in production: ```json { "dependencies": { - "@fundable/sdk": "0.1.0-alpha.3" + "@fundable/sdk": "0.1.0" } } ``` diff --git a/package.json b/package.json index d0974bb..1a3f6f8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fundable/sdk", - "version": "0.1.0-alpha.3", + "version": "0.1.0", "private": false, "description": "Multichain TypeScript SDK for Fundable Protocol; Stellar adapter included", "license": "MIT", @@ -19,9 +19,10 @@ "dist", "docs", "examples", + "CHANGELOG.md", "README.md" ], - "homepage": "https://github.com/Fundable-Protocol/fundable-sdk#readme", + "homepage": "https://fundable-finance.gitbook.io/fundable-finance-docs/", "bugs": { "url": "https://github.com/Fundable-Protocol/fundable-sdk/issues" }, diff --git a/scripts/verify-packed-package.mjs b/scripts/verify-packed-package.mjs index b50c334..c1afc23 100644 --- a/scripts/verify-packed-package.mjs +++ b/scripts/verify-packed-package.mjs @@ -45,6 +45,7 @@ try { const requiredEntries = [ "package/package.json", "package/README.md", + "package/CHANGELOG.md", "package/dist/index.js", "package/dist/index.d.ts", "package/docs/README.md", diff --git a/src/index.ts b/src/index.ts index fdfabf8..6c8c8d2 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,5 +1,5 @@ /** Fundable Protocol multichain SDK. Stellar is the first implemented adapter. */ -export const VERSION = "0.1.0-alpha.3"; +export const VERSION = "0.1.0"; export * from "./client.js"; export * from "./core/index.js";