moldy/vocs migration (#1)

* docs: migrate to using vocs

* docs: migrate the alchemy signer docs over

* docs: update the signer guides to vocs

* docs: migrate over the using smart accounts guides to vocs

* docs: migrate react hook docs to vocs

* docs: migrate choosing a smart account to vocs

* docs: migrate 3rd party to vocs

* docs: migrate extending smart accounts to vocs

* docs: migrate resources to vocs

* docs: add socials to vocs

* docs: add aa-core vocs

* docs: add aa-alchemy to vocs

* docs: add aa-accounts to vocs

* docs: add aa-signers to vocs

* docs: migrate aa-ethers to vocs

* docs: update core head options

* docs: clean up the themes in vocs

* docs: update the build pipeline for vocs

* docs: update all of the header fields

* docs: make the site build

* docs: apply lint and fix github actions

* chore: enable publishing site via workflow_dispatch

.github/workflows/deploy-site.yml

@@ -3,6 +3,7 @@ on:
   push:
     branches:
       - main
+  workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
@@ -68,16 +69,21 @@ jobs:
       - name: Install dependencies
         run: yarn
 
-      - name: Build with VitePress
+      - name: Build with Vocs
         working-directory: site
-        run: |
-          yarn build
-          touch .vitepress/dist/.nojekyll
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 5
+          max_attempts: 2
+          retry_on: error
+          command: |
+            yarn build
+            touch dist/.nojekyll
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
-          path: site/.vitepress/dist
+          path: site/dist
 
   # Deployment job
   deploy:

.github/workflows/on-pull-request.yml

@@ -74,9 +74,14 @@ jobs:
         run: yarn install --frozen-lockfile
 
       - name: Build
+        uses: nick-fields/retry@v3
         env:
           API_KEY: ${{ secrets.API_KEY }}
-        run: yarn build
+        with:
+          timeout_minutes: 5
+          max_attempts: 2
+          retry_on: error
+          command: yarn build
 
       - name: Unit Test
         run: yarn test

.github/workflows/publish-package.yml

@@ -86,16 +86,21 @@ jobs:
           API_KEY: ${{ secrets.API_KEY }}
         run: yarn lerna publish --conventional-commits --no-private --yes --no-verify-access
 
-      - name: Build with VitePress
+      - name: Build with Vocs
         working-directory: site
-        run: |
-          yarn build
-          touch .vitepress/dist/.nojekyll
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 5
+          max_attempts: 2
+          retry_on: error
+          command: |
+            yarn build
+            touch dist/.nojekyll
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
-          path: site/.vitepress/dist
+          path: site/dist
 
   publish_site:
     name: Publish Docs Site

packages/accounts/src/light-account/accounts/account.ts

@@ -49,7 +49,7 @@ export type LightAccount<
   getOwnerAddress: () => Promise<Address>;
 };
 
-//#region CreateLightAccountParams
+// [!region CreateLightAccountParams]
 export type CreateLightAccountParams<
   TTransport extends Transport = Transport,
   TSigner extends SmartAccountSigner = SmartAccountSigner,
@@ -75,7 +75,7 @@ export type CreateLightAccountParams<
   version?: TLightAccountVersion;
   entryPoint?: EntryPointDef<TEntryPointVersion, Chain>;
 };
-//#endregion CreateLightAccountParams
+// [!endregion CreateLightAccountParams]
 
 export async function createLightAccount<
   TTransport extends Transport = Transport,

packages/accounts/src/msca/account/multiOwnerAccount.ts

@@ -32,7 +32,7 @@ export type MultiOwnerModularAccount<
   "0.6.0"
 >;
 
-// #region CreateMultiOwnerModularAccountParams
+// [!region CreateMultiOwnerModularAccountParams]
 export type CreateMultiOwnerModularAccountParams<
   TTransport extends Transport = Transport,
   TSigner extends SmartAccountSigner = SmartAccountSigner,
@@ -53,7 +53,7 @@ export type CreateMultiOwnerModularAccountParams<
   owners?: Address[];
   accountAddress?: Address;
 } & EntryPointParameter<TEntryPointVersion, Chain>;
-// #endregion CreateMultiOwnerModularAccountParams
+// [!endregion CreateMultiOwnerModularAccountParams]
 
 export async function createMultiOwnerModularAccount<
   TTransport extends Transport = Transport,

packages/alchemy/src/config/types.ts

@@ -39,7 +39,7 @@ export type AlchemyAccountsConfig = {
   };
 };
 
