Skip to content

Tutorials still teach the deprecated stellar contract bindings typescript command #2968

Open

Description

@oceans404

Page: several (listed below)
Files:

  • docs/build/smart-contracts/getting-started/hello-world-frontend.mdx:58-61
  • docs/build/guides/dapps/frontend-guide.mdx:820
  • docs/build/guides/dapps/soroban-contract-init-template.mdx:88
  • docs/build/guides/basics/verify-trustlines.mdx:218
  • docs/build/apps/guestbook/bindings.mdx:57
  • docs/build/apps/dapp-frontend.mdx:208 and :364
  • docs/learn/fundamentals/contract-development/types/fully-typed-contracts.mdx:83

What's wrong:
These pages tell readers to run stellar contract bindings typescript. The CLI marks that command deprecated and points to the JS SDK instead (stellar-cli reference on this site). It also still generates packages pinned to an older SDK major, not v17 (see the @stellar/stellar-sdk range in the CLI's TypeScript template), so apps that follow these pages get a second, older SDK copy next to v17.

Change needed:
Teach the SDK's own generator on each page, and say which SDK major the generated package uses.

Correct reference:

How to check the fix:

  • Each tutorial's binding step runs with npx @stellar/stellar-sdk generate and the generated package installs @stellar/stellar-sdk 17.x.
  • npm ls @stellar/stellar-sdk in the tutorial project shows one copy.
  • No page outside docs/tools/cli/stellar-cli.mdx (generated from the CLI) tells readers to run the deprecated command.
  • pnpm validate passes.

Why it matters: At HackMeridian 2026, apps that generated bindings this way ended up with an older SDK copy next to v17; one team pinned its whole app to an older major because of it.

Related: #2561 (adds the generator to the client SDKs page), #2564 (cross-links; mentions the generator for fully-typed-contracts.mdx), #2960 (frontend guide).

Activity

  1. stellar-doxie commented on Nov 1, 2026

    @stellar-doxie
    Contributor

    🤖 Automated message from the Stellar Triage Bot.

    I saw this issue. Nobody has called me in yet, so I will not work it now.

    How to reach me:

    • Anyone with write permission can call me in. Comment /triage, add the bot:take label, or assign @kaankacar, @ElliotFriend or @wmendes.
    • The issue author can send me away with /triage stop. People with write permission can also add the bot:hands-off label.
  2. added
    bot:takeCall the triage bot in: it assesses this issue or reviews this PR
    on Nov 1, 2026
  3. oceans404 commented on Nov 1, 2026

    @oceans404
    ContributorAuthor

    /triage

  4. stellar-doxie commented on Nov 1, 2026

    @stellar-doxie
    Contributor

    🤖 Automated message from the Stellar Triage Bot.

    Working this because @oceans404 added bot:take.

    I am checking each listed page against the CLI and the JS SDK v17 generator now.

  5. stellar-doxie commented on Nov 1, 2026

    @stellar-doxie
    Contributor

    🤖 Automated message from the Stellar Triage Bot.

    Working this because @oceans404 added bot:take.

    PR #2985 fixes 5 of the 7 pages. Its checks pass. It says "Refs #2968", so this issue stays open.

    The SDK generator is not a drop-in swap. Its output has no networks export, it ignores CLI aliases, and it turns _ into - in package names. The PR handles these on each page.

    @kaankacar @ElliotFriend, one decision is needed: how should the 2 pages that depend on a companion repo change?

    1. docs/build/apps/guestbook/bindings.mdx follows ElliotFriend/ye-olde-guestbook. With the SDK generator, the package becomes ye-olde-guestbook. It has no networks.testnet, and it does not re-export the SDK. Options:
      • A. Update the repo and the page together.
      • B. Keep the page as is and add a deprecation note.
    2. docs/build/guides/dapps/soroban-contract-init-template.mdx:88 describes initialize.js in stellar/soroban-astro-template. That repo is archived and still runs the CLI command, so the line is accurate. Options:
      • A. Leave it.
      • B. Rewrite the page so it no longer depends on the archived template.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bot:needs-decisionBot needs a maintainer decision (listing, scope, policy)bot:takeCall the triage bot in: it assesses this issue or reviews this PRjs-sdk-v17

    Type

    No type

    Projects

    • Status
      No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions