Skip to content

docs: add Enterprise SDK documentation#23

Merged
bastienrp merged 20 commits into
mainfrom
bastienrp/enterprise-sdk-docs
Jul 17, 2026
Merged

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

Conversation

@probablyangg

Copy link
Copy Markdown
Member

Re-opens the changes from #20, which was reverted from main (merge e52cec4 rolled back). Branch is unchanged; re-submitting for review.

Supersedes #20.

bastienrp and others added 11 commits July 13, 2026 17:02
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>
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>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 14, 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 6327f91 Commit Preview URL

Branch Preview URL
Jul 17 2026, 01:49 PM

@github-actions

github-actions Bot commented Jul 14, 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.

bastienrp and others added 9 commits July 15, 2026 10:27
Reflect the custodian-signing update on the SDK main branch: the waiver
modules now source their key from a SignerSource (signer > account > env
var). Add a subtle "Signing keys and custody" section to the reference
with the awsKmsSigner subpath, document the Signer/SignerSource types and
signer helpers, and update the build helpers to take a Signer (toSigner).
Fix the renamed guaranteedWaiver key field (waiverAccount -> account) and
add custody tips to the how-to guides.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
SDK main #43 (DR-197) wires one signer through the factory: add the
top-level `signer` config field (default for the waiver modules), update
the key-resolution order to include it, and note that send/sendBatch now
accept a Signer or a viem account.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Remove the TypeScript `!` assertions from the code blocks (null-check
the module instead), and explain gasFeeCap/gasTipCap as the EIP-1559
maxFeePerGas/maxPriorityFeePerGas in the guaranteed transactions guide.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add the npm package link to the Enterprise SDK overview (body + next
steps) and the reference install section, mirroring the Stable SDK docs.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@bastienrp
bastienrp merged commit b16bd8f into main Jul 17, 2026
3 of 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