feat: CanisterStatus utility #572
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
| @@ -0,0 +1,245 @@ | |||
| /** @module CanisterStatus */ | |||
There was a problem hiding this comment.
Not sure if canisterStatus is a good name. time and subnet are not tied to the canister. Maybe call it StateTree to match with the interface spec?
There was a problem hiding this comment.
My reasoning is that StateTree sounds overly generic - state tree of what? The entire IC? State tends to be an overloaded term in frontend
The feature was motivated by me wanting to discover the ModuleHash, Metadata, Controllers, and Subnet of a canister. I'd like the naming to reflect that motivation, which should make it more discoverable.
the fact that this involves a state tree in a certificate is more or less an implementation detail, from my POV as a developer
Co-authored-by: Yan Chen <48968912+chenyan-dfinity@users.noreply.github.com>
Co-authored-by: Yan Chen <48968912+chenyan-dfinity@users.noreply.github.com>
Co-authored-by: Yan Chen <48968912+chenyan-dfinity@users.noreply.github.com>
…ty/agent-js into SDK-493-canister-state-api
Co-authored-by: Yan Chen <48968912+chenyan-dfinity@users.noreply.github.com>
ericswanson-dfinity
requested changes
May 19, 2022
ericswanson-dfinity
approved these changes
May 19, 2022
chenyan-dfinity
approved these changes
May 19, 2022
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.
Description
The CanisterStatus utility is used to request structured data directly from the IC public API. This data can be accessed using agent.readState, but CanisterStatus provides a helpful abstraction with some known paths.
You can request a canisters Controllers, ModuleHash, Candid interface, Subnet, or Time, or provide a custom path {@link CanisterStatus.CustomPath} and pass arbitrary buffers for valid paths identified in https://smartcontracts.org/docs/current/references/ic-interface-spec/.
How Has This Been Tested?
Unit testing & local e2e testing
Checklist: