onflow / onflow/docs

Expand on Capability configuration required for account linking

Open
#1,141 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation improvement
Dominant language
TypeScript
Stars
13
Forks
81
PR merge metrics
No merged PRs in 30d

Description

Description

A recent question in Discord reveals a lack of docs coverage on configuring child account NFT collections for access from a parent account. This same question has been raised at least one other time in Discord.

The two account linking guides should be updated with a section or a callout covering the use of Capabilities. A dropdown section and diagram with an explainer on how Capabilities are leveraged to facilitate accessing assets from child accounts would also be helpful for conceptual understanding.

Guidance should cover the fact that child account collections should be configured to include the issuance of a Capability ( e.g. auth(NonFungibleToken.Withdraw) &{ExampleNFT.ExampleNFTCollectionPublic, NonFungibleToken.CollectionPublic, NonFungibleToken.Provider} as shown here) so a CapabilityController can be accessed via the parent account.

It should also be noted that this Capability should not be published, simply issued during setup. An explicit reference to the error they might encounter if they don't complete this step would also be helpful - [Error Code: 1101] cadence runtime error: Execution failed: error: panic: no controller found for capType.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the two account linking guides and review the linked setup_full.cdc example for the Capability configuration context. Update the guides with the requested explanation, callout or dropdown, diagram, issuance-versus-publication guidance, and error reference; the work is done when child-account collection setup and parent-account access are understandable without Discord context.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.