Merge branch 'main' into sdk-new-structure

Author: alexandratran

.github/workflows/crowdin.yml

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v5
 
       - name: Synchronize with Crowdin
-        uses: crowdin/github-action@v1
+        uses: crowdin/github-action@v2
         with:
           upload_sources: true
           upload_translations: true

delegation-toolkit/assets/erc7715-request.png

@@ -6,7 +6,7 @@ keywords: [caveats, caveat enforcers, delegation]
 # Caveat enforcers
 
 The MetaMask Delegation Toolkit provides *caveat enforcers*, which are smart contracts that implement rules and restrictions (*caveats*) on delegations.
-They serve as the underlying mechanism that enables conditional execution within the [Delegation Framework](index.md#delegation-framework).
+They serve as the underlying mechanism that enables conditional execution within the [Delegation Framework](./index.md#delegation-framework).
 
 A caveat enforcer acts as a gate that validates whether a delegation can be used for a particular execution. When a delegate attempts to execute an action on behalf of a delegator, each caveat enforcer specified in the delegation evaluates whether the execution meets its defined criteria.
 
@@ -164,7 +164,7 @@ For other restriction patterns, you can also [create custom caveat enforcers](/t
 
 ## Attenuating authority with redelegations
 
-When creating chains of delegations via [redelegations](index.md#delegation-types), it's important to understand how authority flows and can be restricted.
+When creating chains of delegations via [redelegations](./index.md#delegation-types), it's important to understand how authority flows and can be restricted.
 
 Caveats applied to a chain of delegations are *accumulative*—they stack on top of each other:
 

delegation-toolkit/concepts/delegation/caveat-enforcers.md

@@ -0,0 +1,64 @@
+---
+description: Learn about MetaMask ERC-7715 permissions.
+keywords: [ERC-7715, 7715, permissions, wallet, smart account]
+---
+
+# ERC-7715 permissions
+
+The Delegation Toolkit supports [ERC-7715](https://eips.ethereum.org/EIPS/eip-7715), which lets you request fine-grained permissions from a MetaMask user to execute transactions on their behalf.
+For example, a user can grant your dapp permission to spend 10 USDC per day to buy ETH over the course of a month.
+Once the permission is granted, your dapp can use the allocated 10 USDC each day to purchase ETH directly from the MetaMask user's account.
+
+ERC-7715 eliminates the need for users to approve every transaction, which is useful for highly interactive dapps.
+It also enables dapps to execute transactions for users without an active wallet connection.
+
+:::note
+This feature requires [MetaMask Flask 12.14.2](/snaps/get-started/install-flask) or later.
+:::
+
+## ERC-7715 technical overview
+
+[ERC-7715](https://eips.ethereum.org/EIPS/eip-7715) defines a JSON-RPC method `wallet_grantPermissions`. 
+Dapps can use this method to request a wallet to grant the dapp permission to execute transactions on a user's behalf.
+`wallet_grantPermissions` requires a `signer` parameter, which identifies the entity requesting or managing the permission.
+Common signer implementations include wallet signers, single key and multisig signers, and account signers.
+
+The Delegation Toolkit supports multiple types of signers, but [an account signer is used in this documentation's examples](../guides/erc7715/execute-on-metamask-users-behalf.md) as a common implementation.
+With an account signer, a session account is created and used for the single purpose of requesting and redeeming ERC-7715 permissions, and does not contain tokens.
+The session account can be granted with permissions and redeem them as specified in [ERC-7710](https://eips.ethereum.org/EIPS/eip-7710).
+The session account can be a smart account or an externally owned account (EOA).
+
+The MetaMask user that the session account requests permissions from must be upgraded to a [MetaMask smart account](smart-accounts.md).
+
+## ERC-7715 vs. delegations
+
+ERC-7715 expands on regular [delegations](delegation/index.md) by enabling permission sharing *via the MetaMask browser extension*.
+
+With regular delegations, the dapp constructs a delegation and requests the user to sign it.
+These delegations are not human-readable, so it is the dapp's responsibility to provide context for the user.
+Regular delegations cannot be signed through the MetaMask extension, because if a dapp requests a delegation without constraints, the whole wallet can be exposed to the dapp.
+
+In contrast, ERC-7715 enables dapps (and AI agents) to request permissions from a user directly via the MetaMask extension.
+ERC-7715 requires a permission configuration which displays a human-readable confirmation for the MetaMask user.
+The user can modify the permission parameters if the request is configured to allow adjustments.
+
+For example, the following ERC-7715 permission request displays a rich UI including the start time, amount, and period duration for an [ERC-20 token periodic transfer](../guides/erc7715/use-permissions/erc20-token.md#erc-20-periodic-permission):
+
+<p align="center">
+<img src={require("../assets/erc7715-request.png").default} alt="ERC-7715 request" width="450px" class="appScreen" />
+</p>
+
+## ERC-7715 permissions lifecycle
+
+The ERC-7715 permissions lifecycle is as follows:
+
+1. **Set up a session account** - Set up a session account to execute transactions on behalf of the MetaMask user.
+  It can be a [smart account](smart-accounts.md) or an externally owned account (EOA).
+
+2. **Request permissions** - Request permissions from the user.
+  The Delegation Toolkit supports [ERC-20 token permissions](../guides/erc7715/use-permissions/erc20-token.md) and
+  [native token permissions](../guides/erc7715/use-permissions/native-token.md).
+
+4. **Redeem permissions** - Once the permission is granted, the session account can redeem the permission, executing on the user's behalf.
+
+See [how to perform executions on a MetaMask user's behalf](../guides/erc7715/execute-on-metamask-users-behalf.md) to get started with the ERC-7715 lifecycle.

delegation-toolkit/concepts/erc7715.md

@@ -23,6 +23,7 @@ If you don't see the network you're looking for, you can request support by emai
 | Unichain            | ❌      | ✅      | ✅      |
 | Arbitrum Nova       | ❌      | ✅      | ✅      |
 | Berachain           | ❌      | ✅      | ✅      |
+| Ink                 | ❌      | ❌      | ✅      |
 
 ## Testnet networks
 
@@ -38,4 +39,6 @@ If you don't see the network you're looking for, you can request support by emai
 | Optimism Sepolia            | ❌      | ✅      | ✅      |
 | Binance Smart Chain         | ❌      | ✅      | ✅      |
 | Polygon Amoy                | ❌      | ✅      | ✅      |
-| Monad                       | ❌      | ✅      | ✅      |  
+| Monad                       | ❌      | ✅      | ✅      |
+| Ink Sepolia                 | ❌      | ❌      | ✅      | 
+| Citrea                      | ❌      | ❌      | ✅      |

delegation-toolkit/get-started/supported-networks.md

@@ -135,7 +135,7 @@ const environment: DeleGatorEnvironment = getDelegatorEnvironment(11155111);
 
 You can deploy the contracts using any method, but the toolkit provides a convenient [`deployDelegatorEnvironment`](../reference/delegation/index.md#deploydelegatorenvironment) function. This function simplifies deploying the Delegation Framework contracts to your desired EVM chain.
 
-This function requires a Viem [Public Client](https://viem.sh/docs/clients/public.html), [Wallet Client](https://viem.sh/docs/clients/wallet.html), and [Chain](https://viem.sh/docs/glossary/types#chain)
+This function requires a Viem [Public Client](https://viem.sh/docs/clients/public), [Wallet Client](https://viem.sh/docs/clients/wallet), and [Chain](https://viem.sh/docs/glossary/types#chain)
 to deploy the contracts and resolve the `DeleGatorEnvironment`. 
 
 Your wallet must have a sufficient native token balance to deploy the contracts.

delegation-toolkit/guides/configure-toolkit.md

@@ -82,14 +82,18 @@ const { availableAmount } = await caveatEnforcerClient.getErc20PeriodTransferEnf
 
 ```typescript
 import { createDelegation } from '@metamask/delegation-toolkit'
+import { parseUnits } from 'viem'
+
+// startDate should be in seconds.
+const startDate = Math.floor(Date.now() / 1000);
 
 export const delegation = createDelegation({
   scope: {
     type: 'erc20PeriodTransfer',
     tokenAddress: '0xb4aE654Aca577781Ca1c5DE8FbE60c2F423f37da',
-    periodAmount: 1000000000000000000n,
+    periodAmount: parseUnits('10', 6),
     periodDuration: 86400,
-    startDate: 1743763600,
+    startDate,
   },
   to: delegateAccount,
   from: delegatorAccount,

delegation-toolkit/guides/delegation/check-delegation-state.md

@@ -0,0 +1,99 @@
+---
+description: Learn how to disable the delegation.
+sidebar_label: Disable a delegation
+toc_max_heading_level: 3
+keywords: [delegation, disable, revoke]
+---
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+# Disable a delegation
+
+Delegations are created off-chain and can be stored anywhere, but you can disable a delegation on-chain using the
+toolkit. When a delegation is disabled, any attempt to redeem it will revert, effectively revoking the permissions 
+that were previously granted.
+
+For example, if Alice has given permission to Bob to spend 10 USDC on her behalf, and after a week she wants to 
+revoke that permission, Alice can disable the delegation she created for Bob. If Bob tries to redeem the disabled 
+delegation, the transaction will revert, preventing him from spending Alice's USDC.
+
+## Prerequisites
+
+- [Install and set up the Delegation Toolkit.](../../get-started/install.md)
+- [Create a delegator account.](execute-on-smart-accounts-behalf.md#3-create-a-delegator-account)
+- [Create a delegate account.](execute-on-smart-accounts-behalf.md#4-create-a-delegate-account)
+
+
+## Disable a delegation
+
+To disable a delegation, you can use the [`disableDelegation`](../../reference/delegation/index.md#disabledelegation) utility function from the 
+toolkit to generate calldata. Once the calldata is prepared, you can send it to the
+Delegation Manager to disable the delegation. 
+
+<Tabs>
+<TabItem value="example.ts">
+
+```typescript
+import { DelegationManager } from '@metamask/delegation-toolkit/contracts';
+import { environment, delegation, bundlerClient } from "./config.ts";
+
+const disableDelegationData = DelegationManager.encode.disableDelegation({
+  delegation,
+});
+
+// Appropriate fee per gas must be determined for the specific bundler being used.
+const maxFeePerGas = 1n;
+const maxPriorityFeePerGas = 1n;
+
+const userOperationHash = await bundlerClient.sendUserOperation({
+  account: delegatorAccount,
+  calls: [
+    {
+      to: environment.DelegationManager,
+      data: disableDelegationData
+    }
+  ],
+  maxFeePerGas,
+  maxPriorityFeePerGas
+});
+```
+
+</TabItem>
+<TabItem value="config.ts">
+
+```typescript
+import { sepolia as chain } from 'viem/chains'
+import { createPublicClient, http, parseEther } from 'viem'
+import { createBundlerClient } from 'viem/account-abstraction'
+import { getDeleGatorEnvironment, createDelegation } from '@metamask/delegation-toolkit'
+
+export const environment = getDeleGatorEnvironment(chain.id)
+
+const currentTime = Math.floor(Date.now() / 1000)
+
+export const delegation = createDelegation({
+  scope: {
+    type: 'nativeTokenPeriodTransfer',
+    periodAmount: parseEther('0.01'),
+    periodDuration: 86400,
+    startDate: currentTime,
+  },
+  to: delegateAccount,
+  from: delegatorAccount,
+  environment: delegatorAccount.environment,
+})
+
+const publicClient = createPublicClient({
+  chain,
+  transport: http()
+})
+
+export const bundlerClient = createBundlerClient({
+  client: publicClient,
+  transport: http('https://api.pimlico.io/v2/11155111/rpc')
+});
+```
+
+</TabItem>
+</Tabs>

delegation-toolkit/guides/delegation/disable-delegation.md

@@ -137,9 +137,10 @@ Before creating a delegation, ensure that the delegator account (in this example
 
 ```typescript
 import { createDelegation } from "@metamask/delegation-toolkit"
+import { parseUnits } from "viem"
 
 // USDC address on Ethereum Sepolia.
-const tokenAddress = "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238";
+const tokenAddress = "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238"
 
 const delegation = createDelegation({
   to: delegateSmartAccount.address, // This example uses a delegate smart account
@@ -148,7 +149,8 @@ const delegation = createDelegation({
   scope: {
     type: "erc20TransferAmount",
     tokenAddress,
-    maxAmount: 10000000n,
+    // 10 USDC 
+    maxAmount: parseUnits("10", 6),
   },
 })
 ```
@@ -175,7 +177,7 @@ Bob can now redeem the delegation. The redeem transaction is sent to the `Delega
 To prepare the calldata for the redeem transaction, use the [`redeemDelegations`](../../reference/delegation/index.md#redeemdelegations) method from `DelegationManager`.
 Since Bob is redeeming a single delegation chain, use the [`SingleDefault`](../../concepts/delegation/index.md#execution-modes) execution mode.
 
-Bob can redeem the delegation by submitting a user operation if his account is a smart account, or a regular transaction if his account is an EOA:
+Bob can redeem the delegation by submitting a user operation if his account is a smart account, or a regular transaction if his account is an EOA. In this example, Bob transfers 1 USDC from Alice’s account to his own.
 
 <Tabs>
 <TabItem value="Redeem with a smart account">
@@ -184,10 +186,14 @@ Bob can redeem the delegation by submitting a user operation if his account is a
 import { createExecution, ExecutionMode } from "@metamask/delegation-toolkit"
 import { DelegationManager } from "@metamask/delegation-toolkit/contracts"
 import { zeroAddress } from "viem"
+import { callData } from "./config.ts"
 
 const delegations = [signedDelegation]
 
-const executions = createExecution({ target: zeroAddress })
+// USDC address on Ethereum Sepolia.
+const tokenAddress = "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238"
+
+const executions = createExecution({ target: tokenAddress, callData })
 
 const redeemDelegationCalldata = DelegationManager.encode.redeemDelegations({
   delegations: [delegations],
@@ -215,10 +221,14 @@ const userOperationHash = await bundlerClient.sendUserOperation({
 import { createExecution, getDeleGatorEnvironment, ExecutionMode } from "@metamask/delegation-toolkit"
 import { DelegationManager } from "@metamask/delegation-toolkit/contracts"
 import { zeroAddress } from "viem"
+import { callData } from "./config.ts"
 
 const delegations = [signedDelegation]
 
-const executions = createExecution({ target: zeroAddress })
+// USDC address on Ethereum Sepolia.
+const tokenAddress = "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238"
+
+const executions = createExecution({ target: tokenAddress, callData })
 
 const redeemDelegationCalldata = DelegationManager.encode.redeemDelegations({
   delegations: [delegations],
@@ -233,10 +243,26 @@ const transactionHash = await delegateWalletClient.sendTransaction({
 })
 ```
 
+</TabItem>
+
+<TabItem value="config.ts">
+
+```typescript
+import { encodeFunctionData, erc20Abi, parseUnits } from "viem"
+
+// calldata to transfer 1 USDC to delegate address.
+export const callData = encodeFunctionData({
+  abi: erc20Abi,
+  args: [ delegateSmartAccount.address, parseUnits("1", 6) ],
+  functionName: 'transfer',
+})
+```
+
 </TabItem>
 </Tabs>
 
 ## Next steps
 
 - See [how to configure different scopes](use-delegation-scopes/index.md) to define the initial authority of a delegation.
-- See [how to further refine the authority of a delegation](use-delegation-scopes/constrain-scope.md) using caveat enforcers.
+- See [how to further refine the authority of a delegation](use-delegation-scopes/constrain-scope.md) using caveat enforcers.
+- See [how to disable a delegation](disable-delegation.md) to revoke permissions.