Smart Backend Wallets

sdk/src/services/BackendWalletService.ts

@@ -665,6 +665,7 @@ export class BackendWalletService {
         requestBody: {
             message: string;
             isBytes?: boolean;
+            chainId?: number;
         },
         xIdempotencyKey?: string,
     ): CancelablePromise<{

src/db/wallets/createWalletDetails.ts

@@ -39,7 +39,8 @@ type CreateWalletDetailsParams = {
       awsKmsAccessKeyId: string;
       accountSignerAddress: Address;
 
-      accountFactoryAddress?: Address;
+      accountFactoryAddress: Address | undefined;
+      entrypointAddress: Address | undefined;
     }
   | {
       type: "smart:gcp-kms";
@@ -48,14 +49,16 @@ type CreateWalletDetailsParams = {
       gcpApplicationCredentialEmail: string;
       accountSignerAddress: Address;
 
-      accountFactoryAddress?: Address;
+      accountFactoryAddress: Address | undefined;
+      entrypointAddress: Address | undefined;
     }
   | {
       type: "smart:local";
       encryptedJson: string; // ENCRYPTION IS NOT HANDLED HERE, process privatekey with legacyLocalCrytpo before passing to this function
       accountSignerAddress: Address;
 
-      accountFactoryAddress?: Address;
+      accountFactoryAddress: Address | undefined;
+      entrypointAddress: Address | undefined;
     }
 );
 
@@ -125,6 +128,7 @@ export const createWalletDetails = async ({
 
         accountFactoryAddress:
           walletDetails.accountFactoryAddress?.toLowerCase(),
+        entrypointAddress: walletDetails.entrypointAddress?.toLowerCase(),
       },
     });
   }
@@ -143,6 +147,7 @@ export const createWalletDetails = async ({
 
         accountFactoryAddress:
           walletDetails.accountFactoryAddress?.toLowerCase(),
+        entrypointAddress: walletDetails.entrypointAddress?.toLowerCase(),
       },
     });
   }
@@ -156,11 +161,10 @@ export const createWalletDetails = async ({
 
         accountFactoryAddress:
           walletDetails.accountFactoryAddress?.toLowerCase(),
+        entrypointAddress: walletDetails.entrypointAddress?.toLowerCase(),
       },
     });
   }
 
-  // we will never reach here
-  // this helps typescript understand that this function will always return
   throw new Error("Unsupported wallet type");
 };

src/db/wallets/getWalletDetails.ts

@@ -1,3 +1,4 @@
+import { getAddress } from "thirdweb";
 import { z } from "zod";
 import type { PrismaTransaction } from "../../schema/prisma";
 import { getConfig } from "../../utils/cache/getConfig";
@@ -17,14 +18,31 @@ export class WalletDetailsError extends Error {
   }
 }
 
+/**
+ * Use the Zod schema to validate the EVM address.
+ * Uses getAddress from thirdweb/utils to validate the address.
+ */
+const zodEvmAddressSchema = z.string().transform((address, ctx) => {
+  try {
+    return getAddress(address);
+  } catch {
+    ctx.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "Invalid EVM address format",
+    });
+    return z.NEVER;
+  }
+});
+
 const baseWalletPartialSchema = z.object({
-  address: z.string(),
+  address: zodEvmAddressSchema,
   label: z.string().nullable(),
 });
 
 const smartWalletPartialSchema = z.object({
-  accountSignerAddress: z.string(),
-  accountFactoryAddress: z.string().nullable(),
+  accountSignerAddress: zodEvmAddressSchema,
+  accountFactoryAddress: zodEvmAddressSchema.nullable(),
+  entrypointAddress: zodEvmAddressSchema.nullable(),
 });
 
 const localWalletSchema = z
