Repository navigation
docs: Building Apps how-to guides, per-language SDK pages and Ride REPL page (ECO-190) - #32
Merged
Merged
Conversation
…ly Renovate updates (#26)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
…ide REPL page (ECO-190) How-to guides (04_building-apps/how-to/), each with a sample in docs/_samples: airdrop (mass transfer in batches of 100), payments (transfer attachment as invoice reference, checked with node-api-js), token exchange (fixed-price dApp), voting (one vote per address, locked verifier) and list arguments (FOLD over two list parameters). The three Ride scripts compile on the public Testnet node. SDK: 02_client-libraries-and-sdk.md becomes an overview; the TypeScript package table moves to sdk/01_typescript.md (check_sdk_table.py follows it) and sdk/02_java.md covers java-sdk 2.0.2, the latest on Maven Central. Its jars are compiled for Java 25 (class file version 69), not Java 11 as the old page said. Java samples live in docs/_samples/java and CI compiles them with JDK 25 (new java_samples_compile job). Tools: 01_developer-tools.md documents the node's compileCode, estimate and decompile endpoints and the current state of surfboard, ride-js and @decentralchain/ride; developer-tools/01_ride-repl.md covers @decentralchain/ride-repl 1.6.2, including the host globals (httpGet and hash functions) it needs to run outside a browser IDE. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Closes ECO-190.
What's in it
How-to guides: new pages in
04_building-apps/how-to/, linked from03_how-to-guides.md. Each page has a sample indocs/_samples.airdrop.tspayments.tsnode-api-jstoken-exchange.ts,ride/token-exchange.ridevoting.ts,ride/voting.ridelist-argument.ts,ride/list-argument.rideFOLD<10>SDK pages:
02_client-libraries-and-sdk.mdis now an overview. Each language page covers install, connecting to the Testnet, and signing and broadcasting, including error handling.sdk/01_typescript.mdnow holds the package table.check_sdk_table.pyand the drift workflow point to it.sdk/02_java.mdcoversjava-sdk2.0.2, the latest release on Maven Central. Samples are indocs/_samples/java.Tools
01_developer-tools.mdis expanded: the node'scompileCode,estimateanddecompileendpoints, and the current state of surfboard, ride-js and@decentralchain/ride.developer-tools/01_ride-repl.mdcovers@decentralchain/ride-repl@1.6.2.CI: new
java_samples_compilejob indocs_checks.yml. It runsmvn -q compileon Temurin 25.Facts that differ from the old pages or the package READMEs
Asset.DCCis also wrong: the class isAssetId.DCC..chainId(ChainId.TESTNET).httpGetand the hash functions (blake2b256,keccak256,sha256) as globals, which a host has to provide. The sample provides them fromts-lib-crypto.surfboard2.2.6 andride-js2.3.0 still depend on compiler packages outside the DecentralChain org. The page says so without naming that project.Verification
sphinx-build -W: no warnings. The independence grep and Vale are clean.npm run typecheckpasses indocs/_samples.mvn -q compilepasses on JDK 25.check_install_snippets.py(15 snippets) andcheck_sdk_table.py(22 rows) pass.check_ride_samples.py: all 7 Ride samples compile on the public Testnet node.ride-repl.ts,CreateAccount.javaandConnectToTestnet.java. The other samples haven't been broadcast, because that needs funded accounts. That is ECO-201.Notes for the reviewer
main, so this PR also brings ci: cut Actions minutes (path filters, pip cache, grouped Renovate) #26 and chore(deps): update dependency gitpython to v3.2.1 [security] #27 intodev. That accounts for therenovate.json,requirements.txtand workflow path-filter changes in the diff.transactions@5.0.1and so on), as the existing pages do. They get bumped when ECO-206 publishes new releases.03_ride-language/01_syntax-basics.rstand05_structures.rstusedecentralchainBalance(). The compiler rejects that name; the real one isdccBalance(). That fix belongs to the Ride reference ticket.🤖 Generated with Claude Code