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

Replace state_get_balance with query_balance #1282

Merged
merged 2 commits into from
Sep 21, 2023

Conversation

ipopescu
Copy link
Collaborator

What does this PR fix/introduce?

Removing the "state_get_balance" documentation and examples, since it has been deprecated in favor of "query_balance".

  • The examples in querying-network.md are the actual commands and responses.
  • The examples in verify-transfer.md are taken from querying-network.md, but have been modified to fit the tutorial (using the same account hashes and state root hash, to match the transfer flow). Eventually, we need to refresh the entire tutorial with fresh examples.
  • In minimal-compliance.md, I found the following explanation confusing, so I'd like to simplify it by removing the crossed-out section. If it adds value to this point, please let me know.
    chain_get_state_root_hash - The state root hash is one of the several global state identifiers used to query the network state after deployments, and the only way to do so in the context of state_get_balance and state_get_dictionary_item. A minimal SDK requires both dependent methods.

Closes #1253

Checklist

(Delete any that aren't relevant)

  • Docs are successfully building - yarn install && yarn run build.
  • My changes follow the Casper docs style guidelines.
  • All technical procedures have been tested (if you want help with this, mention it in Reviewers).

Reviewers

@ACStoneCL

@github-actions
Copy link

github-actions bot commented Sep 20, 2023

Copy link
Contributor

@ACStone-MTS ACStone-MTS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! One suggestion that could go either way.

@ipopescu ipopescu merged commit ce09d0c into dev Sep 21, 2023
16 checks passed
@ipopescu ipopescu deleted the 1253_remove_state_get_balance branch September 21, 2023 19:40
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.

Remove deprecated state_get_balance documentation
2 participants