Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New soroban_readme.md for Soroban sdk usage #516

Open
sreuland opened this issue Aug 23, 2023 · 0 comments
Open

New soroban_readme.md for Soroban sdk usage #516

sreuland opened this issue Aug 23, 2023 · 0 comments

Comments

@sreuland
Copy link
Contributor

What problem does your feature solve?

lack of high level developer focused docs to assist with rapidly writing java sdk code that invokes a soroban contract.

there are many unit tests that demonstrate separate portions of the soroban sdk usage, but a high level opinionated writeup explaining the sdk code that can invoke contracts and navigate the simulations and bump/restore aspects.

What would you like to see?

  • a new soroban_readme.md which provides a 'in a nutshell' section on using the sdk to interact with soroban contracts, with a sdk code example of invoking a contract, handling simulation responses, fees, and potential restore/bump retries for expired entries.

  • reuse links to existing soroban docs for all high level concepts - https://soroban.stellar.org/docs/category/fundamentals-and-concepts, avoid duplicated content.

  • add a section for Development , link to Soroba#RPC for explanation of the stack and how to use quickstart for local dev on standalone or futurenet network.Quickstart#Soroban Development

What alternatives are there?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants
@sreuland and others