Repository navigation
Document Generating and Using Contract Bindings and SDKs #465
Description
Document how client developers get typed bindings for the contracts, how to keep them in sync with the deployed WASM, and how the generated types map to the data types reference.
Proposed steps:
- Create
docs/guides/contract-bindings.md. - Document generating TypeScript bindings from a built WASM or a deployed contract ID with the Stellar CLI, including the exact commands and output layout.
- Document how workspace types (
i128,BytesN<32>,Vec<T>, custom structs and enums) surface in the generated client, with conversion pitfalls (bigint handling, address formats, enum representation). - Provide a minimal working client example: instantiate, read (
get_invoice), and write (pay_invoice) with signing. - Document versioning: regenerating bindings after an interface change, and how to detect a mismatch between client bindings and the deployed contract.
- Document network configuration for local, testnet, and mainnet clients.
Acceptance criteria:
docs/guides/contract-bindings.mdexists.- Binding generation commands are verified against the current toolchain.
- Type mapping pitfalls are documented with examples.
- A minimal read-and-write client example is included and runnable.
Activity
achebejohnpaul commentedon Aug 30, 2026
Am a full-Stack Engineer focused on frontend, backend, APIs, automation, and modern web technologies. Passionate about solving real-world problems, contributing to open source, and delivering clean, scalable, review-ready solutions.
Ranjeet2063 commentedon Sep 6, 2026
Hey team, I would love to tackle this issue!
Execution Plan for
Document Generating and Using Contract Bindings and SDKs:Document Generating and Using Contract Bindings and SDKswith explicit auth checks (require_auth), clean DataKey storage, and zero-overflow arithmetic.ContractErrorvariants.Why assign me?
Happy to pick this up immediately—please assign to me!
guptakumarranjeet150 commentedon Sep 9, 2026
Hi maintainers,
I can tackle
Document Generating and Using Contract Bindings and SDKs. Proposed implementation roadmap:ShadeProtocol/shade-stellar-contractDocument Generating and Using Contract Bindings and SDKswith explicitrequire_authchecks, clean storage layouts, and robust Soroban contract logic.Excited to work on this—please assign to me and I'll submit a clean PR shortly!
shobhamerabacha-star commentedon Sep 9, 2026
Hi maintainers,
I can tackle
Document Generating and Using Contract Bindings and SDKs. Proposed implementation roadmap:ShadeProtocol/shade-stellar-contractDocument Generating and Using Contract Bindings and SDKswith explicitrequire_authchecks, clean storage layouts, and robust Soroban contract logic.Excited to work on this—please assign to me and I'll submit a clean PR shortly!
ranjeet150 commentedon Sep 12, 2026
Hi maintainers,
I can tackle
Document Generating and Using Contract Bindings and SDKs. Proposed implementation roadmap:ShadeProtocol/shade-stellar-contractDocument Generating and Using Contract Bindings and SDKswith explicitrequire_authchecks, clean storage layouts, and robust Soroban contract logic.Looking forward to contributing—please feel free to assign!
alexander22-dev commentedon Sep 28, 2026
@alexander22-dev has applied to work on this issue as part of the Stellar Wave Program's 9th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @alexander22-dev to this issue.
temitope-007 commentedon Sep 28, 2026
@temitope-007 has applied to work on this issue as part of the Stellar Wave Program's 9th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @temitope-007 to this issue.
0xDeon commentedon Sep 28, 2026
@0xDeon has applied to work on this issue as part of the Stellar Wave Program's 9th wave.
ℹ️ Repo Maintainers: To accept this application, review their application or assign @0xDeon to this issue.
drips-wave commentedon Sep 28, 2026
Congratulations, @0xDeon! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on September 30, 2026.
🧑💻 @0xDeon: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.
Warning
When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.
🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.
🌊 Happy Wave 🌊
drips-wave commentedon Sep 29, 2026
This issue has been completed by @0xDeon as part of the Stellar Wave Program's 9th Wave 🥳
😎 @0xDeon: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.
🧑💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.
docs(guides): add contract bindings and SDK generation guide (closes S…