dfinity / dfinity/developer-docs
guides: SNS inspection guide — how to query a live SNS and its canisters
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 4
- Forks
- 5
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 30
Description
Background
The Learn Hub article "How to Inspect an SNS and Its Dapp Canisters" was evaluated during the Learn Hub migration (#208) and intentionally deferred. It was not part of the old portal docs either.
The staging file is at .migration/learn-hub/how-does-icp-work/sns/how-to-inspect-an-sns-and-its-dapp-canisters.md (marked out-of-scope in the final cleanup).
What the guide would cover
A practical how-to for developers building governance tooling or verifying a live SNS deployment:
- List all deployed SNS instances (query
list_deployed_snseson the SNS-W canisterqaa6y-5yaaa-aaaaa-aaafa-cai) - List all canisters belonging to an SNS (
list_sns_canisterson the SNS root) - Get full canister status and controller hierarchy (
get_sns_canisters_summaryon the SNS root) - Find an SNS root from a known dapp canister ID
- Inspect SNS governance neurons (
list_neuronson the SNS governance canister) - Check token balances (swap, treasury) via
icrc1_balance_of
Why it was deferred
- The Learn Hub source uses
dfxthroughout (banned in this repo). All examples would need to be rewritten foricp canister call. - The content was never in the old portal developer docs.
- The audience is narrow: developers writing governance tooling or operators verifying their own SNS. Most of the canister hierarchy context is already documented in
concepts/sns-framework.md.
When picking this up
- Replace all
dfx canister callexamples withicp canister call. - Verify Candid argument syntax against the SNS governance Candid interface in
.sources/icskills/or the on-chain interface. - Place at
docs/guides/governance/inspecting-sns.mdand add a sidebar entry under the Governance section. - Load the
technical-documentationandsns-launchskills before writing.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with .migration/learn-hub/how-does-icp-work/sns/how-to-inspect-an-sns-and-its-dapp-canisters.md and the SNS governance Candid interface in .sources/icskills/. Replace the listed dfx examples with icp canister call, create docs/guides/governance/inspecting-sns.md, and add its Governance sidebar entry. Done means the six inspection tasks are covered with verified argument syntax and the technical-documentation and sns-launch skills have been loaded.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100