Example snippets of code to be directly copied into documentation while being sure that they compile successfully.
The project is structured as a set of simple executable targets:
- CreateIdentity (doc page)
- RecoverIdentity (doc page)
- CreateAccount (doc page)
- SignAndSendTransfer (doc page)
- ListIdentityProviders (doc page)
Except for ListIdentityProviders, the "main" code of each snippet is hosted in a runner function named by the snippet.
This function is executed by withGRPCClient, which provides the NodeClient expected by the runner.
The library Common contains a set of small functions that are used by multiple snippets. All the snippets share a dependency to this library.
Run swift build from this directory.
The snippets are meant purely for documenting how to use the SDK. Even though they're organized as executables, they're not actually meant to be run - just compiled.
Some of the snippets do run while others have unimplemented "todo" parts that need to be provided by a hosting application.
Such commands (currently only CreateIdentity) will fail because they don't know how to, for example, open a web page.
Also, all inputs are hardcoded; no snippets accept any arguments.
Use the command swift run <snippet> to try running the snippet named <snippet> from the list above.
See the CLI example for a "proper" tool with parameterized commands.