Skip to content

Document Butter Network Swidge integration - #259

Merged
ihsraham merged 4 commits into
developfrom
feat/butter-module
Sep 22, 2026
Merged

ihsraham merged 4 commits into
developfrom
feat/butter-module

Conversation

@ihsraham

@ihsraham ihsraham commented Sep 15, 2026 •

Copy link
Copy Markdown
Contributor

Adds Butter Network Swidge 0.2.0 documentation: npm installation, configuration, API reference, confirmed execution, and settlement tracking. Includes navigation, the module catalog, a September 17 changelog entry, and generated documentation. Updated against current develop.

Verified the published artifact against release source 7030e264. Validation: Node 22 production quality checks and external links; generated parity for 363 pages; 839 source tests and 76 repository checks; clean npm installation, Node/Bare imports, and strict consumer TypeScript. Source/API, IA, competing assets, token metadata, and rendered pages checked. No live transaction was submitted; API access requires a Butter-issued entrance.

Layout previews

Captured before publication; installation now uses npm 0.2.0.

Butter Network overview and sidebar Butter Network execution guide Butter API reference Next Steps and Need Help

@kinsta

kinsta Bot commented Sep 15, 2026 •

Copy link
Copy Markdown

Preview deployments for wdk-docs prod ⚡️

Status Branch preview Commit preview
✅ Ready Visit preview Visit preview

Commit: fdbba777c22d281639964140c47b78d5aec60816

Deployment ID: 54951b28-d03a-4ef9-b4d4-77cbd57fde77

Static site name: wdk-docs-prod-pbpbt

@kinsta

kinsta Bot commented Sep 15, 2026 •

Copy link
Copy Markdown

Preview deployments for wdk-docs staging ⚡️

Status Branch preview Commit preview
✅ Ready Visit preview Visit preview

Commit: fdbba777c22d281639964140c47b78d5aec60816

Deployment ID: 6cf3e707-fa3a-45de-ae73-72acf77661fd

Static site name: wdk-docs-ve3eh

} from '@butternetwork/wdk-protocol-swidge-butter'
```

The package also exports `ISwidgeProtocol`, the [public types](#public-types), and [error constructors](#errors) listed below. Internal source files are not public package subpaths.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This package doesn't export ISwidgeProtocol at runtime — only in the .d.ts. I would drop it from this sentence.

@ihsraham ihsraham Sep 22, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 5a71a72. Removed ISwidgeProtocol from the runtime export sentence and synchronized public/llms-full.txt.

@jonathunne jonathunne left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ihsraham
ihsraham merged commit 058c167 into develop Sep 22, 2026
4 checks passed

This branch was successfully deployed

1 active deployment
preview — fdbba777 Deployed Sep 22, 2026 by kinsta[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants