Add example usage for various common JavaScript utilities

Shaptic commented 1 year ago

What problem does your feature solve?

There is a lack of "discoverability" for certain helpers and features in the JavaScript SDK.

People ask questions on Discord frequently about things that are very easy to do if you know about them, but knowing about them requires unnecessarily intimate knowledge about the SDK. Now that it has stabilized, we should take the time to raise the visibility of these helpful devX features.

What would you like to see?

Like with State Expiration, there should be brief demonstrations of how things are done via the JS SDK. Here's a non-exhaustive list:

[ ] Events should cover Server.getEvents and humanizeEvents
[ ] Authorization should cover authorizeInvocation and friends as well as buildInvocationTree.
[ ] Interacting with Contracts: Preflight should discuss Server.simulateTransaction and its related utilities

What alternatives are there?

A lot of this already exists in example dapps and other "fully featured" demos, but this hurts discoverability and ramping up for new users.

sreuland commented 1 year ago

maybe the soroban-examples-dapp repo could be one place to codify these examples in code.

janewang commented 6 months ago

@Shaptic Do you have time to help out contributing to our docs? This is a great one :)

stellar / stellar-docs