feat(bindings-ts)!: require configuring network settings #852
Conversation
This file contains 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
Shaptic
reviewed
Aug 11, 2023
cmd/crates/soroban-spec-typescript/src/project_template/README.md
Outdated
Show resolved
Hide resolved
cmd/crates/soroban-spec-typescript/src/project_template/src/method-options.ts
Show resolved
Hide resolved
|
What would a cli command now look like? I read the README but it's still not clear how to set the |
|
@tyvdh for now, there is no way to automatically generate a library with multiple configured networks. Library authors will need to manually update the Expanding the CLI command to accept multiple |
117c0b6 to
09a8054
Compare
paulbellamy
reviewed
Aug 14, 2023
cmd/crates/soroban-spec-typescript/src/project_template/src/method-options.ts
Show resolved
Hide resolved
5d47a6e to
b6eefd1
Compare
Shaptic
reviewed
Aug 16, 2023
Shaptic
approved these changes
Aug 17, 2023
Generated libraries now export a `Contract` class that needs to be instantiated by the user with RPC URL, Network Passphrase, and contract ID.
this logic was totally broken! thanks for showing us, tests.
you can see here that - the input needs the `as const` - but to make that work for complex types, a `readonly` is needed in the typing additionally, the input and output are typed differently: - the input needs to be wrapped in an array - the output does not also, for enums that do not have `values`, you still need to specify `values: undefined`
When we exported functions for each method, we needed to make sure we only used safe JS words. This no longer matters, since they're exposed as methods on the `Contract` class. Since this change required rebuilding the snapshot, I also made sure the `readonly` settings were added to the source, rather than manually to the snapshot.
Re: https://typedoc.org/tags/example/, it is best to use both `@example` and the triple-backtick code block
b6eefd1 to
f6b64d9
Compare
paulbellamy
approved these changes
Aug 18, 2023
willemneal
added a commit
to AhaLabs/stellar-cli
that referenced
this pull request
Aug 21, 2023
* feat(bindings-ts)!: require configuring network settings Generated libraries now export a `Contract` class that needs to be instantiated by the user with RPC URL, Network Passphrase, and contract ID. * feat(bindings-ts): add test config for generated fixtures * feat: test drive error-parsing in client libs this logic was totally broken! thanks for showing us, tests. * chore: add failing custom type test * chore: demonstrate complex enum shortcomings you can see here that - the input needs the `as const` - but to make that work for complex types, a `readonly` is needed in the typing additionally, the input and output are typed differently: - the input needs to be wrapped in an array - the output does not also, for enums that do not have `values`, you still need to specify `values: undefined` * chore: demonstrate many struct encoding problems * chore: demonstrate many struct encoding problems * feat: no more need for `Method` suffix When we exported functions for each method, we needed to make sure we only used safe JS words. This no longer matters, since they're exposed as methods on the `Contract` class. Since this change required rebuilding the snapshot, I also made sure the `readonly` settings were added to the source, rather than manually to the snapshot. * chore: finish testing all custom_type methods * chore: remove placeholder signing machinery * feat: add `networks` export to generated library * chore: update generated README * chore: fix formatting of generated file * build: appease clippy * docs: remove outdated '--name' from example * docs: fix example in doc comment Re: https://typedoc.org/tags/example/, it is best to use both `@example` and the triple-backtick code block * build: update snapshot build command * docs: improve method-options TSDoc --------- Co-authored-by: Willem Wyndham <willem@ahalabs.dev>
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.
What
Generated libraries now export a
Contractclass that needs to be instantiated by the user with RPC URL, Network Passphrase, and contract ID.They also export a
networksobject to help initializenetworkPassphraseandcontractIdwith known-valid settings.Surprise bonus: adds a
ts-testsdirectory with a test for alltest_custom_types.wasmexported methods! This exposed a couple easy-to-fix problems that were addressed, while marking other tests as known failures, which we can circle back to later. While adding these tests I also discovered some weird behavior. This is documented in the test cases; we can discuss how to best fix this behavior later.Why
Keeps libraries focused on behavior, not specific endpoints, which will make them more flexible. Still gives contract authors a way to tell users about known supported networks.
Known limitations
To do:
Right now the new tests are not incorporated into CI at all. Do we want to incorporate them into CI? How? It might require running a localnet node within CI and deploying the contract to it. This seems like a lot of work! Is there a project with a similar setup we can copy?