diff --git a/delegation-toolkit/get-started/llm-context.md b/delegation-toolkit/get-started/llm-context.md index 022593c03d6..63ead6da5a5 100644 --- a/delegation-toolkit/get-started/llm-context.md +++ b/delegation-toolkit/get-started/llm-context.md @@ -7,9 +7,9 @@ sidebar_class_name: hidden # Delegation Toolkit LLM context -This website contains [`LLMs.txt`](/llms.txt) and [`LLMs-full.txt`](/llms-full.txt) files that are intended for use by large language models (LLMs). -They provide information about the content and structure of the MetaMask Delegation Toolkit documentation, +This website contains an [`LLMs.txt`](/llms.txt) file that is intended for use by large language models (LLMs). +It provides information about the structure of the MetaMask developer documentation, to facilitate better indexing, summarization, and understanding by LLMs. -You can add these files to an LLM-based tool like [ChatGPT](https://chatgpt.com/) or [Cursor](https://docs.cursor.com/context/@-symbols/@-docs), -to provide detailed context about the Delegation Toolkit. +You can add this file to an LLM-based tool like [ChatGPT](https://chatgpt.com/) or [Cursor](https://docs.cursor.com/context/@-symbols/@-docs), +to provide detailed context about the MetaMask developer documentation. diff --git a/delegation-toolkit/how-to/create-smart-account/index.md b/delegation-toolkit/how-to/create-smart-account/index.md index 596db4a6bfe..e4b5f666709 100644 --- a/delegation-toolkit/how-to/create-smart-account/index.md +++ b/delegation-toolkit/how-to/create-smart-account/index.md @@ -9,7 +9,7 @@ import TabItem from "@theme/TabItem"; # Create a 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 [smart account](../concepts/smart-accounts) directly in your dapp. +Enable users to create a [smart account](../../concepts/smart-accounts.md) directly in your dapp. ## Prerequisites diff --git a/docs/whats-new.md b/docs/whats-new.md index 60bb84ff173..7c8250ae645 100644 --- a/docs/whats-new.md +++ b/docs/whats-new.md @@ -21,13 +21,13 @@ of the [MetaMask developer page](https://metamask.io/developer/). ([#1621](https://github.com/MetaMask/metamask-docs/pull/1621)) - Documented [Solana](/wallet/how-to/use-non-evm-networks/solana) dapp support via the Wallet Standard and third-party libraries. ([#1940](https://github.com/MetaMask/metamask-docs/pull/1940)) -- Documented [MetaMask SDK + Web3Auth SDK integration](/sdk/quickstart/javascript-web3auth). +- Documented [MetaMask SDK + Web3Auth SDK integration](/sdk/connect/javascript-web3auth). ([#2029](https://github.com/MetaMask/metamask-docs/pull/2029)) - Added [Delegation Toolkit](/delegation-toolkit) to MetaMask documentation. ([#2045](https://github.com/MetaMask/metamask-docs/pull/2045)) - Documented [how to use the Snaps sandbox](/snaps/how-to/test-a-snap/#test-in-the-sandbox). ([#2030](https://github.com/MetaMask/metamask-docs/pull/2030)) -- Documented how to use the SDK CLI to set up a [JavaScript + Wagmi](/sdk/quickstart/javascript-wagmi) or [Dynamic SDK](/sdk/quickstart/javascript-dynamic) project. +- Documented how to use the SDK CLI to set up a [JavaScript + Wagmi](/sdk/connect/javascript-wagmi) or [Dynamic SDK](/sdk/connect/javascript-dynamic) project. ([#2010](https://github.com/MetaMask/metamask-docs/pull/2010)) - Documented [how to send batch transactions via EIP-5792 and EIP-7702](/wallet/how-to/send-transactions/send-batch-transactions). ([#1946](https://github.com/MetaMask/metamask-docs/pull/1946)) @@ -45,9 +45,9 @@ of the [MetaMask developer page](https://metamask.io/developer/). - Documented [Ethereum Hoodi testnet](/services/get-started/endpoints/#ethereum) support. ([#1977](https://github.com/MetaMask/metamask-docs/pull/1977)) - Documented [how to use deeplinks](/sdk/guides/use-deeplinks). ([#1928](https://github.com/MetaMask/metamask-docs/pull/1928)) -- Documented [MetaMask SDK + Dynamic SDK integration](/sdk/quickstart/javascript-dynamic). +- Documented [MetaMask SDK + Dynamic SDK integration](/sdk/connect/javascript-dynamic). ([#1972](https://github.com/MetaMask/metamask-docs/pull/1972)) -- Documented [Snaps bundle analyzer option](/snaps/reference/cli/subcommands/#analyze). +- Documented [Snaps bundle analyzer option](/snaps/reference/cli/#analyze). ([#1955](https://github.com/MetaMask/metamask-docs/pull/1955)) ## March 2025 @@ -100,7 +100,7 @@ of the [MetaMask developer page](https://metamask.io/developer/). ([#1509](https://github.com/MetaMask/metamask-docs/pull/1509)) - Documented [Scroll](/services/reference/scroll) support. ([#1641](https://github.com/MetaMask/metamask-docs/pull/1641)) -- Updated [Wallet landing page](/wallet) and added [Connect to MetaMask](/wallet/how-to/connect) section +- Updated [Wallet landing page](/wallet) and added [Connect to MetaMask](/wallet/how-to/connect-extension) section with SDK, third-party libraries, and Wallet API connection options. ([#1494](https://github.com/MetaMask/metamask-docs/pull/1494)) - Documented [`snap_getPreferences`](/snaps/reference/snaps-api/#snap_getpreferences). @@ -206,7 +206,7 @@ of the [MetaMask developer page](https://metamask.io/developer/). ## March 2024 -- Documented [Snaps `polyfills` configuration option](/snaps/reference/cli/options/#polyfills). +- Documented [Snaps `polyfills` configuration option](/snaps/reference/config-options/#polyfills). ([#1238](https://github.com/MetaMask/metamask-docs/pull/1238)) - Documented [Snaps interactive UI](/snaps/features/custom-ui/interactive-ui). ([#1166](https://github.com/MetaMask/metamask-docs/pull/1166)) diff --git a/gator_versioned_docs/version-0.11.0/changelog/0.11.0.md b/gator_versioned_docs/version-0.11.0/changelog/0.11.0.md index 3064c9e1dc3..13aef15ba70 100644 --- a/gator_versioned_docs/version-0.11.0/changelog/0.11.0.md +++ b/gator_versioned_docs/version-0.11.0/changelog/0.11.0.md @@ -113,8 +113,8 @@ caveatBuilder.addCaveat("erc1155BalanceChange", - `isValidSignature` function has been added to verify signatures from smart contract accounts. - `aggregateSignature` function is now exposed in the toolkit, allowing multiple required signatures to be combined into a single aggregated signature. -[Learn how to generate a multisig signature](../how-to/generate-multisig-signature) -- A new caveat, `multiTokenPeriod`, has been introduced to ensure that transfers involving multiple tokens remain within defined limits over specified time periods. See [`multiTokenPeriod`](../how-to/create-delegation/restrict-delegation#multitokenperiod) to learn more. +[Learn how to generate a multisig signature.](../how-to/generate-multisig-signature.md) +- A new caveat, `multiTokenPeriod`, has been introduced to ensure that transfers involving multiple tokens remain within defined limits over specified time periods. See [`multiTokenPeriod`](../how-to/create-delegation/restrict-delegation.md#multitokenperiod) to learn more. ## Contract addresses diff --git a/gator_versioned_docs/version-0.11.0/get-started/llm-context.md b/gator_versioned_docs/version-0.11.0/get-started/llm-context.md deleted file mode 100644 index 3129fa57229..00000000000 --- a/gator_versioned_docs/version-0.11.0/get-started/llm-context.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -sidebar_label: LLM context -description: Context about the MetaMask Delegation Toolkit that can be provided to an LLM. -sidebar_position: 3 -sidebar_class_name: hidden ---- - -# Delegation Toolkit LLM context - -This website contains [`LLMs.txt`](/llms.txt) and [`LLMs-full.txt`](/llms-full.txt) files that are intended for use by large language models (LLMs). -They provide information about the content and structure of the MetaMask Delegation Toolkit documentation, -to facilitate better indexing, summarization, and understanding by LLMs. - -You can add these files to an LLM-based tool like [ChatGPT](https://chatgpt.com/) or [Cursor](https://docs.cursor.com/context/@-symbols/@-docs), -to provide detailed context about the Delegation Toolkit. diff --git a/gator_versioned_docs/version-0.11.0/how-to/create-smart-account/index.md b/gator_versioned_docs/version-0.11.0/how-to/create-smart-account/index.md index 596db4a6bfe..e4b5f666709 100644 --- a/gator_versioned_docs/version-0.11.0/how-to/create-smart-account/index.md +++ b/gator_versioned_docs/version-0.11.0/how-to/create-smart-account/index.md @@ -9,7 +9,7 @@ import TabItem from "@theme/TabItem"; # Create a 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 [smart account](../concepts/smart-accounts) directly in your dapp. +Enable users to create a [smart account](../../concepts/smart-accounts.md) directly in your dapp. ## Prerequisites diff --git a/services/concepts/websockets.md b/services/concepts/websockets.md index 27900f28922..e08c9c9619d 100644 --- a/services/concepts/websockets.md +++ b/services/concepts/websockets.md @@ -86,7 +86,7 @@ Credits are consumed for these actions to prevent spamming, even if no valuable :::tip -Refer to the [credit cost table](../get-started/pricing/credit-cost.md) for more information about the +Refer to the [credit cost table](../get-started/pricing/credit-cost.mdx) for more information about the credit costs associated with the relevant method calls. For users on the existing request-based billing system, WebSocket activity is counted toward your daily request diff --git a/services/get-started/pricing/index.md b/services/get-started/pricing/index.md index 7c35f408e38..41526ef1643 100644 --- a/services/get-started/pricing/index.md +++ b/services/get-started/pricing/index.md @@ -13,7 +13,7 @@ This shift not only provides greater flexibility but also encourages efficient u :::tip -View the [credit cost table](./credit-cost.md) for a breakdown of the cost for each method. +View the [credit cost table](credit-cost.mdx) for a breakdown of the cost for each method. ::: @@ -24,7 +24,7 @@ credits toward your daily credit quota: - [**WebSocket streaming**](../../concepts/websockets.md#pricing): Subscribing and unsubscribing to events consume credits from your daily quota. Each event received through a WebSocket connection also - [consumes credits based on the event type](./credit-cost.md#subscription-events). + [consumes credits based on the event type](credit-cost.mdx#subscription-events). WebSocket connections are severed once you reach your daily credit limit. - [**Batch requests**](../../how-to/make-batch-requests.md): Each individual RPC call diff --git a/services/reference/_partials/debug-methods/_debug_traceblock-parameters.mdx b/services/reference/_partials/debug-methods/_debug_traceblock-parameters.mdx index f302454aa10..11dc0ac614f 100644 --- a/services/reference/_partials/debug-methods/_debug_traceblock-parameters.mdx +++ b/services/reference/_partials/debug-methods/_debug_traceblock-parameters.mdx @@ -1,7 +1,7 @@ - `block`: (string) RLP of the block - Optional tracing options object with the following fields: - - `tracer`: (string) _[optional]_ type of tracer. Supports [`callTracer`](../debug/index.md#calltracer) or - [`prestateTracer`](../debug/index.md#prestatetracer). + - `tracer`: (string) _[optional]_ type of tracer. Supports `callTracer` or + `prestateTracer`. - `tracerConfig`: (object) _[optional]_ tracer configuration options: - `onlyTopCall`: (boolean) _[optional]_ when `true`, will only trace the primary (top-level) call and not any sub-calls. It eliminates the additional processing for each call frame. \ No newline at end of file diff --git a/services/reference/_partials/debug-methods/_debug_traceblock-returns.mdx b/services/reference/_partials/debug-methods/_debug_traceblock-returns.mdx index c6651004971..904e1c65bbb 100644 --- a/services/reference/_partials/debug-methods/_debug_traceblock-returns.mdx +++ b/services/reference/_partials/debug-methods/_debug_traceblock-returns.mdx @@ -1,2 +1,2 @@ -Depending on the specified tracer type, returns a [`callTracer`](../debug/index.md#calltracer) object or -[`prestateTracer`](../debug/index.md#prestatetracer) object. \ No newline at end of file +Depending on the specified tracer type, returns a `callTracer` object or +`prestateTracer` object. \ No newline at end of file diff --git a/services/reference/_partials/debug-methods/_debug_traceblockbyhash-parameters.mdx b/services/reference/_partials/debug-methods/_debug_traceblockbyhash-parameters.mdx index 766f4b25889..7a2eb090645 100644 --- a/services/reference/_partials/debug-methods/_debug_traceblockbyhash-parameters.mdx +++ b/services/reference/_partials/debug-methods/_debug_traceblockbyhash-parameters.mdx @@ -1,7 +1,7 @@ - `blockHash`: (string) _[required]_ hash of the block to trace. - Optional tracing options object with the following fields: - - `tracer`: (string) _[optional]_ type of tracer. Supports [`callTracer`](../debug/index.md#calltracer) or - [`prestateTracer`](../debug/index.md#prestatetracer). + - `tracer`: (string) _[optional]_ type of tracer. Supports `callTracer` or + `prestateTracer`. - `tracerConfig`: (object) _[optional]_ tracer configuration options: - `onlyTopCall`: (boolean) _[optional]_ when `true`, will only trace the primary (top-level) call and not any sub-calls. It eliminates the additional processing for each call frame. diff --git a/services/reference/_partials/debug-methods/_debug_traceblockbyhash-returns.mdx b/services/reference/_partials/debug-methods/_debug_traceblockbyhash-returns.mdx index 57a5528e4d3..3dc99afee8d 100644 --- a/services/reference/_partials/debug-methods/_debug_traceblockbyhash-returns.mdx +++ b/services/reference/_partials/debug-methods/_debug_traceblockbyhash-returns.mdx @@ -1,2 +1,2 @@ -Depending on the specified tracer type, returns a [`callTracer`](../debug/index.md#calltracer) object or -[`prestateTracer`](../debug/index.md#prestatetracer) object. +Depending on the specified tracer type, returns a `callTracer` object or +`prestateTracer` object. diff --git a/services/reference/_partials/debug-methods/_debug_traceblockbynumber-parameters.mdx b/services/reference/_partials/debug-methods/_debug_traceblockbynumber-parameters.mdx index 7529d27e673..df4237303b0 100644 --- a/services/reference/_partials/debug-methods/_debug_traceblockbynumber-parameters.mdx +++ b/services/reference/_partials/debug-methods/_debug_traceblockbynumber-parameters.mdx @@ -6,8 +6,8 @@ ::: - Optional tracing options object with the following fields: - - `tracer`: (string) _[optional]_ type of tracer. Supports [`callTracer`](../debug/index.md#calltracer) or - [`prestateTracer`](../debug/index.md#prestatetracer). + - `tracer`: (string) _[optional]_ type of tracer. Supports `callTracer` or + `prestateTracer`. - `tracerConfig`: (object) _[optional]_ tracer configuration options: - `onlyTopCall`: (boolean) _[optional]_ when `true`, will only trace the primary (top-level) call and not any sub-calls. It eliminates the additional processing for each call frame. \ No newline at end of file diff --git a/services/reference/_partials/debug-methods/_debug_traceblockbynumber-returns.mdx b/services/reference/_partials/debug-methods/_debug_traceblockbynumber-returns.mdx index c6651004971..904e1c65bbb 100644 --- a/services/reference/_partials/debug-methods/_debug_traceblockbynumber-returns.mdx +++ b/services/reference/_partials/debug-methods/_debug_traceblockbynumber-returns.mdx @@ -1,2 +1,2 @@ -Depending on the specified tracer type, returns a [`callTracer`](../debug/index.md#calltracer) object or -[`prestateTracer`](../debug/index.md#prestatetracer) object. \ No newline at end of file +Depending on the specified tracer type, returns a `callTracer` object or +`prestateTracer` object. \ No newline at end of file diff --git a/services/reference/_partials/debug-methods/_debug_tracecall-parameters.mdx b/services/reference/_partials/debug-methods/_debug_tracecall-parameters.mdx index db5c61b8b5d..20a1855289a 100644 --- a/services/reference/_partials/debug-methods/_debug_tracecall-parameters.mdx +++ b/services/reference/_partials/debug-methods/_debug_tracecall-parameters.mdx @@ -18,8 +18,8 @@ ::: - Optional tracing options object with the following fields: - - `tracer`: (string) _[optional]_ type of tracer. Supports [`callTracer`](../debug/index.md#calltracer) or - [`prestateTracer`](../debug/index.md#prestatetracer). + - `tracer`: (string) _[optional]_ type of tracer. Supports `callTracer` or + `prestateTracer`. - `tracerConfig`: (object) _[optional]_ tracer configuration options: - `onlyTopCall`: (boolean) _[optional]_ when `true`, will only trace the primary (top-level) call and not any sub-calls. It eliminates the additional processing for each call frame. \ No newline at end of file diff --git a/services/reference/_partials/debug-methods/_debug_tracecall-returns.mdx b/services/reference/_partials/debug-methods/_debug_tracecall-returns.mdx index c6651004971..904e1c65bbb 100644 --- a/services/reference/_partials/debug-methods/_debug_tracecall-returns.mdx +++ b/services/reference/_partials/debug-methods/_debug_tracecall-returns.mdx @@ -1,2 +1,2 @@ -Depending on the specified tracer type, returns a [`callTracer`](../debug/index.md#calltracer) object or -[`prestateTracer`](../debug/index.md#prestatetracer) object. \ No newline at end of file +Depending on the specified tracer type, returns a `callTracer` object or +`prestateTracer` object. \ No newline at end of file diff --git a/services/reference/_partials/debug-methods/_debug_tracetransaction-parameters.mdx b/services/reference/_partials/debug-methods/_debug_tracetransaction-parameters.mdx index 858252d8796..a22cad44e54 100644 --- a/services/reference/_partials/debug-methods/_debug_tracetransaction-parameters.mdx +++ b/services/reference/_partials/debug-methods/_debug_tracetransaction-parameters.mdx @@ -1,7 +1,7 @@ -- `transactionHash`: (string) _[required]_ hash of the block to trace. +- `transactionHash`: (string) _[required]_ hash of the transaction. - Optional tracing options object with the following fields: - - `tracer`: (string) _[optional]_ type of tracer. Supports [`callTracer`](../debug/index.md#calltracer) or - [`prestateTracer`](../debug/index.md#prestatetracer). + - `tracer`: (string) _[optional]_ type of tracer. Supports `callTracer` or + `prestateTracer`. - `tracerConfig`: (object) _[optional]_ tracer configuration options: - `onlyTopCall`: (boolean) _[optional]_ when `true`, will only trace the primary (top-level) call and not any sub-calls. It eliminates the additional processing for each call frame. diff --git a/services/reference/_partials/debug-methods/_debug_tracetransaction-returns.mdx b/services/reference/_partials/debug-methods/_debug_tracetransaction-returns.mdx index c6651004971..904e1c65bbb 100644 --- a/services/reference/_partials/debug-methods/_debug_tracetransaction-returns.mdx +++ b/services/reference/_partials/debug-methods/_debug_tracetransaction-returns.mdx @@ -1,2 +1,2 @@ -Depending on the specified tracer type, returns a [`callTracer`](../debug/index.md#calltracer) object or -[`prestateTracer`](../debug/index.md#prestatetracer) object. \ No newline at end of file +Depending on the specified tracer type, returns a `callTracer` object or +`prestateTracer` object. \ No newline at end of file diff --git a/services/reference/scroll/json-rpc-methods/index.md b/services/reference/scroll/json-rpc-methods/index.md index cac9e3de0d3..550af7020de 100644 --- a/services/reference/scroll/json-rpc-methods/index.md +++ b/services/reference/scroll/json-rpc-methods/index.md @@ -70,7 +70,7 @@ service availability problems. | 400 | Bad request | Incorrect HTTP Request type or invalid characters, ensure that your request body and format is correct. | | 401 | Unauthorized | This can happen when one or multiple security requirements are not met. Example responses: `project id required in the url`, `invalid project id`, `invalid project id or project secret`, `invalid JWT`. | | 403 | Forbidden | The request was intentionally refused due to specific settings mismatch, check your key settings. Example response: `"error":{"code":-32002,"message":"rejected due to project ID settings"}`. | -| 429 | Too Many Requests | The daily request total or request per second are higher than your plan allows. Refer to the [Avoid rate limiting](../../how-to/avoid-rate-limiting.md) topic for more information. Example responses: `"error": {"code": -32005, "message": "daily request count exceeded, request rate limited"}`, `"error": {"code": -32005, "message": "project ID request rate exceeded"}`. | +| 429 | Too Many Requests | The daily request total or request per second are higher than your plan allows. Refer to the [Avoid rate limiting](../../../how-to/avoid-rate-limiting.md) topic for more information. Example responses: `"error": {"code": -32005, "message": "daily request count exceeded, request rate limited"}`, `"error": {"code": -32005, "message": "project ID request rate exceeded"}`. | | 500 | Internal Server Error | Error while processing the request on the server side. | | 502 | Bad Gateway | Indicates a communication error which can have various causes, from networking issues to invalid response received from the server. | | 503 | Service Unavailable | Indicates that the server is not ready to handle the request. | diff --git a/snaps/how-to/connect-to-a-snap.md b/snaps/how-to/connect-to-a-snap.md index bb383c737f3..e4c7d9e5c1b 100644 --- a/snaps/how-to/connect-to-a-snap.md +++ b/snaps/how-to/connect-to-a-snap.md @@ -15,7 +15,7 @@ This is possible because Snaps can expose a [custom JSON-RPC API](../learn/about ## Detect wallet To connect to a Snap, dapps must first detect MetaMask in the user's browser. -See the Wallet documentation on [how to connect to MetaMask](/wallet/how-to/connect). +See the Wallet API documentation on [how to connect to the MetaMask extension](/wallet/how-to/connect-extension). ### Detect MetaMask Flask diff --git a/snaps/how-to/test-a-snap.md b/snaps/how-to/test-a-snap.md index 554bb089191..1fb8a0372a8 100644 --- a/snaps/how-to/test-a-snap.md +++ b/snaps/how-to/test-a-snap.md @@ -5,7 +5,7 @@ sidebar_position: 6 # Test a Snap -You can test your Snap [locally](#test-locally), in the [Snaps sandbox](#test-in-a-sandbox), and [end-to-end using Jest](#test-end-to-end). +You can test your Snap [locally](#test-locally), in the [Snaps sandbox](#test-in-the-sandbox), and [end-to-end using Jest](#test-end-to-end). ## Test locally diff --git a/src/components/CreditCost/CreditCostPrice.js b/src/components/CreditCost/CreditCostPrice.js index ee611989aab..fa376dce60c 100644 --- a/src/components/CreditCost/CreditCostPrice.js +++ b/src/components/CreditCost/CreditCostPrice.js @@ -2,6 +2,7 @@ import React from 'react'; import { API_COSTS } from '@site/src/lib/data'; +import Link from '@docusaurus/Link' const CreditCost = ({ network, method }) => { // Get the credit cost for the given network and method, defaulting to 80 if not found @@ -12,9 +13,9 @@ const CreditCost = ({ network, method }) => { return ( This method uses{' '} - + {cost} credits - {' '} + {' '} from your daily balance. ); diff --git a/wallet/how-to/run-devnet.md b/wallet/how-to/run-devnet.md index 9cbebf19e00..bf48fa1f43f 100644 --- a/wallet/how-to/run-devnet.md +++ b/wallet/how-to/run-devnet.md @@ -99,8 +99,7 @@ and select **Reset account**. ## Next steps Once you have your development environment set up and development network running, you can -[connect your dapp to MetaMask](/wallet/how-to/connect) by setting up MetaMask SDK, detecting -MetaMask, detecting a user's network, and accessing a user's accounts. +[connect your dapp to MetaMask](/sdk) by setting up MetaMask SDK. For an end-to-end example, you can also follow the [Create a simple React dapp](../tutorials/react-dapp-local-state.md) tutorial.