Skip to content

Reflect stellar-base fold-in (SDK v16): stop pointing readers at js-stellar-base and js-soroban-client #2560

Description

@oceans404

Context

As of @stellar/stellar-sdk v16, @stellar/stellar-base is folded into the SDK and re-exported from the top level. The SDK is the only package developers need (see migration notes). Several stellar-docs pages still treat stellar-base (or the long-retired js-soroban-client) as a separate library. Each item below lists the exact location and the fix.

Checklist

1. docs/learn/fundamentals/data-format/xdr.mdx: repoint XDR type references

  • Line 61: links js-stellar-base/blob/master/types/curr.d.ts and calls it "your primary guide to navigating the XDR if you're using JavaScript". Repoint to the SDK XDR reference: https://stellar.github.io/js-stellar-sdk/reference/core-xdr/
  • Line 119: another js-stellar-base curr.d.ts deep link for ScAddress. Same fix.
  • Line 144 and line 186: link to old jsdoc pages (js-stellar-base_src_scval.js.html, js-stellar-base_src_events.js.html) on the SDK docs site. Verify these URLs still resolve on the current site; replace with current API doc links for scValToNative and humanizeEvents.

2. docs/networks/software-versions.mdx: drop the separate "JS Stellar Base" row going forward

  • Lines 32-33 (Protocol 27 table): Stellar JS Stellar Base | TBD next to Stellar JS Stellar SDK | v16.0.0-rc.2. For Protocol 27 and future tables, remove the JS Stellar Base row or annotate it "folded into stellar-sdk as of v16". Leave historical protocol tables unchanged.

3. docs/build/guides/freighter/sign-auth-entries.mdx: repoint auth helper links

4. docs/build/guides/archival/restore-contract-js.mdx: retire js-soroban-client links

5. docs/build/guides/dapps/frontend-guide.mdx: fix unscoped install

  • Line 93: npm install stellar-sdk @stellar/freighter-api bignumber.js uses the deprecated unscoped package. Change to @stellar/stellar-sdk. This is the only unscoped install left in the repo.

6. docs/data/apis/rpc/api-reference/methods/getLedgerEntries.mdx: repoint type definition link

7. docs/data/analytics/hubble/developer-guide/backfill/JS-UDF.mdx: rewrite around the SDK bundle

  • This page's premise is stale: it instructs users to clone and build js-stellar-base standalone (line 16, lines 24-41, GCS path on line 68) to get stellar-base.min.js for BigQuery UDFs. Rewrite to build or download the @stellar/stellar-sdk browser bundle instead, and update the StellarBase.* globals in the UDF code accordingly. The BigQuery-specific guidance stays.

Acceptance criteria

  • rg 'js-stellar-base|js-soroban-client' docs/ --glob '!i18n/**' returns no hits outside intentionally historical content.
  • Protocol 27+ software version tables no longer imply stellar-base ships separately.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Fields

    No fields configured for Task.

    Projects

    Status
    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions