Added the README's for cross-contract-calls & factory-contract. #1232
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
I made the README's for both folders following the standard used on the other folders that had a README within the folder of examples.
frol
requested changes
Aug 2, 2024
…oss-contract-examples
Just made the changes for the usage part and gave it more details on how to do it, like an step-by-step, and also got rid of unnecessary markdown
frol
requested changes
Aug 14, 2024
examples/factory-contract/README.md
Outdated
| 3. Deploy the factory contract: | ||
|
|
||
| ```bash | ||
| cargo near deploy --wasmFile path/to/factory-contract.wasm --accountId your-account.testnet |
There was a problem hiding this comment.
This command is invalid. Please, test all the commands
Suggested change
| cargo near deploy --wasmFile path/to/factory-contract.wasm --accountId your-account.testnet | |
| cargo near deploy |
examples/factory-contract/README.md
Outdated
| 4. Use the factory contract to create instances of the target contract: | ||
|
|
||
| ```bash | ||
| near call your-factory-contract-account.testnet create_instance '{"args": "value"}' --accountId your-account.testnet |
There was a problem hiding this comment.
This command is outdated, please, use the new syntax (it is suggested to you in the output):
Suggested change
| near call your-factory-contract-account.testnet create_instance '{"args": "value"}' --accountId your-account.testnet | |
| near contract call-function as-transaction your-factory-contract-account.testnet deploy_status_message json-args '{"account_id": "sub.your-factory-contract-account.testnet"}' prepaid-gas '100 Tgas' attached-deposit '0 NEAR' |
| ``` | ||
|
|
||
| NOTE: Replace `path/to/factory-contract.wasm` with the actual path to your compiled WebAssembly file, and `your-account.testnet` with your actual NEAR testnet account ID. | ||
|
|
There was a problem hiding this comment.
Demonstrate calls to simple_call and complex_call functions.
| - Call the high-level contract to initiate a cross-contract call to the low-level contract: | ||
|
|
||
| ```bash | ||
| near call your-high-level-contract-account.testnet call-function '{"args": "value"}' --accountId your-account.testnet |
There was a problem hiding this comment.
This does not demonstrate the actual function defined in the contract (factorial). Please, write the example to the specific contract at hand, not just some placeholder
…oss-contract-examples
…with the changes requested.
|
I just updated the README's @frol, please review them, thanks |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1232 +/- ##
==========================================
- Coverage 80.09% 80.02% -0.08%
==========================================
Files 102 102
Lines 14597 14597
==========================================
- Hits 11692 11681 -11
- Misses 2905 2916 +11 ☔ View full report in Codecov by Sentry. |
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 pull request is for the issue #152.
I made the README's for both folders, cross-contract-calls and factory-contract following the standard used on the other folders that had a README within the folder of examples.