Skip to content

Commit 43142e7

Browse files
AyushBherwani1998alexandratran
AyushBherwani1998
and
alexandratran
authored
Release docs for delegation toolkit v0.12
* lock files for v0.12 * revert prettier changes * Apply suggestions from code review Co-authored-by: Alexandra Carrillo <[email protected]> --------- Co-authored-by: Alexandra Carrillo <[email protected]>
1 parent e7bface commit 43142e7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+6285
-12
lines changed

‎delegation-toolkit/get-started/cli-quickstart.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
description: Get started with the MetaMask Delegation Toolkit using the `create-gator-app` CLI.
2+
description: Get started with the MetaMask Delegation Toolkit using the `@metamask/create-gator-app` CLI.
33
sidebar_position: 4
44
sidebar_label: CLI quickstart
55
---
66

77
# Delegation Toolkit CLI quickstart
88

9-
Use the `create-gator-app` interactive CLI to bootstrap a project with the MetaMask Delegation Toolkit in under two minutes.
9+
Use the `@metamask/create-gator-app` interactive CLI to bootstrap a project with the MetaMask Delegation Toolkit in under two minutes.
1010
The CLI automatically installs the required dependencies and sets up a project structure using a selected template,
1111
allowing you to focus on building your dapp.
1212

1313
## Run the CLI
1414

15-
Run the following command to automatically install the `create-gator-app` package:
15+
Run the following command to automatically install the `@metamask/create-gator-app` package:
1616

1717
```bash
18-
npx create-gator-app@latest
18+
npx @metamask/create-gator-app@latest
1919
```
2020

2121
Upon installation, you'll be asked the following prompts:
@@ -43,7 +43,7 @@ The CLI provides the following options to display CLI details, and further custo
4343

4444
| Option | Description |
4545
|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
46-
| `-v` or `--version` | Check the current version of the `create-gator-app` CLI. |
46+
| `-v` or `--version` | Check the current version of the `@metamask/create-gator-app` CLI. |
4747
| `-h` or `--help` | Display the available options. |
4848
| `--skip-install` | Skip the installation of dependencies. |
4949
| `--add-web3auth` | Add Web3Auth Embedded Wallet as a signer for the delegator account. <br/>Supported templates: <ul><li>Next.js starter</li><li> Vite React starter</li></ul> |
@@ -53,10 +53,10 @@ The CLI provides the following options to display CLI details, and further custo
5353

5454
### Web3Auth configuration
5555

