docs: sign user op hash doc and fix navigation links in docs

alchemyplatform · Dec 1, 2023 · 1fc4495 · 1fc4495
1 parent ea6a9bf
commit 1fc4495
Show file tree

Hide file tree

Showing 13 changed files with 65 additions and 13 deletions.
diff --git a/site/.vitepress/config.ts b/site/.vitepress/config.ts
@@ -357,6 +357,10 @@ export default defineConfig({
                     text: "signTypedDataWith6492",
                     link: "/signTypedDataWith6492",
                   },
+                  {
+                    text: "signUserOperationHash",
+                    link: "/signUserOperationHash",
+                  },
                 ],
               },
               {
@@ -681,7 +685,7 @@ export default defineConfig({
               { text: "getAddress", link: "/getAddress" },
               { text: "signMessage", link: "/signMessage" },
               { text: "signTypedData", link: "/signTypedData" },
-              { text: "getAuthDetails", link: "/getDgetAuthDetailsetails" },
+              { text: "getAuthDetails", link: "/getAuthDetails" },
             ],
           },
           { text: "Contributing", link: "/contributing" },

diff --git a/site/packages/aa-accounts/contributing.md b/site/packages/aa-accounts/contributing.md
@@ -11,7 +11,7 @@ head:
     - property: og:description
       content: How to add your own Account Implementation to aa-accounts
 next:
-  text: aa-ethers
+  text: aa-signers
 ---
 
 # Contributing to `aa-accounts`

diff --git a/site/packages/aa-alchemy/middleware/withAlchemyGasManager.md b/site/packages/aa-alchemy/middleware/withAlchemyGasManager.md
@@ -10,8 +10,6 @@ head:
   - - meta
     - property: og:description
       content: Overview of the withAlchemyGasManager method in aa-alchemy
-next:
-  text: Utils
 ---
 
 # withAlchemyGasManager

diff --git a/site/packages/aa-alchemy/provider/withAlchemyEnhancedApis.md b/site/packages/aa-alchemy/provider/withAlchemyEnhancedApis.md
@@ -10,6 +10,8 @@ head:
   - - meta
     - property: og:description
       content: Overview of the withAlchemyEnhancedApis method on Alchemy Provider in aa-alchemy
+next:
+  text: Middleware
 ---
 
 # withAlchemyEnhancedApis

diff --git a/site/packages/aa-alchemy/provider/withAlchemyGasManager.md b/site/packages/aa-alchemy/provider/withAlchemyGasManager.md
@@ -10,8 +10,6 @@ head:
   - - meta
     - property: og:description
       content: Overview of the withAlchemyGasManager method on Alchemy Provider in aa-alchemy
-next:
-  text: Middleware
 ---
 
 # withAlchemyGasManager

diff --git a/site/packages/aa-alchemy/provider/withAlchemyUserOpSimulation.md b/site/packages/aa-alchemy/provider/withAlchemyUserOpSimulation.md
@@ -10,8 +10,6 @@ head:
   - - meta
     - property: og:description
       content: Overview of the withAlchemyUserOpSimulation method on Alchemy Provider in aa-alchemy
-next:
-  text: Middleware
 ---
 
 # withAlchemyUserOpSimulation

diff --git a/site/packages/aa-core/accounts/optional/signTypedDataWith6492.md b/site/packages/aa-core/accounts/optional/signTypedDataWith6492.md
@@ -10,8 +10,6 @@ head:
   - - meta
     - property: og:description
       content: Overview of the signTypedDataWith6492 method on BaseSmartContractAccount
-next:
-  text: Other Methods
 ---
 
 # signTypedDataWith6492

diff --git a/site/packages/aa-core/accounts/optional/signUserOperationHash.md b/site/packages/aa-core/accounts/optional/signUserOperationHash.md
@@ -0,0 +1,49 @@
+---
+outline: deep
+head:
+  - - meta
+    - property: og:title
+      content: signUserOperationHash
+  - - meta
+    - name: description
+      content: Overview of the signUserOperationHash method on BaseSmartContractAccount
+  - - meta
+    - property: og:description
+      content: Overview of the signUserOperationHash method on BaseSmartContractAccount
+next:
+  text: Other Methods
+---
+
+# signUserOperationHash
+
+If your account handles [ERC-1271 signatures](https://eips.ethereum.org/EIPS/eip-1271) of `personal_sign` differently than it does user operations, you can implement your additional way to sign the user operation.
+
+**Note**: This method is already implemented on `BaseSmartContractAccount` defaulting to using the [`signMessage`](/packages/aa-core/accounts/required/signMessage.md) method. So any class that extends and implements `BaseSmartContractAccount` may call this method.
+
+## Usage
+
+::: code-group
+
+```ts [example.ts]
+import { provider } from "./provider";
+// [!code focus:99]
+const signature = await provider.account.signUserOperationHash(
+  `<SOME_UO_HASH>`
+);
+```
+
+<<< @/snippets/provider.ts
+
+:::
+
+## Returns
+
+### `Promise<Hash>`
+
+The signature of the UserOperation
+
+## Parameters
+
+### `uoHash: Hash`
+
+The hash of the UserOperation to sign
diff --git a/site/packages/aa-core/provider/extend.md b/site/packages/aa-core/provider/extend.md
@@ -10,8 +10,7 @@ head:
   - - meta
     - property: og:description
       content: Overview of the extend method on ISmartAccountProvider
-next:
-  text: SmartContractAccount
+next: Types
 ---
 
 # extend

diff --git a/site/packages/aa-core/provider/types/userOperationOverrides.md b/site/packages/aa-core/provider/types/userOperationOverrides.md
@@ -10,6 +10,8 @@ head:
   - - meta
     - property: og:description
       content: Overview of the UserOperationOverrides type in aa-core types
+next:
+  text: SmartContractAccount
 ---
 
 # UserOperationOverrides

diff --git a/site/packages/aa-ethers/utils/convertEthersSignerToAccountSigner.md b/site/packages/aa-ethers/utils/convertEthersSignerToAccountSigner.md
@@ -10,6 +10,8 @@ head:
   - - meta
     - property: og:description
       content: Overview of the convertEthersSignerToAccountSigner method in aa-ethers
+next:
+  text: Glossary
 ---
 
 # Utils

diff --git a/site/packages/aa-signers/magic/getAuthDetails.md b/site/packages/aa-signers/magic/getAuthDetails.md
@@ -10,6 +10,8 @@ head:
   - - meta
     - property: og:description
       content: Overview of the getAuthDetails method on MagicSigner
+next:
+  text: Web3auth
 ---
 
 # getAuthDetails

diff --git a/site/packages/aa-signers/web3auth/introduction.md b/site/packages/aa-signers/web3auth/introduction.md
@@ -12,7 +12,7 @@ head:
       content: Overview of the Web3AuthSigner class in aa-signers
 ---
 
-# web3auth Signer
+# Web3auth Signer
 
 `Web3AuthSigner` is a signer implementation which extends `SmartAccountAuthenticator` to leverage the [web3auth web modal SDK](https://web3auth.io/docs/sdk/pnp/web/modal). It supports features such as authentication, message and typed data signing, and authentication details retrieval.