Skip to content

docs: add Enterprise SDK documentation#20

Merged
probablyangg merged 11 commits into
mainfrom
bastienrp/enterprise-sdk-docs
Jul 14, 2026
Merged

docs: add Enterprise SDK documentation#20
probablyangg merged 11 commits into
mainfrom
bastienrp/enterprise-sdk-docs

Conversation

@bastienrp

Copy link
Copy Markdown
Contributor

Summary

Adds documentation for the Stable Enterprise SDK (@stablechain/enterprise), sourced from the SDK repo's main branch (packages/enterprise and examples/enterprise).

Two new English pages, wired into the /en sidebar under Build → Enterprise SDK:

  • explanation/enterprise-sdk — overview: the three modules (gasWaiver, guaranteedBlock, guaranteedWaiver), when to use it, server-side-only warning, and access.
  • reference/enterprise-sdk — full API reference: createStableEnterprise, each module's config and send / sendBatch / relay / relayBatch methods, the buildWaiverInnerTx / buildGuaranteedTx / nonceKeyForLane helpers, shared types (WaiverInnerTx, GuaranteedTxRequest, ValidationLimits, AllowedTarget, BatchResultItem), the full ErrorCode table, and constants.

Per the user's notes, both pages state that the SDK is currently available on Stable Testnet only and that integration is gated — contact Stable to get access (a governance-registered waiver key and an Enterprise RPC gateway API key). Code samples use stableTestnet.

Notes

Checks

  • npm run style:check — 0 blocking (pre-existing warnings in other files only)
  • npx tsc --noEmit — clean
  • npm run docs:build — builds all locales, no broken links

🤖 Generated with Claude Code

Document @stablechain/enterprise: the gas waiver, guaranteed
blockspace, and composed guaranteedWaiver modules, their send/relay
methods, build helpers, shared types, and error codes. Note testnet-only
availability and the contact-for-access gating. Add both pages to the
/en sidebar under Build.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Styleguide check

✓ 132 en pages — 0 blocking, 11 warnings

docs/pages/en/explanation/autobahn.mdx

  • ⚠ warning: marketing word "robust" (L20)
  • ⚠ warning: marketing word "seamless" (L34)

docs/pages/en/explanation/consensus.mdx

  • ⚠ warning: marketing word "robust" (L32)

docs/pages/en/explanation/ethereum-compatibility.mdx

  • ⚠ warning: marketing word "seamless" (L10)

docs/pages/en/how-to/monitor-node.mdx

  • ⚠ warning: marketing word "comprehensive" (L7)

docs/pages/en/how-to/troubleshoot-node.mdx

  • ⚠ warning: marketing word "comprehensive" (L7)

docs/pages/en/reference/indexers.mdx

  • ⚠ warning: marketing word "seamlessly" (L9)

docs/pages/en/reference/ramps.mdx

  • ⚠ warning: marketing word "seamless" (L28)

docs/pages/en/reference/system-transactions-api.mdx

  • ⚠ warning: marketing word "comprehensive" (L358)

docs/pages/en/reference/wallets.mdx

  • ⚠ warning: marketing word "powerful" (L83)
  • ⚠ warning: marketing word "seamless" (L30)

Enforced by npm run style:check — see STYLEGUIDE.md.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 13, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
docs 9002b0f Commit Preview URL

Branch Preview URL
Jul 14 2026, 08:14 AM

github-actions Bot and others added 10 commits July 13, 2026 15:04
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add task-focused implementation guides modeled on the Stable SDK Earn
yield page: relay-with-gas-waiver and send-guaranteed-transactions
(which also covers the combined guaranteed relay transactions flow).
Point the Enterprise SDK menu's Gas Waiver and Guaranteed Blockspace
items at these guides. List the three features by name in the overview
and reference. Reiterate testnet-only, on-request availability.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add a dedicated how-to for the combined guaranteedWaiver feature
(gas-waived transactions over guaranteed blockspace), modeled on the
reference. Add it to the Enterprise SDK menu, and replace the inline
"Combine with gas waiver" section in the guaranteed blockspace guide
with a pointer to it.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The Cloudflare prerender OOMs at the previous 6144 MB cap: it prerenders
all 395 pages (en/cn/ko) sequentially in one process and dies right at
the ceiling (peak 6010/6191 MB). The same build passes locally, so the
working set is ~6 GB and just tips over. Raise the cap to 7168 MB, which
stays under the 8 GB Cloudflare build container.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@probablyangg probablyangg merged commit e52cec4 into main Jul 14, 2026
4 checks passed
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.

2 participants