Skip to content

Rewrite the JavaScript SDK section of client-sdks.mdx: TypeScript-first, one package, bindings CLI, dedicated docs site #2561

Description

@oceans404

Context

docs/tools/sdks/client-sdks.mdx is the front door for the JS SDK in the developer docs. The current section (lines 22-33) is out of date on positioning:

  • It says "stellar-sdk is the JavaScript library" and never mentions the SDK is fully TypeScript.
  • It does not mention that @stellar/stellar-base is now folded into the SDK (v16), so the SDK is the only package developers need.
  • It does not mention the bundled CLI for generating typed contract bindings (npx @stellar/stellar-sdk generate).
  • The prose uses the bare name stellar-sdk (line 28); the correct package is @stellar/stellar-sdk.

What to do

Rewrite the JavaScript SDK section to lead with the current story. Suggested copy (adjust to page conventions):

JavaScript SDK

JavaScript SDK | Docs | NPM

The JavaScript SDK is maintained by SDF.

@stellar/stellar-sdk is the TypeScript SDK for communicating with Stellar RPC and Horizon, and for building, signing, and submitting transactions. It is fully typed, works in Node.js and the browser, and as of v16 includes everything that used to live in @stellar/stellar-base, so it is the only package you need.

It provides:

  • A networking layer for Stellar RPC methods and the Horizon API.
  • Facilities for building and signing transactions and for submitting them or querying network state.
  • A CLI that generates fully typed TypeScript bindings for any deployed smart contract (npx @stellar/stellar-sdk generate).

The SDK has its own docs site with task guides (connect and fund, send a payment, issue an asset, query and stream, handle errors, invoke a contract, contract auth) and a full API reference: https://stellar.github.io/js-stellar-sdk/

Also consider linking the agent-facing bundles the SDK docs publish (llms.txt, llms-full.txt) since this page is where tooling authors look first.

Acceptance criteria

  • The section states the SDK is TypeScript.
  • The section states stellar-base is bundled in as of v16.
  • The section mentions the bindings CLI.
  • Package name appears as @stellar/stellar-sdk throughout.

Metadata

Metadata

Assignees

Projects

  • Status
    No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions