Enhance account documentation with utility functions and examples #1403
Conversation
- Updated the accounts.adoc file to correct minor formatting issues in usage examples. - Added a new section on Account Utilities in the account.adoc file, detailing utility functions for executing calls, validating signatures, and verifying transaction versions. - Included comprehensive descriptions of utility functions and constants related to account management.
|
hello @ericnordelo , the pull request is ready for review please review it when you have time. |
|
Hey @markv44. Thanks for taking the time to contribute! We will go through the PR and give some feedback later this week. |
|
Hey @ericnordelo soft reminder to review the pr. Thanks again. Cheers |
|
Hey @markv44. You can check how the docs would look by going to the Deploy Preview action executed in the PR for the latest commit. If you go there, you can see there's a few broken sections that we need to handle. After that, I will leave feedback about the structure and the content. Thanks for the patience! |
|
Hi @ericnordelo , I checked the Deploy Preview for Could you point me to the correct AsciiDoc syntax or an example in the docs for formatting these definitions? Thanks! |
|
Hey @markv44, on the same page where you added the Account Utilities there are examples on how to use the attributes in the right way. |
… descriptions - Merged updates to the Account Utilities section in accounts.adoc, adding comprehensive descriptions for utility functions such as `execute_call`, `is_valid_transaction_version`, `hash_transaction`, and `verify_signature`. - Introduced constants `VALIDATION_SUCCESS` and `VALIDATION_FAILED` with explanations for their usage in validation functions.
|
Hello @ericnordelo , would you please take a look at the CI failures, I dont think they are related to my code changes, if I missed something please advice how should I fix them. |
| @@ -527,6 +527,7 @@ await provider.waitForTransaction(tx.transaction_hash); | |||
|
|
|||
| == Account Utilities | |||
|
|
|||
| <<<<<<< Updated upstream | |||
There was a problem hiding this comment.
This is probably an issue with merging that needs to be addressed.
…amline documentation to focus on the `AccountComponent` utility functions. This update enhances clarity and relevance in the documentation.
|
Hey @ericnordelo I have changed the merging issues but now the tests are failing, can you please check why the test are failing? |
Fixes #1016
PR Checklist