-// #region CreateConfigProps
+// [!region CreateConfigProps]
 export type Connection = ConnectionConfig & {
   chain: Chain;
   gasManagerConfig?: AlchemyGasManagerConfig;
@@ -86,6 +86,6 @@ export type CreateConfigProps = RpcConnectionConfig & {
     >,
     "connection"
   >;
-// #endregion CreateConfigProps
+// [!endregion CreateConfigProps]
 
 export type AlchemyClientState = StoredState;

packages/alchemy/src/signer/client/types.ts

@@ -6,15 +6,15 @@ export type CredentialCreationOptionOverrides = {
   publicKey?: Partial<CredentialCreationOptions["publicKey"]>;
 } & Pick<CredentialCreationOptions, "signal">;
 
-//#region User
+// [!region User]
 export type User = {
   email?: string;
   orgId: string;
   userId: string;
   address: Address;
   credentialId?: string;
 };
-//#endregion User
+// [!endregion User]
 
 export type ExportWalletParams = {
   iframeContainerId: string;

packages/core/src/account/smartContractAccount.ts

@@ -80,7 +80,7 @@ export const isSmartAccountWithSigner = (
   return "getSigner" in account;
 };
 
-//#region SmartContractAccount
+// [!region SmartContractAccount]
 export type SmartContractAccount<
   Name extends string = string,
   TEntryPointVersion extends EntryPointVersion = EntryPointVersion
@@ -106,7 +106,7 @@ export type SmartContractAccount<
   getEntryPoint: () => EntryPointDef<TEntryPointVersion>;
   getImplementationAddress: () => Promise<NullAddress | Address>;
 };
-//#endregion SmartContractAccount
+// [!endregion SmartContractAccount]
 
 export interface AccountEntryPointRegistry<Name extends string = string>
   extends EntryPointRegistryBase<
@@ -116,7 +116,7 @@ export interface AccountEntryPointRegistry<Name extends string = string>
   "0.7.0": SmartContractAccount<Name, "0.7.0">;
 }
 
-//#region ToSmartContractAccountParams
+// [!region ToSmartContractAccountParams]
 export type ToSmartContractAccountParams<
   Name extends string = string,
   TTransport extends Transport = Transport,
@@ -136,7 +136,7 @@ export type ToSmartContractAccountParams<
   signUserOperationHash?: (uoHash: Hex) => Promise<Hex>;
   encodeUpgradeToAndCall?: (params: UpgradeToAndCallParams) => Promise<Hex>;
 } & Omit<CustomSource, "signTransaction" | "address">;
-//#endregion ToSmartContractAccountParams
+// [!endregion ToSmartContractAccountParams]
 
 export const parseFactoryAddressFromAccountInitCode = (
   initCode: Hex
@@ -192,7 +192,7 @@ export const getAccountAddress = async ({
   throw new GetCounterFactualAddressError();
 };
 
-//#region toSmartContractAccount
+// [!region toSmartContractAccount]
 export async function toSmartContractAccount<
   Name extends string = string,
   TTransport extends Transport = Transport,
@@ -218,7 +218,7 @@ export async function toSmartContractAccount<
   TChain,
   TEntryPointVersion
 >): Promise<SmartContractAccount<Name, TEntryPointVersion>>;
-//#endregion toSmartContractAccount
+// [!endregion toSmartContractAccount]
 
 export async function toSmartContractAccount({
   transport,

packages/core/src/actions/smartAccount/types.ts

@@ -15,7 +15,7 @@ import type {
 } from "../../types";
 import type { IsUndefined } from "../../utils";
 
-//#region UpgradeAccountParams
+// [!region UpgradeAccountParams]
 export type UpgradeAccountParams<
   TAccount extends SmartContractAccount | undefined,
   TContext extends UserOperationContext | undefined =
@@ -28,9 +28,9 @@ export type UpgradeAccountParams<
 } & GetAccountParameter<TAccount> &
   GetContextParameter<TContext> &
   UserOperationOverridesParameter<TEntryPointVersion>;
-//#endregion UpgradeAccountParams
+// [!endregion UpgradeAccountParams]
 
-//#region SendUserOperationParameters
+// [!region SendUserOperationParameters]
 export type SendUserOperationParameters<
   TAccount extends SmartContractAccount | undefined,
   TContext extends UserOperationContext | undefined =
@@ -42,19 +42,19 @@ export type SendUserOperationParameters<
 } & GetAccountParameter<TAccount> &
   GetContextParameter<TContext> &
   UserOperationOverridesParameter<TEntryPointVersion>;
-//#endregion SendUserOperationParameters
+// [!endregion SendUserOperationParameters]
 
-//#region BuildUserOperationParameters
+// [!region BuildUserOperationParameters]
 export type BuildUserOperationParameters<
   TAccount extends SmartContractAccount | undefined,
   TContext extends UserOperationContext | undefined =
     | UserOperationContext
     | undefined,
   TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>
 > = SendUserOperationParameters<TAccount, TContext, TEntryPointVersion>;
-//#endregion BuildUserOperationParameters
+// [!endregion BuildUserOperationParameters]
 
-//#region SignUserOperationParameters
+// [!region SignUserOperationParameters]
 export type SignUserOperationParameters<
   TAccount extends SmartContractAccount | undefined =
     | SmartContractAccount
@@ -67,9 +67,9 @@ export type SignUserOperationParameters<
   uoStruct: UserOperationStruct<TEntryPointVersion>;
 } & GetAccountParameter<TAccount> &
   GetContextParameter<TContext>;
-//#endregion SignUserOperationParameters
+// [!endregion SignUserOperationParameters]
 
