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

Add previous custom types contract back in as simple_custom_types #322

Merged
merged 4 commits into from
Aug 9, 2024

Conversation

sisuresh
Copy link
Contributor

@sisuresh sisuresh commented Aug 6, 2024

What

#313 rewrote the custom-types contract. This PR adds that contract back in under a slightly different name so this documentation stays current https://developers.stellar.org/docs/build/smart-contracts/example-contracts/custom-types. If this PR is accepted, the docs will need to link to this contract instead.

It would be ideal if the current custom-types contract could be renamed or moved instead, but I'll defer to @BlaineHeffron / @fnando / @chadoh on that because the CLI uses it.

@leighmcculloch
Copy link
Member

leighmcculloch commented Aug 7, 2024

It would be ideal if the current custom-types contract could be renamed or moved instead, but I'll defer to @BlaineHeffron / @fnando / @chadoh on that because the CLI uses it.

+1 the custom types example being resurrected in this pr should be the custom types example because it is simpler and easier to understand by a much wider variety of folks with different backgrounds. @sisuresh Can you rename the example in this PR to custom_types to replace the example?

I'm not really sure the example that was added in #313 really belongs in examples, even under a different name, because it isn't hyper-focused on a simple example. It's actually a test vector for the js-stellar-sdk, and the examples repo is not intended to host test vectors. The other repos like the rs-soroban-sdk, and rs-soroban-env, that need specific test vectors host their own test vectors internally. Test vectors are often poor examples due to other noise and conflicting intent.

For the moment I suggest we rename the #313 custom type example to custom_type_more_types or something else while we give the js-stellar-sdk space to figure out a path forward.

Potentially we need a soroban-test-vectors repo where non-example test-vectors can live. cc @Shaptic

@leighmcculloch leighmcculloch merged commit f42ae73 into stellar:main Aug 9, 2024
89 checks passed
chadoh added a commit to AhaLabs/js-stellar-sdk that referenced this pull request Sep 10, 2024
The custom-types contract was renamed in
stellar/soroban-examples#322. The e2e end tests
have been failing since then. This uses the renamed example contract to
fix the tests.

This also updates the pinned version of Stellar CLI. The latest CLI
fixes the bug that two tests were working around, so we no longer need
these tests.
Shaptic pushed a commit to stellar/js-stellar-sdk that referenced this pull request Sep 12, 2024
The custom-types contract was renamed in
stellar/soroban-examples#322. The e2e end tests
have been failing since then. This uses the renamed example contract to
fix the tests.

This also updates the pinned version of Stellar CLI. The latest CLI
fixes the bug that two tests were working around, so we no longer need
these tests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants