Merge branch 'alchemyplatform:main' into main

OMGWINNING · Feb 13, 2024 · a271a50 · a271a50
2 parents 9172698 + 340c5c8
commit a271a50
Show file tree

Hide file tree

Showing 32 changed files with 755 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-alpha.9](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.8...v3.0.0-alpha.9) (2024-02-13)
+
+### Features
+
+- **amoy:** add amoy from viem update ([#448](https://github.com/alchemyplatform/aa-sdk/issues/448)) ([adae84a](https://github.com/alchemyplatform/aa-sdk/commit/adae84add30536676725dbc8805f3436c8ad395e))
+
 # [3.0.0-alpha.8](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.7...v3.0.0-alpha.8) (2024-02-11)
 
 ### Features

diff --git a/lerna.json b/lerna.json
@@ -1,6 +1,6 @@
 {
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
-  "version": "3.0.0-alpha.8",
+  "version": "3.0.0-alpha.9",
   "npmClient": "yarn",
   "conventionalCommits": true,
   "conventionalPrerelease": true,

diff --git a/packages/accounts/CHANGELOG.md b/packages/accounts/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-alpha.9](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.8...v3.0.0-alpha.9) (2024-02-13)
+
+### Features
+
+- **amoy:** add amoy from viem update ([#448](https://github.com/alchemyplatform/aa-sdk/issues/448)) ([adae84a](https://github.com/alchemyplatform/aa-sdk/commit/adae84add30536676725dbc8805f3436c8ad395e))
+
 # [3.0.0-alpha.7](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.6...v3.0.0-alpha.7) (2024-02-10)
 
 **Note:** Version bump only for package @alchemy/aa-accounts

diff --git a/packages/accounts/package.json b/packages/accounts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@alchemy/aa-accounts",
-  "version": "3.0.0-alpha.7",
+  "version": "3.0.0-alpha.9",
   "description": "A collection of ERC-4337 compliant smart contract account interfaces",
   "author": "Alchemy",
   "license": "MIT",
@@ -74,7 +74,7 @@
   "homepage": "https://github.com/alchemyplatform/aa-sdk#readme",
   "gitHead": "ee46e8bb857de3b631044fa70714ea706d9e317d",
   "dependencies": {
-    "@alchemy/aa-core": "^3.0.0-alpha.5",
+    "@alchemy/aa-core": "^3.0.0-alpha.9",
     "viem": "^2.7.8"
   }
 }
diff --git a/packages/alchemy/CHANGELOG.md b/packages/alchemy/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-alpha.9](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.8...v3.0.0-alpha.9) (2024-02-13)
+
+### Features
+
+- **amoy:** add amoy from viem update ([#448](https://github.com/alchemyplatform/aa-sdk/issues/448)) ([adae84a](https://github.com/alchemyplatform/aa-sdk/commit/adae84add30536676725dbc8805f3436c8ad395e))
+
 # [3.0.0-alpha.8](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.7...v3.0.0-alpha.8) (2024-02-11)
 
 ### Features

diff --git a/packages/alchemy/package.json b/packages/alchemy/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@alchemy/aa-alchemy",
-  "version": "3.0.0-alpha.8",
+  "version": "3.0.0-alpha.9",
   "description": "adapters for @alchemy/aa-core for interacting with alchemy services",
   "author": "Alchemy",
   "license": "MIT",
@@ -46,7 +46,7 @@
     "vitest": "^0.31.0"
   },
   "dependencies": {
-    "@alchemy/aa-core": "^3.0.0-alpha.5",
+    "@alchemy/aa-core": "^3.0.0-alpha.9",
     "@turnkey/http": "^2.6.2",
     "@turnkey/iframe-stamper": "^1.0.0",
     "@turnkey/viem": "^0.4.8",

diff --git a/packages/alchemy/src/signer/client/index.ts b/packages/alchemy/src/signer/client/index.ts
@@ -7,7 +7,6 @@ import { IframeStamper } from "@turnkey/iframe-stamper";
 import { WebauthnStamper } from "@turnkey/webauthn-stamper";
 import { type Hex } from "viem";
 import { z } from "zod";
-import { SessionManagerParamsSchema } from "../session/manager.js";
 import { base64UrlEncode } from "../utils/base64UrlEncode.js";
 import { generateRandomBuffer } from "../utils/generateRandomBuffer.js";
 import type {
@@ -26,7 +25,6 @@ export const AlchemySignerClientParamsSchema = z.object({
     iframeElementId: z.string().default("turnkey-iframe"),
     iframeContainerId: z.string(),
   }),
-  sessionConfig: SessionManagerParamsSchema.optional(),
 });
 
 export type AlchemySignerClientParams = z.input<

diff --git a/packages/alchemy/src/version.ts b/packages/alchemy/src/version.ts
@@ -1,3 +1,3 @@
 // This file is autogenerated by inject-version.ts. Any changes will be
 // overwritten on commit!
-export const VERSION = "3.0.0-alpha.8";
+export const VERSION = "3.0.0-alpha.9";
diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-alpha.9](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.8...v3.0.0-alpha.9) (2024-02-13)
+
+### Features
+
+- **amoy:** add amoy from viem update ([#448](https://github.com/alchemyplatform/aa-sdk/issues/448)) ([adae84a](https://github.com/alchemyplatform/aa-sdk/commit/adae84add30536676725dbc8805f3436c8ad395e))
+
 # [3.0.0-alpha.5](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.4...v3.0.0-alpha.5) (2024-02-07)
 
 ### Bug Fixes

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@alchemy/aa-core",
   "license": "MIT",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.9",
   "description": "viem based SDK that enables interactions with ERC-4337 Smart Accounts. ABIs are based off the definitions generated in @account-abstraction/contracts",
   "author": "Alchemy",
   "type": "module",

diff --git a/packages/core/src/version.ts b/packages/core/src/version.ts
@@ -1,3 +1,3 @@
 // This file is autogenerated by inject-version.ts. Any changes will be
 // overwritten on commit!
-export const VERSION = "3.0.0-alpha.5";
+export const VERSION = "3.0.0-alpha.9";
diff --git a/packages/ethers/CHANGELOG.md b/packages/ethers/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-alpha.9](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.8...v3.0.0-alpha.9) (2024-02-13)
+
+### Features
+
+- **amoy:** add amoy from viem update ([#448](https://github.com/alchemyplatform/aa-sdk/issues/448)) ([adae84a](https://github.com/alchemyplatform/aa-sdk/commit/adae84add30536676725dbc8805f3436c8ad395e))
+
 # [3.0.0-alpha.5](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.4...v3.0.0-alpha.5) (2024-02-07)
 
 **Note:** Version bump only for package @alchemy/aa-ethers

diff --git a/packages/ethers/package.json b/packages/ethers/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@alchemy/aa-ethers",
   "license": "MIT",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.9",
   "description": "Ethers.js wrapper for @alchemy/aa-core",
   "author": "Alchemy",
   "type": "module",
@@ -49,7 +49,7 @@
     "vitest": "^0.31.0"
   },
   "dependencies": {
-    "@alchemy/aa-core": "^3.0.0-alpha.5",
+    "@alchemy/aa-core": "^3.0.0-alpha.9",
     "@ethersproject/abi": "^5.7.0",
     "@ethersproject/abstract-signer": "^5.7.0",
     "@ethersproject/bytes": "^5.7.0",

diff --git a/packages/signers/CHANGELOG.md b/packages/signers/CHANGELOG.md
@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-alpha.9](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.8...v3.0.0-alpha.9) (2024-02-13)
+
+### Features
+
+- **amoy:** add amoy from viem update ([#448](https://github.com/alchemyplatform/aa-sdk/issues/448)) ([adae84a](https://github.com/alchemyplatform/aa-sdk/commit/adae84add30536676725dbc8805f3436c8ad395e))
+
 # [3.0.0-alpha.5](https://github.com/alchemyplatform/aa-sdk/compare/v3.0.0-alpha.4...v3.0.0-alpha.5) (2024-02-07)
 
 **Note:** Version bump only for package @alchemy/aa-signers

diff --git a/packages/signers/package.json b/packages/signers/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@alchemy/aa-signers",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.9",
   "description": "A collection of signers used to create ERC-4337 smart accounts",
   "author": "Alchemy",
   "license": "MIT",
@@ -114,7 +114,7 @@
   "homepage": "https://github.com/alchemyplatform/aa-sdk#readme",
   "gitHead": "ee46e8bb857de3b631044fa70714ea706d9e317d",
   "dependencies": {
-    "@alchemy/aa-core": "^3.0.0-alpha.5",
+    "@alchemy/aa-core": "^3.0.0-alpha.9",
     "viem": "^2.7.8"
   },
   "optionalDependencies": {

diff --git a/site/.vitepress/sidebar/index.ts b/site/.vitepress/sidebar/index.ts
@@ -51,6 +51,7 @@ export const sidebar: DefaultTheme.Sidebar = [
     base: "/signers",
     items: [
       { text: "Introduction", link: "/choosing-a-signer" },
+      { text: "Alchemy Signer", link: "/alchemy-signer" },
       {
         text: "Signer guides",
         base: "/signers/guides",

diff --git a/site/.vitepress/sidebar/packages/aa-alchemy.ts b/site/.vitepress/sidebar/packages/aa-alchemy.ts
@@ -51,6 +51,54 @@ export const aaAlchemySidebar: DefaultTheme.SidebarItem = {
         },
       ],
     },
+    {
+      text: "Alchemy Signer",
+      base: "/packages/aa-alchemy/signer",
+      collapsed: true,
+      items: [
+        {
+          text: "Overview",
+          link: "/overview",
+        },
+        {
+          text: "authenticate",
+          link: "/authenticate",
+        },
+        {
+          text: "disconnect",
+          link: "/disconnect",
+        },
+        {
+          text: "getAuthDetails",
+          link: "/getAuthDetails",
+        },
+
+        {
+          text: "getAddress",
+          link: "/getAddress",
+        },
+        {
+          text: "signMessage",
+          link: "/signMessage",
+        },
+        {
+          text: "signTypedData",
+          link: "/signTypedData",
+        },
+        {
+          text: "getUser",
+          link: "/getUser",
+        },
+        {
+          text: "addPasskey",
+          link: "/addPasskey",
+        },
+        {
+          text: "exportWallet",
+          link: "/exportWallet",
+        },
+      ],
+    },
     {
       text: "Utils",
       collapsed: true,

diff --git a/site/packages/aa-alchemy/signer/addPasskey.md b/site/packages/aa-alchemy/signer/addPasskey.md
@@ -0,0 +1,49 @@
+---
+outline: deep
+head:
+  - - meta
+    - property: og:title
+      content: Alchemy Signer • addPasskey
+  - - meta
+    - name: description
+      content: Learn how to use the AlchemySigner.addPasskey method
+  - - meta
+    - property: og:description
+      content: Learn how to use the AlchemySigner.addPasskey method
+  - - meta
+    - name: twitter:title
+      content: Alchemy Signer • addPasskey
+  - - meta
+    - name: twitter:description
+      content: Learn how to use the AlchemySigner.addPasskey method
+---
+
+# addPasskey
+
+The `addPasskey` method is used to add a passkey as an auth method to an already logged in user.
+
+::: warning
+This method throws if there is no authenticated user.
+:::
+
+## Usage
+
+::: code-group
+
+```ts
+import { signer } from "./signer";
+
+await signer.addPasskey();
+```
+
+<<< @/snippets/signers/alchemy/signer.ts
+
+:::
+
+## Returns
+
+`Promise<string[]>` -- on success returns an array of credential ids
+
+## Parameters
+
+`params?: CredentialCreationOptions` -- overrides for the WebAuthn credential creation options. For more info on the `CredentialCreationOptions` interface, see [here](https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules_typedoc_node_modules_typescript_lib_lib_dom_d_.credentialcreationoptions.html).
diff --git a/site/packages/aa-alchemy/signer/authenticate.md b/site/packages/aa-alchemy/signer/authenticate.md
@@ -0,0 +1,71 @@
+---
+outline: deep
+head:
+  - - meta
+    - property: og:title
+      content: Alchemy Signer • authenticate
+  - - meta
+    - name: description
+      content: Learn how to use the AlchemySigner.authenticate method
+  - - meta
+    - property: og:description
+      content: Learn how to use the AlchemySigner.authenticate method
+  - - meta
+    - name: twitter:title
+      content: Alchemy Signer • authenticate
+  - - meta
+    - name: twitter:description
+      content: Learn how to use the AlchemySigner.authenticate method
+---
+
+# authenticate
+
+The `authenticate` method is used to authenticate a user with the Alchemy Signer.
+
+## Usage
+
+::: code-group
+
+```ts
+import { signer } from "./signer";
+
+const bundlePromise = new Promise(async (resolve) => {
+  // up to you define how you collect the OTP from the user
+  const otpFromUser = await getOtpFromUser();
+  resolve(otpFromUser);
+});
+
+const user = await signer.authenticate({
+  type: "email",
+  email: "[email protected]",
+  // the bundle is the OTP that the user will input from their email
+  bundle: bundlePromise,
+});
+```
+
+<<< @/snippets/signers/alchemy/signer.ts
+
+:::
+
+## Returns
+
+`Promise<User>` -- on success returns a `User` object representing the authenticated user.
+
+## Parameters
+
+`AuthParams` -- an object that contains the following properties:
+
+```ts
+export type AuthParams =
+  | { type: "email"; email: string; bundle: Promise<string> }
+  | {
+      type: "passkey";
+      createNew: false;
+    }
+  | {
+      type: "passkey";
+      createNew: true;
+      username: string;
+      creationOpts?: CredentialCreationOptionOverrides;
+    };
+```