Skip to main content
info

For Cadence 0.42 go to Legacy Docs

Account Linking

Account linking is a unique Flow concept that enables sharing ownership over accounts. In order to understand how we can achieve that we must first understand how accounts on Flow are accessed.

Accounts on flow can be accessed in Cadence through two types, PublicAccount and AuthAccount. As the name implies the PublicAccount type gives access to all public account information such as address, balance, storage capacity, etc., but doesn't allow changes to the account. The AuthAccount type allows the same access as PublicAccount but also allows changing the account, including adding/revoking account keys, managing the deployed contracts, as well as linking and publishing Capabilities.

Flow account structure

Accessing AuthAccount​

Accessing the auth account allows for account modification, so it's essential to safeguard this access by mandating that transactions are signed by the account being accessed. A transaction can list multiple auth accounts it wants to access as part of the pre section of the transaction. Read more about transaction signing in the transaction documentation.

Since access to the AuthAccount object enables state change, the idea of account ownership actually translates to the ability to access the auth account. Traditionally, you might consider this the same as having key access on an account, but we'll see in just a minute how programmatic, ownership-level access is unlocked with Capabilities on Flow.

AuthAccount Capabilities​

Before proceeding the reader will need a clear understanding of Cadence capabilities to follow this section. Advanced features such as AuthAccount Capabilities are powerful but if used incorrectly can put your app or users at risk.

Cadence allows the creation of capabilities to delegate access to account storage, meaning any account that has a valid capability to another account object in the storage can access it. This is a powerful feature on its own. The access to the object can be limited when creating a capability so only intended functions or fields can be accessed.

Account linking is made possible by the extension of Capabilities on the AuthAccount object itself. Similar to how storage capabilities allow access to a value stored in an account's storage, AuthAccount capabilities allow access to an AuthAccount.

When referring to 'account linking' we mean that an AuthAccount capability is created by the parent account and published to another account. The account owning the AuthAccount capability which was made available to another account is the parent account. The account in possession of the capability given by the parent account becomes its child account.

Account linking on Flow

A link between two existing accounts on Flow can be created in two steps:

  1. a child account creates an AuthAccount capability and publishes it to the parent account.
  2. The parent account, claims that capability and can access the child's account through it.

Account linking steps on Flow

These two steps are implemented in Cadence as two transactions:

Create capability

The account B creates and publishes the AuthAccount capability to the account A at the address 0x01


_10
#allowAccountLinking
_10
_10
transaction {
_10
prepare(signer: AuthAccount) {
_10
let capability = signer.linkAccount(/private/accountCapA)!
_10
signer.inbox.publish(capability, name: "accountCapA", recipient: 0x1)
_10
}
_10
}

Claim capability

The account A claims the capability published by account B.


_10
transaction {
_10
prepare(signer: AuthAccount) {
_10
let capability = signer.inbox.claim<&AuthAccount>("accountCapB", provider: 0x2)!
_10
let accountRef = capability.borrow()!
_10
}
_10
}

What is account linking most useful for?​

Account linking was specifically designed to enable smooth and seamless onboarding of users to your Flow based application without them first requiring a wallet to do so. This pattern overcomes both the technical hurdle, as well as user's reluctance to install a wallet, and opens access to apps on Flow to every user. Users can experience an app without any delay while still offering a path to self-sovreign ownership.

Naturally, users may expect to use their account with another application, or otherwise move assets stored in that account elsewhere. When an app initially leverages account linking it creates the account instead of the user and is where that user's specific state is stored. At a later point, users can take ownership of the app account providing they possess a full Flow account, typically by installing a wallet app.

Account linking enables users to possess multiple linked child accounts from different apps. Complexities associated with accessing those child accounts are eliminated by abstracting access to them through the user's parent account. Simply put, child accounts are accessed and treated as a seamless part of the parent account.

All assets in the app account can now jump the walled garden to play in the rest of the Flow ecosystem. No transactions are needed to move assets from the child account to the parent account, as the parent account already has full access to the assets in the child account.

Multiple parent-child accounts on Flow

This shared control over the digital items in the in-app account enables users to establish real ownership of the items beyond the context of the app, where they can use their parent account to view inventory, take the items to other apps in the ecosystem, such as a marketplace or a game.

Most importantly, users are able to do this without the need to transfer the digital items between accounts, making it seamless to continue using the original app while also using other apps.

Security Considerations​

Account linking is a very powerful Cadence feature, and thus it must be treated with care. So far in this document, we’ve talked about account linking between two accounts we own, even if the child account is managed by a third-party application. But, we can't make the same trust assumptions about custodial accounts in the real world.

Creating an AuthAccount capability and publishing it to an account we don’t own means we are giving that account full access to our account. This should be seen as an anti-pattern.

warning

❗ Creating an AuthAccount capability and sharing it with third-party account is in concept the same as giving that person your account's private keys.

Because pure account linking can be dangerous, Flow introduces the HybridCustody contract that helps custodial applications regulate access and parent account manage their many child accounts.

Hybrid Custody and Account Linking​

Apps need assurances that their own resources are safe from malicious actors, so giving out full access might not be the form they want. Using hybrid custody contracts, the app still maintains control of their managed accounts, but they can:

  1. Share capabilities freely, with a few built-in controls over the types of capabilities that can be retrieved by parent accounts via helper contracts (the CapabilityFactory, and CapabilityFilter)
  2. Share additional capabilities (public or private) with a parent account via a CapabilityDelegator resource

Learn more about it in the Hybrid Custody documentation.

Guides​

  • Building Walletless Applications Using Child Accounts covers how apps can leverage Account Linking to create a seamless user experience and enable future self-custody.
  • Working With Parent Accounts covers features enabled by the core HybridCustody contract to access child account assets from parent accounts. This is useful for apps like marketplaces or wallets that are working with accounts that have potential child accounts.

Resources​

  • Forum Post where core concepts were introduced and discussed.
  • GitHub repository where HybridCustody core contract is maintained. Check out the repository for more advanced script or transaction examples.
  • Example Account Linking project with Magic.
  • Starter template for Niftory Account Linking API.
  • Scaffold to start a new Account Linking project. Check out Flow CLI Scaffolds to get started.
  • Wallet API is a microservice that enables apps to custody accounts. This is useful if you don't want to use a third-party service to manage user accounts.
  • Walletless Arcade example demonstrates Account Linking with a local key management solution.