diff --git a/delegation-toolkit/concepts/smart-accounts.md b/delegation-toolkit/concepts/smart-accounts.md index dbb47225d4b..298f217daef 100644 --- a/delegation-toolkit/concepts/smart-accounts.md +++ b/delegation-toolkit/concepts/smart-accounts.md @@ -39,11 +39,11 @@ ERC-4337 introduces the following concepts: The MetaMask Delegation Toolkit supports three types of MetaMask Smart Accounts, each offering unique features and use cases. -See [Configure accounts and signers](../how-to/create-smart-account/configure-accounts-signers.md) to learn how to use these different account types. +See [Create a smart account](../how-to/create-smart-account.md) to learn how to use these different account types. ### Hybrid smart account -The Hybrid smart account is a flexible implementation that supports both an externally owned account (EOA) "owner" and any number of P256 (passkey) signers. +The Hybrid smart account is a flexible implementation that supports both an externally owned account (EOA) owner and any number of P256 (passkey) signers. You can configure any of these signers as the signatory, and use them to sign any data, including user operations, on behalf of the smart account. This type is referenced in the toolkit as `Implementation.Hybrid`. diff --git a/delegation-toolkit/experimental/erc-7710-redeem-delegations.md b/delegation-toolkit/experimental/erc-7710-redeem-delegations.md index 1747929db51..f5d3854206d 100644 --- a/delegation-toolkit/experimental/erc-7710-redeem-delegations.md +++ b/delegation-toolkit/experimental/erc-7710-redeem-delegations.md @@ -84,7 +84,7 @@ Redeem a delegation with a [MetaMask smart account](#redeem-with-a-metamask-smar ### Redeem with a MetaMask smart account -To redeem a delegation with a MetaMask smart account, create a [`MetaMaskSmartAccount`](../how-to/create-smart-account/index.md#create-a-metamasksmartaccount) +To redeem a delegation with a MetaMask smart account, [create a smart account](../how-to/create-smart-account.md) and a [Viem Bundler Client](https://viem.sh/account-abstraction/clients/bundler). After setting up your Bundler Client, you can extend its functionality with `erc7710BundlerActions` actions to support ERC-7710. Once extended, use [`sendUserOperationWithDelegation`](../reference/api/experimental-actions/bundler-client.md#senduseroperationwithdelegation) to redeem the permission. diff --git a/delegation-toolkit/experimental/store-retrieve-delegations.md b/delegation-toolkit/experimental/store-retrieve-delegations.md index 3b6cde29fd6..5021496fe25 100644 --- a/delegation-toolkit/experimental/store-retrieve-delegations.md +++ b/delegation-toolkit/experimental/store-retrieve-delegations.md @@ -2,6 +2,7 @@ description: Store and retrieve delegations using the `DelegationStorageClient`. sidebar_position: 1 toc_max_heading_level: 2 +sidebar_class_name: hidden --- import Tabs from "@theme/Tabs"; diff --git a/delegation-toolkit/get-started/delegation-quickstart.md b/delegation-toolkit/get-started/delegation-quickstart.md index 1c09e784693..04f49baff35 100644 --- a/delegation-toolkit/get-started/delegation-quickstart.md +++ b/delegation-toolkit/get-started/delegation-quickstart.md @@ -48,9 +48,9 @@ const bundlerClient = createBundlerClient({ ### 3. Create a delegator account Create an account to represent Alice, the delegator who will create a delegation. -The delegator must be a [smart account](../how-to/create-smart-account/index.md). +The delegator must be a [smart account](../concepts/smart-accounts.md). -This example configures a [Hybrid](../concepts/smart-accounts.md#hybrid-smart-account) smart account, +This example configures a Hybrid smart account, which is a flexible smart account implementation that supports both an externally owned account (EOA) owner and any number of P256 (passkey) signers: ```typescript @@ -69,7 +69,7 @@ const delegatorSmartAccount = await toMetaMaskSmartAccount({ ``` :::note -See [how to configure other smart account types](../how-to/create-smart-account/configure-accounts-signers.md). +See [how to configure other smart account types](../how-to/create-smart-account.md). ::: ### 4. Create a delegate account diff --git a/delegation-toolkit/get-started/quickstart.md b/delegation-toolkit/get-started/quickstart.md index d1d9d99846e..6a43fb205d4 100644 --- a/delegation-toolkit/get-started/quickstart.md +++ b/delegation-toolkit/get-started/quickstart.md @@ -43,9 +43,9 @@ const bundlerClient = createBundlerClient({ ### 3. Create a MetaMask smart account -[Create a MetaMask smart account](../how-to/create-smart-account/index.md) to send the first user operation. +[Create a MetaMask smart account](../how-to/create-smart-account.md) to send the first user operation. -This example configures a [Hybrid](../concepts/smart-accounts.md#hybrid-smart-account) smart account, +This example configures a Hybrid smart account, which is a flexible smart account implementation that supports both an externally owned account (EOA) owner and any number of P256 (passkey) signers: ```typescript @@ -64,7 +64,7 @@ const smartAccount = await toMetaMaskSmartAccount({ ``` :::note -See [how to configure other smart account types](../how-to/create-smart-account/configure-accounts-signers.md). +See [how to configure other smart account types](../how-to/create-smart-account.md). ::: ### 4. Send a user operation diff --git a/delegation-toolkit/how-to/create-delegation/index.md b/delegation-toolkit/how-to/create-delegation/index.md index 1a0efc36d98..d8ec006e139 100644 --- a/delegation-toolkit/how-to/create-delegation/index.md +++ b/delegation-toolkit/how-to/create-delegation/index.md @@ -28,7 +28,7 @@ Learn how to [restrict a delegation](./restrict-delegation.md) using caveat enfo - [Install and set up the Delegation Toolkit.](../../get-started/install.md) - [Configure the Delegation Toolkit.](../configure.md) -- [Create a MetaMask smart account.](../create-smart-account/index.md) +- [Create a MetaMask smart account.](../create-smart-account.md) ## Create a root delegation diff --git a/delegation-toolkit/how-to/create-smart-account/configure-accounts-signers.md b/delegation-toolkit/how-to/create-smart-account.md similarity index 65% rename from delegation-toolkit/how-to/create-smart-account/configure-accounts-signers.md rename to delegation-toolkit/how-to/create-smart-account.md index d14425c7047..31f3922ee04 100644 --- a/delegation-toolkit/how-to/create-smart-account/configure-accounts-signers.md +++ b/delegation-toolkit/how-to/create-smart-account.md @@ -1,47 +1,33 @@ --- -sidebar_label: Configure accounts and signers -description: Learn how to configure different types of MetaMask Smart Accounts and signers using Viem. -sidebar_position: 1 +description: Learn how to create a MetaMask smart account using Viem. +sidebar_position: 2 --- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# Configure MetaMask Smart Accounts and signers +# Create a MetaMask smart account -The MetaMask Delegation Toolkit supports different [MetaMask smart account types](../../concepts/smart-accounts.md#smart-account-implementation-types), +The MetaMask Delegation Toolkit is embedded, meaning that the end user can instantly interact with a dapp without wallet authorization, confirmations, or corporate logos. +You can enable users to create a [MetaMask smart account](../concepts/smart-accounts.md) directly in your dapp. +The toolkit supports different [smart account types](../concepts/smart-accounts.md#smart-account-implementation-types), each with its own configuration and support for different signing mechanisms. -You can create flexible and secure delegator accounts tailored to your specific needs. -## Prerequisites - -- [Install and set up the Delegation Toolkit.](../../get-started/install.md) -- [Configure the Delegation Toolkit.](../configure.md) -- [Create a MetaMask smart account.](index.md) - -## Configure a Hybrid smart account +This page provides examples of using [`toMetaMaskSmartAccount`](../reference/api/smart-account.md#tometamasksmartaccount) with Viem Core SDK to create different types of smart accounts with different types of signatories. -The [Hybrid smart account](../../concepts/smart-accounts.md#hybrid-smart-account) supports both an EOA "owner" and any number of P256 (passkey) signers. - -To configure a Hybrid smart account, provide the following parameters: +## Prerequisites -- `owner`: The owner's account address as a hex string. - The owner can be the zero address, indicating that there is no owner configured. -- `p256KeyIds`: An array of key identifiers for P256 signers as hex strings. -- `p256XValues`: An array of public key x-values for P256 signers as `bigint`s. -- `p256YValues`: An array of public key y-values for P256 signers as `bigint`s. -- `signatory`: A signer that will sign on behalf of the smart account. +- [Install and set up the Delegation Toolkit.](../get-started/install.md) +- [Configure the Delegation Toolkit.](configure.md) -:::note -You can set all `p256` parameters to empty arrays to configure no WebAuthn signer. -However, we recommend configuring at least one signer for account recovery. -::: +## Create a Hybrid smart account -For a Hybrid smart account, you can configure the following types of signatories: +A Hybrid smart account supports both an externally owned account (EOA) owner and any number of P256 (passkey) signers. +You can create a Hybrid smart account with the following types of signatories. -### Configure an account signatory +### Create a Hybrid smart account with an account signatory -This example creates a signatory from a private key using Viem's [`privateKeyToAccount`](https://viem.sh/docs/accounts/local/privateKeyToAccount) function. +Use [`toMetaMaskSmartAccount`](../reference/api/smart-account.md#tometamasksmartaccount) and Viem's [`privateKeyToAccount`](https://viem.sh/docs/accounts/local/privateKeyToAccount) to create a Hybrid smart account with a signatory from a private key: @@ -92,10 +78,9 @@ export const account = privateKeyToAccount(privateKey); -### Configure a Wallet Client signatory +### Create a Hybrid smart account with a Wallet Client signatory -This example creates a [Viem Wallet Client](https://viem.sh/docs/clients/wallet) as the signatory, -using Viem's `createWalletClient` function. +Use [`toMetaMaskSmartAccount`](../reference/api/smart-account.md#tometamasksmartaccount) and Viem's [`createWalletClient`](https://viem.sh/docs/clients/wallet) to create a Hybrid smart account with a Wallet Client signatory: @@ -157,15 +142,12 @@ export const walletClient = createWalletClient({ -### Configure a WebAuthn (passkey) signatory +### Create a Hybrid smart account with a WebAuthn (passkey) signatory -This example creates a [Viem WebAuthn Account](https://viem.sh/account-abstraction/accounts/webauthn) as the signatory, -using Viem's `toWebAuthnAccount` function. +Use [`toMetaMaskSmartAccount`](../reference/api/smart-account.md#tometamasksmartaccount) and Viem's [`toWebAuthnAccount`](https://viem.sh/account-abstraction/accounts/webauthn) to create a Hybrid smart account with a WebAuthn Account signatory: :::info Installation required - -To work with WebAuthn, install the [Ox SDK](https://oxlib.sh/). - +To use WebAuthn, install the [Ox SDK](https://oxlib.sh/). ::: @@ -231,21 +213,10 @@ export const webAuthnAccount = toWebAuthnAccount({ credential }); +## Create a Multisig smart account -## Configure a Multisig smart account - -The [Multisig smart account](../../concepts/smart-accounts.md#multisig-smart-account) supports multiple EOA signers with a configurable threshold for execution. - -To configure a Multisig smart account, provide the following parameters: - -- `signers`: An array of EOA signer addresses as hex strings. -- `threshold`: The number of signers required to execute a transaction, as a `bigint`. -- `signatory`: A signer that will sign on behalf of the smart account. - -### Configure signatories - -For a Multisig smart account, you can use a combination of account signatories and Wallet Client signatories. -For example: +A [Multisig smart account](../concepts/smart-accounts.md#multisig-smart-account) supports multiple EOA signers with a configurable threshold for execution. +Use [`toMetaMaskSmartAccount`](../reference/api/smart-account.md#tometamasksmartaccount) to create a Multsig smart account with a combination of account signatories and Wallet Client signatories: @@ -316,21 +287,20 @@ export const walletClient = createWalletClient({ The number of signers in the signatories must be at least equal to the threshold for valid signature generation. ::: -## Configure a Stateless 7702 smart account - -The [Stateless 7702 smart account](../../concepts/smart-accounts.md#stateless-7702-smart-account) represents an EOA that has been upgraded to support MetaMask Smart Accounts -functionality as defined by [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702). This implementation does not handle the upgrade process; see the [EIP-7702 quickstart](./../../get-started/eip7702-quickstart.md) to learn how to upgrade. +## Create a Stateless 7702 smart account -To configure a Stateless 7702 smart account, provide the following parameters: +A [Stateless 7702 smart account](../concepts/smart-accounts.md#stateless-7702-smart-account) represents an EOA that has been upgraded to support MetaMask Smart Accounts +functionality as defined by [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702). -- `address`: The address of the EOA that has been upgraded to a smart account. -- `signatory`: A signer that will sign on behalf of the smart account. +:::note +This implementation does not handle the upgrade process; see the [EIP-7702 quickstart](../get-started/eip7702-quickstart.md) to learn how to upgrade. +::: -For a Stateless 7702 smart account, you can configure the following types of signatories: +You can create a Stateless 7702 smart account with the following types of signatories. -### Configure an account signatory +### Create a Stateless 7702 smart account with an account signatory -This example creates a signatory from a private key using Viem's [`privateKeyToAccount`](https://viem.sh/docs/accounts/local/privateKeyToAccount) function. +Use [`toMetaMaskSmartAccount`](../reference/api/smart-account.md#tometamasksmartaccount) and Viem's [`privateKeyToAccount`](https://viem.sh/docs/accounts/local/privateKeyToAccount) to create a Stateless 7702 smart account with a signatory from a private key: @@ -346,7 +316,7 @@ import { const smartAccount = await toMetaMaskSmartAccount({ client: publicClient, implementation: Implementation.Stateless7702, - address: account.address + address: account.address // Address of the upgraded EOA signatory: { account }, }); ``` @@ -380,10 +350,9 @@ export const account = privateKeyToAccount(privateKey); -### Configure a Wallet Client signatory +### Create a Stateless 7702 smart account with a Wallet Client signatory -This example creates a [Viem Wallet Client](https://viem.sh/docs/clients/wallet) as the signatory, -using Viem's `createWalletClient` function. +Use [`toMetaMaskSmartAccount`](../reference/api/smart-account.md#tometamasksmartaccount) and Viem's [`createWalletClient`](https://viem.sh/docs/clients/wallet) to create a Stateless 7702 smart account with a Wallet Client signatory: @@ -402,7 +371,7 @@ const address = addresses[0]; const smartAccount = await toMetaMaskSmartAccount({ client: publicClient, implementation: Implementation.Stateless7702, - address, + address, // Address of the upgraded EOA signatory: { walletClient }, }); ``` @@ -443,3 +412,12 @@ export const walletClient = createWalletClient({ + +## Next steps + +With a MetaMask smart account, you can perform the following functions: + +- In conjunction with [Viem Account Abstraction clients](configure.md), deploy the smart account + and [send user operations](send-user-operation.md). +- [Sign delegations](create-delegation/index.md) that can be used to grant specific rights and permissions to other accounts. + Smart accounts that sign delegations are called *delegator accounts*. diff --git a/delegation-toolkit/how-to/create-smart-account/index.md b/delegation-toolkit/how-to/create-smart-account/index.md deleted file mode 100644 index 1145bb0d96d..00000000000 --- a/delegation-toolkit/how-to/create-smart-account/index.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -description: Learn how to create a MetaMask smart account using Viem. -sidebar_position: 2 ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; - -# Create a MetaMask smart account - -The MetaMask Delegation Toolkit is embedded, meaning that the end user can instantly interact with a dapp without wallet authorization, confirmations, or corporate logos. -Enable users to create a [MetaMask smart account](../../concepts/smart-accounts.md) directly in your dapp. - -## Prerequisites - -- [Install and set up the Delegation Toolkit.](../../get-started/install.md) -- [Configure the Delegation Toolkit.](../configure.md) - -## Create a `MetaMaskSmartAccount` - -The following is an example of creating a MetaMask smart account using Viem Core SDK. -Viem Core SDK provides low-level interfaces to offer flexibility and control over the smart -account creation lifecycle. - -In the example, the Viem [`privateKeyToAccount`](https://viem.sh/docs/accounts/privateKey.html) -function creates an externally owned account as the owner of the smart account. - - - - -```typescript -import { publicClient, owner } from "./config.ts"; -import { - Implementation, - toMetaMaskSmartAccount, -} from "@metamask/delegation-toolkit"; - -const deploySalt = "0x"; - -const smartAccount = await toMetaMaskSmartAccount({ - client: publicClient, - implementation: Implementation.Hybrid, - deployParams: [owner.address, [], [], []], - deploySalt, - signatory: { account: owner }, -}); -``` - - - - - -```typescript -import { http, createPublicClient } from "viem"; -import { privateKeyToAccount, generatePrivateKey } from "viem/accounts"; -import { sepolia as chain } from "viem/chains"; - -const transport = http(); -export const publicClient = createPublicClient({ - transport, - chain, -}); - -const privateKey = generatePrivateKey(); -export const owner = privateKeyToAccount(privateKey); -``` - - - - - -This example creates the `MetaMaskSmartAccount`, which can perform several functions: - -- In conjunction with [Viem Account Abstraction clients](../configure.md), deploy the smart account - and [send user operations](../send-user-operation.md). -- [Sign delegations](../create-delegation/index.md) that can be used to grant specific rights and permissions to other accounts. - Smart accounts that sign delegations are called *delegator accounts*. - -:::note -The example above uses a Hybrid smart account, which is configurable to have an EOA "owner" and any number of P256 (passkey) signers. -You can also [configure other smart account types](configure-accounts-signers.md). -::: diff --git a/delegation-toolkit/how-to/generate-multisig-signature.md b/delegation-toolkit/how-to/generate-multisig-signature.md index f225c8a56ba..706352124fb 100644 --- a/delegation-toolkit/how-to/generate-multisig-signature.md +++ b/delegation-toolkit/how-to/generate-multisig-signature.md @@ -19,7 +19,7 @@ into a single aggregated signature. - [Install and set up the Delegation Toolkit.](../get-started/install.md) - [Configure the Delegation Toolkit.](configure.md) -- [Create a Multisig smart account.](create-smart-account/configure-accounts-signers.md#configure-a-multisig-smart-account) +- [Create a Multisig smart account.](create-smart-account.md#create-a-multisig-smart-account) ## Generate a multisig signature diff --git a/delegation-toolkit/how-to/redeem-delegation.md b/delegation-toolkit/how-to/redeem-delegation.md index f50bcf4b774..4db41559422 100644 --- a/delegation-toolkit/how-to/redeem-delegation.md +++ b/delegation-toolkit/how-to/redeem-delegation.md @@ -20,7 +20,7 @@ The function supports batch redemption, allowing multiple delegations to be proc - [Install and set up the Delegation Toolkit.](../get-started/install.md) - [Configure the Delegation Toolkit.](configure.md) -- [Create a delegator smart account.](create-smart-account/index.md) +- [Create a delegator smart account.](create-smart-account.md) - [Create a delegation.](create-delegation/index.md) ## Redeem a delegation diff --git a/delegation-toolkit/how-to/send-user-operation.md b/delegation-toolkit/how-to/send-user-operation.md index ca958579579..85fc45bb407 100644 --- a/delegation-toolkit/how-to/send-user-operation.md +++ b/delegation-toolkit/how-to/send-user-operation.md @@ -27,7 +27,7 @@ If a user operation is sent from a MetaMask smart account that has not been depl - [Install and set up the Delegation Toolkit.](../get-started/install.md) - [Configure the Delegation Toolkit.](configure.md) -- [Create a MetaMask smart account.](create-smart-account/index.md) +- [Create a MetaMask smart account.](create-smart-account.md) ## Send a user operation diff --git a/delegation-toolkit/index.md b/delegation-toolkit/index.md index 6213576a51f..febbd212381 100644 --- a/delegation-toolkit/index.md +++ b/delegation-toolkit/index.md @@ -73,6 +73,42 @@ Check out the following guides to get started with the MetaMask Delegation Toolk ]} /> -## Questions? +## Partner integrations -If you have questions, email hellogators@consensys.net. +The MetaMask Delegation Toolkit is integrated with multiple ecosystem partners. +Check out the following documentation from these partners: + + diff --git a/delegation-toolkit/reference/api/smart-account.md b/delegation-toolkit/reference/api/smart-account.md index 30940f55336..f74e73c0122 100644 --- a/delegation-toolkit/reference/api/smart-account.md +++ b/delegation-toolkit/reference/api/smart-account.md @@ -379,7 +379,20 @@ Creates a `MetaMaskSmartAccount` instance. | `deploySalt` | `Hex` | Required if `address` is not provided | The salt that will be used to deploy the smart account. | | `address` | `Address` | Required if `deployParams` and `deploySalt` are not provided, or if the implementation is `Stateless7702`. | The address of the smart account. If an address is provided, the smart account will not be deployed. This should be used if you intend to interact with an existing smart account. | -### Hybrid implementation example +### Hybrid implementation + +#### `deployParams` + +All Hybrid deploy parameters are required: + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `owner` | `Hex` | The owner's account address. The owner can be the zero address, indicating that there is no owner configured. | +| `p256KeyIds` | `Hex[]` | An array of key identifiers for P256 signers. | +| `p256XValues` | `bigint[]` | An array of public key x-values for P256 signers. | +| `p256YValues` | `bigint[]` | An array of public key y-values for P256 signers. | + +#### Example @@ -418,7 +431,18 @@ export const publicClient = createPublicClient({ -### Multisig implementation example +### Multisig implementation + +#### `deployParams` + +All Multisig deploy parameters are required: + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `signers` | `Hex[]` | An array of EOA signer addresses. | +| `threshold` | `bigint` | The number of signers required to execute a transaction. | + +#### Example diff --git a/vercel.json b/vercel.json index 4340875e506..43b8cd652af 100644 --- a/vercel.json +++ b/vercel.json @@ -709,6 +709,10 @@ { "source": "/services/reference/:path*/json-rpc-methods/eth_coinbase/", "destination": "/services/get-started/infura/" + }, + { + "source": "/delegation-toolkit/development/how-to/create-smart-account/configure-accounts-signers/", + "destination": "/delegation-toolkit/development/how-to/create-smart-account/" } ] }