Repository navigation
Correct Stellar CLI binding languages and spec command - #3153
Open
stellar-doxie[bot] wants to merge 1 commit into
Open
stellar-doxie[bot] wants to merge 1 commit into
stellar-doxie[bot] wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
🤖 Automated message from the Stellar Triage Bot. Reviewing because this is my own PR for Raven issue #3151. Verified: the binding list and the What I checked
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 Automated message from the Stellar Triage Bot.
Closes #3151
Working this because the raven label called me in on a Raven finding (sd-110).
The Lab Contract Explorer page said the Stellar CLI generates bindings in TypeScript, JSON, Rust, Python, and Java. The CLI has no JSON bindings, and Python and Java need an external plugin. This PR corrects the list. It also fixes two pages that sent readers to
stellar contract bindingsfor the JSON contract spec, which the CLI no longer does.Why this matters
A reader runs
stellar contract bindings jsonorpythonand gets an error. Readers of the other two pages look for a spec command in the wrong place.Changes
docs/tools/lab/smart-contracts/contract-explorer.mdx: Rust from the CLI; TypeScript from the JavaScript Stellar SDK generator (the CLI command is deprecated); Python, Java, and others through a plugin. The two relative links on that line are now root-relative.docs/learn/fundamentals/contract-development/overview.mdx:123anddocs/build/guides/dapps/frontend-guide.mdx:370: point tostellar contract info interface, which outputs the spec. The second line also had the typo "genrated".Sweep
docs/build/guides/dapps/working-with-contract-specs.mdx:73and:86teachstellar contract bindings json. Left out: CLI commands on 8 pages fail with the current CLI: removed flags and subcommands #2973 already tracks that page, and it needs a rewrite (the JSON shape differs), not a command swap.docs/tools/cli/stellar-cli.mdxis already correct.stellar/laboratorysrc/app/(sidebar)/smart-contracts/contract-explorer/components/Bindings.tsx:8-11.Verified
Verified against stellar-cli 30.0.1, the newest release. The issue cited 30.0.1 too. The page pins none.
stellar contract bindings --help: rust; typescript marked deprecated; python, java, flutter, swift, php, kmp "(requires external plugin)".stellar contract bindings python: "not implemented in the stellar-cli" and points to lightsail-network/stellar-contract-bindings.stellar contract bindings json: "unrecognized subcommand 'json'".stellar contract info interface --wasm hello_world.wasm --output json-formattedprinted thefunction_v0spec of a freshstellar contract initcontract.## CLIheading that#clilinks to (stellar/js-stellar-sdk main README.md:291).pnpm format:mdx,pnpm checkandpnpm check:linkspass locally.Not verified
Overlaps
docs/learn/fundamentals/contract-development/overview.mdx. The hunks are in different sections (line 68 vs line 123), so either can merge first.For the Raven recheck (sd-110)