feat: merge in all of the staged changes to the aa-sdk

.github/workflows/deploy-site.yml

@@ -0,0 +1,71 @@
+name: Deploy VitePress site to Pages
+on:
+  workflow_dispatch:
+    inputs:
+      no_base_path:
+        required: false
+        default: false
+        type: boolean
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    name: Build
+    env:
+      NO_BASE_PATH: ${{ inputs.no_base_path }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18.10"
+          cache: yarn
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Build with VitePress
+        working-directory: site
+        run: |
+          yarn build
+          touch .vitepress/dist/.nojekyll
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: site/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+        env:
+          NO_BASE_PATH: ${{ inputs.no_base_path }}

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

@@ -10,9 +10,9 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: "16.20"
+          node-version: "18.10"
           cache: "yarn"
 
       - name: Install dependencies
@@ -28,9 +28,9 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: "16.20"
+          node-version: "18.10"
           cache: "yarn"
 
       - name: Install dependencies

.github/workflows/publish-package.yml

@@ -15,31 +15,33 @@ on:
         default: false
         type: boolean
 
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
 # If we ever migrate this to not be manual, we HAVE to check that the commit
 # it is running against DOES NOT contain [skip-ci] in the commit message
 jobs:
-  build_test_and_deploy:
-    name: Build, Test, and Deploy
+  build_and_test:
+    name: Build and Test
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
         with:
           token: ${{ secrets.ALCHEMY_BOT_PAT }}
 
-      - name: Set Github User Details
-        run: |
-          git config --global user.name "Alchemy Bot"
-          git config --global user.email "alchemy-bot@alchemy.com"
-
-      - name: Set NPM Permissions
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
-
       - name: Set Node.js 16.x
         uses: actions/setup-node@v3
         with:
-          node-version: "16.20"
+          node-version: "18.10"
           cache: "yarn"
 
       - name: Install dependencies
@@ -54,9 +56,42 @@ jobs:
           API_KEY: ${{ secrets.API_KEY }}
           OWNER_MNEMONIC: ${{ secrets.OWNER_MNEMONIC }}
           PAYMASTER_POLICY_ID: ${{ secrets.PAYMASTER_POLICY_ID }}
+          UNDEPLOYED_OWNER_MNEMONIC: ${{ secrets.UNDEPLOYED_OWNER_MNEMONIC }}
+          LIGHT_ACCOUNT_OWNER_MNEMONIC: ${{ secrets.LIGHT_ACCOUNT_OWNER_MNEMONIC }}
         run: yarn test:e2e
 
+  deploy:
+    name: Deploy
+    needs: build_and_test
+    runs-on: ubuntu-latest
+    if: inputs.publish
+    steps:
+      - name: Set Github User Details
+        run: |
+          git config --global user.name "Alchemy Bot"
+          git config --global user.email "alchemy-bot@alchemy.com"
+
+      - name: Set NPM Permissions
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
+
       # Lerna publish will, compute the new version, update files, run precommit hooks, tag, publish, and push change log
       - name: Publish using Lerna
-        if: inputs.publish
         run: yarn lerna publish --no-private --yes --no-verify-access
+
+  publish_site:
+    name: Publish Docs Site
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: deploy
+    runs-on: ubuntu-latest
+    if: inputs.publish
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
+        env:
+          # TODO(moldy): just remove this altogether once we're live
+          NO_BASE_PATH: true

.gitignore

@@ -23,4 +23,7 @@ lerna-debug.log
 .tool-versions
 
 # example ignores
-examples/contracts/**/out
+examples/contracts/**/out
+
+docs/.vitepress/dist
+docs/.vitepress/cache

CODEOWNERS

@@ -1 +1 @@
-*   @moldy530 @rthomare @dancoombs @mokok123 @avasisht23
+*   @moldy530 @rthomare @dancoombs @mokok123 @avasisht23 @denniswon

README.md

@@ -2,7 +2,7 @@
 
 ⚠️ This repo is actively being developed and certain features might not be fully implemented yet or are subject to change ⚠️
 
-Alchemy's Account Abstraction Kit is an SDK that enables easy interactions with ERC-4337 compliant smart accounts. It supports bringing your own Account Contracts or using any of the currently available accounts. The SDK is built on top of `viem` to enable a lighter-weight bundle and is published with ESM default exports though also supports CJS.
+Alchemy's Account Abstraction Kit is an SDK that enables easy interactions with [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) compliant smart accounts. It supports bringing your own Account Contracts or using any of the currently available accounts. The SDK is built on top of `viem` to enable a lighter-weight bundle and is published with ESM default exports though also supports CJS.
 
 ## Getting Started
 
@@ -73,13 +73,13 @@ const owner: SmartAccountSigner =
   LocalAccountSigner.mnemonicToAccountSigner(MNEMONIC);
 
 // 2. initialize the provider and connect it to the account
-const provider = new SmartAccountProvider(
+const provider = new SmartAccountProvider({
   // the demo key below is public and rate-limited, it's better to create a new one
   // you can get started with a free account @ https://www.alchemy.com/
-  "https://polygon-mumbai.g.alchemy.com/v2/demo", // rpcUrl
-  "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789", // entryPointAddress
-  polygonMumbai // chain
-).connect(
+  rpcProvider: "https://polygon-mumbai.g.alchemy.com/v2/demo",
+  entryPointAddress: "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789",
+  chain: polygonMumbai,
+}).connect(
   (rpcClient) =>
     new SimpleSmartContractAccount({
       entryPointAddress: "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789",
@@ -139,7 +139,7 @@ let provider = new AlchemyProvider({
 );
 
 // [OPTIONAL] Use Alchemy Gas Manager
-provider = provider.withAlchemyGasManager({
+provider.withAlchemyGasManager({
   policyId: PAYMASTER_POLICY_ID,
   entryPoint: ENTRYPOINT_ADDRESS,
 });
@@ -208,16 +208,16 @@ const { hash } = await signer.sendUserOperation({
 
 The primary interfaces are the `SmartAccountProvider` and `BaseSmartContractAccount`.
 
-The `SmartAccountProvider` is an ERC-1193 compliant Provider that wraps JSON RPC methods and some Wallet Methods (signing, sendTransaction, etc). It also provides two utility methods for sending UserOperations:
+The `SmartAccountProvider` is an [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compliant Provider that wraps JSON RPC methods and some Wallet Methods (signing, sendTransaction, etc). It also provides two utility methods for sending UserOperations:
 
 1. `sendUserOperation` -- this takes in `target`, `callData`, and an optional `value` which then constructs a UserOperation (UO), sends it, and returns the `hash` of the UO. It handles estimating gas, fetching fee data, (optionally) requesting paymasterAndData, and lastly signing. This is done via a middleware stack that runs in a specific order. The middleware order is `getDummyPaymasterData` => `estimateGas` => `getFeeData` => `getPaymasterAndData`. The paymaster fields are set to `0x` by default. They can be changed using `provider.withPaymasterMiddleware`.
-2. `sendTransaction` -- this takes in a traditional Transaction Request object which then gets converted into a UO. Currently, the only data being used from the Transaction Request object is `from`, `to`, `data` and `value`. Support for other fields is coming soon.
+2. `sendTransaction` -- this takes in a traditional Transaction Request object which then gets converted into a UO. Note that `to` field of transaction is required, and among other fields of transaction, only `data`, `value`, `maxFeePerGas`, `maxPriorityFeePerGas` fields are considered if given. Support for other fields is coming soon.
 
 If you want to add support for your own `SmartAccounts` then you will need to provide an implementation of `BaseSmartContractAccount`. You can see an example of this in [SimpleSmartContractAccount](packages/core/src/account/simple.ts). You will need to implement 4 methods:
 
 1. `getDummySignature` -- this method should return a signature that will not `revert` during validation. It does not have to pass validation, just not cause the contract to revert. This is required for gas estimation so that the gas estimate are accurate.
 2. `encodeExecute` -- this method should return the abi encoded function data for a call to your contract's `execute` method
-3. `signMessage` -- this should return an ERC-191 compliant message and is used to sign UO Hashes
+3. `signMessage` -- this should return an [EIP-191](https://eips.ethereum.org/EIPS/eip-191) compliant message and is used to sign UO Hashes
 4. `getAccountInitCode` -- this should return the init code that will be used to create an account if one does not exist. Usually this is the concatenation of the account's factory address and the abi encoded function data of the account factory's `createAccount` method.
 
 ### Paymaster Middleware

examples/aa-simple-dapp/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

examples/alchemy-daapp/README.md

@@ -32,16 +32,16 @@ export const alchemyApiKey = "<your-api-key>";
 export const serverConfigs: Record<number, ServerConfiguration> = {
   [polygonMumbai.id]: {
     nftContractAddress: "<your-nft-contract-address>",
-    simpleAccountFactoryAddress: "<your-simple-account-factory-address>",
+    lightAccountFactoryAddress: "<your-light-account-factory-address>",
     gasManagerPolicyId: "<your-gas-manager-policy-id>",
     chain: polygonMumbai,
   },
   // Repeat for other chains as needed
 };
 ```
-### **🗒️ Notes:** for `nftContractAddress` and `simpleAccountFactoryAddress` 
+### **🗒️ Notes:** for `nftContractAddress` and `lightAccountFactoryAddress` 
 - There are already contract addresses deployed for them across [various chains here](https://github.com/alchemyplatform/aa-sdk/blob/main/examples/alchemy-daapp/src/configs/clientConfigs.ts).
-- We used eth-infinitism's [simpleAccountFactory here](https://github.com/eth-infinitism/account-abstraction/blob/main/contracts/samples/SimpleAccountFactory.sol).
+- We used Alchemy's [lightAccountFactory here]. todo(ajay): post the repo when live
 - Finally, the contracts sibling package has the copy of the [NFT contract](https://github.com/alchemyplatform/aa-sdk/tree/main/examples/contracts/DAAppNFT/src) along instructions on [how to deploy it](https://github.com/alchemyplatform/aa-sdk/blob/main/examples/contracts/README.md).
 
 4. Update the serverConfigs.ts file with your alchemy API keys:
@@ -60,7 +60,7 @@ yarn dev
 ## How This Works
 The [`onboarding-controller.ts`](https://github.com/alchemyplatform/aa-sdk/blob/master/examples/alchemy-daapp/src/surfaces/onboarding/OnboardingController.ts) file contains the onboarding controller, which handles the onboarding process for new users. The controller uses the Alchemy SDK to create a new account and mint an NFT.
 
-In the [`clientConfigs.ts`](https://github.com/alchemyplatform/aa-sdk/blob/main/examples/alchemy-daapp/src/configs/clientConfigs.ts) file, you will find the configuration for the DAApp, including the nft contract address, simple account factory address, gas manager policy id, rpc url, and chain. You'll also find an example NFT contract in [`examples/contracts/DAAppNFT`](https://github.com/alchemyplatform/aa-sdk/tree/main/examples/contracts/DAAppNFT)
+In the [`clientConfigs.ts`](https://github.com/alchemyplatform/aa-sdk/blob/main/examples/alchemy-daapp/src/configs/clientConfigs.ts) file, you will find the configuration for the DAApp, including the nft contract address, light account factory address, gas manager policy id, rpc url, and chain. You'll also find an example NFT contract in [`examples/contracts/DAAppNFT`](https://github.com/alchemyplatform/aa-sdk/tree/main/examples/contracts/DAAppNFT)
 
 You can replace the default values with your contract addresses and policy ids and add or remove chains as needed.
 

examples/alchemy-daapp/package.json

@@ -9,6 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
+    "@alchemy/aa-accounts": "latest",
     "@alchemy/aa-alchemy": "latest",
     "@alchemy/aa-core": "latest",
     "@chakra-ui/react": "^2.6.1",
@@ -24,7 +25,7 @@
     "next": "^13.4.1",
     "react": "18.2.0",
     "react-dom": "18.2.0",
-    "viem": "^1.10.9",
+    "viem": "^1.16.2",
     "wagmi": "^1.3.11",
     "zod": "^3.21.4"
   },

examples/alchemy-daapp/src/clients/simpleAccountSigner.ts → examples/alchemy-daapp/src/clients/lightAccountSigner.ts

@@ -3,7 +3,7 @@ import { useCallback } from "react";
 import { toHex } from "viem";
 import { useWalletClient } from "wagmi";
 
-type SimpleSmartAccountSignerResult =
+type LightSmartAccountSignerResult =
   | {
       isLoading: false;
       owner: SmartAccountSigner;
@@ -13,8 +13,9 @@ type SimpleSmartAccountSignerResult =
       owner: undefined;
     };
 
-export function useSimpleAccountSigner(): SimpleSmartAccountSignerResult {
+export function useLightAccountSigner(): LightSmartAccountSignerResult {
   const walletClientQuery = useWalletClient();
+  const signerType = "json-rpc"
   // We need this to by pass a viem bug https://github.com/wagmi-dev/viem/issues/606
   const signMessage = useCallback(
     (data: string | Uint8Array) =>
@@ -48,5 +49,5 @@ export function useSimpleAccountSigner(): SimpleSmartAccountSignerResult {
       owner: undefined,
     };
   }
-  return { isLoading: false, owner: { signMessage, signTypedData, getAddress } };
+  return { isLoading: false, owner: { signerType, signMessage, signTypedData, getAddress } };
 }