feat: use JS SDK's Client for "invoke contract" #1101
Merged
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
chadoh
force-pushed
the
feat/js-sdk-invoke
branch
from
6947bcd to
44d1161
Compare
|
Preview is available here: |
willemneal
reviewed
Nov 26, 2024
|
Preview is available here: |
|
@chadoh and @willemneal, howdy! Are we still working on this one? Waiting on anything? Thanks! :) |
chadoh
added a commit
to AhaLabs/js-stellar-sdk
that referenced
this pull request
Dec 17, 2024
@willemneal [pointed out](stellar/stellar-docs#1101 (review)) that it's a bit of a bummer to create accounts with a pure-SDK interface just to revert to `fetch` and a hard-coded Friendbot URL in order to fund that account. This uses `rpc.Server#requestAirdrop` to do the funding. I find the name of this method a bit unexpected! I wonder if the language here has evolved since the method was first added.
chadoh
added a commit
to AhaLabs/js-stellar-sdk
that referenced
this pull request
Dec 20, 2024
@willemneal [pointed out](stellar/stellar-docs#1101 (review)) that it's a bit of a bummer to create accounts with a pure-SDK interface just to revert to `fetch` and a hard-coded Friendbot URL in order to fund that account. This uses `rpc.Server#requestAirdrop` to do the funding. I find the name of this method a bit unexpected! I wonder if the language here has evolved since the method was first added.
chadoh
added a commit
to AhaLabs/js-stellar-sdk
that referenced
this pull request
Dec 20, 2024
@willemneal [pointed out](stellar/stellar-docs#1101 (review)) that it's a bit of a bummer to create accounts with a pure-SDK interface just to revert to `fetch` and a hard-coded Friendbot URL in order to fund that account. This uses `rpc.Server#requestAirdrop` to do the funding. I find the name of this method a bit unexpected! I wonder if the language here has evolved since the method was first added.
chadoh
force-pushed
the
feat/js-sdk-invoke
branch
2 times, most recently
from
28dbcaa to
b491346
Compare
This page contained a very complicated, old-school example of how to
invoke a smart contract. I've updated it with how to use
`contract.Client`.
I made this somewhat more complicated than it needs to be, showing how
to also deploy a new contract from an already-uploaded Wasm hash. I
wanted to do this for a few reasons:
- The part where we actually call `increment` has become so simple that
the page feels almost unnecessary, if that's all we show. (Although
maybe that would be good?)
- The example contract ID is almost certainly invalid. If people want to
walk through the whole thing, it would be nice to show them how to
walk through _the whole thing._
- It's actually fairly straightforward! It allows us to show off more of
Client's features.
That said, I would love to add the ability to deploy directly from a
file:
```ts
Client.deploy({ wasm: "path/to/some/file.wasm" })
```
If the JS SDK gains this ability, then we can clean up this example even
more, removing the `stellar contract install` CLI step.
chadoh
force-pushed
the
feat/js-sdk-invoke
branch
from
b491346 to
445c7e9
Compare
chadoh
added a commit
to AhaLabs/js-stellar-sdk
that referenced
this pull request
Dec 20, 2024
@willemneal [pointed out](stellar/stellar-docs#1101 (review)) that it's a bit of a bummer to create accounts with a pure-SDK interface just to revert to `fetch` and a hard-coded Friendbot URL in order to fund that account. This uses `rpc.Server#requestAirdrop` to do the funding. I find the name of this method a bit unexpected! I wonder if the language here has evolved since the method was first added.
|
Preview is available here: |
2 similar comments
|
Preview is available here: |
|
Preview is available here: |
janewang
pushed a commit
to stellar/js-stellar-sdk
that referenced
this pull request
Dec 20, 2024
@willemneal [pointed out](stellar/stellar-docs#1101 (review)) that it's a bit of a bummer to create accounts with a pure-SDK interface just to revert to `fetch` and a hard-coded Friendbot URL in order to fund that account. This uses `rpc.Server#requestAirdrop` to do the funding. I find the name of this method a bit unexpected! I wonder if the language here has evolved since the method was first added.
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.
This page contained a very complicated, old-school example of how to invoke a smart contract. I've updated it with how to use
contract.Client.I made this somewhat more complicated than it needs to be, showing how to also deploy a new contract from an already-uploaded Wasm hash. I wanted to do this for a few reasons:
incrementhas become so simple thatthe page feels almost unnecessary, if that's all we show. (Although
maybe that would be good?)
walk through the whole thing, it would be nice to show them how to
walk through the whole thing.
Client's features.
That said, I would love to add the ability to deploy directly from a file:
If the JS SDK gains this ability, then we can clean up this example even more, removing the
stellar contract installCLI step.Should we keep the old example?
Maybe it's nice to see a side-by-side of low-level JS SDK logic next to higher-level Client logic? Sort of a "peek under the hood", to show how much Client is doing. This seems most useful to SDK/client authors, since I can't imagine most app developers caring to dive into that logic. Unless they encounter some problem, and need to understand these lower-level details? Not sure if this is the document where we should do that, though. Honestly, it might be fine to refer them to the source code of
Client.