diff --git a/gator-sidebar.js b/gator-sidebar.js index 519cbd8e59e..ff39956a4cd 100644 --- a/gator-sidebar.js +++ b/gator-sidebar.js @@ -23,7 +23,7 @@ const sidebar = { items: ['get-started/smart-account-quickstart/eip7702'], }, 'get-started/use-the-cli', - 'get-started/use-with-openclaw', + 'get-started/use-skills', { type: 'category', label: 'Use Scaffold-ETH 2', diff --git a/gator_versioned_docs/version-1.6.0/get-started/use-skills.md b/gator_versioned_docs/version-1.6.0/get-started/use-skills.md new file mode 100644 index 00000000000..304e082f5cf --- /dev/null +++ b/gator_versioned_docs/version-1.6.0/get-started/use-skills.md @@ -0,0 +1,59 @@ +--- +sidebar_label: Use skills +description: Use MetaMask Smart Accounts Kit skills with agent frameworks to build dapps +toc_max_heading_level: 2 +keywords: + [skill, delegation, smart accounts, ai, metamask smart accounts kit, agent framework, x402] +--- + +import GlossaryTerm from '@theme/GlossaryTerm'; + +# Use skills + +Use skills to give your agent framework context on the MetaMask Smart Accounts Kit. +Skills guide your agent through smart account creation, delegations, (ERC-7715), and [x402](../guides/x402/overview.md) +payments. + +Skills are available through the open-source [`MetaMask/skills`](https://github.com/MetaMask/skills) +repository. + +## Smart Accounts Kit + +This skill gives your agent context on the Smart Accounts Kit and how to integrate its +capabilities into your dapp, including smart account creation, delegations, and Advanced +Permissions. + +```bash +npx skills add MetaMask/skills/domains/web3-tools/skills/smart-accounts-kit +``` + +### Key capabilities + +| Capability | Description | +| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Smart accounts | Integrate MetaMask Smart Accounts to support batch transactions, multi-sig signatures, and gas sponsorship. | +| Delegation | Integrate delegations to execute transactions on behalf of a smart account. | +| Advanced Permissions | Integrate Advanced Permissions to execute transactions on behalf of a MetaMask user. | + +## x402 Payments + +This skill helps your agent implement [x402 HTTP-based payments](../guides/x402/overview.md) using +the Smart Accounts Kit, enabling both buyer and seller flows with delegations and Advanced +Permissions. + +```bash +npx skills add MetaMask/skills/domains/web3-tools/skills/x402-payments +``` + +### Key capabilities + +| Capability | Description | +| ---------- | --------------------------------------------------------------------------- | +| Seller | Set up x402 payment endpoints that accept HTTP 402-based payments. | +| Buyer | Pay for x402-protected resources using delegations or Advanced Permissions. | + +## Next steps + +- [Install the Smart Accounts Kit](./install.md) +- [Create your first smart account](./smart-account-quickstart/index.md) +- [Learn about x402 payments](../guides/x402/overview.md) diff --git a/gator_versioned_docs/version-1.6.0/get-started/use-with-openclaw.md b/gator_versioned_docs/version-1.6.0/get-started/use-with-openclaw.md deleted file mode 100644 index 35c49ed1deb..00000000000 --- a/gator_versioned_docs/version-1.6.0/get-started/use-with-openclaw.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -sidebar_label: Use with OpenClaw -description: Use the MetaMask Smart Accounts Kit skill with OpenClaw to build and deploy applications with smart accounts support. -toc_max_heading_level: 2 -keywords: [openclaw, skill, delegation, smart accounts, ai, metamask smart accounts kit] ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import GlossaryTerm from '@theme/GlossaryTerm'; - -# Use the Smart Accounts Kit with OpenClaw - -Use the MetaMask Smart Accounts Kit [OpenClaw skills](https://docs.openclaw.ai/tools/skills) to interact with the Smart Accounts Kit using natural language prompts. - -[OpenClaw](https://openclaw.ai/) is an open-source platform for AI agents that enables you to build, deploy, and -manage AI assistants with access to various tools and skills. The Smart Accounts Kit provides the following two skills. - -## Gator CLI skill - -This skill enables your agent to grant, redeem, inspect, and revoke ERC-7710 delegations using the [`@metamask/gator-cli`](https://www.npmjs.com/package/@metamask/gator-cli) package. - -:::warning Alpha version - -This CLI is in alpha version, and stores agent's private key in a local -JSON file (`~/.gator-cli/`). Please proceed with caution, and do not use -it with accounts holding significant funds. - -::: - -### Install - - - - -```bash -clawhub install gator-cli -``` - - - - -```txt -Install the skill from https://github.com/MetaMask/openclaw-skills/blob/main/metamask/gator-cli/SKILL.md -``` - - - - -### Reference - -The skill provides access to the following commands: - -| Command | Description | -| --------- | -------------------------------------------- | -| `init` | Generate a private key and save config. | -| `create` | Upgrade an EOA to an EIP-7702 smart account. | -| `show` | Display the EOA address. | -| `status` | Check config and onchain account status. | -| `balance` | Show native or ERC-20 balance. | -| `grant` | Create, sign, and store a delegation. | -| `redeem` | Redeem a delegation using an action type. | -| `revoke` | Revoke a delegation onchain. | -| `inspect` | View delegations for your account. | - -## Smart Accounts Kit skill - -This skill helps your agent learn about the Smart Accounts Kit and its capabilities, and integrate them into your applications. - -### Install - - - - -```bash -clawhub install smart-accounts-kit -``` - - - - -```bash -cd ~/.openclaw/workspace/skills -git clone https://github.com/smartgator/smart-accounts-kit-skills.git -``` - - - - -```txt -Install the skill from https://github.com/smartgator/smart-accounts-kit-skills.git -``` - - - - -### Reference - -The skill provides access to the following capabilities: - -| Capability | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| [Smart accounts](https://github.com/smartgator/smart-accounts-kit-skills/blob/main/references/smart-accounts.md) | Helps you integrate MetaMask Smart Accounts to support batch transactions, multi-sig signatures, and gas sponsorship. | -| [Delegation](https://github.com/smartgator/smart-accounts-kit-skills/blob/main/references/delegations.md) | Helps you integrate delegations with scopes and caveats. | -| [Advanced Permissions](https://github.com/smartgator/smart-accounts-kit-skills/blob/main/references/advanced-permissions.md) | Helps you integrate Advanced Permissions. | diff --git a/gator_versioned_sidebars/version-1.6.0-sidebars.json b/gator_versioned_sidebars/version-1.6.0-sidebars.json index f758b72297c..187fc4591d4 100644 --- a/gator_versioned_sidebars/version-1.6.0-sidebars.json +++ b/gator_versioned_sidebars/version-1.6.0-sidebars.json @@ -22,7 +22,7 @@ "items": ["get-started/smart-account-quickstart/eip7702"] }, "get-started/use-the-cli", - "get-started/use-with-openclaw", + "get-started/use-skills", { "type": "category", "label": "Use Scaffold-ETH 2", diff --git a/smart-accounts-kit/get-started/use-skills.md b/smart-accounts-kit/get-started/use-skills.md new file mode 100644 index 00000000000..304e082f5cf --- /dev/null +++ b/smart-accounts-kit/get-started/use-skills.md @@ -0,0 +1,59 @@ +--- +sidebar_label: Use skills +description: Use MetaMask Smart Accounts Kit skills with agent frameworks to build dapps +toc_max_heading_level: 2 +keywords: + [skill, delegation, smart accounts, ai, metamask smart accounts kit, agent framework, x402] +--- + +import GlossaryTerm from '@theme/GlossaryTerm'; + +# Use skills + +Use skills to give your agent framework context on the MetaMask Smart Accounts Kit. +Skills guide your agent through smart account creation, delegations, (ERC-7715), and [x402](../guides/x402/overview.md) +payments. + +Skills are available through the open-source [`MetaMask/skills`](https://github.com/MetaMask/skills) +repository. + +## Smart Accounts Kit + +This skill gives your agent context on the Smart Accounts Kit and how to integrate its +capabilities into your dapp, including smart account creation, delegations, and Advanced +Permissions. + +```bash +npx skills add MetaMask/skills/domains/web3-tools/skills/smart-accounts-kit +``` + +### Key capabilities + +| Capability | Description | +| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Smart accounts | Integrate MetaMask Smart Accounts to support batch transactions, multi-sig signatures, and gas sponsorship. | +| Delegation | Integrate delegations to execute transactions on behalf of a smart account. | +| Advanced Permissions | Integrate Advanced Permissions to execute transactions on behalf of a MetaMask user. | + +## x402 Payments + +This skill helps your agent implement [x402 HTTP-based payments](../guides/x402/overview.md) using +the Smart Accounts Kit, enabling both buyer and seller flows with delegations and Advanced +Permissions. + +```bash +npx skills add MetaMask/skills/domains/web3-tools/skills/x402-payments +``` + +### Key capabilities + +| Capability | Description | +| ---------- | --------------------------------------------------------------------------- | +| Seller | Set up x402 payment endpoints that accept HTTP 402-based payments. | +| Buyer | Pay for x402-protected resources using delegations or Advanced Permissions. | + +## Next steps + +- [Install the Smart Accounts Kit](./install.md) +- [Create your first smart account](./smart-account-quickstart/index.md) +- [Learn about x402 payments](../guides/x402/overview.md) diff --git a/smart-accounts-kit/get-started/use-with-openclaw.md b/smart-accounts-kit/get-started/use-with-openclaw.md deleted file mode 100644 index 35c49ed1deb..00000000000 --- a/smart-accounts-kit/get-started/use-with-openclaw.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -sidebar_label: Use with OpenClaw -description: Use the MetaMask Smart Accounts Kit skill with OpenClaw to build and deploy applications with smart accounts support. -toc_max_heading_level: 2 -keywords: [openclaw, skill, delegation, smart accounts, ai, metamask smart accounts kit] ---- - -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import GlossaryTerm from '@theme/GlossaryTerm'; - -# Use the Smart Accounts Kit with OpenClaw - -Use the MetaMask Smart Accounts Kit [OpenClaw skills](https://docs.openclaw.ai/tools/skills) to interact with the Smart Accounts Kit using natural language prompts. - -[OpenClaw](https://openclaw.ai/) is an open-source platform for AI agents that enables you to build, deploy, and -manage AI assistants with access to various tools and skills. The Smart Accounts Kit provides the following two skills. - -## Gator CLI skill - -This skill enables your agent to grant, redeem, inspect, and revoke ERC-7710 delegations using the [`@metamask/gator-cli`](https://www.npmjs.com/package/@metamask/gator-cli) package. - -:::warning Alpha version - -This CLI is in alpha version, and stores agent's private key in a local -JSON file (`~/.gator-cli/`). Please proceed with caution, and do not use -it with accounts holding significant funds. - -::: - -### Install - - - - -```bash -clawhub install gator-cli -``` - - - - -```txt -Install the skill from https://github.com/MetaMask/openclaw-skills/blob/main/metamask/gator-cli/SKILL.md -``` - - - - -### Reference - -The skill provides access to the following commands: - -| Command | Description | -| --------- | -------------------------------------------- | -| `init` | Generate a private key and save config. | -| `create` | Upgrade an EOA to an EIP-7702 smart account. | -| `show` | Display the EOA address. | -| `status` | Check config and onchain account status. | -| `balance` | Show native or ERC-20 balance. | -| `grant` | Create, sign, and store a delegation. | -| `redeem` | Redeem a delegation using an action type. | -| `revoke` | Revoke a delegation onchain. | -| `inspect` | View delegations for your account. | - -## Smart Accounts Kit skill - -This skill helps your agent learn about the Smart Accounts Kit and its capabilities, and integrate them into your applications. - -### Install - - - - -```bash -clawhub install smart-accounts-kit -``` - - - - -```bash -cd ~/.openclaw/workspace/skills -git clone https://github.com/smartgator/smart-accounts-kit-skills.git -``` - - - - -```txt -Install the skill from https://github.com/smartgator/smart-accounts-kit-skills.git -``` - - - - -### Reference - -The skill provides access to the following capabilities: - -| Capability | Description | -| ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| [Smart accounts](https://github.com/smartgator/smart-accounts-kit-skills/blob/main/references/smart-accounts.md) | Helps you integrate MetaMask Smart Accounts to support batch transactions, multi-sig signatures, and gas sponsorship. | -| [Delegation](https://github.com/smartgator/smart-accounts-kit-skills/blob/main/references/delegations.md) | Helps you integrate delegations with scopes and caveats. | -| [Advanced Permissions](https://github.com/smartgator/smart-accounts-kit-skills/blob/main/references/advanced-permissions.md) | Helps you integrate Advanced Permissions. | diff --git a/vercel.json b/vercel.json index ab8e035d546..1fc0983976e 100644 --- a/vercel.json +++ b/vercel.json @@ -715,6 +715,10 @@ "source": "/delegation-toolkit/:path*/", "destination": "/smart-accounts-kit/" }, + { + "source": "/smart-accounts-kit/get-started/use-with-openclaw/", + "destination": "/smart-accounts-kit/get-started/use-skills/" + }, { "source": "/developer-tools/dashboard/how-to/", "destination": "/developer-tools/dashboard/"