We anticipate that most applications will fall under one of two categories.
Share all NFT Collections with a parent, and nothing else
Share some NFT Collections with a parent, and nothing else
Importantly, both of these setup options give no access to Fungible Token capabilities that are not on public paths. Below are some sample transactions depending on the kind of steps you want to follow. You can deploy your own version of the CapabilityFactory and CapabilityFilter resources should you want to customize their behavior
Share all NFT Collections
Use this setup flow if you want to give access to all NFT Collections with a parent account.
Testnet
(if you can sign from both accounts)
Mainnet
(if you can sign from both accounts)
Share access to some NFT Collections (allow list)
Use this setup flow if you want to give access to specific NFT Collections with a parent account
NOTE: Unlike sharing access to all collections, there is no pre-made sample that can be used to express an allow-list. You must create one yourself and decide how to manage it.
Allow List Filter Management
Testnet
Mainnet
Once you have your Filter created, you can initialize and publish your child account
Multi-step
Testnet
Mainnet
All in one transaction (set up child and publish parent in one transaction)
Share access to all but some NFT Collections (deny list)
Use this setup flow if you want to give access to all NFT Collections except the types you add to your deny list
NOTE: Unlike sharing access to all collections, there is no pre-made sample that can be used to express a deny-list. You must create one yourself and decide how to manage it.
Allow List Filter Management
Testnet
Mainnet
Once you have your Filter created, you can initialize and publish your child account
All in one transaction (set up child and publish parent in one transaction)
Multi-step
Testnet
Mainnet
Pre-made resources
Flow has created a few common resources for you to use. If you would like to set your own up, you can find a link to set transactions for each resource to run on your own account to get the same effect.
What Capability types can be obtained?
The CapabilityFactory used in a ChildAccount resource is used to express what types T can be obtained from a child account from a parent. For example, a CapabilityFactory with an entry that can return Capability<&{NonFungibleToken.Provider}> would be giving the ability for a parent to obtain NFT Provider capabilities.
A Capability can only be obtained if a child account's CapabilityFilter permits it, there is a CapabilityFactory for the type of the Capability requested, and the path being requested exists.
Capability Factory pre-made resources
All NFT standard interfaces
This pre-made CapabilityFactory resource can be used if you want to give a parent account access to the following Capability<T> types:
Once an account is published, you can claim them from your specified parent address using the Redeem a child account transaction
Capability Filter pre-made resources
Allow all filter
The allow all filter allows any resource to be borrowed from a child account, provided that it can be obtained through the child account's Capability Filter.
Common Transactions
Set up a child account
Configures the necessary resources on what will become a child account. Once set up, you will be ready to publish the account to any other address for it to redeem and become a parent
Publish a child account
Takes the account which should be the child of another account and publishes it for the parent to redeem.
Redeem a child account
In order for a child account to be accessible to a parent, it must be redeemed, first. While redeeming, you can set some metadata about the child account to make it easily identifiable to platforms
Remove a child account
If you are a parent account and no longer wish to have a particular child account anymore, you can unlink it. Doing so will revoke the ability to access a child's capabilities from the parent account, but could be added later if the child publishes their account to the parent again.
Remove a parent account
A child account is able to remove parent accounts at any time. Doing so will prevent the removed parent from accessing any new capabilities. However, it will not unlink any existing capabilities the parent already has
The order of types specified by a CapabilityFactory matter! There is an to handle this. Until it is settled, please take note of the types you are linking or expecting to be accessible.