chore: update signMessage route to v5 SDK (#720)

* fix: Return 400 on invalid wallet

* chore: Migrate signMessage to v5 SDK

* undo wallet

* add e2e test

* sign raw message, update tests

Author: arcoraven

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

@@ -1,8 +1,10 @@
-import { Static, Type } from "@sinclair/typebox";
-import { ethers } from "ethers";
-import { FastifyInstance } from "fastify";
+import { Type, type Static } from "@sinclair/typebox";
+import type { FastifyInstance } from "fastify";
 import { StatusCodes } from "http-status-codes";
-import { getWallet } from "../../../utils/cache/getWallet";
+import { isHex, type Hex } from "thirdweb";
+import { getAccount } from "../../../utils/account";
+import { getChecksumAddress } from "../../../utils/primitiveTypes";
+import { createCustomError } from "../../middleware/error";
 import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
 import { walletHeaderSchema } from "../../schemas/wallet";
 
@@ -15,7 +17,7 @@ const responseBodySchema = Type.Object({
   result: Type.String(),
 });
 
-export async function signMessage(fastify: FastifyInstance) {
+export async function signMessageRoute(fastify: FastifyInstance) {
   fastify.route<{
     Body: Static<typeof requestBodySchema>;
     Reply: Static<typeof responseBodySchema>;
@@ -39,22 +41,23 @@ export async function signMessage(fastify: FastifyInstance) {
       const { "x-backend-wallet-address": walletAddress } =
         request.headers as Static<typeof walletHeaderSchema>;
 
-      const wallet = await getWallet({
-        chainId: 1,
-        walletAddress,
-      });
-
-      const signer = await wallet.getSigner();
-
-      let signedMessage;
-      if (isBytes) {
-        signedMessage = await signer.signMessage(
-          ethers.utils.arrayify(message),
+      if (isBytes && !isHex(message)) {
+        throw createCustomError(
+          '"isBytes" is true but message is not hex.',
+          StatusCodes.BAD_REQUEST,
+          "INVALID_MESSAGE",
         );
-      } else {
-        signedMessage = await signer.signMessage(message);
       }
 
+      const account = await getAccount({
+        chainId: 1,
+        from: getChecksumAddress(walletAddress),
+      });
+      const messageToSign = isBytes ? { raw: message as Hex } : message;
+      const signedMessage = await account.signMessage({
+        message: messageToSign,
+      });
+
       reply.status(StatusCodes.OK).send({
         result: signedMessage,
       });

src/server/routes/index.ts

@@ -22,7 +22,7 @@ import { removeBackendWallet } from "./backend-wallet/remove";
 import { resetBackendWalletNonces } from "./backend-wallet/resetNonces";
 import { sendTransaction } from "./backend-wallet/sendTransaction";
 import { sendTransactionBatch } from "./backend-wallet/sendTransactionBatch";
-import { signMessage } from "./backend-wallet/signMessage";
+import { signMessageRoute } from "./backend-wallet/signMessage";
 import { signTransaction } from "./backend-wallet/signTransaction";
 import { signTypedData } from "./backend-wallet/signTypedData";
 import { simulateTransaction } from "./backend-wallet/simulateTransaction";
@@ -123,7 +123,7 @@ export const withRoutes = async (fastify: FastifyInstance) => {
   await fastify.register(sendTransaction);
   await fastify.register(sendTransactionBatch);
   await fastify.register(signTransaction);
-  await fastify.register(signMessage);
+  await fastify.register(signMessageRoute);
   await fastify.register(signTypedData);
   await fastify.register(getTransactionsForBackendWallet);
   await fastify.register(getTransactionsForBackendWalletByNonce);

test/e2e/bun.lockb

@@ -11,6 +11,6 @@
   "type": "module",
   "dependencies": {
     "prool": "^0.0.16",
-    "thirdweb": "^5.43.2"
+    "thirdweb": "^5.61.5"
   }
 }

test/e2e/package.json

@@ -0,0 +1,37 @@
+import { describe, expect, test } from "bun:test";
+import { signMessage, toHex } from "thirdweb/utils";
+import { ANVIL_PKEY_A } from "../../utils/wallets";
+import { setup } from "../setup";
+
+describe("signMessageRoute", () => {
+  test("Sign a message (string)", async () => {
+    const { engine, backendWallet } = await setup();
+
+    const res = await engine.backendWallet.signMessage(backendWallet, {
+      message: "hello world",
+    });
+
+    const expected = signMessage({
+      message: "hello world",
+      privateKey: ANVIL_PKEY_A,
+    });
+
+    expect(res.result).toEqual(expected);
+  });
+
+  test("Sign a message (bytes)", async () => {
+    const { engine, backendWallet } = await setup();
+
+    const res = await engine.backendWallet.signMessage(backendWallet, {
+      message: toHex("hello world"),
+      isBytes: true,
+    });
+
+    const expected = signMessage({
+      message: "hello world",
+      privateKey: ANVIL_PKEY_A,
+    });
+
+    expect(res.result).toEqual(expected);
+  });
+});