Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
5 changes: 2 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 3 additions & 2 deletions docs/delivery-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down
10 changes: 5 additions & 5 deletions docs/troubleshooting-and-versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
```
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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"
},
Expand Down
1 change: 1 addition & 0 deletions scripts/verify-packed-package.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
@@ -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";
Expand Down
Loading