@@ -44,7 +62,6 @@ const smartLocalWalletSchema = localWalletSchema
 const awsKmsWalletSchema = z
   .object({
     type: z.literal("aws-kms"),
-    address: z.string(),
     awsKmsArn: z.string(),
     awsKmsSecretAccessKey: z.string(),
     awsKmsAccessKeyId: z.string(),
@@ -61,7 +78,6 @@ const smartAwsKmsWalletSchema = awsKmsWalletSchema
 const gcpKmsWalletSchema = z
   .object({
     type: z.literal("gcp-kms"),
-    address: z.string(),
     gcpKmsResourcePath: z.string(),
     gcpApplicationCredentialPrivateKey: z.string(),
     gcpApplicationCredentialEmail: z.string(),

src/prisma/migrations/20241022222921_add_entrypoint_address/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "wallet_details" ADD COLUMN     "entrypointAddress" TEXT;

src/prisma/schema.prisma

@@ -97,6 +97,7 @@ model WalletDetails {
   // Smart Backend Wallet
   accountSignerAddress               String? @map("accountSignerAddress") /// this, and either local, aws or gcp encryptedJson, are required for smart wallet
   accountFactoryAddress              String? @map("accountFactoryAddress") /// optional even for smart wallet, if not available default factory will be used
+  entrypointAddress                  String? @map("entrypointAddress") /// optional even for smart wallet, if not available SDK will use default entrypoint
 
   @@map("wallet_details")
 }

src/server/routes/backend-wallet/create.ts

@@ -1,7 +1,11 @@
 import { Type, type Static } from "@sinclair/typebox";
 import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
-import { DEFAULT_ACCOUNT_FACTORY_V0_6 } from "thirdweb/wallets/smart";
+import { getAddress } from "thirdweb";
+import {
+  DEFAULT_ACCOUNT_FACTORY_V0_7,
+  ENTRYPOINT_ADDRESS_v0_7,
+} from "thirdweb/wallets/smart";
 import { WalletType } from "../../../schema/wallet";
 import { getConfig } from "../../../utils/cache/getConfig";
 import { createCustomError } from "../../middleware/error";
@@ -15,7 +19,7 @@ import {
   CreateGcpKmsWalletError,
   createGcpKmsWalletDetails,
 } from "../../utils/wallets/createGcpKmsWallet";
-import { createAndStoreLocalWallet } from "../../utils/wallets/createLocalWallet";
+import { createLocalWalletDetails } from "../../utils/wallets/createLocalWallet";
 import {
   createSmartAwsWalletDetails,
   createSmartGcpWalletDetails,
@@ -78,7 +82,7 @@ export const createBackendWallet = async (fastify: FastifyInstance) => {
 
       switch (walletType) {
         case WalletType.local:
-          walletAddress = await createAndStoreLocalWallet({ label });
+          walletAddress = await createLocalWalletDetails({ label });
           break;
         case WalletType.awsKms:
           try {
@@ -112,10 +116,11 @@ export const createBackendWallet = async (fastify: FastifyInstance) => {
           try {
             const smartAwsWallet = await createSmartAwsWalletDetails({
               label,
-              accountFactoryAddress: DEFAULT_ACCOUNT_FACTORY_V0_6,
+              accountFactoryAddress: DEFAULT_ACCOUNT_FACTORY_V0_7,
+              entrypointAddress: ENTRYPOINT_ADDRESS_v0_7,
             });
 
-            walletAddress = smartAwsWallet.address;
+            walletAddress = getAddress(smartAwsWallet.address);
           } catch (e) {
             if (e instanceof CreateAwsKmsWalletError) {
               throw createCustomError(
@@ -131,9 +136,10 @@ export const createBackendWallet = async (fastify: FastifyInstance) => {
           try {
             const smartGcpWallet = await createSmartGcpWalletDetails({
               label,
-              accountFactoryAddress: DEFAULT_ACCOUNT_FACTORY_V0_6,
+              accountFactoryAddress: DEFAULT_ACCOUNT_FACTORY_V0_7,
+              entrypointAddress: ENTRYPOINT_ADDRESS_v0_7,
             });
-            walletAddress = smartGcpWallet.address;
+            walletAddress = getAddress(smartGcpWallet.address);
           } catch (e) {
             if (e instanceof CreateGcpKmsWalletError) {
               throw createCustomError(
@@ -149,9 +155,10 @@ export const createBackendWallet = async (fastify: FastifyInstance) => {
           {
             const smartLocalWallet = await createSmartLocalWalletDetails({
               label,
-              accountFactoryAddress: DEFAULT_ACCOUNT_FACTORY_V0_6,
+              accountFactoryAddress: DEFAULT_ACCOUNT_FACTORY_V0_7,
+              entrypointAddress: ENTRYPOINT_ADDRESS_v0_7,
             });
-            walletAddress = smartLocalWallet.address;
+            walletAddress = getAddress(smartLocalWallet.address);
           }
           break;
       }

src/server/routes/backend-wallet/signMessage.ts

@@ -2,6 +2,7 @@ import { Type, type Static } from "@sinclair/typebox";
 import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
 import { isHex, type Hex } from "thirdweb";
+import { arbitrumSepolia } from "thirdweb/chains";
 import { getAccount } from "../../../utils/account";
 import { getChecksumAddress } from "../../../utils/primitiveTypes";
 import { createCustomError } from "../../middleware/error";
@@ -11,6 +12,7 @@ import { walletHeaderSchema } from "../../schemas/wallet";
 const requestBodySchema = Type.Object({
   message: Type.String(),
   isBytes: Type.Optional(Type.Boolean()),
+  chainId: Type.Optional(Type.Number()),
 });
 
 const responseBodySchema = Type.Object({
@@ -37,7 +39,7 @@ export async function signMessageRoute(fastify: FastifyInstance) {
       },
     },
     handler: async (request, reply) => {
-      const { message, isBytes } = request.body;
+      const { message, isBytes, chainId } = request.body;
       const { "x-backend-wallet-address": walletAddress } =
         request.headers as Static<typeof walletHeaderSchema>;
 
@@ -50,7 +52,7 @@ export async function signMessageRoute(fastify: FastifyInstance) {
       }
 
       const account = await getAccount({
-        chainId: 1,
+        chainId: chainId ?? arbitrumSepolia.id,
         from: getChecksumAddress(walletAddress),
       });
       const messageToSign = isBytes ? { raw: message as Hex } : message;

src/server/utils/wallets/createAwsKmsWallet.ts

@@ -39,10 +39,12 @@ export const createAwsKmsWalletDetails = async ({
  * All optional parameters are overrides for the configuration in the database
  * If any required parameter cannot be resolved from either the configuration or the overrides, an error is thrown.
  */
-export const createAwsKmsKey = async (params: Partial<AwsKmsWalletParams>) => {
-  let kmsWalletParams: AwsKmsWalletParams;
+export const createAwsKmsKey = async (
+  partialParams: Partial<AwsKmsWalletParams>,
+) => {
+  let params: AwsKmsWalletParams;
   try {
-    kmsWalletParams = await fetchAwsKmsWalletParams(params);
+    params = await fetchAwsKmsWalletParams(partialParams);
   } catch (e) {
     if (e instanceof FetchAwsKmsWalletParamsError) {
       throw new CreateAwsKmsWalletError(e.message);
@@ -51,10 +53,10 @@ export const createAwsKmsKey = async (params: Partial<AwsKmsWalletParams>) => {
   }
 
   const client = new KMSClient({
-    region: kmsWalletParams.awsRegion,
+    region: params.awsRegion,
     credentials: {
-      accessKeyId: kmsWalletParams.awsAccessKeyId,
-      secretAccessKey: kmsWalletParams.awsSecretAccessKey,
+      accessKeyId: params.awsAccessKeyId,
+      secretAccessKey: params.awsSecretAccessKey,
     },
   });
 
@@ -75,6 +77,6 @@ export const createAwsKmsKey = async (params: Partial<AwsKmsWalletParams>) => {
 
   return {
     awsKmsArn,
-    params: kmsWalletParams,
+    params: params,
   };
 };

src/server/utils/wallets/createLocalWallet.ts

@@ -13,7 +13,7 @@ interface CreateLocalWallet {
  * Create a local wallet with a random private key
  * Does not store the wallet in the database
  */
-export const createLocalWallet = async () => {
+export const createRandomLocalWallet = async () => {
   const pk = generatePrivateKey();
   const account = privateKeyToAccount({
     client: thirdwebClient,
@@ -44,10 +44,10 @@ export const createLocalWallet = async () => {
 /**
  * Creates a local wallet and stores it in the database
  */
-export const createAndStoreLocalWallet = async ({
+export const createLocalWalletDetails = async ({
   label,
 }: CreateLocalWallet): Promise<string> => {
-  const { account, encryptedJson } = await createLocalWallet();
+  const { account, encryptedJson } = await createRandomLocalWallet();
 
   await createWalletDetails({
     type: "local",