docs: add deploy-your-own-splitter guide#302
Open
olaleyeolajide81-sketch wants to merge 3 commits into
Open
Conversation
Closes tributary-protocol#134 Add a five-minute SDK quickstart (install, read a split, create one, pay through it) and link it from the README. Include the new doc in the CI markdown-link check.
Walk through building the splitter wasm and deploying it to testnet with the Stellar CLI, referencing scripts/deploy.sh. Cover SDK regeneration, dashboard wiring, and troubleshooting. Link from README and add to the CI markdown-link-check job. Closes tributary-protocol#143
Contributor
|
This PR's |
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.
Summary
Closes #143. Adds a step-by-step guide for building and deploying your own splitter contract to the Stellar testnet using the Stellar CLI.
docs/deploy.md: prerequisites, building thewasm32v1-nonewasm, deploying viascripts/deploy.sh, smoke-testing withscripts/demo.sh, regenerating the TypeScript SDK bindings from the deployed instance, optionally wiring up the web dashboard, and a troubleshooting section.scripts/deploy.shthroughout (prerequisites, deploy step, troubleshooting).README.md.docs/deploy.mdto the CImarkdown-link-checkjob so broken doc links fail CI.Why
Issue #143 asked for a deploy-your-own-splitter guide that walks through building and deploying the contract with the Stellar CLI and references
scripts/deploy.sh. This gives contributors and fork maintainers a clear, copy-pasteable path from source checkout to a live contract instance and a regenerated SDK.Acceptance Criteria
scripts/deploy.sh(prerequisites, step 2, troubleshooting).no_std/ typed-error contract constraints are unaffected (no contract code changes).markdown-link-checknow includesdocs/deploy.mdand passed locally.Verification
markdown-link-checkonREADME.md+ alldocs/*.md(includingdeploy.md): passed locally (exit 0, no broken links).cargo fmt --all,cargo clippy --all-targets -- -D warnings, andcargo testare unaffected by a docs-only change;npm run buildfor the sdk/app is unaffected.Test plan
cargo build --release --target wasm32v1-none -p tributary-splitterstellar keys generate deployer --network testnet --fund./scripts/deploy.sh deployer./scripts/demo.sh deployerstellar contract bindings typescript --contract-id "$(stellar contract id splitter --network testnet)" --network testnet --output-dir sdk --overwriteChecklist
cargo fmt --all/cargo clippy --all-targets -- -D warningspass (no Rust changes)cargo testpasses (no Rust changes)closes #143