diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx index 1848d18..7f8c50e 100644 --- a/docs/pages/index.mdx +++ b/docs/pages/index.mdx @@ -10,14 +10,14 @@ import { HomePage } from 'vocs/components' **Pimlico** is the world's most advanced ERC-4337 account abstraction infrastructure platform. Pimlico provides a suite of tools and services to help you build, deploy, and manage smart accounts on Ethereum and other EVM-compatible chains. - Get started + Get started Go to Dashboard
- ## [permissionless.js →](/permissionless/core) + ## [permissionless.js →](/permissionless) Our TypeScript library built on viem for interacting with ERC-4337 bundlers, paymasters, and user operations.
diff --git a/docs/pages/infra/bundler/compression/index.mdx b/docs/pages/infra/bundler/compression/index.mdx index a5f9560..961893d 100644 --- a/docs/pages/infra/bundler/compression/index.mdx +++ b/docs/pages/infra/bundler/compression/index.mdx @@ -1,7 +1,7 @@ # How to create your own inflator contract and submit compressed user operations to Pimlico's bundler :::info -This guide assumes you are already familiar with the process of creating and submitting normal user operations to bundlers. If you are not, we recommend you start with [tutorial 1 of our library, permissionless.js](/permissionless/core/tutorial/tutorial-1). +This guide assumes you are already familiar with the process of creating and submitting normal user operations to bundlers. If you are not, we recommend you start with [tutorial 1 of our library, permissionless.js](/permissionless/tutorial/tutorial-1). ::: This guide walks you through how to create your own inflator contract, compress your user operations and submit them to Pimlico's bundler to achieve significant gas cost savings for your users. @@ -93,7 +93,7 @@ We have deployed the above `SimpleInflator` contract to `0x564c7dC50f8293d070F49 ### Start submitting your compressed user operations :::tip[Tip] -If you are using [permissionless.js](/permissionless/core), there is a useful helper function that will allow you to easily submit compressed user operations. See the [`sendCompressedUserOperation`](/permissionless/core/reference/pimlico-actions/sendCompressedUserOperation) helper function. +If you are using [permissionless.js](/permissionless), there is a useful helper function that will allow you to easily submit compressed user operations. See the [`sendCompressedUserOperation`](/permissionless/reference/pimlico-actions/sendCompressedUserOperation) helper function. ::: Once your decompressor contract is deployed and whitelisted, you can start submitting compressed user operations to Pimlico's bundler using the [`pimlico_sendCompressedUserOperation`](/infra/bundler/endpoints/pimlico_sendCompressedUserOperation) JSON-RPC method. diff --git a/docs/pages/infra/bundler/entrypoint-errors/aa14.mdx b/docs/pages/infra/bundler/entrypoint-errors/aa14.mdx index 563e026..8ea4cd8 100644 --- a/docs/pages/infra/bundler/entrypoint-errors/aa14.mdx +++ b/docs/pages/infra/bundler/entrypoint-errors/aa14.mdx @@ -4,7 +4,7 @@ The address of the smart account deployed with the `initCode` provided does not ## Possible solutions -- Verify that the `sender` address was generated deterministically from the `initCode`. (consider leveraging functions like [getSenderAddress](/permissionless/core/reference/public-actions/getSenderAddress)) +- Verify that the `sender` address was generated deterministically from the `initCode`. (consider leveraging functions like [getSenderAddress](/permissionless/reference/public-actions/getSenderAddress)) - Verify that the factory address in the `initCode` is correct (the factory address is the first 20 bytes of the `initCode`). - Verify that the `initCode` is correct. - If all else fails, investigate why the `initCode` deploys to a different address than expected using tools like [Tenderly](https://tenderly.co/). \ No newline at end of file diff --git a/docs/pages/infra/bundler/entrypoint-errors/aa21.mdx b/docs/pages/infra/bundler/entrypoint-errors/aa21.mdx index 688a2f3..99c88f4 100644 --- a/docs/pages/infra/bundler/entrypoint-errors/aa21.mdx +++ b/docs/pages/infra/bundler/entrypoint-errors/aa21.mdx @@ -4,7 +4,7 @@ You are *not* using a paymaster, but the `sender` address did not have enough na ## Possible solutions -- If you are *not* using a paymaster, verify that the `sender` address has enough native tokens to cover the required prefund. Consider leveraging functions like [`getRequiredPrefund`](/permissionless/core/reference/utils/getRequiredPrefund). +- If you are *not* using a paymaster, verify that the `sender` address has enough native tokens to cover the required prefund. Consider leveraging functions like [`getRequiredPrefund`](/permissionless/reference/utils/getRequiredPrefund). ```ts const requiredPrefund = getRequiredPrefund({ userOperation diff --git a/docs/pages/infra/bundler/entrypoint-errors/aa23.mdx b/docs/pages/infra/bundler/entrypoint-errors/aa23.mdx index fb475fa..e2776e5 100644 --- a/docs/pages/infra/bundler/entrypoint-errors/aa23.mdx +++ b/docs/pages/infra/bundler/entrypoint-errors/aa23.mdx @@ -10,7 +10,7 @@ The `validateUserOp` function of the smart account either reverted or ran out of - Verify that the `verificationGasLimit` is high enough to cover the `validateUserOp` function's gas costs. - Verify that the `validateUserOp` function is implemented with the correct logic, and that the user operation is supposed to be valid. -- If you are *not* using a paymaster, verify that the `sender` address has enough native tokens to cover the required prefund. Consider leveraging functions like [`getRequiredPrefund`](/permissionless/core/reference/utils/getRequiredPrefund). +- If you are *not* using a paymaster, verify that the `sender` address has enough native tokens to cover the required prefund. Consider leveraging functions like [`getRequiredPrefund`](/permissionless/reference/utils/getRequiredPrefund). ```ts const requiredPrefund = getRequiredPrefund({ userOperation diff --git a/docs/pages/infra/bundler/entrypoint-errors/aa25.mdx b/docs/pages/infra/bundler/entrypoint-errors/aa25.mdx index c01a6b1..0e6f9a0 100644 --- a/docs/pages/infra/bundler/entrypoint-errors/aa25.mdx +++ b/docs/pages/infra/bundler/entrypoint-errors/aa25.mdx @@ -4,11 +4,11 @@ The `nonce` of the user operation is invalid. ## Possible solutions -- Verify that you are using the correct `nonce` for the user operation. The `nonce` should be the current nonce of the smart account for the selected `key`. Consider leveraging functions like [`getAccountNonce`](/permissionless/core/reference/public-actions/getAccountNonce). +- Verify that you are using the correct `nonce` for the user operation. The `nonce` should be the current nonce of the smart account for the selected `key`. Consider leveraging functions like [`getAccountNonce`](/permissionless/reference/public-actions/getAccountNonce). - Make sure that you are not reusing a nonce that has already been used. - Make sure that you are not using a nonce that is too far in the future (more than 10 higher than the current nonce). - Verify that the nonce is formatted correctly. -- Use custom nonce `key` to send parallel transactions. See [How to Send Multiple Transactions](/permissionless/core/how-to/parallel-transactions##sending-multiple-transactions-in-parallel). +- Use custom nonce `key` to send parallel transactions. See [How to Send Multiple Transactions](/permissionless/how-to/parallel-transactions##sending-multiple-transactions-in-parallel). :::info Instead of sequential nonce the EntryPoint implements a nonce mechanism that uses a single `uint256` nonce value in the user operation, but treats it as two values: diff --git a/docs/pages/infra/bundler/index.mdx b/docs/pages/infra/bundler/index.mdx index 76d84c1..f6e3257 100644 --- a/docs/pages/infra/bundler/index.mdx +++ b/docs/pages/infra/bundler/index.mdx @@ -10,8 +10,8 @@ Our focus is on full type safety, transaction inclusion reliability (even in the Learning-oriented lessons that take you through a series of steps to complete a project. Most useful when you want to get started with Pimlico. They all involve the Alto Bundler. -- [Tutorial 1](/permissionless/core/tutorial/tutorial-1) leverages the Alto Bundler to create and bundle a user operation on-chain. -- [Tutorial 2](/permissionless/core/tutorial/tutorial-2) leverages the Alto Bundler again, but using the [ERC-20 paymaster](/infra/paymaster/erc20-paymaster) instead of the Verifying Paymaster +- [Tutorial 1](/permissionless/tutorial/tutorial-1) leverages the Alto Bundler to create and bundle a user operation on-chain. +- [Tutorial 2](/permissionless/tutorial/tutorial-2) leverages the Alto Bundler again, but using the [ERC-20 paymaster](/infra/paymaster/erc20-paymaster) instead of the Verifying Paymaster ## How-To Guides diff --git a/docs/pages/infra/bundler/usage.mdx b/docs/pages/infra/bundler/usage.mdx index c4b66ee..ff053a6 100644 --- a/docs/pages/infra/bundler/usage.mdx +++ b/docs/pages/infra/bundler/usage.mdx @@ -1,7 +1,7 @@ # How to use the bundler :::tip[Tip] -We recommend using [permissionless.js](/permissionless/core/reference/smart-account-actions/sendUserOperation) as the SDK to interact with the bundler as it provides type-safe wrappers for all bundler methods. +We recommend using [permissionless.js](/permissionless/reference/smart-account-actions/sendUserOperation) as the SDK to interact with the bundler as it provides type-safe wrappers for all bundler methods. ::: ERC-4337 bundlers are relayers that bundle user operations into transactions and submit them to the blockchain. You can interact with bundlers using standard JSON-RPC requests. @@ -17,4 +17,4 @@ To get access to the bundler, you need to use your [Pimlico API key](https://das - [pimlico_getUserOperationGasPrice](/infra/bundler/endpoints/pimlico_getUserOperationGasPrice) - [pimlico_getUserOperationStatus](/infra/bundler/endpoints/pimlico_getUserOperationStatus) -If you would like an end-to-end example of how to use the bundler, please refer to [tutorial 1](/permissionless/core/tutorial/tutorial-1) of the permissionless.js documentation. +If you would like an end-to-end example of how to use the bundler, please refer to [tutorial 1](/permissionless/tutorial/tutorial-1) of the permissionless.js documentation. diff --git a/docs/pages/infra/paymaster/erc20-paymaster-permissionless/faqs.mdx b/docs/pages/infra/paymaster/erc20-paymaster-permissionless/faqs.mdx index dda08a6..3cf43f7 100644 --- a/docs/pages/infra/paymaster/erc20-paymaster-permissionless/faqs.mdx +++ b/docs/pages/infra/paymaster/erc20-paymaster-permissionless/faqs.mdx @@ -33,7 +33,7 @@ This paymaster has four modes. It allows the user to be simply made to pay thems ## How do I use Pimlico's ERC-20 Paymaster? :::info -**Check out our tutorial!** We wrote a [tutorial](/permissionless/core/tutorial/tutorial-2) that takes you through the whole flow of deploying a Safe account and sending your first user operation sponsored with USDC. +**Check out our tutorial!** We wrote a [tutorial](/permissionless/tutorial/tutorial-2) that takes you through the whole flow of deploying a Safe account and sending your first user operation sponsored with USDC. ::: While the specifics can vary depending on the specific ERC-20 token and chain you're using, the general steps are as follows: @@ -62,7 +62,7 @@ Do any final touches to your user operation, such as signing, then submit the us Yes! -Check out our [Getting Started with the ERC-20 Paymaster](/permissionless/core/tutorial/tutorial-2) guide that walks you through deploying your SimpleWallet and getting your first UserOperation sponsored with USDC. +Check out our [Getting Started with the ERC-20 Paymaster](/permissionless/tutorial/tutorial-2) guide that walks you through deploying your SimpleWallet and getting your first UserOperation sponsored with USDC. ## What ERC-20 tokens and on what chains can I use Pimlico's ERC-20 Paymaster with? @@ -86,7 +86,7 @@ However, an audit does not guarantee complete security. Please use the paymaster ## Is there an SDK I can use to interact with the ERC-20 Paymaster? -You can use permissionless.js to easily interact with the ERC-20 Paymaster. Check out the [documentation](/permissionless/core/how-to/paymasters/use-custom-paymaster) for more information. +You can use permissionless.js to easily interact with the ERC-20 Paymaster. Check out the [documentation](/permissionless/how-to/paymasters/use-custom-paymaster) for more information. ## Is the ERC-20 Paymaster permissionless? diff --git a/docs/pages/infra/paymaster/erc20-paymaster-permissionless/index.mdx b/docs/pages/infra/paymaster/erc20-paymaster-permissionless/index.mdx index c1da134..8b774c1 100644 --- a/docs/pages/infra/paymaster/erc20-paymaster-permissionless/index.mdx +++ b/docs/pages/infra/paymaster/erc20-paymaster-permissionless/index.mdx @@ -10,7 +10,7 @@ Pimlico is proud to have written and launched the first permissionless, fully-au Learning-oriented lessons that take you through a series of steps to complete a project. Most useful when you want to get started with Pimlico. They all involve the Alto Bundler. -- [Tutorial 2](/permissionless/core/tutorial/tutorial-2) leverages the ERC-20 Paymaster to sponsor the gas fees for a User Operation with USDC. +- [Tutorial 2](/permissionless/tutorial/tutorial-2) leverages the ERC-20 Paymaster to sponsor the gas fees for a User Operation with USDC. ## References diff --git a/docs/pages/infra/paymaster/erc20-paymaster/faqs.mdx b/docs/pages/infra/paymaster/erc20-paymaster/faqs.mdx index 1d57320..a347143 100644 --- a/docs/pages/infra/paymaster/erc20-paymaster/faqs.mdx +++ b/docs/pages/infra/paymaster/erc20-paymaster/faqs.mdx @@ -10,7 +10,7 @@ An ERC-20 Paymaster is a specific type of paymaster that is willing to sponsor t ## How do I use Pimlico's ERC-20 Paymaster? -We wrote a [tutorial](/permissionless/core/tutorial/tutorial-2) that takes you through the whole flow of deploying a Safe account and sending your first user operation sponsored with USDC. +We wrote a [tutorial](/permissionless/tutorial/tutorial-2) that takes you through the whole flow of deploying a Safe account and sending your first user operation sponsored with USDC. We also have a [how-to guide](/infra/paymaster/erc20-paymaster/how-to/use-paymaster) that explains how to use the ERC-20 Paymaster in your app's flow. diff --git a/docs/pages/infra/paymaster/erc20-paymaster/index.mdx b/docs/pages/infra/paymaster/erc20-paymaster/index.mdx index d09c489..da6c9c7 100644 --- a/docs/pages/infra/paymaster/erc20-paymaster/index.mdx +++ b/docs/pages/infra/paymaster/erc20-paymaster/index.mdx @@ -8,7 +8,7 @@ Pimlico's ERC-20 Paymaster is a ERC-4337 paymaster that is able to pay for the g Learning-oriented lessons that take you through a series of steps to complete a project. Most useful when you want to get started with Pimlico. They all involve the Alto Bundler. -- [Tutorial 2](/permissionless/core/tutorial/tutorial-2) leverages the ERC-20 Paymaster to sponsor the gas fees for a user operation with USDC. +- [Tutorial 2](/permissionless/tutorial/tutorial-2) leverages the ERC-20 Paymaster to sponsor the gas fees for a user operation with USDC. ## How-to Guides diff --git a/docs/pages/infra/paymaster/verifying-paymaster/index.mdx b/docs/pages/infra/paymaster/verifying-paymaster/index.mdx index f441755..451851b 100644 --- a/docs/pages/infra/paymaster/verifying-paymaster/index.mdx +++ b/docs/pages/infra/paymaster/verifying-paymaster/index.mdx @@ -7,7 +7,7 @@ Pimlico's Verifying Paymaster is a combination of an API and an on-chain smart c Learning-oriented lessons that take you through a series of steps to complete a project. Most useful when you want to get started with Pimlico. They all involve the Alto Bundler. -- [Tutorial 1](/permissionless/core/tutorial/tutorial-1) leverages the Verifying Paymaster to sponsor the gas fees for a User Operation. +- [Tutorial 1](/permissionless/tutorial/tutorial-1) leverages the Verifying Paymaster to sponsor the gas fees for a User Operation. ## References diff --git a/docs/pages/infra/paymaster/verifying-paymaster/usage.mdx b/docs/pages/infra/paymaster/verifying-paymaster/usage.mdx index 77359cd..dbb6ead 100644 --- a/docs/pages/infra/paymaster/verifying-paymaster/usage.mdx +++ b/docs/pages/infra/paymaster/verifying-paymaster/usage.mdx @@ -1,7 +1,7 @@ # How to use the Verifying Paymaster :::tip[Tip] -We recommend using [permissionless.js](/permissionless/core/reference/smart-account-actions/sendUserOperation) as the SDK to interact with the Verifying Paymaster as it provides type-safe wrappers for paymaster methods. +We recommend using [permissionless.js](/permissionless/reference/smart-account-actions/sendUserOperation) as the SDK to interact with the Verifying Paymaster as it provides type-safe wrappers for paymaster methods. ::: Paymasters are entities that user operations can delegate the responsibilities for gas fee payments for. You can interact with paymasters using JSON-RPC requests. @@ -10,4 +10,4 @@ To get access to the paymaster, you need to sign up to the [Pimlico dashboard](h - [pm_sponsorUserOperation](/infra/paymaster/verifying-paymaster/endpoints/pm_sponsorUserOperation) -If you would like an end-to-end example of how to use the Verifying Paymaster, please refer to [tutorial 1](/permissionless/core/tutorial/tutorial-1) of the permissionless.js documentation. \ No newline at end of file +If you would like an end-to-end example of how to use the Verifying Paymaster, please refer to [tutorial 1](/permissionless/tutorial/tutorial-1) of the permissionless.js documentation. \ No newline at end of file diff --git a/docs/pages/infra/platform/sponsorship-policies/index.mdx b/docs/pages/infra/platform/sponsorship-policies/index.mdx index 59a601d..c5bbe3b 100644 --- a/docs/pages/infra/platform/sponsorship-policies/index.mdx +++ b/docs/pages/infra/platform/sponsorship-policies/index.mdx @@ -12,7 +12,7 @@ Start by going to the [sponsorship policies page](/infra/platform/sponsorship-po ## Usage of Sponsorship Policies with permisionless.js -If you are using [permissionless.js](/permissionless/core), you can use the `PimlicoPaymasterClient` to use sponsorship policies. +If you are using [permissionless.js](/permissionless), you can use the `PimlicoPaymasterClient` to use sponsorship policies. :::::steps diff --git a/docs/pages/infra/platform/why-pimlico/enterprise.mdx b/docs/pages/infra/platform/why-pimlico/enterprise.mdx index 6b659cc..06e4d06 100644 --- a/docs/pages/infra/platform/why-pimlico/enterprise.mdx +++ b/docs/pages/infra/platform/why-pimlico/enterprise.mdx @@ -16,7 +16,7 @@ At Pimlico, we built our platform for scale. Our servers are regularly load test Pimlico is also built to be customizable to fit your enterprise's needs. Out of the box, we support: - [70+ chains](/infra/platform/supported-chains) -- [All ERC-4337 smart accounts implementations, and all official EntryPoint versions](/permissionless/core/how-to/accounts/support) +- [All ERC-4337 smart accounts implementations, and all official EntryPoint versions](/permissionless/how-to/accounts/support) - [Sponsorship policies](/infra/platform/sponsorship-policies) with global, per user, per user operation spending limits, custom webhook validation, and more - API key authentication and authorization options diff --git a/docs/pages/infra/platform/why-pimlico/startups.mdx b/docs/pages/infra/platform/why-pimlico/startups.mdx index 9ed289c..a06b841 100644 --- a/docs/pages/infra/platform/why-pimlico/startups.mdx +++ b/docs/pages/infra/platform/why-pimlico/startups.mdx @@ -17,7 +17,7 @@ This means you can expect features such as: - Multi-chain support, letting you build with smart accounts on [over 70+ chains](/infra/platform/supported-chains) - API key authentication and authorization options, letting you control how your bundlers and paymasters can be accessed - Flexible payment methods, letting you pay for your usage with a credit card, bank transfer, crypto -- [permissionless.js](/permissionless/core/why), a smart account-focused TypeScript library that supports any bundler and paymaster providers and all major smart account implementations, built by developers for developers with over 20,000 weekly NPM downloads. +- [permissionless.js](/permissionless/why), a smart account-focused TypeScript library that supports any bundler and paymaster providers and all major smart account implementations, built by developers for developers with over 20,000 weekly NPM downloads. ## Pay-as-you-go pricing options diff --git a/docs/pages/permissionless/core/VersionWarning.tsx b/docs/pages/permissionless/VersionWarning.tsx similarity index 100% rename from docs/pages/permissionless/core/VersionWarning.tsx rename to docs/pages/permissionless/VersionWarning.tsx diff --git a/docs/pages/permissionless/core/tutorial/index.mdx b/docs/pages/permissionless/core/tutorial/index.mdx deleted file mode 100644 index 3802591..0000000 --- a/docs/pages/permissionless/core/tutorial/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -import VersionWarning from "../VersionWarning" - - - -# Tutorials - -Learning-oriented lessons that take you through a series of steps to complete a project. Most useful when you want to get started with Pimlico. - -[Tutorial 1](/permissionless/core/tutorial/tutorial-1) takes you through the journey of leveraging permissionless.js's high-level APIs to easily create and bundle a user operation. - -[Tutorial 2](/permissionless/core/tutorial/tutorial-2) takes you through the journey of sponsoring your first user operation with USDC with an ERC-20 paymaster. diff --git a/docs/pages/permissionless/core/v0_1/tutorial/index.mdx b/docs/pages/permissionless/core/v0_1/tutorial/index.mdx deleted file mode 100644 index 79c09d8..0000000 --- a/docs/pages/permissionless/core/v0_1/tutorial/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -import VersionWarning from "../../VersionWarning" - - - -# Tutorials - -Learning-oriented lessons that take you through a series of steps to complete a project. Most useful when you want to get started with Pimlico. - -[Tutorial 1](/permissionless/core/v0_1/tutorial/tutorial-1) takes you through the journey of leveraging permissionless.js's high-level APIs to easily create and bundle a user operation. - -[Tutorial 2](/permissionless/core/v0_1/tutorial/tutorial-2) takes you through the journey of creating a user operation, getting it sponsored by our verifying paymaster, and then sending it to be included on-chain with our bundler. diff --git a/docs/pages/permissionless/core/faqs.mdx b/docs/pages/permissionless/faqs.mdx similarity index 100% rename from docs/pages/permissionless/core/faqs.mdx rename to docs/pages/permissionless/faqs.mdx diff --git a/docs/pages/permissionless/core/how-to/accounts/support.mdx b/docs/pages/permissionless/how-to/accounts/support.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/accounts/support.mdx rename to docs/pages/permissionless/how-to/accounts/support.mdx diff --git a/docs/pages/permissionless/core/how-to/accounts/use-biconomy-account.mdx b/docs/pages/permissionless/how-to/accounts/use-biconomy-account.mdx similarity index 96% rename from docs/pages/permissionless/core/how-to/accounts/use-biconomy-account.mdx rename to docs/pages/permissionless/how-to/accounts/use-biconomy-account.mdx index cd2ce14..0a0968c 100644 --- a/docs/pages/permissionless/core/how-to/accounts/use-biconomy-account.mdx +++ b/docs/pages/permissionless/how-to/accounts/use-biconomy-account.mdx @@ -26,7 +26,7 @@ First we must create the public, (optionally) pimlico paymaster clients that wil ### Create the signer -Biconomy accounts can work with a variety of signing algorithms such as ECDSA, passkeys, and multisig. In permissionless.js, the default Biconomy account validates ECDSA signatures. [Any signer](/permissionless/core/how-to/signers) can be used as a signer for the Biconomy account. +Biconomy accounts can work with a variety of signing algorithms such as ECDSA, passkeys, and multisig. In permissionless.js, the default Biconomy account validates ECDSA signatures. [Any signer](/permissionless/how-to/signers) can be used as a signer for the Biconomy account. For example, to create a signer based on a private key: diff --git a/docs/pages/permissionless/core/how-to/accounts/use-coinbase-account.mdx b/docs/pages/permissionless/how-to/accounts/use-coinbase-account.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/accounts/use-coinbase-account.mdx rename to docs/pages/permissionless/how-to/accounts/use-coinbase-account.mdx diff --git a/docs/pages/permissionless/core/how-to/accounts/use-erc7579-account.mdx b/docs/pages/permissionless/how-to/accounts/use-erc7579-account.mdx similarity index 96% rename from docs/pages/permissionless/core/how-to/accounts/use-erc7579-account.mdx rename to docs/pages/permissionless/how-to/accounts/use-erc7579-account.mdx index d74d5d0..d427e21 100644 --- a/docs/pages/permissionless/core/how-to/accounts/use-erc7579-account.mdx +++ b/docs/pages/permissionless/how-to/accounts/use-erc7579-account.mdx @@ -8,7 +8,7 @@ import VersionWarning from "../../VersionWarning" Currently Safe and Kernel are the only smart accounts that implements ERC-7579. -For this guide, we will use the Safe smart accounts as an example. If you would like to find out more about the Safe smart account, you can check out the [Safe-specific guide](/permissionless/core/how-to/accounts/use-safe-account). +For this guide, we will use the Safe smart accounts as an example. If you would like to find out more about the Safe smart account, you can check out the [Safe-specific guide](/permissionless/how-to/accounts/use-safe-account). This guide will show you how to create and use a ERC-7579 compatible smart account with permissionless.js. @@ -33,7 +33,7 @@ First we must create the public, (optionally) pimlico paymaster clients that wil ### Create the SafeAccount :::info -For a full list of options for creating a SafeAccount, take a look at the reference documentation page for [`toSafeSmartAccount`](/permissionless/core/reference/accounts/toSafeSmartAccount). +For a full list of options for creating a SafeAccount, take a look at the reference documentation page for [`toSafeSmartAccount`](/permissionless/reference/accounts/toSafeSmartAccount). ::: You can also pass an `address` to use an already created SafeAccount. diff --git a/docs/pages/permissionless/core/how-to/accounts/use-kernel-account.mdx b/docs/pages/permissionless/how-to/accounts/use-kernel-account.mdx similarity index 95% rename from docs/pages/permissionless/core/how-to/accounts/use-kernel-account.mdx rename to docs/pages/permissionless/how-to/accounts/use-kernel-account.mdx index 166c7b5..944564f 100644 --- a/docs/pages/permissionless/core/how-to/accounts/use-kernel-account.mdx +++ b/docs/pages/permissionless/how-to/accounts/use-kernel-account.mdx @@ -38,7 +38,7 @@ First we must create the public, (optionally) pimlico paymaster clients that wil ### Create the signer -Kernel accounts can work with a variety of signing algorithms such as ECDSA, passkeys, and multisig. In permissionless.js, the default Kernel account validates ECDSA signatures. [Any signer](/permissionless/core/how-to/signers) can be used as a signer for the Kernel account. +Kernel accounts can work with a variety of signing algorithms such as ECDSA, passkeys, and multisig. In permissionless.js, the default Kernel account validates ECDSA signatures. [Any signer](/permissionless/how-to/signers) can be used as a signer for the Kernel account. For example, to create a signer based on a private key: @@ -49,7 +49,7 @@ For example, to create a signer based on a private key: ### Create the Kernel account :::info -For a full list of options for creating a Kernel account, take a look at the reference documentation page for [`toEcdsaKernelSmartAccount`](/permissionless/core/reference/accounts/toEcdsaKernelSmartAccount). +For a full list of options for creating a Kernel account, take a look at the reference documentation page for [`toEcdsaKernelSmartAccount`](/permissionless/reference/accounts/toEcdsaKernelSmartAccount). ::: With a signer, you can create a Kernel account as such: diff --git a/docs/pages/permissionless/core/how-to/accounts/use-light-account.mdx b/docs/pages/permissionless/how-to/accounts/use-light-account.mdx similarity index 96% rename from docs/pages/permissionless/core/how-to/accounts/use-light-account.mdx rename to docs/pages/permissionless/how-to/accounts/use-light-account.mdx index 8562333..40e4644 100644 --- a/docs/pages/permissionless/core/how-to/accounts/use-light-account.mdx +++ b/docs/pages/permissionless/how-to/accounts/use-light-account.mdx @@ -30,7 +30,7 @@ First we must create the public, (optionally) pimlico paymaster clients that wil ### Create the LightAccount :::info -For a full list of options for creating a LightAccount, take a look at the reference documentation page for [`toLightSmartAccount`](/permissionless/core/reference/accounts/toLightSmartAccount). +For a full list of options for creating a LightAccount, take a look at the reference documentation page for [`toLightSmartAccount`](/permissionless/reference/accounts/toLightSmartAccount). ::: You can also pass an `address` to use an already created LightAccount. diff --git a/docs/pages/permissionless/core/how-to/accounts/use-safe-account.mdx b/docs/pages/permissionless/how-to/accounts/use-safe-account.mdx similarity index 95% rename from docs/pages/permissionless/core/how-to/accounts/use-safe-account.mdx rename to docs/pages/permissionless/how-to/accounts/use-safe-account.mdx index 13070b9..ff1f827 100644 --- a/docs/pages/permissionless/core/how-to/accounts/use-safe-account.mdx +++ b/docs/pages/permissionless/how-to/accounts/use-safe-account.mdx @@ -26,7 +26,7 @@ First we must create the public, (optionally) pimlico paymaster clients that wil ### Create the signer -The Safe account will need to have a signer to sign user operations. In permissionless.js, the default Safe account validates ECDSA signatures. [Any permissionless.js-compatible signer](/permissionless/core/how-to/signers) can be used for the Safe account. +The Safe account will need to have a signer to sign user operations. In permissionless.js, the default Safe account validates ECDSA signatures. [Any permissionless.js-compatible signer](/permissionless/how-to/signers) can be used for the Safe account. For example, to create a signer based on a private key: @@ -37,7 +37,7 @@ For example, to create a signer based on a private key: ### Create the Safe account :::info -For a full list of options for creating a Safe account, take a look at the reference documentation page for [`toSafeSmartAccount`](/permissionless/core/reference/accounts/toSafeSmartAccount). +For a full list of options for creating a Safe account, take a look at the reference documentation page for [`toSafeSmartAccount`](/permissionless/reference/accounts/toSafeSmartAccount). ::: With a signer, you can create a Safe account as such: diff --git a/docs/pages/permissionless/core/how-to/accounts/use-simple-account.mdx b/docs/pages/permissionless/how-to/accounts/use-simple-account.mdx similarity index 96% rename from docs/pages/permissionless/core/how-to/accounts/use-simple-account.mdx rename to docs/pages/permissionless/how-to/accounts/use-simple-account.mdx index 8eb3bb1..ee39b81 100644 --- a/docs/pages/permissionless/core/how-to/accounts/use-simple-account.mdx +++ b/docs/pages/permissionless/how-to/accounts/use-simple-account.mdx @@ -28,7 +28,7 @@ First we must create the public, (optionally) pimlico paymaster clients that wil ### Create the SimpleAccount :::info -For a full list of options for creating a SimpleAccount, take a look at the reference documentation page for [`toSimpleSmartAccount`](/permissionless/core/reference/accounts/toSimpleSmartAccount). +For a full list of options for creating a SimpleAccount, take a look at the reference documentation page for [`toSimpleSmartAccount`](/permissionless/reference/accounts/toSimpleSmartAccount). ::: You can create a SimpleAccount with the canonical module addresses by specifying the factory address the account will be deployed from. You can also pass an `address` to use an already created SimpleAccount. diff --git a/docs/pages/permissionless/core/how-to/accounts/use-trustwallet-account.mdx b/docs/pages/permissionless/how-to/accounts/use-trustwallet-account.mdx similarity index 97% rename from docs/pages/permissionless/core/how-to/accounts/use-trustwallet-account.mdx rename to docs/pages/permissionless/how-to/accounts/use-trustwallet-account.mdx index ef27a5c..3dc50b8 100644 --- a/docs/pages/permissionless/core/how-to/accounts/use-trustwallet-account.mdx +++ b/docs/pages/permissionless/how-to/accounts/use-trustwallet-account.mdx @@ -39,7 +39,7 @@ First we must create the public, (optionally) pimlico paymaster clients that wil ### Create the TrustAccount :::info -For a full list of options for creating a TrustAccount, take a look at the reference documentation page for [`toTrustSmartAccount`](/permissionless/core/reference/accounts/toTrustSmartAccount). +For a full list of options for creating a TrustAccount, take a look at the reference documentation page for [`toTrustSmartAccount`](/permissionless/reference/accounts/toTrustSmartAccount). ::: You can also pass an `address` to use an already created TrustAccount. diff --git a/docs/pages/permissionless/core/how-to/dapp-gas-sponsorship.mdx b/docs/pages/permissionless/how-to/dapp-gas-sponsorship.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/dapp-gas-sponsorship.mdx rename to docs/pages/permissionless/how-to/dapp-gas-sponsorship.mdx diff --git a/docs/pages/permissionless/core/how-to/local-testing.mdx b/docs/pages/permissionless/how-to/local-testing.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/local-testing.mdx rename to docs/pages/permissionless/how-to/local-testing.mdx diff --git a/docs/pages/permissionless/core/how-to/migration-guide.mdx b/docs/pages/permissionless/how-to/migration-guide.mdx similarity index 99% rename from docs/pages/permissionless/core/how-to/migration-guide.mdx rename to docs/pages/permissionless/how-to/migration-guide.mdx index 91fce95..70e7786 100644 --- a/docs/pages/permissionless/core/how-to/migration-guide.mdx +++ b/docs/pages/permissionless/how-to/migration-guide.mdx @@ -319,7 +319,7 @@ It also allows you to submit user operations with using `calls` object like with ### Deprecated `smartAccountClient.sendTransactions` -Use `smartAccountClient.sendTransaction` instead. It now accepts an array of transactions. Read more about it [here](/permissionless/core/reference/smart-account-actions/sendTransaction#usage). +Use `smartAccountClient.sendTransaction` instead. It now accepts an array of transactions. Read more about it [here](/permissionless/reference/smart-account-actions/sendTransaction#usage). Example: diff --git a/docs/pages/permissionless/core/how-to/parallel-transactions.mdx b/docs/pages/permissionless/how-to/parallel-transactions.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/parallel-transactions.mdx rename to docs/pages/permissionless/how-to/parallel-transactions.mdx diff --git a/docs/pages/permissionless/core/how-to/paymasters/conditional-sponsoring.mdx b/docs/pages/permissionless/how-to/paymasters/conditional-sponsoring.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/paymasters/conditional-sponsoring.mdx rename to docs/pages/permissionless/how-to/paymasters/conditional-sponsoring.mdx diff --git a/docs/pages/permissionless/core/how-to/paymasters/use-custom-paymaster.mdx b/docs/pages/permissionless/how-to/paymasters/use-custom-paymaster.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/paymasters/use-custom-paymaster.mdx rename to docs/pages/permissionless/how-to/paymasters/use-custom-paymaster.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/arcana.mdx b/docs/pages/permissionless/how-to/signers/arcana.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/arcana.mdx rename to docs/pages/permissionless/how-to/signers/arcana.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/capsule.mdx b/docs/pages/permissionless/how-to/signers/capsule.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/capsule.mdx rename to docs/pages/permissionless/how-to/signers/capsule.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/dfns.mdx b/docs/pages/permissionless/how-to/signers/dfns.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/dfns.mdx rename to docs/pages/permissionless/how-to/signers/dfns.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/dynamic.mdx b/docs/pages/permissionless/how-to/signers/dynamic.mdx similarity index 91% rename from docs/pages/permissionless/core/how-to/signers/dynamic.mdx rename to docs/pages/permissionless/how-to/signers/dynamic.mdx index 80d623a..d3fbb71 100644 --- a/docs/pages/permissionless/core/how-to/signers/dynamic.mdx +++ b/docs/pages/permissionless/how-to/signers/dynamic.mdx @@ -46,7 +46,7 @@ export const App = () => { ### Create the SmartAccountClient -Create the smart account client using the Dynamic signer. Note: DynamicWagmiConnector internally sets up the WagmiConfig, so there is no need to do it separately. This is where you would configure what smart account implementation (e.g. [Safe](/permissionless/core/how-to/accounts/use-safe-account), [Kernel](/permissionless/core/how-to/accounts/use-kernel-account), Biconomy, [TrustWallet](/permissionless/core/how-to/accounts/use-trustwallet-account) [SimpleAccount](/permissionless/core/how-to/accounts/use-simple-account)) and what paymaster logic you want to use. +Create the smart account client using the Dynamic signer. Note: DynamicWagmiConnector internally sets up the WagmiConfig, so there is no need to do it separately. This is where you would configure what smart account implementation (e.g. [Safe](/permissionless/how-to/accounts/use-safe-account), [Kernel](/permissionless/how-to/accounts/use-kernel-account), Biconomy, [TrustWallet](/permissionless/how-to/accounts/use-trustwallet-account) [SimpleAccount](/permissionless/how-to/accounts/use-simple-account)) and what paymaster logic you want to use. ```ts import { createSmartAccountClient } from "permissionless"; diff --git a/docs/pages/permissionless/core/how-to/signers/fireblocks.mdx b/docs/pages/permissionless/how-to/signers/fireblocks.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/fireblocks.mdx rename to docs/pages/permissionless/how-to/signers/fireblocks.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/index.mdx b/docs/pages/permissionless/how-to/signers/index.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/index.mdx rename to docs/pages/permissionless/how-to/signers/index.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/lit-protocol.mdx b/docs/pages/permissionless/how-to/signers/lit-protocol.mdx similarity index 95% rename from docs/pages/permissionless/core/how-to/signers/lit-protocol.mdx rename to docs/pages/permissionless/how-to/signers/lit-protocol.mdx index f9e55fa..da7d7a9 100644 --- a/docs/pages/permissionless/core/how-to/signers/lit-protocol.mdx +++ b/docs/pages/permissionless/how-to/signers/lit-protocol.mdx @@ -187,9 +187,9 @@ await pkpWallet.init(); ### Use the PKP Wallet to sign user operations and send them through Pimlico -You can now use the `pkpWallet` as a regular Ethers.js wallet to sign user operations. To submit a user operation to Pimlico, you can follow the steps to [sponsor a user operation with Pimlico's verifying paymaster](/infra/paymaster/verifying-paymaster/usage) and/or [submit a user operation through Pimlico's bundler](/infra/bundler/usage). If you would like to integrate Lit Protocol with the full flow of generating, signing, and submitting a user operation, you can follow the steps in [tutorial 1](/permissionless/core/tutorial/tutorial-1), replacing the signing step with the PKP wallet and using `pkpWallet.address` as the owner address of the smart account. +You can now use the `pkpWallet` as a regular Ethers.js wallet to sign user operations. To submit a user operation to Pimlico, you can follow the steps to [sponsor a user operation with Pimlico's verifying paymaster](/infra/paymaster/verifying-paymaster/usage) and/or [submit a user operation through Pimlico's bundler](/infra/bundler/usage). If you would like to integrate Lit Protocol with the full flow of generating, signing, and submitting a user operation, you can follow the steps in [tutorial 1](/permissionless/tutorial/tutorial-1), replacing the signing step with the PKP wallet and using `pkpWallet.address` as the owner address of the smart account. -Modified from [tutorial 1](/permissionless/core/tutorial/tutorial-1), an example of how to use the PKP wallet to sign a user operation is shown below: +Modified from [tutorial 1](/permissionless/tutorial/tutorial-1), an example of how to use the PKP wallet to sign a user operation is shown below: ```typescript const signature = await pkpWallet.signMessage( diff --git a/docs/pages/permissionless/core/how-to/signers/magic.mdx b/docs/pages/permissionless/how-to/signers/magic.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/magic.mdx rename to docs/pages/permissionless/how-to/signers/magic.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/particle-network.mdx b/docs/pages/permissionless/how-to/signers/particle-network.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/particle-network.mdx rename to docs/pages/permissionless/how-to/signers/particle-network.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/passport.mdx b/docs/pages/permissionless/how-to/signers/passport.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/passport.mdx rename to docs/pages/permissionless/how-to/signers/passport.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/passportSigners.mdx b/docs/pages/permissionless/how-to/signers/passportSigners.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/passportSigners.mdx rename to docs/pages/permissionless/how-to/signers/passportSigners.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/privy.mdx b/docs/pages/permissionless/how-to/signers/privy.mdx similarity index 92% rename from docs/pages/permissionless/core/how-to/signers/privy.mdx rename to docs/pages/permissionless/how-to/signers/privy.mdx index b73328e..a52e2b0 100644 --- a/docs/pages/permissionless/core/how-to/signers/privy.mdx +++ b/docs/pages/permissionless/how-to/signers/privy.mdx @@ -59,7 +59,7 @@ useEffect(() => setActiveWallet(embeddedWallet), [embeddedWallet]) ### Create the SmartAccountClient -Create the smart account client using the Privy signer. This is where you would configure what smart account implementation (e.g. [Safe](/permissionless/core/how-to/accounts/use-safe-account), [Kernel](/permissionless/core/how-to/accounts/use-kernel-account), Biconomy, [TrustWallet](/permissionless/core/how-to/accounts/use-trustwallet-account), [SimpleAccount](/permissionless/core/how-to/accounts/use-simple-account)) and what paymaster logic you want to use. +Create the smart account client using the Privy signer. This is where you would configure what smart account implementation (e.g. [Safe](/permissionless/how-to/accounts/use-safe-account), [Kernel](/permissionless/how-to/accounts/use-kernel-account), Biconomy, [TrustWallet](/permissionless/how-to/accounts/use-trustwallet-account), [SimpleAccount](/permissionless/how-to/accounts/use-simple-account)) and what paymaster logic you want to use. ```ts import { createSmartAccountClient } from "permissionless"; diff --git a/docs/pages/permissionless/core/how-to/signers/smartAccounts.mdx b/docs/pages/permissionless/how-to/signers/smartAccounts.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/smartAccounts.mdx rename to docs/pages/permissionless/how-to/signers/smartAccounts.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/turnkey.mdx b/docs/pages/permissionless/how-to/signers/turnkey.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/turnkey.mdx rename to docs/pages/permissionless/how-to/signers/turnkey.mdx diff --git a/docs/pages/permissionless/core/how-to/signers/web3auth.mdx b/docs/pages/permissionless/how-to/signers/web3auth.mdx similarity index 100% rename from docs/pages/permissionless/core/how-to/signers/web3auth.mdx rename to docs/pages/permissionless/how-to/signers/web3auth.mdx diff --git a/docs/pages/permissionless/core/index.mdx b/docs/pages/permissionless/index.mdx similarity index 96% rename from docs/pages/permissionless/core/index.mdx rename to docs/pages/permissionless/index.mdx index 980af6d..4432946 100644 --- a/docs/pages/permissionless/core/index.mdx +++ b/docs/pages/permissionless/index.mdx @@ -16,7 +16,7 @@ import VersionWarning from "./VersionWarning" permissionless.js is a TypeScript library built on viem for building with ERC-4337 smart accounts, bundlers, paymasters, and user operations. The core focuses are avoiding provider lock-in, having no dependencies, maximum viem compatibility, and a small bundle size. permissionless.js also provides high-level support for the major ERC-4337 smart accounts, including Safe, Kernel, Biconomy, SimpleAccount, TrustWallet and LightAccount. - Get started + Get started GitHub diff --git a/docs/pages/permissionless/core/reference/accounts/toEcdsaKernelSmartAccount.mdx b/docs/pages/permissionless/reference/accounts/toEcdsaKernelSmartAccount.mdx similarity index 96% rename from docs/pages/permissionless/core/reference/accounts/toEcdsaKernelSmartAccount.mdx rename to docs/pages/permissionless/reference/accounts/toEcdsaKernelSmartAccount.mdx index 8a1f2f8..1128d61 100644 --- a/docs/pages/permissionless/core/reference/accounts/toEcdsaKernelSmartAccount.mdx +++ b/docs/pages/permissionless/reference/accounts/toEcdsaKernelSmartAccount.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../VersionWarning" # toEcdsaKernelSmartAccount -Creates a KernelAccount instance controlled by a `owners`. Check out [this guide](/permissionless/core/how-to/accounts/use-kernel-account) for a complete tutorial. +Creates a KernelAccount instance controlled by a `owners`. Check out [this guide](/permissionless/how-to/accounts/use-kernel-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/reference/accounts/toLightSmartAccount.mdx b/docs/pages/permissionless/reference/accounts/toLightSmartAccount.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/accounts/toLightSmartAccount.mdx rename to docs/pages/permissionless/reference/accounts/toLightSmartAccount.mdx diff --git a/docs/pages/permissionless/core/reference/accounts/toSafeSmartAccount.mdx b/docs/pages/permissionless/reference/accounts/toSafeSmartAccount.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/accounts/toSafeSmartAccount.mdx rename to docs/pages/permissionless/reference/accounts/toSafeSmartAccount.mdx diff --git a/docs/pages/permissionless/core/reference/accounts/toSimpleSmartAccount.mdx b/docs/pages/permissionless/reference/accounts/toSimpleSmartAccount.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/accounts/toSimpleSmartAccount.mdx rename to docs/pages/permissionless/reference/accounts/toSimpleSmartAccount.mdx diff --git a/docs/pages/permissionless/core/reference/accounts/toTrustSmartAccount.mdx b/docs/pages/permissionless/reference/accounts/toTrustSmartAccount.mdx similarity index 94% rename from docs/pages/permissionless/core/reference/accounts/toTrustSmartAccount.mdx rename to docs/pages/permissionless/reference/accounts/toTrustSmartAccount.mdx index 905bc14..58bbce1 100644 --- a/docs/pages/permissionless/core/reference/accounts/toTrustSmartAccount.mdx +++ b/docs/pages/permissionless/reference/accounts/toTrustSmartAccount.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../VersionWarning" # toTrustSmartAccount -Creates a Trust Wallet Smart Account instance controlled by a `owner`. Check out [this guide](/permissionless/core/how-to/accounts/use-trustwallet-account) for a complete tutorial. +Creates a Trust Wallet Smart Account instance controlled by a `owner`. Check out [this guide](/permissionless/how-to/accounts/use-trustwallet-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/reference/clients/pimlicoClient.mdx b/docs/pages/permissionless/reference/clients/pimlicoClient.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/clients/pimlicoClient.mdx rename to docs/pages/permissionless/reference/clients/pimlicoClient.mdx diff --git a/docs/pages/permissionless/core/reference/clients/smartAccountClient.mdx b/docs/pages/permissionless/reference/clients/smartAccountClient.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/clients/smartAccountClient.mdx rename to docs/pages/permissionless/reference/clients/smartAccountClient.mdx diff --git a/docs/pages/permissionless/core/reference/erc7579-actions/accountId.mdx b/docs/pages/permissionless/reference/erc7579-actions/accountId.mdx similarity index 89% rename from docs/pages/permissionless/core/reference/erc7579-actions/accountId.mdx rename to docs/pages/permissionless/reference/erc7579-actions/accountId.mdx index 5705b78..fb6b76e 100644 --- a/docs/pages/permissionless/core/reference/erc7579-actions/accountId.mdx +++ b/docs/pages/permissionless/reference/erc7579-actions/accountId.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../VersionWarning" # accountId -Gets the accountId of the smart account as defined in [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579). Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Gets the accountId of the smart account as defined in [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579). Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/reference/erc7579-actions/installModule.mdx b/docs/pages/permissionless/reference/erc7579-actions/installModule.mdx similarity index 95% rename from docs/pages/permissionless/core/reference/erc7579-actions/installModule.mdx rename to docs/pages/permissionless/reference/erc7579-actions/installModule.mdx index 368bd17..9d4dad9 100644 --- a/docs/pages/permissionless/core/reference/erc7579-actions/installModule.mdx +++ b/docs/pages/permissionless/reference/erc7579-actions/installModule.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../VersionWarning" # installModule -Installs a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module to the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Installs a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module to the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/reference/erc7579-actions/isModuleInstalled.mdx b/docs/pages/permissionless/reference/erc7579-actions/isModuleInstalled.mdx similarity index 91% rename from docs/pages/permissionless/core/reference/erc7579-actions/isModuleInstalled.mdx rename to docs/pages/permissionless/reference/erc7579-actions/isModuleInstalled.mdx index da93978..e068906 100644 --- a/docs/pages/permissionless/core/reference/erc7579-actions/isModuleInstalled.mdx +++ b/docs/pages/permissionless/reference/erc7579-actions/isModuleInstalled.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../VersionWarning" # isModuleInstalled -Checks if an [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module is installed on the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Checks if an [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module is installed on the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/reference/erc7579-actions/supportsExecutionMode.mdx b/docs/pages/permissionless/reference/erc7579-actions/supportsExecutionMode.mdx similarity index 93% rename from docs/pages/permissionless/core/reference/erc7579-actions/supportsExecutionMode.mdx rename to docs/pages/permissionless/reference/erc7579-actions/supportsExecutionMode.mdx index 3616cd5..3439336 100644 --- a/docs/pages/permissionless/core/reference/erc7579-actions/supportsExecutionMode.mdx +++ b/docs/pages/permissionless/reference/erc7579-actions/supportsExecutionMode.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../VersionWarning" # supportsExecutionMode -Checks if a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) execution mode is supported on the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Checks if a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) execution mode is supported on the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. :::info According to the specification, not all execution modes must be supported. So it is recommended to use this function to check if the execution mode is supported before using it. diff --git a/docs/pages/permissionless/core/reference/erc7579-actions/supportsModule.mdx b/docs/pages/permissionless/reference/erc7579-actions/supportsModule.mdx similarity index 89% rename from docs/pages/permissionless/core/reference/erc7579-actions/supportsModule.mdx rename to docs/pages/permissionless/reference/erc7579-actions/supportsModule.mdx index 9d0a435..a24463b 100644 --- a/docs/pages/permissionless/core/reference/erc7579-actions/supportsModule.mdx +++ b/docs/pages/permissionless/reference/erc7579-actions/supportsModule.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../VersionWarning" # supportsModule -Checks if a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module type is supported by the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Checks if a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module type is supported by the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/reference/erc7579-actions/uninstallModule.mdx b/docs/pages/permissionless/reference/erc7579-actions/uninstallModule.mdx similarity index 95% rename from docs/pages/permissionless/core/reference/erc7579-actions/uninstallModule.mdx rename to docs/pages/permissionless/reference/erc7579-actions/uninstallModule.mdx index c9fc545..8bf4fb1 100644 --- a/docs/pages/permissionless/core/reference/erc7579-actions/uninstallModule.mdx +++ b/docs/pages/permissionless/reference/erc7579-actions/uninstallModule.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../VersionWarning" # uninstallModule -Uninstalls a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module from the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Uninstalls a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module from the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/reference/index.mdx b/docs/pages/permissionless/reference/index.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/index.mdx rename to docs/pages/permissionless/reference/index.mdx diff --git a/docs/pages/permissionless/core/reference/pimlico-actions/getPaymasterData.mdx b/docs/pages/permissionless/reference/pimlico-actions/getPaymasterData.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/pimlico-actions/getPaymasterData.mdx rename to docs/pages/permissionless/reference/pimlico-actions/getPaymasterData.mdx diff --git a/docs/pages/permissionless/core/reference/pimlico-actions/getPaymasterStubData.mdx b/docs/pages/permissionless/reference/pimlico-actions/getPaymasterStubData.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/pimlico-actions/getPaymasterStubData.mdx rename to docs/pages/permissionless/reference/pimlico-actions/getPaymasterStubData.mdx diff --git a/docs/pages/permissionless/core/reference/pimlico-actions/getUserOperationGasPrice.mdx b/docs/pages/permissionless/reference/pimlico-actions/getUserOperationGasPrice.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/pimlico-actions/getUserOperationGasPrice.mdx rename to docs/pages/permissionless/reference/pimlico-actions/getUserOperationGasPrice.mdx diff --git a/docs/pages/permissionless/core/reference/pimlico-actions/getUserOperationStatus.mdx b/docs/pages/permissionless/reference/pimlico-actions/getUserOperationStatus.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/pimlico-actions/getUserOperationStatus.mdx rename to docs/pages/permissionless/reference/pimlico-actions/getUserOperationStatus.mdx diff --git a/docs/pages/permissionless/core/reference/pimlico-actions/sendCompressedUserOperation.mdx b/docs/pages/permissionless/reference/pimlico-actions/sendCompressedUserOperation.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/pimlico-actions/sendCompressedUserOperation.mdx rename to docs/pages/permissionless/reference/pimlico-actions/sendCompressedUserOperation.mdx diff --git a/docs/pages/permissionless/core/reference/pimlico-actions/validateSponsorshipPolicies.mdx b/docs/pages/permissionless/reference/pimlico-actions/validateSponsorshipPolicies.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/pimlico-actions/validateSponsorshipPolicies.mdx rename to docs/pages/permissionless/reference/pimlico-actions/validateSponsorshipPolicies.mdx diff --git a/docs/pages/permissionless/core/reference/public-actions/getAccountNonce.mdx b/docs/pages/permissionless/reference/public-actions/getAccountNonce.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/public-actions/getAccountNonce.mdx rename to docs/pages/permissionless/reference/public-actions/getAccountNonce.mdx diff --git a/docs/pages/permissionless/core/reference/public-actions/getSenderAddress.mdx b/docs/pages/permissionless/reference/public-actions/getSenderAddress.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/public-actions/getSenderAddress.mdx rename to docs/pages/permissionless/reference/public-actions/getSenderAddress.mdx diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/estimateUserOperationGas.mdx b/docs/pages/permissionless/reference/smart-account-actions/estimateUserOperationGas.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/smart-account-actions/estimateUserOperationGas.mdx rename to docs/pages/permissionless/reference/smart-account-actions/estimateUserOperationGas.mdx diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/getChainId.mdx b/docs/pages/permissionless/reference/smart-account-actions/getChainId.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/smart-account-actions/getChainId.mdx rename to docs/pages/permissionless/reference/smart-account-actions/getChainId.mdx diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/getSupportedEntryPoints.mdx b/docs/pages/permissionless/reference/smart-account-actions/getSupportedEntryPoints.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/smart-account-actions/getSupportedEntryPoints.mdx rename to docs/pages/permissionless/reference/smart-account-actions/getSupportedEntryPoints.mdx diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/getUserOperation.mdx b/docs/pages/permissionless/reference/smart-account-actions/getUserOperation.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/smart-account-actions/getUserOperation.mdx rename to docs/pages/permissionless/reference/smart-account-actions/getUserOperation.mdx diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/getUserOperationReceipt.mdx b/docs/pages/permissionless/reference/smart-account-actions/getUserOperationReceipt.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/smart-account-actions/getUserOperationReceipt.mdx rename to docs/pages/permissionless/reference/smart-account-actions/getUserOperationReceipt.mdx diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/prepareUserOperation.mdx b/docs/pages/permissionless/reference/smart-account-actions/prepareUserOperation.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/smart-account-actions/prepareUserOperation.mdx rename to docs/pages/permissionless/reference/smart-account-actions/prepareUserOperation.mdx diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/sendTransaction.mdx b/docs/pages/permissionless/reference/smart-account-actions/sendTransaction.mdx similarity index 99% rename from docs/pages/permissionless/core/reference/smart-account-actions/sendTransaction.mdx rename to docs/pages/permissionless/reference/smart-account-actions/sendTransaction.mdx index 45a0901..0c868d8 100644 --- a/docs/pages/permissionless/core/reference/smart-account-actions/sendTransaction.mdx +++ b/docs/pages/permissionless/reference/smart-account-actions/sendTransaction.mdx @@ -246,7 +246,7 @@ const hash = await smartAccountClient.sendTransaction({ Sets Paymaster configuration for the User Operation. - If `paymaster: Address`, it will use the provided Paymaster contract address for sponsorship. -- If `paymaster: PaymasterClient`, it will use the provided Paymaster Client eg [Pimlico Client](/permissionless/core/reference/clients/pimlicoClient) for sponsorship. +- If `paymaster: PaymasterClient`, it will use the provided Paymaster Client eg [Pimlico Client](/permissionless/reference/clients/pimlicoClient) for sponsorship. - If `paymaster: true`, it will be assumed that the Bundler Client also supports Paymaster RPC methods (e.g. `pm_getPaymasterData`), and use them for sponsorship. #### Using a Paymaster Contract Address diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/sendUserOperation.mdx b/docs/pages/permissionless/reference/smart-account-actions/sendUserOperation.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/smart-account-actions/sendUserOperation.mdx rename to docs/pages/permissionless/reference/smart-account-actions/sendUserOperation.mdx diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/waitForUserOperationReceipt.mdx b/docs/pages/permissionless/reference/smart-account-actions/waitForUserOperationReceipt.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/smart-account-actions/waitForUserOperationReceipt.mdx rename to docs/pages/permissionless/reference/smart-account-actions/waitForUserOperationReceipt.mdx diff --git a/docs/pages/permissionless/core/reference/smart-account-actions/writeContract.mdx b/docs/pages/permissionless/reference/smart-account-actions/writeContract.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/smart-account-actions/writeContract.mdx rename to docs/pages/permissionless/reference/smart-account-actions/writeContract.mdx diff --git a/docs/pages/permissionless/core/reference/utils/getRequiredPrefund.mdx b/docs/pages/permissionless/reference/utils/getRequiredPrefund.mdx similarity index 100% rename from docs/pages/permissionless/core/reference/utils/getRequiredPrefund.mdx rename to docs/pages/permissionless/reference/utils/getRequiredPrefund.mdx diff --git a/docs/pages/permissionless/tutorial/index.mdx b/docs/pages/permissionless/tutorial/index.mdx new file mode 100644 index 0000000..34b4093 --- /dev/null +++ b/docs/pages/permissionless/tutorial/index.mdx @@ -0,0 +1,11 @@ +import VersionWarning from "../VersionWarning" + + + +# Tutorials + +Learning-oriented lessons that take you through a series of steps to complete a project. Most useful when you want to get started with Pimlico. + +[Tutorial 1](/permissionless/tutorial/tutorial-1) takes you through the journey of leveraging permissionless.js's high-level APIs to easily create and bundle a user operation. + +[Tutorial 2](/permissionless/tutorial/tutorial-2) takes you through the journey of sponsoring your first user operation with USDC with an ERC-20 paymaster. diff --git a/docs/pages/permissionless/core/tutorial/tutorial-1.mdx b/docs/pages/permissionless/tutorial/tutorial-1.mdx similarity index 98% rename from docs/pages/permissionless/core/tutorial/tutorial-1.mdx rename to docs/pages/permissionless/tutorial/tutorial-1.mdx index fb88576..3e5ee10 100644 --- a/docs/pages/permissionless/core/tutorial/tutorial-1.mdx +++ b/docs/pages/permissionless/tutorial/tutorial-1.mdx @@ -56,7 +56,7 @@ Let's open up `index.ts`, and add the following to the bottom: For the purposes of this guide, we will be using [Safe](https://safe.global) accounts. This account is an ERC-4337 wallet controlled by a single EOA signer. :::tip[Tip] -Want to learn more about using Safe accounts? Take a look at our [dedicated Safe guide](/permissionless/core/how-to/accounts/use-safe-account) +Want to learn more about using Safe accounts? Take a look at our [dedicated Safe guide](/permissionless/how-to/accounts/use-safe-account) ::: To create the Safe account, we will use the `toSafeSmartAccount` utility function from permissionless.js. We need to specify the Safe version we are using as well as the global ERC-4337 EntryPoint address. For the signer, we will be using the previously generated private key. diff --git a/docs/pages/permissionless/core/tutorial/tutorial-2.mdx b/docs/pages/permissionless/tutorial/tutorial-2.mdx similarity index 97% rename from docs/pages/permissionless/core/tutorial/tutorial-2.mdx rename to docs/pages/permissionless/tutorial/tutorial-2.mdx index 4043694..2774b1c 100644 --- a/docs/pages/permissionless/core/tutorial/tutorial-2.mdx +++ b/docs/pages/permissionless/tutorial/tutorial-2.mdx @@ -2,7 +2,7 @@ import VersionWarning from "../VersionWarning" -import { GeneratePrivateKey } from "../../../../components/generatePrivateKey" +import { GeneratePrivateKey } from "../../../components/generatePrivateKey" # Tutorial 2 — Submit a user operation with an ERC-20 Paymaster @@ -60,7 +60,7 @@ Let's open up `index.ts`, and add the following to the bottom: For the purposes of this guide, we will be using [Safe](https://safe.global) accounts. This account is an ERC-4337 wallet controlled by a single EOA signer. :::tip[Tip] -Want to learn more about using Safe accounts? Take a look at our [dedicated Safe guide](/permissionless/core/how-to/accounts/use-safe-account) +Want to learn more about using Safe accounts? Take a look at our [dedicated Safe guide](/permissionless/how-to/accounts/use-safe-account) ::: To create the Safe account, we will use the `toSafeSmartAccount` utility function from permissionless.js. diff --git a/docs/pages/permissionless/core/v0_1/experimental/eip7677/getPaymasterData.mdx b/docs/pages/permissionless/v0_1/experimental/eip7677/getPaymasterData.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/experimental/eip7677/getPaymasterData.mdx rename to docs/pages/permissionless/v0_1/experimental/eip7677/getPaymasterData.mdx diff --git a/docs/pages/permissionless/core/v0_1/experimental/eip7677/getPaymasterStubData.mdx b/docs/pages/permissionless/v0_1/experimental/eip7677/getPaymasterStubData.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/experimental/eip7677/getPaymasterStubData.mdx rename to docs/pages/permissionless/v0_1/experimental/eip7677/getPaymasterStubData.mdx diff --git a/docs/pages/permissionless/core/v0_1/faqs.mdx b/docs/pages/permissionless/v0_1/faqs.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/faqs.mdx rename to docs/pages/permissionless/v0_1/faqs.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/accounts/support.mdx b/docs/pages/permissionless/v0_1/how-to/accounts/support.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/accounts/support.mdx rename to docs/pages/permissionless/v0_1/how-to/accounts/support.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-biconomy-account.mdx b/docs/pages/permissionless/v0_1/how-to/accounts/use-biconomy-account.mdx similarity index 96% rename from docs/pages/permissionless/core/v0_1/how-to/accounts/use-biconomy-account.mdx rename to docs/pages/permissionless/v0_1/how-to/accounts/use-biconomy-account.mdx index 3c3bf15..9658a9b 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-biconomy-account.mdx +++ b/docs/pages/permissionless/v0_1/how-to/accounts/use-biconomy-account.mdx @@ -26,7 +26,7 @@ First we must create the public, bundler, and (optionally) paymaster clients tha ### Create the signer -Biconomy accounts can work with a variety of signing algorithms such as ECDSA, passkeys, and multisig. In permissionless.js, the default Biconomy account validates ECDSA signatures. [Any signer](/permissionless/core/how-to/signers) can be used as a signer for the Biconomy account. +Biconomy accounts can work with a variety of signing algorithms such as ECDSA, passkeys, and multisig. In permissionless.js, the default Biconomy account validates ECDSA signatures. [Any signer](/permissionless/how-to/signers) can be used as a signer for the Biconomy account. For example, to create a signer based on a private key: diff --git a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-erc7579-account.mdx b/docs/pages/permissionless/v0_1/how-to/accounts/use-erc7579-account.mdx similarity index 95% rename from docs/pages/permissionless/core/v0_1/how-to/accounts/use-erc7579-account.mdx rename to docs/pages/permissionless/v0_1/how-to/accounts/use-erc7579-account.mdx index 15914b9..002f610 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-erc7579-account.mdx +++ b/docs/pages/permissionless/v0_1/how-to/accounts/use-erc7579-account.mdx @@ -8,7 +8,7 @@ import VersionWarning from "../../../VersionWarning" Currently Safe and Kernel are the only smart accounts that implements ERC-7579. -For this guide, we will use the Safe smart accounts as an example. If you would like to find out more about the Safe smart account, you can check out the [Safe-specific guide](/permissionless/core/how-to/accounts/use-safe-account). +For this guide, we will use the Safe smart accounts as an example. If you would like to find out more about the Safe smart account, you can check out the [Safe-specific guide](/permissionless/how-to/accounts/use-safe-account). This guide will show you how to create and use a ERC-7579 compatible smart account with permissionless.js. @@ -33,7 +33,7 @@ First we must create the public, bundler, and (optionally) paymaster clients tha ### Create the SafeAccount :::info -For a full list of options for creating a SafeAccount, take a look at the reference documentation page for [`signerToSafeSmartAccount`](/permissionless/core/v0_1/reference/accounts/signerToSafeSmartAccount). +For a full list of options for creating a SafeAccount, take a look at the reference documentation page for [`signerToSafeSmartAccount`](/permissionless/v0_1/reference/accounts/signerToSafeSmartAccount). ::: You can also pass an `address` to use an already created SafeAccount. diff --git a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-kernel-account.mdx b/docs/pages/permissionless/v0_1/how-to/accounts/use-kernel-account.mdx similarity index 95% rename from docs/pages/permissionless/core/v0_1/how-to/accounts/use-kernel-account.mdx rename to docs/pages/permissionless/v0_1/how-to/accounts/use-kernel-account.mdx index 6e2d403..ab02dfe 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-kernel-account.mdx +++ b/docs/pages/permissionless/v0_1/how-to/accounts/use-kernel-account.mdx @@ -38,7 +38,7 @@ First we must create the public, bundler, and (optionally) paymaster clients tha ### Create the signer -Kernel accounts can work with a variety of signing algorithms such as ECDSA, passkeys, and multisig. In permissionless.js, the default Kernel account validates ECDSA signatures. [Any signer](/permissionless/core/how-to/signers) can be used as a signer for the Kernel account. +Kernel accounts can work with a variety of signing algorithms such as ECDSA, passkeys, and multisig. In permissionless.js, the default Kernel account validates ECDSA signatures. [Any signer](/permissionless/how-to/signers) can be used as a signer for the Kernel account. For example, to create a signer based on a private key: @@ -49,7 +49,7 @@ For example, to create a signer based on a private key: ### Create the Kernel account :::info -For a full list of options for creating a Kernel account, take a look at the reference documentation page for [`signerToKernelSmartAccount`](/permissionless/core/v0_1/reference/accounts/signerToKernelSmartAccount). +For a full list of options for creating a Kernel account, take a look at the reference documentation page for [`signerToKernelSmartAccount`](/permissionless/v0_1/reference/accounts/signerToKernelSmartAccount). ::: With a signer, you can create a Kernel account as such: diff --git a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-light-account.mdx b/docs/pages/permissionless/v0_1/how-to/accounts/use-light-account.mdx similarity index 96% rename from docs/pages/permissionless/core/v0_1/how-to/accounts/use-light-account.mdx rename to docs/pages/permissionless/v0_1/how-to/accounts/use-light-account.mdx index 15b8d0f..d90d553 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-light-account.mdx +++ b/docs/pages/permissionless/v0_1/how-to/accounts/use-light-account.mdx @@ -30,7 +30,7 @@ First we must create the public, bundler, and (optionally) paymaster clients tha ### Create the LightAccount :::info -For a full list of options for creating a LightAccount, take a look at the reference documentation page for [`signerToLightSmartAccount`](/permissionless/core/v0_1/reference/accounts/signerToLightSmartAccount). +For a full list of options for creating a LightAccount, take a look at the reference documentation page for [`signerToLightSmartAccount`](/permissionless/v0_1/reference/accounts/signerToLightSmartAccount). ::: You can also pass an `address` to use an already created LightAccount. diff --git a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-safe-account.mdx b/docs/pages/permissionless/v0_1/how-to/accounts/use-safe-account.mdx similarity index 94% rename from docs/pages/permissionless/core/v0_1/how-to/accounts/use-safe-account.mdx rename to docs/pages/permissionless/v0_1/how-to/accounts/use-safe-account.mdx index ae61c8f..1829fbd 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-safe-account.mdx +++ b/docs/pages/permissionless/v0_1/how-to/accounts/use-safe-account.mdx @@ -26,7 +26,7 @@ First we must create the public, bundler, and (optionally) paymaster clients tha ### Create the signer -The Safe account will need to have a signer to sign user operations. In permissionless.js, the default Safe account validates ECDSA signatures. [Any permissionless.js-compatible signer](/permissionless/core/how-to/signers) can be used for the Safe account. +The Safe account will need to have a signer to sign user operations. In permissionless.js, the default Safe account validates ECDSA signatures. [Any permissionless.js-compatible signer](/permissionless/how-to/signers) can be used for the Safe account. For example, to create a signer based on a private key: @@ -37,7 +37,7 @@ For example, to create a signer based on a private key: ### Create the Safe account :::info -For a full list of options for creating a Safe account, take a look at the reference documentation page for [`signerToSafeSmartAccount`](/permissionless/core/v0_1/reference/accounts/signerToSafeSmartAccount). +For a full list of options for creating a Safe account, take a look at the reference documentation page for [`signerToSafeSmartAccount`](/permissionless/v0_1/reference/accounts/signerToSafeSmartAccount). ::: With a signer, you can create a Safe account as such: diff --git a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-simple-account.mdx b/docs/pages/permissionless/v0_1/how-to/accounts/use-simple-account.mdx similarity index 96% rename from docs/pages/permissionless/core/v0_1/how-to/accounts/use-simple-account.mdx rename to docs/pages/permissionless/v0_1/how-to/accounts/use-simple-account.mdx index fcee5a1..6370624 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-simple-account.mdx +++ b/docs/pages/permissionless/v0_1/how-to/accounts/use-simple-account.mdx @@ -28,7 +28,7 @@ First we must create the public, bundler, and (optionally) paymaster clients tha ### Create the SimpleAccount :::info -For a full list of options for creating a SimpleAccount, take a look at the reference documentation page for [`signerToSimpleSmartAccount`](/permissionless/core/v0_1/reference/accounts/signerToSimpleSmartAccount). +For a full list of options for creating a SimpleAccount, take a look at the reference documentation page for [`signerToSimpleSmartAccount`](/permissionless/v0_1/reference/accounts/signerToSimpleSmartAccount). ::: You can create a SimpleAccount with the canonical module addresses by specifying the factory address the account will be deployed from. You can also pass an `address` to use an already created SimpleAccount. diff --git a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-trustwallet-account.mdx b/docs/pages/permissionless/v0_1/how-to/accounts/use-trustwallet-account.mdx similarity index 97% rename from docs/pages/permissionless/core/v0_1/how-to/accounts/use-trustwallet-account.mdx rename to docs/pages/permissionless/v0_1/how-to/accounts/use-trustwallet-account.mdx index bfbad45..6c4ca2c 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/accounts/use-trustwallet-account.mdx +++ b/docs/pages/permissionless/v0_1/how-to/accounts/use-trustwallet-account.mdx @@ -39,7 +39,7 @@ First we must create the public, bundler, and (optionally) paymaster clients tha ### Create the TrustAccount :::info -For a full list of options for creating a TrustAccount, take a look at the reference documentation page for [`signerToTrustSmartAccount`](/permissionless/core/v0_1/reference/accounts/signerToTrustSmartAccount). +For a full list of options for creating a TrustAccount, take a look at the reference documentation page for [`signerToTrustSmartAccount`](/permissionless/v0_1/reference/accounts/signerToTrustSmartAccount). ::: You can also pass an `address` to use an already created TrustAccount. diff --git a/docs/pages/permissionless/core/v0_1/how-to/dapp-gas-sponsorship.mdx b/docs/pages/permissionless/v0_1/how-to/dapp-gas-sponsorship.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/dapp-gas-sponsorship.mdx rename to docs/pages/permissionless/v0_1/how-to/dapp-gas-sponsorship.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/error-handling.mdx b/docs/pages/permissionless/v0_1/how-to/error-handling.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/error-handling.mdx rename to docs/pages/permissionless/v0_1/how-to/error-handling.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/local-testing.mdx b/docs/pages/permissionless/v0_1/how-to/local-testing.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/local-testing.mdx rename to docs/pages/permissionless/v0_1/how-to/local-testing.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/migration-guide.mdx b/docs/pages/permissionless/v0_1/how-to/migration-guide.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/migration-guide.mdx rename to docs/pages/permissionless/v0_1/how-to/migration-guide.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/parallel-transactions.mdx b/docs/pages/permissionless/v0_1/how-to/parallel-transactions.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/parallel-transactions.mdx rename to docs/pages/permissionless/v0_1/how-to/parallel-transactions.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/paymasters/conditional-sponsoring.mdx b/docs/pages/permissionless/v0_1/how-to/paymasters/conditional-sponsoring.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/paymasters/conditional-sponsoring.mdx rename to docs/pages/permissionless/v0_1/how-to/paymasters/conditional-sponsoring.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/paymasters/use-custom-paymaster.mdx b/docs/pages/permissionless/v0_1/how-to/paymasters/use-custom-paymaster.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/paymasters/use-custom-paymaster.mdx rename to docs/pages/permissionless/v0_1/how-to/paymasters/use-custom-paymaster.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/arcana.mdx b/docs/pages/permissionless/v0_1/how-to/signers/arcana.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/arcana.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/arcana.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/capsule.mdx b/docs/pages/permissionless/v0_1/how-to/signers/capsule.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/capsule.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/capsule.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/dfns.mdx b/docs/pages/permissionless/v0_1/how-to/signers/dfns.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/dfns.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/dfns.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/dynamic.mdx b/docs/pages/permissionless/v0_1/how-to/signers/dynamic.mdx similarity index 91% rename from docs/pages/permissionless/core/v0_1/how-to/signers/dynamic.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/dynamic.mdx index d3d86f8..6339854 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/signers/dynamic.mdx +++ b/docs/pages/permissionless/v0_1/how-to/signers/dynamic.mdx @@ -46,7 +46,7 @@ export const App = () => { ### Create the SmartAccountClient -Create the smart account client using the Dynamic signer. Note: DynamicWagmiConnector internally sets up the WagmiConfig, so there is no need to do it separately. This is where you would configure what smart account implementation (e.g. [Safe](/permissionless/core/how-to/accounts/use-safe-account), [Kernel](/permissionless/core/how-to/accounts/use-kernel-account), Biconomy, [TrustWallet](/permissionless/core/how-to/accounts/use-trustwallet-account) [SimpleAccount](/permissionless/core/how-to/accounts/use-simple-account)) and what paymaster logic you want to use. +Create the smart account client using the Dynamic signer. Note: DynamicWagmiConnector internally sets up the WagmiConfig, so there is no need to do it separately. This is where you would configure what smart account implementation (e.g. [Safe](/permissionless/how-to/accounts/use-safe-account), [Kernel](/permissionless/how-to/accounts/use-kernel-account), Biconomy, [TrustWallet](/permissionless/how-to/accounts/use-trustwallet-account) [SimpleAccount](/permissionless/how-to/accounts/use-simple-account)) and what paymaster logic you want to use. ```ts import { createSmartAccountClient, walletClientToSmartAccountSigner, ENTRYPOINT_ADDRESS_V06 } from "permissionless"; diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/fireblocks.mdx b/docs/pages/permissionless/v0_1/how-to/signers/fireblocks.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/fireblocks.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/fireblocks.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/index.mdx b/docs/pages/permissionless/v0_1/how-to/signers/index.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/index.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/index.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/lit-protocol.mdx b/docs/pages/permissionless/v0_1/how-to/signers/lit-protocol.mdx similarity index 95% rename from docs/pages/permissionless/core/v0_1/how-to/signers/lit-protocol.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/lit-protocol.mdx index bee0a69..e148276 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/signers/lit-protocol.mdx +++ b/docs/pages/permissionless/v0_1/how-to/signers/lit-protocol.mdx @@ -187,9 +187,9 @@ await pkpWallet.init(); ### Use the PKP Wallet to sign user operations and send them through Pimlico -You can now use the `pkpWallet` as a regular Ethers.js wallet to sign user operations. To submit a user operation to Pimlico, you can follow the steps to [sponsor a user operation with Pimlico's verifying paymaster](/infra/paymaster/verifying-paymaster/usage) and/or [submit a user operation through Pimlico's bundler](/infra/bundler/usage). If you would like to integrate Lit Protocol with the full flow of generating, signing, and submitting a user operation, you can follow the steps in [tutorial 1](/permissionless/core/tutorial/tutorial-1), replacing the signing step with the PKP wallet and using `pkpWallet.address` as the owner address of the smart account. +You can now use the `pkpWallet` as a regular Ethers.js wallet to sign user operations. To submit a user operation to Pimlico, you can follow the steps to [sponsor a user operation with Pimlico's verifying paymaster](/infra/paymaster/verifying-paymaster/usage) and/or [submit a user operation through Pimlico's bundler](/infra/bundler/usage). If you would like to integrate Lit Protocol with the full flow of generating, signing, and submitting a user operation, you can follow the steps in [tutorial 1](/permissionless/tutorial/tutorial-1), replacing the signing step with the PKP wallet and using `pkpWallet.address` as the owner address of the smart account. -Modified from [tutorial 1](/permissionless/core/tutorial/tutorial-1), an example of how to use the PKP wallet to sign a user operation is shown below: +Modified from [tutorial 1](/permissionless/tutorial/tutorial-1), an example of how to use the PKP wallet to sign a user operation is shown below: ```typescript const signature = await pkpWallet.signMessage( diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/magic.mdx b/docs/pages/permissionless/v0_1/how-to/signers/magic.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/magic.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/magic.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/particle-network.mdx b/docs/pages/permissionless/v0_1/how-to/signers/particle-network.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/particle-network.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/particle-network.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/passport.mdx b/docs/pages/permissionless/v0_1/how-to/signers/passport.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/passport.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/passport.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/passportSigners.mdx b/docs/pages/permissionless/v0_1/how-to/signers/passportSigners.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/passportSigners.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/passportSigners.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/privy.mdx b/docs/pages/permissionless/v0_1/how-to/signers/privy.mdx similarity index 91% rename from docs/pages/permissionless/core/v0_1/how-to/signers/privy.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/privy.mdx index 793dea7..a4e89c4 100644 --- a/docs/pages/permissionless/core/v0_1/how-to/signers/privy.mdx +++ b/docs/pages/permissionless/v0_1/how-to/signers/privy.mdx @@ -59,7 +59,7 @@ useEffect(() => setActiveWallet(embeddedWallet), [embeddedWallet]) ### Create the SmartAccountClient -Create the smart account client using the Privy signer. This is where you would configure what smart account implementation (e.g. [Safe](/permissionless/core/how-to/accounts/use-safe-account), [Kernel](/permissionless/core/how-to/accounts/use-kernel-account), Biconomy, [TrustWallet](/permissionless/core/how-to/accounts/use-trustwallet-account), [SimpleAccount](/permissionless/core/how-to/accounts/use-simple-account)) and what paymaster logic you want to use. +Create the smart account client using the Privy signer. This is where you would configure what smart account implementation (e.g. [Safe](/permissionless/how-to/accounts/use-safe-account), [Kernel](/permissionless/how-to/accounts/use-kernel-account), Biconomy, [TrustWallet](/permissionless/how-to/accounts/use-trustwallet-account), [SimpleAccount](/permissionless/how-to/accounts/use-simple-account)) and what paymaster logic you want to use. ```ts import { createSmartAccountClient, walletClientToSmartAccountSigner, ENTRYPOINT_ADDRESS_V06 } from "permissionless"; diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/smartAccounts.mdx b/docs/pages/permissionless/v0_1/how-to/signers/smartAccounts.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/smartAccounts.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/smartAccounts.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/turnkey.mdx b/docs/pages/permissionless/v0_1/how-to/signers/turnkey.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/turnkey.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/turnkey.mdx diff --git a/docs/pages/permissionless/core/v0_1/how-to/signers/web3auth.mdx b/docs/pages/permissionless/v0_1/how-to/signers/web3auth.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/how-to/signers/web3auth.mdx rename to docs/pages/permissionless/v0_1/how-to/signers/web3auth.mdx diff --git a/docs/pages/permissionless/core/v0_1/index.mdx b/docs/pages/permissionless/v0_1/index.mdx similarity index 96% rename from docs/pages/permissionless/core/v0_1/index.mdx rename to docs/pages/permissionless/v0_1/index.mdx index 8abae52..1ab8c56 100644 --- a/docs/pages/permissionless/core/v0_1/index.mdx +++ b/docs/pages/permissionless/v0_1/index.mdx @@ -18,7 +18,7 @@ import { HomePage } from 'vocs/components' permissionless.js is a TypeScript library built on viem for building with ERC-4337 smart accounts, bundlers, paymasters, and user operations. The core focuses are avoiding provider lock-in, having no dependencies, maximum viem compatibility, and a small bundle size. permissionless.js also provides high-level support for the major ERC-4337 smart accounts, including Safe, Kernel, Biconomy, SimpleAccount, TrustWallet and LightAccount. - Get started + Get started GitHub diff --git a/docs/pages/permissionless/core/v0_1/reference/accounts/signerToKernelSmartAccount.mdx b/docs/pages/permissionless/v0_1/reference/accounts/signerToKernelSmartAccount.mdx similarity index 93% rename from docs/pages/permissionless/core/v0_1/reference/accounts/signerToKernelSmartAccount.mdx rename to docs/pages/permissionless/v0_1/reference/accounts/signerToKernelSmartAccount.mdx index 46577fc..bdea6ae 100644 --- a/docs/pages/permissionless/core/v0_1/reference/accounts/signerToKernelSmartAccount.mdx +++ b/docs/pages/permissionless/v0_1/reference/accounts/signerToKernelSmartAccount.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../../VersionWarning" # signerToKernelSmartAccount -Creates a KernelAccount instance controlled by a `SmartAccountSigner`. Check out [this guide](/permissionless/core/how-to/accounts/use-kernel-account) for a complete tutorial. +Creates a KernelAccount instance controlled by a `SmartAccountSigner`. Check out [this guide](/permissionless/how-to/accounts/use-kernel-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/v0_1/reference/accounts/signerToLightSmartAccount.mdx b/docs/pages/permissionless/v0_1/reference/accounts/signerToLightSmartAccount.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/accounts/signerToLightSmartAccount.mdx rename to docs/pages/permissionless/v0_1/reference/accounts/signerToLightSmartAccount.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/accounts/signerToSafeSmartAccount.mdx b/docs/pages/permissionless/v0_1/reference/accounts/signerToSafeSmartAccount.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/accounts/signerToSafeSmartAccount.mdx rename to docs/pages/permissionless/v0_1/reference/accounts/signerToSafeSmartAccount.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/accounts/signerToSimpleSmartAccount.mdx b/docs/pages/permissionless/v0_1/reference/accounts/signerToSimpleSmartAccount.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/accounts/signerToSimpleSmartAccount.mdx rename to docs/pages/permissionless/v0_1/reference/accounts/signerToSimpleSmartAccount.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/accounts/signerToTrustSmartAccount.mdx b/docs/pages/permissionless/v0_1/reference/accounts/signerToTrustSmartAccount.mdx similarity index 91% rename from docs/pages/permissionless/core/v0_1/reference/accounts/signerToTrustSmartAccount.mdx rename to docs/pages/permissionless/v0_1/reference/accounts/signerToTrustSmartAccount.mdx index e22f75d..80617bc 100644 --- a/docs/pages/permissionless/core/v0_1/reference/accounts/signerToTrustSmartAccount.mdx +++ b/docs/pages/permissionless/v0_1/reference/accounts/signerToTrustSmartAccount.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../../VersionWarning" # signerToTrustSmartAccount -Creates a Trust Wallet Smart Account instance controlled by a `SmartAccountSigner`. Check out [this guide](/permissionless/core/how-to/accounts/use-trustwallet-account) for a complete tutorial. +Creates a Trust Wallet Smart Account instance controlled by a `SmartAccountSigner`. Check out [this guide](/permissionless/how-to/accounts/use-trustwallet-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/v0_1/reference/bundler-actions/estimateUserOperationGas.mdx b/docs/pages/permissionless/v0_1/reference/bundler-actions/estimateUserOperationGas.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/bundler-actions/estimateUserOperationGas.mdx rename to docs/pages/permissionless/v0_1/reference/bundler-actions/estimateUserOperationGas.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/bundler-actions/getUserOperationByHash.mdx b/docs/pages/permissionless/v0_1/reference/bundler-actions/getUserOperationByHash.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/bundler-actions/getUserOperationByHash.mdx rename to docs/pages/permissionless/v0_1/reference/bundler-actions/getUserOperationByHash.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/bundler-actions/getUserOperationReceipt.mdx b/docs/pages/permissionless/v0_1/reference/bundler-actions/getUserOperationReceipt.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/bundler-actions/getUserOperationReceipt.mdx rename to docs/pages/permissionless/v0_1/reference/bundler-actions/getUserOperationReceipt.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/bundler-actions/sendUserOperation.mdx b/docs/pages/permissionless/v0_1/reference/bundler-actions/sendUserOperation.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/bundler-actions/sendUserOperation.mdx rename to docs/pages/permissionless/v0_1/reference/bundler-actions/sendUserOperation.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/bundler-actions/supportedEntryPoints.mdx b/docs/pages/permissionless/v0_1/reference/bundler-actions/supportedEntryPoints.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/bundler-actions/supportedEntryPoints.mdx rename to docs/pages/permissionless/v0_1/reference/bundler-actions/supportedEntryPoints.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/bundler-actions/waitForUserOperationReceipt.mdx b/docs/pages/permissionless/v0_1/reference/bundler-actions/waitForUserOperationReceipt.mdx similarity index 96% rename from docs/pages/permissionless/core/v0_1/reference/bundler-actions/waitForUserOperationReceipt.mdx rename to docs/pages/permissionless/v0_1/reference/bundler-actions/waitForUserOperationReceipt.mdx index a814b1c..435e93d 100644 --- a/docs/pages/permissionless/core/v0_1/reference/bundler-actions/waitForUserOperationReceipt.mdx +++ b/docs/pages/permissionless/v0_1/reference/bundler-actions/waitForUserOperationReceipt.mdx @@ -7,7 +7,7 @@ import VersionWarning from "../../../VersionWarning" Waits for the User Operation to be included on a block (one confirmation), and then returns the User Operation Receipt. :::warning -If you are getting `WaitForUserOperationReceiptTimeoutError`. Use custom timeout in transport, please see the [FAQs](/permissionless/core/faqs#getting-waitforuseroperationreceipttimeouterror) for more information. +If you are getting `WaitForUserOperationReceiptTimeoutError`. Use custom timeout in transport, please see the [FAQs](/permissionless/faqs#getting-waitforuseroperationreceipttimeouterror) for more information. ::: ## Usage diff --git a/docs/pages/permissionless/core/v0_1/reference/clients/bundlerClient.mdx b/docs/pages/permissionless/v0_1/reference/clients/bundlerClient.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/clients/bundlerClient.mdx rename to docs/pages/permissionless/v0_1/reference/clients/bundlerClient.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/clients/pimlicoBundlerClient.mdx b/docs/pages/permissionless/v0_1/reference/clients/pimlicoBundlerClient.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/clients/pimlicoBundlerClient.mdx rename to docs/pages/permissionless/v0_1/reference/clients/pimlicoBundlerClient.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/clients/pimlicoPaymasterClient.mdx b/docs/pages/permissionless/v0_1/reference/clients/pimlicoPaymasterClient.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/clients/pimlicoPaymasterClient.mdx rename to docs/pages/permissionless/v0_1/reference/clients/pimlicoPaymasterClient.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/clients/smartAccountClient.mdx b/docs/pages/permissionless/v0_1/reference/clients/smartAccountClient.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/clients/smartAccountClient.mdx rename to docs/pages/permissionless/v0_1/reference/clients/smartAccountClient.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/accountId.mdx b/docs/pages/permissionless/v0_1/reference/erc7579-actions/accountId.mdx similarity index 89% rename from docs/pages/permissionless/core/v0_1/reference/erc7579-actions/accountId.mdx rename to docs/pages/permissionless/v0_1/reference/erc7579-actions/accountId.mdx index 8bd2115..e47e031 100644 --- a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/accountId.mdx +++ b/docs/pages/permissionless/v0_1/reference/erc7579-actions/accountId.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../../VersionWarning" # accountId -Gets the accountId of the smart account as defined in [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579). Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Gets the accountId of the smart account as defined in [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579). Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/installModule.mdx b/docs/pages/permissionless/v0_1/reference/erc7579-actions/installModule.mdx similarity index 95% rename from docs/pages/permissionless/core/v0_1/reference/erc7579-actions/installModule.mdx rename to docs/pages/permissionless/v0_1/reference/erc7579-actions/installModule.mdx index fc4e6f3..cb05b20 100644 --- a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/installModule.mdx +++ b/docs/pages/permissionless/v0_1/reference/erc7579-actions/installModule.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../../VersionWarning" # installModule -Installs a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module to the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Installs a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module to the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/isModuleInstalled.mdx b/docs/pages/permissionless/v0_1/reference/erc7579-actions/isModuleInstalled.mdx similarity index 91% rename from docs/pages/permissionless/core/v0_1/reference/erc7579-actions/isModuleInstalled.mdx rename to docs/pages/permissionless/v0_1/reference/erc7579-actions/isModuleInstalled.mdx index 39aaf73..fcabd83 100644 --- a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/isModuleInstalled.mdx +++ b/docs/pages/permissionless/v0_1/reference/erc7579-actions/isModuleInstalled.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../../VersionWarning" # isModuleInstalled -Checks if an [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module is installed on the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Checks if an [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module is installed on the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/supportsExecutionMode.mdx b/docs/pages/permissionless/v0_1/reference/erc7579-actions/supportsExecutionMode.mdx similarity index 93% rename from docs/pages/permissionless/core/v0_1/reference/erc7579-actions/supportsExecutionMode.mdx rename to docs/pages/permissionless/v0_1/reference/erc7579-actions/supportsExecutionMode.mdx index 34dd0d4..a9684ba 100644 --- a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/supportsExecutionMode.mdx +++ b/docs/pages/permissionless/v0_1/reference/erc7579-actions/supportsExecutionMode.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../../VersionWarning" # supportsExecutionMode -Checks if a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) execution mode is supported on the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Checks if a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) execution mode is supported on the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. :::info According to the specification, not all execution modes must be supported. So it is recommended to use this function to check if the execution mode is supported before using it. diff --git a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/supportsModule.mdx b/docs/pages/permissionless/v0_1/reference/erc7579-actions/supportsModule.mdx similarity index 89% rename from docs/pages/permissionless/core/v0_1/reference/erc7579-actions/supportsModule.mdx rename to docs/pages/permissionless/v0_1/reference/erc7579-actions/supportsModule.mdx index bcca385..b44020a 100644 --- a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/supportsModule.mdx +++ b/docs/pages/permissionless/v0_1/reference/erc7579-actions/supportsModule.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../../VersionWarning" # supportsModule -Checks if a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module type is supported by the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Checks if a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module type is supported by the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/uninstallModule.mdx b/docs/pages/permissionless/v0_1/reference/erc7579-actions/uninstallModule.mdx similarity index 95% rename from docs/pages/permissionless/core/v0_1/reference/erc7579-actions/uninstallModule.mdx rename to docs/pages/permissionless/v0_1/reference/erc7579-actions/uninstallModule.mdx index 91b7471..06c717c 100644 --- a/docs/pages/permissionless/core/v0_1/reference/erc7579-actions/uninstallModule.mdx +++ b/docs/pages/permissionless/v0_1/reference/erc7579-actions/uninstallModule.mdx @@ -4,7 +4,7 @@ import VersionWarning from "../../../VersionWarning" # uninstallModule -Uninstalls a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module from the smart account. Check out [this guide](/permissionless/core/how-to/accounts/use-erc7579-account) for a complete tutorial. +Uninstalls a [ERC-7579](https://eips.ethereum.org/EIPS/eip-7579) module from the smart account. Check out [this guide](/permissionless/how-to/accounts/use-erc7579-account) for a complete tutorial. ## Usage diff --git a/docs/pages/permissionless/core/v0_1/reference/glossary/errors.mdx b/docs/pages/permissionless/v0_1/reference/glossary/errors.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/glossary/errors.mdx rename to docs/pages/permissionless/v0_1/reference/glossary/errors.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/index.mdx b/docs/pages/permissionless/v0_1/reference/index.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/index.mdx rename to docs/pages/permissionless/v0_1/reference/index.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/pimlico-bundler-actions/getUserOperationGasPrice.mdx b/docs/pages/permissionless/v0_1/reference/pimlico-bundler-actions/getUserOperationGasPrice.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/pimlico-bundler-actions/getUserOperationGasPrice.mdx rename to docs/pages/permissionless/v0_1/reference/pimlico-bundler-actions/getUserOperationGasPrice.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/pimlico-bundler-actions/getUserOperationStatus.mdx b/docs/pages/permissionless/v0_1/reference/pimlico-bundler-actions/getUserOperationStatus.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/pimlico-bundler-actions/getUserOperationStatus.mdx rename to docs/pages/permissionless/v0_1/reference/pimlico-bundler-actions/getUserOperationStatus.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/pimlico-bundler-actions/sendCompressedUserOperation.mdx b/docs/pages/permissionless/v0_1/reference/pimlico-bundler-actions/sendCompressedUserOperation.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/pimlico-bundler-actions/sendCompressedUserOperation.mdx rename to docs/pages/permissionless/v0_1/reference/pimlico-bundler-actions/sendCompressedUserOperation.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/pimlico-paymaster-actions/sponsorUserOperation.mdx b/docs/pages/permissionless/v0_1/reference/pimlico-paymaster-actions/sponsorUserOperation.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/pimlico-paymaster-actions/sponsorUserOperation.mdx rename to docs/pages/permissionless/v0_1/reference/pimlico-paymaster-actions/sponsorUserOperation.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/pimlico-paymaster-actions/validateSponsorshipPolicies.mdx b/docs/pages/permissionless/v0_1/reference/pimlico-paymaster-actions/validateSponsorshipPolicies.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/pimlico-paymaster-actions/validateSponsorshipPolicies.mdx rename to docs/pages/permissionless/v0_1/reference/pimlico-paymaster-actions/validateSponsorshipPolicies.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/public-actions/getAccountNonce.mdx b/docs/pages/permissionless/v0_1/reference/public-actions/getAccountNonce.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/public-actions/getAccountNonce.mdx rename to docs/pages/permissionless/v0_1/reference/public-actions/getAccountNonce.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/public-actions/getSenderAddress.mdx b/docs/pages/permissionless/v0_1/reference/public-actions/getSenderAddress.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/public-actions/getSenderAddress.mdx rename to docs/pages/permissionless/v0_1/reference/public-actions/getSenderAddress.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/smart-account-actions/deployContract.mdx b/docs/pages/permissionless/v0_1/reference/smart-account-actions/deployContract.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/smart-account-actions/deployContract.mdx rename to docs/pages/permissionless/v0_1/reference/smart-account-actions/deployContract.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/smart-account-actions/prepareUserOperationRequest.mdx b/docs/pages/permissionless/v0_1/reference/smart-account-actions/prepareUserOperationRequest.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/smart-account-actions/prepareUserOperationRequest.mdx rename to docs/pages/permissionless/v0_1/reference/smart-account-actions/prepareUserOperationRequest.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/smart-account-actions/sendTransaction.mdx b/docs/pages/permissionless/v0_1/reference/smart-account-actions/sendTransaction.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/smart-account-actions/sendTransaction.mdx rename to docs/pages/permissionless/v0_1/reference/smart-account-actions/sendTransaction.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/smart-account-actions/sendTransactions.mdx b/docs/pages/permissionless/v0_1/reference/smart-account-actions/sendTransactions.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/smart-account-actions/sendTransactions.mdx rename to docs/pages/permissionless/v0_1/reference/smart-account-actions/sendTransactions.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/smart-account-actions/sendUserOperation.mdx b/docs/pages/permissionless/v0_1/reference/smart-account-actions/sendUserOperation.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/smart-account-actions/sendUserOperation.mdx rename to docs/pages/permissionless/v0_1/reference/smart-account-actions/sendUserOperation.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/smart-account-actions/signMessage.mdx b/docs/pages/permissionless/v0_1/reference/smart-account-actions/signMessage.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/smart-account-actions/signMessage.mdx rename to docs/pages/permissionless/v0_1/reference/smart-account-actions/signMessage.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/smart-account-actions/signTypedData.mdx b/docs/pages/permissionless/v0_1/reference/smart-account-actions/signTypedData.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/smart-account-actions/signTypedData.mdx rename to docs/pages/permissionless/v0_1/reference/smart-account-actions/signTypedData.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/smart-account-actions/writeContract.mdx b/docs/pages/permissionless/v0_1/reference/smart-account-actions/writeContract.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/smart-account-actions/writeContract.mdx rename to docs/pages/permissionless/v0_1/reference/smart-account-actions/writeContract.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/utils/getRequiredPrefund.mdx b/docs/pages/permissionless/v0_1/reference/utils/getRequiredPrefund.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/utils/getRequiredPrefund.mdx rename to docs/pages/permissionless/v0_1/reference/utils/getRequiredPrefund.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/utils/getUserOperationHash.mdx b/docs/pages/permissionless/v0_1/reference/utils/getUserOperationHash.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/utils/getUserOperationHash.mdx rename to docs/pages/permissionless/v0_1/reference/utils/getUserOperationHash.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/utils/providerToSmartAccountSigner.mdx b/docs/pages/permissionless/v0_1/reference/utils/providerToSmartAccountSigner.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/utils/providerToSmartAccountSigner.mdx rename to docs/pages/permissionless/v0_1/reference/utils/providerToSmartAccountSigner.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/utils/signUserOperationHashWithECDSA.mdx b/docs/pages/permissionless/v0_1/reference/utils/signUserOperationHashWithECDSA.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/utils/signUserOperationHashWithECDSA.mdx rename to docs/pages/permissionless/v0_1/reference/utils/signUserOperationHashWithECDSA.mdx diff --git a/docs/pages/permissionless/core/v0_1/reference/utils/walletClientToSmartAccountSigner.mdx b/docs/pages/permissionless/v0_1/reference/utils/walletClientToSmartAccountSigner.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/reference/utils/walletClientToSmartAccountSigner.mdx rename to docs/pages/permissionless/v0_1/reference/utils/walletClientToSmartAccountSigner.mdx diff --git a/docs/pages/permissionless/v0_1/tutorial/index.mdx b/docs/pages/permissionless/v0_1/tutorial/index.mdx new file mode 100644 index 0000000..fc63de9 --- /dev/null +++ b/docs/pages/permissionless/v0_1/tutorial/index.mdx @@ -0,0 +1,11 @@ +import VersionWarning from "../../VersionWarning" + + + +# Tutorials + +Learning-oriented lessons that take you through a series of steps to complete a project. Most useful when you want to get started with Pimlico. + +[Tutorial 1](/permissionless/v0_1/tutorial/tutorial-1) takes you through the journey of leveraging permissionless.js's high-level APIs to easily create and bundle a user operation. + +[Tutorial 2](/permissionless/v0_1/tutorial/tutorial-2) takes you through the journey of creating a user operation, getting it sponsored by our verifying paymaster, and then sending it to be included on-chain with our bundler. diff --git a/docs/pages/permissionless/core/v0_1/tutorial/tutorial-1.mdx b/docs/pages/permissionless/v0_1/tutorial/tutorial-1.mdx similarity index 98% rename from docs/pages/permissionless/core/v0_1/tutorial/tutorial-1.mdx rename to docs/pages/permissionless/v0_1/tutorial/tutorial-1.mdx index f4f8d6c..731dda7 100644 --- a/docs/pages/permissionless/core/v0_1/tutorial/tutorial-1.mdx +++ b/docs/pages/permissionless/v0_1/tutorial/tutorial-1.mdx @@ -56,7 +56,7 @@ Let's open up `index.ts`, and add the following to the bottom: For the purposes of this guide, we will be using [Safe](https://safe.global) accounts. This account is an ERC-4337 wallet controlled by a single EOA signer. :::tip[Tip] -Want to learn more about using Safe accounts? Take a look at our [dedicated Safe guide](/permissionless/core/how-to/accounts/use-safe-account) +Want to learn more about using Safe accounts? Take a look at our [dedicated Safe guide](/permissionless/how-to/accounts/use-safe-account) ::: To create the Safe account, we will use the `signerToSafeSmartAccount` utility function from permissionless.js. We need to specify the Safe version we are using as well as the global ERC-4337 EntryPoint address. For the signer, we will be using the previously generated private key. diff --git a/docs/pages/permissionless/core/v0_1/tutorial/tutorial-2.mdx b/docs/pages/permissionless/v0_1/tutorial/tutorial-2.mdx similarity index 99% rename from docs/pages/permissionless/core/v0_1/tutorial/tutorial-2.mdx rename to docs/pages/permissionless/v0_1/tutorial/tutorial-2.mdx index 08eded1..3db90be 100644 --- a/docs/pages/permissionless/core/v0_1/tutorial/tutorial-2.mdx +++ b/docs/pages/permissionless/v0_1/tutorial/tutorial-2.mdx @@ -5,7 +5,7 @@ import VersionWarning from "../../VersionWarning" # Tutorial 2 — Submit a user operation with a Verifying Paymaster :::note -This is a low-level tutorial that walks you through the steps of constructing a user operation from scratch. If you would like to leverage permissionless.js's high-level functions, take a look at [tutorial 1](/permissionless/core/tutorial/tutorial-1). +This is a low-level tutorial that walks you through the steps of constructing a user operation from scratch. If you would like to leverage permissionless.js's high-level functions, take a look at [tutorial 1](/permissionless/tutorial/tutorial-1). ::: In this tutorial, you will generate a user operation, ask Pimlico's verifying paymaster to sponsor it, and then submit the sponsored user operation on-chain with Pimlico's Alto bundler. diff --git a/docs/pages/permissionless/core/v0_1/why.mdx b/docs/pages/permissionless/v0_1/why.mdx similarity index 100% rename from docs/pages/permissionless/core/v0_1/why.mdx rename to docs/pages/permissionless/v0_1/why.mdx diff --git a/docs/pages/permissionless/wagmi/index.mdx b/docs/pages/permissionless/wagmi/index.mdx index 7b1df52..8e725c5 100644 --- a/docs/pages/permissionless/wagmi/index.mdx +++ b/docs/pages/permissionless/wagmi/index.mdx @@ -14,7 +14,7 @@ import { HomePage } from 'vocs/components' @permissionless/wagmi is a TypeScript library built on top of permissionless.js and wagmi for quickly enabling support for EIP-5792 features on your app, including gas sponsorship and transaction batching, with just a couple lines of code. We built @permissionless/wagmi to allow app developers to support the features of new smart accounts such as Coinbase Smart Wallet without any of the complexity. - Get started + Get started GitHub diff --git a/docs/pages/permissionless/core/why.mdx b/docs/pages/permissionless/why.mdx similarity index 100% rename from docs/pages/permissionless/core/why.mdx rename to docs/pages/permissionless/why.mdx diff --git a/vercel.json b/vercel.json index 722ecac..9b905c1 100644 --- a/vercel.json +++ b/vercel.json @@ -7,7 +7,7 @@ }, { "source": "/permissionless/v0.1/:path*", - "destination": "/permissionless/core/v0_1/:path*" + "destination": "/permissionless/v0_1/:path*" } ], "redirects": [ @@ -18,7 +18,7 @@ }, { "source": "/tutorial/:match*", - "destination": "/permissionless/core/tutorial/:match", + "destination": "/permissionless/tutorial/:match", "permanent": false }, { @@ -113,7 +113,7 @@ }, { "source": "/reference/getting-started-with-pimlico", - "destination": "/permissionless/core/tutorial/tutorial-1", + "destination": "/permissionless/tutorial/tutorial-1", "permanent": false }, { @@ -123,12 +123,12 @@ }, { "source": "/docs/erc20-paymaster-getting-started", - "destination": "/permissionless/core/tutorial/tutorial-2", + "destination": "/permissionless/tutorial/tutorial-2", "permanent": false }, { "source": "/docs/getting-started", - "destination": "/permissionless/core/tutorial/tutorial-1", + "destination": "/permissionless/tutorial/tutorial-1", "permanent": false }, { @@ -198,12 +198,12 @@ }, { "source": "/how-to/integrations/lit-protocol", - "destination": "/permissionless/core/how-to/signers/lit-protocol", + "destination": "/permissionless/how-to/signers/lit-protocol", "permanent": false }, { "source": "/tutorial/integrations/lit-protocol", - "destination": "/permissionless/core/how-to/signers/lit-protocol", + "destination": "/permissionless/how-to/signers/lit-protocol", "permanent": false } ] diff --git a/vocs.config.tsx b/vocs.config.tsx index 9a98564..6b29ee0 100644 --- a/vocs.config.tsx +++ b/vocs.config.tsx @@ -377,12 +377,12 @@ export const paymasterSidebar = [ ] /* - { text: "deployContract", link: "/permissionless/core/reference/smart-account-actions/deployContract" }, - { text: "sendTransaction", link: "/permissionless/core/reference/smart-account-actions/sendTransaction" }, - { text: "sendTransactions", link: "/permissionless/core/reference/smart-account-actions/sendTransactions" }, - { text: "signMessage", link: "/permissionless/core/reference/smart-account-actions/signMessage" }, - { text: "signTypedData", link: "/permissionless/core/reference/smart-account-actions/signTypedData" }, - { text: "writeContract", link: "/permissionless/core/reference/smart-account-actions/writeContract" }, + { text: "deployContract", link: "/permissionless/reference/smart-account-actions/deployContract" }, + { text: "sendTransaction", link: "/permissionless/reference/smart-account-actions/sendTransaction" }, + { text: "sendTransactions", link: "/permissionless/reference/smart-account-actions/sendTransactions" }, + { text: "signMessage", link: "/permissionless/reference/smart-account-actions/signMessage" }, + { text: "signTypedData", link: "/permissionless/reference/smart-account-actions/signTypedData" }, + { text: "writeContract", link: "/permissionless/reference/smart-account-actions/writeContract" }, */ @@ -408,27 +408,27 @@ export const conceptualSidebar = [ export const permissionlessSidebar = [ { text: "Overview", - link: "/permissionless/core", + link: "/permissionless", }, { text: "Why permissionless.js", - link: "/permissionless/core/why", + link: "/permissionless/why", }, { text: "FAQs", - link: "/permissionless/core/faqs", + link: "/permissionless/faqs", }, { text: "Tutorials", - link: "/permissionless/core/tutorial", + link: "/permissionless/tutorial", items: [ { text: "1. Send your first gasless transaction", - link: "/permissionless/core/tutorial/tutorial-1", + link: "/permissionless/tutorial/tutorial-1", }, { text: "2. Submit a user operation with an ERC-20 Paymaster", - link: "/permissionless/core/tutorial/tutorial-2", + link: "/permissionless/tutorial/tutorial-2", }, ], }, @@ -437,62 +437,62 @@ export const permissionlessSidebar = [ items: [ { text: "Update your existing app to sponsor gas fees for smart account users", - link: "/permissionless/core/how-to/dapp-gas-sponsorship", + link: "/permissionless/how-to/dapp-gas-sponsorship", }, { text: "How to send multiple user operations in parallel", - link: "/permissionless/core/how-to/parallel-transactions", + link: "/permissionless/how-to/parallel-transactions", }, // { // text: "Error Handling", - // link: "/permissionless/core/how-to/error-handling", + // link: "/permissionless/how-to/error-handling", // }, { text: "Migration Guide", - link: "/permissionless/core/how-to/migration-guide", + link: "/permissionless/how-to/migration-guide", }, { text: "Local Testing", - link: "/permissionless/core/how-to/local-testing", + link: "/permissionless/how-to/local-testing", }, { text: "Accounts", items: [ { text: "EntryPoint support", - link: "/permissionless/core/how-to/accounts/support", + link: "/permissionless/how-to/accounts/support", }, { text: "How to use a Safe account", - link: "/permissionless/core/how-to/accounts/use-safe-account", + link: "/permissionless/how-to/accounts/use-safe-account", }, { text: "How to use a Kernel account", - link: "/permissionless/core/how-to/accounts/use-kernel-account", + link: "/permissionless/how-to/accounts/use-kernel-account", }, { text: "How to use a SimpleAccount", - link: "/permissionless/core/how-to/accounts/use-simple-account", + link: "/permissionless/how-to/accounts/use-simple-account", }, { text: "How to use a Biconomy account", - link: "/permissionless/core/how-to/accounts/use-biconomy-account", + link: "/permissionless/how-to/accounts/use-biconomy-account", }, { text: "How to use a LightAccount", - link: "/permissionless/core/how-to/accounts/use-light-account", + link: "/permissionless/how-to/accounts/use-light-account", }, { text: "How to use a Trust Wallet account", - link: "/permissionless/core/how-to/accounts/use-trustwallet-account", + link: "/permissionless/how-to/accounts/use-trustwallet-account", }, { text: "How to use a Coinbase Wallet account", - link: "/permissionless/core/how-to/accounts/use-coinbase-account", + link: "/permissionless/how-to/accounts/use-coinbase-account", }, { text: "How to use an ERC-7579 compatible smart account", - link: "/permissionless/core/how-to/accounts/use-erc7579-account", + link: "/permissionless/how-to/accounts/use-erc7579-account", }, ], }, @@ -501,65 +501,65 @@ export const permissionlessSidebar = [ items: [ { text: "How to use a custom Paymaster", - link: "/permissionless/core/how-to/paymasters/use-custom-paymaster", + link: "/permissionless/how-to/paymasters/use-custom-paymaster", }, { text: "How to conditionally sponsor a user operation", - link: "/permissionless/core/how-to/paymasters/conditional-sponsoring", + link: "/permissionless/how-to/paymasters/conditional-sponsoring", }, ], }, { text: "Signers", - link: "/permissionless/core/how-to/signers", + link: "/permissionless/how-to/signers", items: [ { text: "How to use a Dynamic signer", - link: "/permissionless/core/how-to/signers/dynamic", + link: "/permissionless/how-to/signers/dynamic", }, { text: "How to use a Privy signer", - link: "/permissionless/core/how-to/signers/privy", + link: "/permissionless/how-to/signers/privy", }, { text: "How to use a Magic signer", - link: "/permissionless/core/how-to/signers/magic", + link: "/permissionless/how-to/signers/magic", }, { text: "How to use a Passport signer", - link: "/permissionless/core/how-to/signers/passport", + link: "/permissionless/how-to/signers/passport", }, { text: "How to use a Lit Protocol signer", - link: "/permissionless/core/how-to/signers/lit-protocol", + link: "/permissionless/how-to/signers/lit-protocol", }, { text: "How to use a Web3Auth signer", - link: "/permissionless/core/how-to/signers/web3auth", + link: "/permissionless/how-to/signers/web3auth", }, { text: "How to use a Turnkey signer", - link: "/permissionless/core/how-to/signers/turnkey", + link: "/permissionless/how-to/signers/turnkey", }, { text: "How to use a Fireblocks signer", - link: "/permissionless/core/how-to/signers/fireblocks", + link: "/permissionless/how-to/signers/fireblocks", }, { text: "How to use a Capsule signer", - link: "/permissionless/core/how-to/signers/capsule", + link: "/permissionless/how-to/signers/capsule", }, { text: "How to use a DFNS signer", - link: "/permissionless/core/how-to/signers/dfns", + link: "/permissionless/how-to/signers/dfns", }, { text: "How to use an Arcana Auth signer", - link: "/permissionless/core/how-to/signers/arcana", + link: "/permissionless/how-to/signers/arcana", }, { text: "How to use a Particle Network signer", - link: "/permissionless/core/how-to/signers/particle-network", + link: "/permissionless/how-to/signers/particle-network", }, ], }, @@ -567,7 +567,7 @@ export const permissionlessSidebar = [ }, { text: "Reference", - link: "/permissionless/core/reference", + link: "/permissionless/reference", items: [ { text: "Clients", @@ -575,11 +575,11 @@ export const permissionlessSidebar = [ items: [ { text: "Pimlico Client", - link: "/permissionless/core/reference/clients/pimlicoClient", + link: "/permissionless/reference/clients/pimlicoClient", }, { text: "Smart Account Client", - link: "/permissionless/core/reference/clients/smartAccountClient", + link: "/permissionless/reference/clients/smartAccountClient", }, ], }, @@ -589,23 +589,23 @@ export const permissionlessSidebar = [ items: [ { text: "toSimpleSmartAccount", - link: "/permissionless/core/reference/accounts/toSimpleSmartAccount", + link: "/permissionless/reference/accounts/toSimpleSmartAccount", }, { text: "toSafeSmartAccount", - link: "/permissionless/core/reference/accounts/toSafeSmartAccount", + link: "/permissionless/reference/accounts/toSafeSmartAccount", }, { text: "toEcdsaKernelSmartAccount", - link: "/permissionless/core/reference/accounts/toEcdsaKernelSmartAccount", + link: "/permissionless/reference/accounts/toEcdsaKernelSmartAccount", }, { text: "toLightSmartAccount", - link: "/permissionless/core/reference/accounts/toLightSmartAccount", + link: "/permissionless/reference/accounts/toLightSmartAccount", }, { text: "toTrustSmartAccount", - link: "/permissionless/core/reference/accounts/toTrustSmartAccount", + link: "/permissionless/reference/accounts/toTrustSmartAccount", }, ], }, @@ -615,43 +615,43 @@ export const permissionlessSidebar = [ items: [ { text: "sendTransaction", - link: "/permissionless/core/reference/smart-account-actions/sendTransaction", + link: "/permissionless/reference/smart-account-actions/sendTransaction", }, { text: "writeContract", - link: "/permissionless/core/reference/smart-account-actions/writeContract", + link: "/permissionless/reference/smart-account-actions/writeContract", }, { text: "estimateUserOperationGas", - link: "/permissionless/core/reference/smart-account-actions/estimateUserOperationGas", + link: "/permissionless/reference/smart-account-actions/estimateUserOperationGas", }, { text: "getChainId", - link: "/permissionless/core/reference/smart-account-actions/getChainId", + link: "/permissionless/reference/smart-account-actions/getChainId", }, { text: "getSupportedEntryPoints", - link: "/permissionless/core/reference/smart-account-actions/getSupportedEntryPoints", + link: "/permissionless/reference/smart-account-actions/getSupportedEntryPoints", }, { text: "getUserOperation", - link: "/permissionless/core/reference/smart-account-actions/getUserOperation", + link: "/permissionless/reference/smart-account-actions/getUserOperation", }, { text: "getUserOperationReceipt", - link: "/permissionless/core/reference/smart-account-actions/getUserOperationReceipt", + link: "/permissionless/reference/smart-account-actions/getUserOperationReceipt", }, { text: "prepareUserOperation", - link: "/permissionless/core/reference/smart-account-actions/prepareUserOperation", + link: "/permissionless/reference/smart-account-actions/prepareUserOperation", }, { text: "sendUserOperation", - link: "/permissionless/core/reference/smart-account-actions/sendUserOperation", + link: "/permissionless/reference/smart-account-actions/sendUserOperation", }, { text: "waitForUserOperationReceipt", - link: "/permissionless/core/reference/smart-account-actions/waitForUserOperationReceipt", + link: "/permissionless/reference/smart-account-actions/waitForUserOperationReceipt", }, ], }, @@ -661,27 +661,27 @@ export const permissionlessSidebar = [ items: [ { text: "getPaymasterData", - link: "/permissionless/core/reference/pimlico-actions/getPaymasterData", + link: "/permissionless/reference/pimlico-actions/getPaymasterData", }, { text: "getPaymasterStubData", - link: "/permissionless/core/reference/pimlico-actions/getPaymasterStubData", + link: "/permissionless/reference/pimlico-actions/getPaymasterStubData", }, { text: "sendCompressedUserOperation", - link: "/permissionless/core/reference/pimlico-actions/sendCompressedUserOperation", + link: "/permissionless/reference/pimlico-actions/sendCompressedUserOperation", }, { text: "getUserOperationGasPrice", - link: "/permissionless/core/reference/pimlico-actions/getUserOperationGasPrice", + link: "/permissionless/reference/pimlico-actions/getUserOperationGasPrice", }, { text: "getUserOperationStatus", - link: "/permissionless/core/reference/pimlico-actions/getUserOperationStatus", + link: "/permissionless/reference/pimlico-actions/getUserOperationStatus", }, { text: "validateSponsorshipPolicies", - link: "/permissionless/core/reference/pimlico-actions/validateSponsorshipPolicies", + link: "/permissionless/reference/pimlico-actions/validateSponsorshipPolicies", }, ], }, @@ -691,11 +691,11 @@ export const permissionlessSidebar = [ items: [ { text: "getSenderAddress", - link: "/permissionless/core/reference/public-actions/getSenderAddress", + link: "/permissionless/reference/public-actions/getSenderAddress", }, { text: "getAccountNonce", - link: "/permissionless/core/reference/public-actions/getAccountNonce", + link: "/permissionless/reference/public-actions/getAccountNonce", }, ], }, @@ -705,27 +705,27 @@ export const permissionlessSidebar = [ items: [ { text: "accountId", - link: "/permissionless/core/reference/erc7579-actions/accountId", + link: "/permissionless/reference/erc7579-actions/accountId", }, { text: "installModule", - link: "/permissionless/core/reference/erc7579-actions/installModule", + link: "/permissionless/reference/erc7579-actions/installModule", }, { text: "uninstallModule", - link: "/permissionless/core/reference/erc7579-actions/uninstallModule", + link: "/permissionless/reference/erc7579-actions/uninstallModule", }, { text: "isModuleInstalled", - link: "/permissionless/core/reference/erc7579-actions/isModuleInstalled", + link: "/permissionless/reference/erc7579-actions/isModuleInstalled", }, { text: "supportsExecutionMode", - link: "/permissionless/core/reference/erc7579-actions/supportsExecutionMode", + link: "/permissionless/reference/erc7579-actions/supportsExecutionMode", }, { text: "supportsModule", - link: "/permissionless/core/reference/erc7579-actions/supportsModule", + link: "/permissionless/reference/erc7579-actions/supportsModule", }, ], }, @@ -735,7 +735,7 @@ export const permissionlessSidebar = [ items: [ { text: "getRequiredPrefund", - link: "/permissionless/core/reference/utils/getRequiredPrefund", + link: "/permissionless/reference/utils/getRequiredPrefund", }, ], }, @@ -743,7 +743,7 @@ export const permissionlessSidebar = [ }, { text: "permissionless 0.1.x", - link: "/permissionless/core/v0_1", + link: "/permissionless/v0_1", }, ] @@ -773,7 +773,7 @@ export const permissionlessWagmiSidebar = [ }, { text: "Reference", - link: "/permissionless/core/reference", + link: "/permissionless/reference", items: [ { text: "Configuration", @@ -1246,7 +1246,7 @@ export default defineConfig({ sidebar: { "/permissionless": [ { - link: "/permissionless/core", + link: "/permissionless", text: "permissionless.js Core", items: permissionlessSidebar, }, @@ -1308,7 +1308,7 @@ export default defineConfig({ items: [ { text: "core", - link: "/permissionless/core", + link: "/permissionless", }, { text: "wagmi",