-//#region SendTransactionsParameters
+// [!region SendTransactionsParameters]
 export type SendTransactionsParameters<
   TAccount extends SmartContractAccount | undefined,
   TContext extends UserOperationContext | undefined =
@@ -81,19 +81,19 @@ export type SendTransactionsParameters<
 } & GetAccountParameter<TAccount> &
   GetContextParameter<TContext> &
   UserOperationOverridesParameter<TEntryPointVersion>;
-//#endregion SendTransactionsParameters
+// [!endregion SendTransactionsParameters]
 
-//#region BuildTransactionParameters
+// [!region BuildTransactionParameters]
 export type BuildTransactionParameters<
   TAccount extends SmartContractAccount | undefined,
   TContext extends UserOperationContext | undefined =
     | UserOperationContext
     | undefined,
   TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>
 > = SendTransactionsParameters<TAccount, TContext, TEntryPointVersion>;
-//#endregion BuildTransactionParameters
+// [!endregion BuildTransactionParameters]
 
-//#region DropAndReplaceUserOperationParameters
+// [!region DropAndReplaceUserOperationParameters]
 export type DropAndReplaceUserOperationParameters<
   TAccount extends SmartContractAccount | undefined,
   TContext extends UserOperationContext | undefined =
@@ -105,9 +105,9 @@ export type DropAndReplaceUserOperationParameters<
 } & GetAccountParameter<TAccount> &
   GetContextParameter<TContext> &
   UserOperationOverridesParameter<TEntryPointVersion>;
-//#endregion DropAndReplaceUserOperationParameters
+// [!endregion DropAndReplaceUserOperationParameters]
 
-//#region WaitForUserOperationTxParameters
+// [!region WaitForUserOperationTxParameters]
 export type WaitForUserOperationTxParameters = {
   hash: Hex;
   /**
@@ -130,22 +130,22 @@ export type WaitForUserOperationTxParameters = {
     maxRetries: number;
   };
 };
-//#endregion WaitForUserOperationTxParameters
+// [!endregion WaitForUserOperationTxParameters]
 
-//#region BuildUserOperationFromTransactionsResult
+// [!region BuildUserOperationFromTransactionsResult]
 export type BuildUserOperationFromTransactionsResult<
   TEntryPointVersion extends EntryPointVersion = EntryPointVersion
 > = {
   uoStruct: UserOperationStruct<TEntryPointVersion>;
   batch: BatchUserOperationCallData;
 } & UserOperationOverridesParameter<TEntryPointVersion, true>;
-//#endregion BuildUserOperationFromTransactionsResult
+// [!endregion BuildUserOperationFromTransactionsResult]
 
-//#region UserOperationContext
+// [!region UserOperationContext]
 export type UserOperationContext = Record<string, any>;
-//#endregion UserOperationContext
+// [!endregion UserOperationContext]
 
-//#region GetContextParameter
+// [!region GetContextParameter]
 export type GetContextParameter<
   TContext extends UserOperationContext | undefined =
     | UserOperationContext
@@ -155,4 +155,4 @@ export type GetContextParameter<
       context?: TContext;
     }
   : { context: TContext };
-//#endregion GetContextParameter
+// [!endregion GetContextParameter]

packages/core/src/client/bundlerClient.ts

@@ -20,7 +20,7 @@ import {
   type BundlerRpcSchema,
 } from "./decorators/bundlerClient.js";
 
-//#region BundlerClient
+// [!region BundlerClient]
 export type BundlerClient<T extends Transport = Transport> = Client<
   T,
   Chain,
@@ -38,7 +38,7 @@ export const createBundlerClientFromExisting: <
 ): BundlerClient<T> => {
   return client.extend(bundlerActions);
 };
-//#endregion BundlerClient
+// [!endregion BundlerClient]
 
 /**
  * Creates a PublicClient with methods for calling Bundler RPC methods

packages/core/src/client/decorators/bundlerClient.ts

@@ -49,7 +49,7 @@ export type BundlerRpcSchema = [
   }
 ];
 
-//#region BundlerActions
+// [!region BundlerActions]
 export type BundlerActions = {
   /**
    * calls `eth_estimateUserOperationGas` and  returns the result
@@ -104,7 +104,7 @@ export type BundlerActions = {
    */
   getSupportedEntryPoints(): Promise<Address[]>;
 };
-//#endregion BundlerActions
+// [!endregion BundlerActions]
 
 export const bundlerActions: <
   TClient extends Client<

packages/core/src/client/schema.ts

@@ -18,7 +18,7 @@ export const createPublicErc4337ClientSchema = <
     );
   });
 
-// #region ConnectionConfigSchema
+// [!region ConnectionConfigSchema]
 export const ConnectionConfigSchema = z.union([
   z.object({
     rpcUrl: z.never().optional(),
@@ -41,7 +41,7 @@ export const ConnectionConfigSchema = z.union([
     jwt: z.string(),
   }),
 ]);
-// #endregion ConnectionConfigSchema
+// [!endregion ConnectionConfigSchema]
 
 export const UserOperationFeeOptionsFieldSchema =
   BigNumberishRangeSchema.merge(MultiplierSchema).partial();