Resources and Transactions

Transaction samples to get you started

What you probably need

We anticipate that most applications will fall under one of two categories.

  1. Share all NFT Collections with a parent, and nothing else

  2. 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

chevron-rightShare all NFT Collectionshashtag

Use this setup flow if you want to give access to all NFT Collections with a parent account.

chevron-rightShare access to some NFT Collections (allow list)hashtag

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.

Once you have your Filter created, you can initialize and publish your child account

chevron-rightShare access to all but some NFT Collections (deny list)hashtag

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.

Once you have your Filter created, you can initialize and publish your child account

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.

circle-info

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.

triangle-exclamation

Capability Factory pre-made resources

chevron-rightAll NFT standard interfaceshashtag

Testnet - 0x1055970ee34ef4dcarrow-up-right

Mainnet - 0xee9ff4f07a2d6dadarrow-up-right

This pre-made CapabilityFactory resource can be used if you want to give a parent account access to the following Capability<T> types:

  • &{NonFungibleToken.CollectionPublic}

  • &{NonFungibleToken.Provider, NonFungibleToken.CollectionPublic}

  • &{NonFungibleToken.Provider}

chevron-rightAll FungibleToken standard interfaceshashtag

Testnet - 0x08bed9e8508ed20earrow-up-right

Mainnet - 0x410aa603925923d9arrow-up-right

This pre-made CapabilityFactory resource can be used if you want to give a parent account access to the following Capability<T> types:

  • &{FungibleToken.Provider}

  • &{FungibleToken.Provider, FungibleToken.Balance, FungibleToken.Receiver}

  • &{FungibleToken.Balance}

  • &{FungibleToken.Receiver}

  • &{FungibleToken.Receiver, FungibleToken.Balance}

chevron-rightAll NFT and Fungible Token interfaceshashtag

Testnet - 0x1b7fa5972fcb8af5arrow-up-right

Mainnet - 0x071d382668250606arrow-up-right

This pre-made CapabilityFactory resource can be used if you want to give a parent account access to the following Capability<T> types:

  • &{NonFungibleToken.CollectionPublic}

  • &{NonFungibleToken.Provider, NonFungibleToken.CollectionPublic}

  • &{NonFungibleToken.Provider}

  • &{FungibleToken.Provider}

  • &{FungibleToken.Provider, FungibleToken.Balance, FungibleToken.Receiver}

  • &{FungibleToken.Balance}

  • &{FungibleToken.Receiver}

  • &{FungibleToken.Receiver, FungibleToken.Balance}

circle-info

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

chevron-rightAllow all filterhashtag

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.

Testnet - 0xe2664be06bb0fe62arrow-up-right

Mainnet - 0x78e93a79b05d0d7darrow-up-right

Common Transactions

chevron-rightSet up a child accounthashtag

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

Testnetarrow-up-right

Mainnetarrow-up-right

chevron-rightPublish a child accounthashtag

Takes the account which should be the child of another account and publishes it for the parent to redeem.

Testnetarrow-up-right

Mainnetarrow-up-right

chevron-rightRedeem a child accounthashtag

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

Testnetarrow-up-right

Mainnetarrow-up-right

chevron-rightRemove a child accounthashtag

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.

Testnetarrow-up-right

Mainnetarrow-up-right

chevron-rightRemove a parent accounthashtag

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

Testnetarrow-up-right

Mainnetarrow-up-right

Last updated