56-
To create a project that uses [Web3Auth](https://web3auth.io/docs/) Embedded Wallet as the signer for your delegator account, use the `--add-web3auth` option with `create-gator-app`:
56+
To create a project that uses [Web3Auth](https://web3auth.io/docs/) Embedded Wallet as the signer for your delegator account, use the `--add-web3auth` option with `@metamask/create-gator-app`:
5757

5858
```bash
59-
npx create-gator-app --add-web3auth
59+
npx @metamask/create-gator-app --add-web3auth
6060
```
6161

6262
You'll be prompted to provide additional Web3Auth configuration details:
@@ -69,10 +69,10 @@ You'll be prompted to provide additional Web3Auth configuration details:
6969

7070
### LLM rules
7171

72-
To create a project with LLM rules tailored to your preferred IDE, use the `--add-llm-rules` option with `create-gator-app`:
72+
To create a project with LLM rules tailored to your preferred IDE, use the `--add-llm-rules` option with `@metamask/create-gator-app`:
7373

7474
```bash
75-
npx create-gator-app --add-llm-rules
75+
npx @metamask/create-gator-app --add-llm-rules
7676
```
7777

7878
You'll be prompted to select your IDE.

‎docusaurus.config.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ const config = {
123123
sidebarCollapsed: false,
124124
includeCurrentVersion: true,
125125
// Set to the latest release.
126-
lastVersion: "0.11.0",
126+
lastVersion: "0.12.0",
127127
versions: {
128128
// Defaults to the ./docs folder.
129129
// Using "development" instead of "next" as path.
@@ -132,8 +132,8 @@ const config = {
132132
path: "development",
133133
},
134134
// The latest release.
135-
"0.11.0": {
136-
label: "latest (0.11.0)",
135+
"0.12.0": {
136+
label: "latest (0.12.0)",
137137
},
138138
},
139139
},

‎gator_versioned_docs/version-0.12.0/changelog/0.10.1.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
sidebar_label: 0.10.1
3+
sidebar_position: 4
4+
description: MetaMask Delegation Toolkit v0.10.1 changelog
5+
---
6+
7+
# What's new in v0.10.1?
8+
9+
## Bug fixes
10+
11+
- Fixed an issue where the ERC-7715 `PermissionRequest` object could not be serialized when `maxAmount` or `initialAmount` was set to `null`.
12+
13+
## Contract addresses
14+
15+
The following are the contract addresses for the
16+
[Delegation Framework version 1.3.0](https://github.com/MetaMask/delegation-framework/blob/v1.3.0/documents/Deployments.md),
17+
as used by this version of the toolkit.
18+
19+
### Delegation Framework
20+
21+
| Contract | Address |
22+
|----------|---------|
23+
| EntryPoint | `0x0000000071727De22E5E9d8BAf0edAc6f37da032` |
24+
| SimpleFactory | `0x69Aa2f9fe1572F1B640E1bbc512f5c3a734fc77c` |
25+
| DelegationManager | `0xdb9B1e94B5b69Df7e401DDbedE43491141047dB3` |
26+
| MultiSigDeleGatorImpl | `0x56a9EdB16a0105eb5a4C54f4C062e2868844f3A7` |
27+
| HybridDeleGatorImpl | `0x48dBe696A4D990079e039489bA2053B36E8FFEC4` |
28+
29+
### Caveat enforcers
30+
31+
| Enforcer | Address |
32+
|----------|---------|
33+
| AllowedCalldataEnforcer | `0xc2b0d624c1c4319760C96503BA27C347F3260f55` |
34+
| AllowedMethodsEnforcer | `0x2c21fD0Cb9DC8445CB3fb0DC5E7Bb0Aca01842B5` |
35+
| AllowedTargetsEnforcer | `0x7F20f61b1f09b08D970938F6fa563634d65c4EeB` |
36+
| ArgsEqualityCheckEnforcer | `0x44B8C6ae3C304213c3e298495e12497Ed3E56E41` |
37+
| BlockNumberEnforcer | `0x5d9818dF0AE3f66e9c3D0c5029DAF99d1823ca6c` |
38+
| DeployedEnforcer | `0x24ff2AA430D53a8CD6788018E902E098083dcCd2` |
39+
| ERC20BalanceGteEnforcer | `0x433A6A4d9875D87510584fd6cc586eB1c5F8A1d2` |
40+
| ERC20TransferAmountEnforcer | `0xf100b0819427117EcF76Ed94B358B1A5b5C6D2Fc` |
41+
| ERC20PeriodTransferEnforcer| `0x474e3Ae7E169e940607cC624Da8A15Eb120139aB` |
42+
| ERC20StreamingEnforcer | `0x56c97aE02f233B29fa03502Ecc0457266d9be00e` |
43+
| ERC721BalanceGteEnforcer | `0xA5d03eb350FA89f854685f6313CeCA27A4212542` |
44+
| ERC721TransferEnforcer | `0x3790e6B7233f779b09DA74C72b6e94813925b9aF` |
45+
| ERC1155BalanceGteEnforcer | `0x831b76f53601f38BfaCa2e6b442D6A5408Ae375c` |
46+
| ExactCalldataBatchEnforcer | `0x982FD5C86BBF425d7d1451f974192d4525113DfD` |
47+
| ExactCalldataEnforcer | `0x99F2e9bF15ce5eC84685604836F71aB835DBBdED` |
48+
| ExactExecutionBatchEnforcer | `0x1e141e455d08721Dd5BCDA1BaA6Ea5633Afd5017` |
49+
| ExactExecutionEnforcer | `0x146713078D39eCC1F5338309c28405ccf85Abfbb` |
50+
| IdEnforcer | `0xC8B5D93463c893401094cc70e66A206fb5987997` |
51+
| LimitedCallsEnforcer | `0x04658B29F6b82ed55274221a06Fc97D318E25416` |
52+
| NonceEnforcer | `0xDE4f2FAC4B3D87A1d9953Ca5FC09FCa7F366254f` |
53+
| TimestampEnforcer | `0x1046bb45C8d673d4ea75321280DB34899413c069` |
54+
| ValueLteEnforcer | `0x92Bf12322527cAA612fd31a0e810472BBB106A8F` |
55+
| NativeBalanceGteEnforcer | `0x54e17146b9CCE2642881E0879e06e9D63F7d7606` |
56+
| NativeTokenPaymentEnforcer | `0x4803a326ddED6dDBc60e659e5ed12d85c7582811` |
57+
| NativeTokenTransferAmountEnforcer | `0xF71af580b9c3078fbc2BBF16FbB8EEd82b330320` |
58+
| NativeTokenStreamingEnforcer | `0xD10b97905a320b13a0608f7E9cC506b56747df19` |
59+
| NativeTokenPeriodTransferEnforcer | `0x9BC0FAf4Aca5AE429F4c06aEEaC517520CB16BD9` |
60+
| OwnershipTransferEnforcer | `0x7EEf9734E7092032B5C56310Eb9BbD1f4A524681` |
61+
| RedeemerEnforcer | `0xE144b0b2618071B4E56f746313528a669c7E65c5` |
62+
| SpecificActionERC20TransferBatchEnforcer | `0x00e0251aaA263dfE3B3541B758A82D1CBA1c3B6D` |
63+
64+
### Supported mainnet networks
65+
- Ethereum
66+
- Polygon
67+
- Binance Smart Chain
68+
- Optimism
69+
- Arbitrum
70+
- Linea
71+
- Base
72+
- Gnosis Chain
73+
74+
### Supported testnet networks
75+
- Ethereum Sepolia
76+
- Linea Sepolia
77+
- Base Sepolia
78+
- MegaEth

‎gator_versioned_docs/version-0.12.0/changelog/0.10.2.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
sidebar_label: 0.10.2
3+
sidebar_position: 3
4+
description: MetaMask Delegation Toolkit v0.10.2 changelog
5+
---
6+
7+
# What's new in v0.10.2?
8+
9+
## Bug fixes
10+
11+
- Fixed the ERC-7715 request permission issue on Firefox.
12+
- Dropped ESM exports to enforce CommonJS module resolution.
13+
14+
## Contract addresses
15+
16+
The following are the contract addresses for the
17+
[Delegation Framework version 1.3.0](https://github.com/MetaMask/delegation-framework/blob/v1.3.0/documents/Deployments.md),
18+
as used by this version of the toolkit.
19+
20+
### Delegation Framework
21+
22+
| Contract | Address |
23+
|----------|---------|
24+
| EntryPoint | `0x0000000071727De22E5E9d8BAf0edAc6f37da032` |
25+
| SimpleFactory | `0x69Aa2f9fe1572F1B640E1bbc512f5c3a734fc77c` |
26+
| DelegationManager | `0xdb9B1e94B5b69Df7e401DDbedE43491141047dB3` |
27+
| MultiSigDeleGatorImpl | `0x56a9EdB16a0105eb5a4C54f4C062e2868844f3A7` |
28+
| HybridDeleGatorImpl | `0x48dBe696A4D990079e039489bA2053B36E8FFEC4` |
29+
30+
### Caveat enforcers
31+
32+
| Enforcer | Address |
33+
|----------|---------|
34+
| AllowedCalldataEnforcer | `0xc2b0d624c1c4319760C96503BA27C347F3260f55` |
35+
| AllowedMethodsEnforcer | `0x2c21fD0Cb9DC8445CB3fb0DC5E7Bb0Aca01842B5` |
36+
| AllowedTargetsEnforcer | `0x7F20f61b1f09b08D970938F6fa563634d65c4EeB` |
37+
| ArgsEqualityCheckEnforcer | `0x44B8C6ae3C304213c3e298495e12497Ed3E56E41` |
38+
| BlockNumberEnforcer | `0x5d9818dF0AE3f66e9c3D0c5029DAF99d1823ca6c` |
39+
| DeployedEnforcer | `0x24ff2AA430D53a8CD6788018E902E098083dcCd2` |
40+
| ERC20BalanceGteEnforcer | `0x433A6A4d9875D87510584fd6cc586eB1c5F8A1d2` |
41+
| ERC20TransferAmountEnforcer | `0xf100b0819427117EcF76Ed94B358B1A5b5C6D2Fc` |
42+
| ERC20PeriodTransferEnforcer| `0x474e3Ae7E169e940607cC624Da8A15Eb120139aB` |
43+
| ERC20StreamingEnforcer | `0x56c97aE02f233B29fa03502Ecc0457266d9be00e` |
44+
| ERC721BalanceGteEnforcer | `0xA5d03eb350FA89f854685f6313CeCA27A4212542` |
45+
| ERC721TransferEnforcer | `0x3790e6B7233f779b09DA74C72b6e94813925b9aF` |
46+
| ERC1155BalanceGteEnforcer | `0x831b76f53601f38BfaCa2e6b442D6A5408Ae375c` |
47+
| ExactCalldataBatchEnforcer | `0x982FD5C86BBF425d7d1451f974192d4525113DfD` |
48+
| ExactCalldataEnforcer | `0x99F2e9bF15ce5eC84685604836F71aB835DBBdED` |
49+
| ExactExecutionBatchEnforcer | `0x1e141e455d08721Dd5BCDA1BaA6Ea5633Afd5017` |
50+
| ExactExecutionEnforcer | `0x146713078D39eCC1F5338309c28405ccf85Abfbb` |
51+
| IdEnforcer | `0xC8B5D93463c893401094cc70e66A206fb5987997` |
52+
| LimitedCallsEnforcer | `0x04658B29F6b82ed55274221a06Fc97D318E25416` |
53+
| NonceEnforcer | `0xDE4f2FAC4B3D87A1d9953Ca5FC09FCa7F366254f` |
54+
| TimestampEnforcer | `0x1046bb45C8d673d4ea75321280DB34899413c069` |
55+
| ValueLteEnforcer | `0x92Bf12322527cAA612fd31a0e810472BBB106A8F` |
56+
| NativeBalanceGteEnforcer | `0x54e17146b9CCE2642881E0879e06e9D63F7d7606` |
57+
| NativeTokenPaymentEnforcer | `0x4803a326ddED6dDBc60e659e5ed12d85c7582811` |
58+
| NativeTokenTransferAmountEnforcer | `0xF71af580b9c3078fbc2BBF16FbB8EEd82b330320` |
59+
| NativeTokenStreamingEnforcer | `0xD10b97905a320b13a0608f7E9cC506b56747df19` |
60+
| NativeTokenPeriodTransferEnforcer | `0x9BC0FAf4Aca5AE429F4c06aEEaC517520CB16BD9` |
61+
| OwnershipTransferEnforcer | `0x7EEf9734E7092032B5C56310Eb9BbD1f4A524681` |
62+
| RedeemerEnforcer | `0xE144b0b2618071B4E56f746313528a669c7E65c5` |
63+
| SpecificActionERC20TransferBatchEnforcer | `0x00e0251aaA263dfE3B3541B758A82D1CBA1c3B6D` |
64+
65+
### Supported mainnet networks
66+
- Ethereum
67+
- Polygon
68+
- Binance Smart Chain
69+
- Optimism
70+
- Arbitrum
71+
- Linea
72+
- Base
73+
- Gnosis Chain
74+
75+
### Supported testnet networks
76+
- Ethereum Sepolia
77+
- Linea Sepolia
78+
- Base Sepolia
79+
- MegaEth

0 commit comments

Comments
 (0)