Tutorials still teach the deprecated stellar contract bindings typescript command

Aperta Adatta ai principianti
  • Qualcosa non va?
#2,968 4 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
Mezza giornata
Idoneità per principianti
62/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
git, javascript, typescript
Ambito
documentation

Direzione di ricerca

Inizia dalle pagine MDX elencate, partendo da docs/build/smart-contracts/getting-started/hello-world-frontend.mdx intorno alle righe 58-61, e individua ogni punto in cui viene eseguito stellar contract bindings typescript. Controlla la sezione "CLI" del README dell'SDK alla v17.4.0 per il comando del generatore sostitutivo. Il lavoro è completo quando ogni pagina elencata usa il generatore dell'SDK, indica la major version dell'SDK (17.x) e pnpm validate viene superato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bot:needs-decision bot:take js-sdk-v17

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).

Lingua principale
MDX
Stelle
145
Fork
326
Merge medio
2g 18h
PR unite (30g)
109

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stellar/stellar-docs

Tutte le issue di stellar/stellar-docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.