Update the Fuel Rust SDK book to match latest development #258
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
adlerjohn
suggested changes
May 6, 2022
docs/src/getting-started/basics.md
Outdated
Comment on lines
95
to
98
| pub const DEFAULT_GAS_LIMIT: u64 = 1_000_000; | ||
| pub const DEFAULT_GAS_PRICE: u64 = 0; | ||
| pub const DEFAULT_BYTE_PRICE: u64 = 0; | ||
| pub const DEFAULT_MATURITY: u32 = 0; |
There was a problem hiding this comment.
Could just permalink to the source file? And add extensive docstrings to the constants.
MujkicA
reviewed
May 6, 2022
| ## Calling and configuring contract calls | ||
|
|
||
| Once you've deployed your contract, as seen in the previous section, you'll likely want to call contract methods and configure some parameters such as gas price, byte price, gas limit, and forward coins in your contract call. | ||
|
|
There was a problem hiding this comment.
The contract_instance seems to appear out of nowhere, maybe include something like:
Suggested change
| Start by creating an instance of `MyContract`: | |
| ```Rust | |
| let contract_instance = MyContract::new(contract_id.to_string(), provider, wallet); | |
| ``` |
There was a problem hiding this comment.
Oh that's a great point, thanks!
MujkicA
reviewed
May 6, 2022
docs/src/getting-started/basics.md
Outdated
| // this is a big number for checking that amount can be a u64 | ||
| let call_params = CallParameters::new(Some(1_000_000), None); | ||
|
|
||
| let response = instance |
There was a problem hiding this comment.
Consistency nitpick
Suggested change
| let response = instance | |
| let response = contract_instance |
MujkicA
reviewed
May 6, 2022
docs/src/getting-started/basics.md
Outdated
| let address = wallet.address(); | ||
|
|
||
| // withdraw some tokens to wallet | ||
| instance |
There was a problem hiding this comment.
Suggested change
| instance | |
| contract_instance |
MujkicA
previously approved these changes
May 6, 2022
docs/src/getting-started/basics.md
Outdated
|
|
||
| ### Contract calls calling other contracts | ||
|
|
||
| Sometimes, you might need to call your contract, which calls other contracts. To do so, you must feed the external contract IDs that your contract depends on to the method you're calling. You do it by chaining `.set_contracts(&[external_contract_id, ...])` to the method you want to call. For instance: | ||
|
|
||
| ```Rust | ||
| let response = my_contract |
There was a problem hiding this comment.
Suggested change
| let response = my_contract | |
| let response = contract_instance |
MujkicA
reviewed
May 6, 2022
MujkicA
reviewed
May 6, 2022
adlerjohn
approved these changes
May 6, 2022
Salka1988
approved these changes
May 6, 2022
| let (provider, wallet) = setup_test_provider_and_wallet().await; | ||
|
|
||
| // Load the compiled Sway contract (this is the output from `forc build`) | ||
| let compiled = Contract::load_sway_contract( |
There was a problem hiding this comment.
Perhaps we should include in the documentation for the new function load_sway_contract_with_salt() and how and when to use it?
There was a problem hiding this comment.
That's a good point! As we discussed earlier, I'll add this (and some other wallet-related stuff) on the next batch of doc updates -- I'm trying to keep this one bite-sized.
|
|
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.
Updates the mdbook to include and match all that's new to the SDK.