Skip to content

Commit 4adc574

Browse files
committed
Feat EVM Structure changes
1 parent 4838121 commit 4adc574

34 files changed

+1510
-811
lines changed

docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ const config = {
122122
markdown: {
123123
mermaid: true,
124124
hooks: {
125-
onBrokenMarkdownLinks: 'throw',
125+
onBrokenMarkdownLinks: 'warn',
126126
},
127127
},
128128
themes: ['@docusaurus/theme-mermaid'],

sdk-sidebar.js

Lines changed: 53 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -49,76 +49,77 @@ const sdkSidebar = {
4949
],
5050
evm: [
5151
'evm/index',
52+
{
53+
type: 'category',
54+
label: 'Quickstart',
55+
collapsible: false,
56+
collapsed: false,
57+
items: [
58+
'evm/connect/quickstart/javascript',
59+
'evm/connect/quickstart/wagmi',
60+
'evm/connect/quickstart/rainbowkit',
61+
'evm/connect/quickstart/connectkit',
62+
'evm/connect/quickstart/react-native',
63+
'evm/connect/quickstart/dynamic',
64+
'evm/connect/quickstart/web3auth',
65+
],
66+
},
5267
{
5368
type: 'category',
5469
label: 'Guides',
5570
collapsible: false,
5671
collapsed: false,
5772
items: [
73+
'evm/connect/guides/manage-user-accounts',
74+
'evm/connect/guides/manage-networks',
5875
{
5976
type: 'category',
60-
label: 'JavaScript',
77+
label: 'Send transactions',
6178
collapsible: true,
6279
collapsed: true,
63-
link: { type: "doc", id: "evm/connect/guides/javascript/index" },
80+
link: { type: "doc", id: "evm/connect/guides/send-transactions/index" },
6481
items: [
65-
'evm/connect/guides/javascript/manage-user-accounts',
66-
'evm/connect/guides/javascript/manage-networks',
67-
{
68-
type: 'category',
69-
label: 'Send transactions',
70-
collapsible: true,
71-
collapsed: true,
72-
link: { type: "doc", id: "evm/connect/guides/javascript/send-transactions/index" },
73-
items: [
74-
'evm/connect/guides/javascript/send-transactions/batch-transactions',
75-
],
76-
},
77-
{
78-
type: 'category',
79-
label: 'Sign data',
80-
collapsible: true,
81-
collapsed: true,
82-
link: { type: "doc", id: "evm/connect/guides/javascript/sign-data/index" },
83-
items: [
84-
'evm/connect/guides/javascript/sign-data/siwe',
85-
],
86-
},
87-
'evm/connect/guides/javascript/batch-requests',
88-
'evm/connect/guides/javascript/interact-with-contracts',
89-
'evm/connect/guides/javascript/use-deeplinks',
90-
'evm/connect/guides/javascript/display-tokens',
91-
{
92-
type: 'category',
93-
label: 'Best practices',
94-
collapsible: true,
95-
collapsed: true,
96-
items: [
97-
'evm/connect/guides/javascript/best-practices/display',
98-
'evm/connect/guides/javascript/best-practices/run-devnet',
99-
'evm/connect/guides/javascript/best-practices/production-readiness',
100-
],
101-
},
82+
'evm/connect/guides/send-transactions/batch-transactions',
10283
],
10384
},
10485
{
10586
type: 'category',
106-
label: 'Wagmi',
87+
label: 'Sign data',
10788
collapsible: true,
10889
collapsed: true,
109-
link: { type: "doc", id: "evm/connect/guides/wagmi/index" },
90+
link: { type: "doc", id: "evm/connect/guides/sign-data/index" },
11091
items: [
111-
'evm/connect/guides/wagmi/manage-user-accounts',
112-
'evm/connect/guides/wagmi/manage-networks',
113-
'evm/connect/guides/wagmi/send-transactions',
114-
'evm/connect/guides/wagmi/interact-with-contracts',
92+
'evm/connect/guides/sign-data/siwe',
11593
],
11694
},
117-
'evm/connect/guides/rainbowkit',
118-
'evm/connect/guides/connectkit',
119-
'evm/connect/guides/react-native',
120-
'evm/connect/guides/dynamic',
121-
'evm/connect/guides/web3auth',
95+
'evm/connect/guides/interact-with-contracts',
96+
{
97+
type: 'category',
98+
label: 'MetaMask Exclusive',
99+
collapsible: true,
100+
collapsed: true,
101+
items: [
102+
'evm/connect/guides/batch-requests',
103+
'evm/connect/guides/use-deeplinks',
104+
'evm/connect/guides/display-tokens',
105+
'evm/connect/guides/best-practices/display',
106+
'evm/connect/guides/best-practices/run-devnet',
107+
'evm/connect/guides/best-practices/production-readiness',
108+
],
109+
},
110+
// {
111+
// type: 'category',
112+
// label: 'Wagmi',
113+
// collapsible: true,
114+
// collapsed: true,
115+
// link: { type: "doc", id: "evm/connect/guides/wagmi/index" },
116+
// items: [
117+
// 'evm/connect/guides/wagmi/manage-user-accounts',
118+
// 'evm/connect/guides/wagmi/manage-networks',
119+
// 'evm/connect/guides/wagmi/send-transactions',
120+
// 'evm/connect/guides/wagmi/interact-with-contracts',
121+
// ],
122+
// },
122123
],
123124
},
124125
{
@@ -132,7 +133,7 @@ const sdkSidebar = {
132133
label: "Create a wallet AI agent",
133134
href: "/tutorials/create-wallet-ai-agent"
134135
},
135-
{
136+
{
136137
type: "link",
137138
label: "Upgrade an EOA to a smart account",
138139
href: "/tutorials/upgrade-eoa-to-smart-account"
@@ -152,7 +153,7 @@ const sdkSidebar = {
152153
label: "JSON-RPC API",
153154
collapsible: true,
154155
collapsed: true,
155-
link: { type: "doc", id: "evm/connect/reference/json-rpc-api/index" },
156+
link: { type: "doc", id: "evm/connect/reference/json-rpc-api/index" },
156157
items: [
157158
"evm/connect/reference/json-rpc-api/wallet_sendCalls",
158159
"evm/connect/reference/json-rpc-api/eth_signTypedData_v4",
241 KB
Loading
303 KB
Loading
488 KB
Loading
528 KB
Loading

sdk/evm/connect/_assets/siwe.png

475 KB
Loading

sdk/evm/connect/guides/javascript/batch-requests.md renamed to sdk/evm/connect/guides/batch-requests.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ These requests can be contract calls or other JSON-RPC methods (for example, sig
1010
Despite being batched into one HTTP request, each call still requires individual user approval, and if any request is rejected, the entire batch fails.
1111

1212
:::info
13-
"Batching" can also refer to [Wagmi contract read batching](../wagmi/interact-with-contracts.md#batch-contract-reads) or
13+
"Batching" can also refer to [Wagmi contract read batching](./wagmi/interact-with-contracts.md#batch-contract-reads) or
1414
[sending atomic batch transactions](send-transactions/batch-transactions.md) in MetaMask.
1515
:::
1616

@@ -29,44 +29,44 @@ When using `metamask_batch`, keep in mind the following:
2929

3030
- Even though the requests are batched, each individual request still requires user approval.
3131
- If any request in the batch is rejected, the entire batch will fail.
32-
:::
32+
:::
3333

3434
The following is an example of batching JSON-RPC requests using `metamask_batch`:
3535

3636
```js
37-
import { createEVMClient } from "@metamask/connect/evm";
37+
import { createEVMClient } from '@metamask/connect/evm'
3838

39-
const evmClient = createEVMClient();
40-
const provider = evmClient.getProvider();
39+
const evmClient = createEVMClient()
40+
const provider = evmClient.getProvider()
4141

4242
async function handleBatchRequests() {
4343
// Example batch: one personal_sign call and one eth_sendTransaction call.
4444
const requests = [
45-
{ method: "personal_sign", params: ["Hello from batch!", "0x1234..."] },
45+
{ method: 'personal_sign', params: ['Hello from batch!', '0x1234...'] },
4646
{
47-
method: "eth_sendTransaction",
47+
method: 'eth_sendTransaction',
4848
params: [
4949
{
50-
from: "0x1234...",
51-
to: "0xABCD...",
50+
from: '0x1234...',
51+
to: '0xABCD...',
5252
// Additional transaction parameters.
5353
},
5454
],
5555
},
56-
];
56+
]
5757

5858
try {
5959
const results = await provider.request({
60-
method: "metamask_batch",
60+
method: 'metamask_batch',
6161
params: [requests],
62-
});
63-
console.log("Batch Results:", results);
62+
})
63+
console.log('Batch Results:', results)
6464
} catch (err) {
65-
console.error("Batch request failed:", err);
65+
console.error('Batch request failed:', err)
6666
}
6767
}
6868

69-
document.getElementById("batchBtn").addEventListener("click", handleBatchRequests);
69+
document.getElementById('batchBtn').addEventListener('click', handleBatchRequests)
7070
```
7171

7272
The following HTML displays a **Send Batch** button:
@@ -76,7 +76,8 @@ The following HTML displays a **Send Batch** button:
7676
```
7777

7878
:::tip Tips
79+
7980
- For a better user experience, it's important to use reliable RPC providers instead of public nodes.
8081
We recommend using services like [MetaMask Developer](https://developer.metamask.io/) to ensure better reliability and performance.
8182
- Ensure that requests in a batch do not depend on one another's chain context, as mid-batch state changes can affect outcomes.
82-
:::
83+
:::

sdk/evm/connect/guides/javascript/best-practices/display.md renamed to sdk/evm/connect/guides/best-practices/display.md

File renamed without changes.

sdk/evm/connect/guides/javascript/best-practices/production-readiness.md renamed to sdk/evm/connect/guides/best-practices/production-readiness.md

File renamed without changes.

0 commit comments

Comments
 (0)