Change sign rewards message payload (#554)

Changes the SignRewardsMessage request payload from
```ts
{
   account: {
       address: ""
   },
   message: ""
}
```
to 
```ts
{
   accountId: "",
   message: ""
}
```

This allows to read the account from state via
`this.#accountsService.findById(accountId);` instead of
`this.#accountsService.findByAddress(address);`, to benefit from more
efficient lookup.

Also adds a button in test dapp to test the endpoint:
<img width="255" height="165" alt="image"
src="https://github.com/user-attachments/assets/ff5313f8-b759-498f-b1b0-47937fdcf2d1"
/>


<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Change signRewardsMessage to use accountId instead of address and add
a test dapp UI/handler to invoke it.
> 
> - **Snap**:
> - **API change**: `signRewardsMessage` now accepts `accountId` (UUID)
instead of `account.address`; OpenRPC schema and examples updated.
> - **Handler**: use `accountsService.findById(accountId)` and validate
rewards message address against `account.address` before `signMessage`.
> - **Validation**: update request structs to `accountId`; keep
`RewardsMessage` parsing/validation.
> - **RPC wiring**: add `TestDappRpcRequestMethod.SignRewardsMessage`
route that forwards to `ClientRequestMethod.SignRewardsMessage`.
> - **Permissions**: allow `TestDappRpcRequestMethod.SignRewardsMessage`
for dev dapp origins.
> - **Tests**: update unit tests to use `accountId` and `findById`
assertions.
> - **Site**:
> - Add `ClientRequest` component with "Sign Rewards Message" button;
lists accounts via keyring, invokes `signRewardsMessage`, and shows
success toast.
>   - Register `ClientRequest` in `Handlers`.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
3b21090. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Author: xavier-brochard

packages/site/src/components/Handlers/ClientRequest.tsx

@@ -0,0 +1,63 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { Button, Card, Flex } from '@chakra-ui/react';
+import type { KeyringAccount } from '@metamask/keyring-api';
+import { KeyringRpcMethod } from '@metamask/keyring-api';
+
+import { TestDappRpcRequestMethod } from '../../../../snap/src/core/handlers/onRpcRequest/types';
+import { useInvokeKeyring, useInvokeSnap } from '../../hooks';
+import { useShowToasterForResponse } from '../../hooks/useToasterForResponse';
+
+export const ClientRequest = () => {
+  const invokeSnap = useInvokeSnap();
+  const { showToasterForResponse } = useShowToasterForResponse();
+  const invokeKeyring = useInvokeKeyring();
+
+  const showSuccessToast = (title: string) =>
+    showToasterForResponse(
+      { result: 'ok' },
+      {
+        title,
+      },
+    );
+
+  const signRewardsMessage = async () => {
+    const accountsToSet = (await invokeKeyring({
+      method: KeyringRpcMethod.ListAccounts,
+    })) as KeyringAccount[];
+    const account = accountsToSet[0];
+    if (!account) {
+      return;
+    }
+    const { id: accountId, address } = account;
+
+    const timestamp = Math.floor(Date.now() / 1000);
+
+    const response = await invokeSnap({
+      method: TestDappRpcRequestMethod.SignRewardsMessage,
+      params: {
+        accountId,
+        message: btoa(`rewards,${address},${timestamp}`),
+      },
+    });
+
+    showSuccessToast(
+      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+      `Successfully signed the rewards message! Signature: ${(response as any).signature}`,
+    );
+  };
+
+  return (
+    <Card.Root>
+      <Card.Header>
+        <Card.Title>ClientRequest</Card.Title>
+      </Card.Header>
+      <Card.Body>
+        <Flex>
+          <Button variant="outline" onClick={signRewardsMessage}>
+            Sign Rewards Message
+          </Button>
+        </Flex>
+      </Card.Body>
+    </Card.Root>
+  );
+};

packages/site/src/components/Handlers/Handlers.tsx

@@ -1,6 +1,7 @@
 import { Text as ChakraText, Flex, Stack } from '@chakra-ui/react';
 
 import { Accounts } from './Accounts';
+import { ClientRequest } from './ClientRequest';
 import { Lifecycle } from './Lifecycle';
 import { OnProtocolRequest } from './OnProtocolRequest';
 import { WebSockets } from './WebSockets';
@@ -15,6 +16,7 @@ export const Handlers = () => (
       <WebSockets />
       <Lifecycle />
       <Accounts />
+      <ClientRequest />
     </Stack>
   </Flex>
 );

packages/snap/openrpc.json

@@ -695,11 +695,11 @@
       "paramStructure": "by-name",
       "params": [
         {
-          "name": "account",
-          "summary": "The account to use for signing the transaction",
+          "name": "accountId",
+          "summary": "The UUID of the account to use for signing the message",
           "required": true,
           "schema": {
-            "$ref": "#/components/schemas/WalletAccount"
+            "$ref": "#/components/schemas/Uuid"
           }
         },
         {
@@ -741,10 +741,8 @@
           "description": "Example of signing a rewards message for a Solana address",
           "params": [
             {
-              "name": "account",
-              "value": {
-                "address": "BLw3RweJmfbTapJRgnPRvd962YDjFYAnVGd1p5hmZ5tP"
-              }
+              "name": "accountId",
+              "value": "c747acb9-1b2b-4352-b9da-3d658fcc3cc7"
             },
             {
               "name": "message",

packages/snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-solana-wallet.git"
   },
   "source": {
-    "shasum": "TTK9syaPsZFKQk016Wz1yNlpXLFYJ/LFiukpGHiXyOE=",
+    "shasum": "k8LmcKs1C8v0XMNdO+rMMcd9PULlPonVHBprzUmNipU=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/snap/src/core/handlers/onClientRequest/ClientRequestHandler.test.ts

@@ -534,7 +534,7 @@ describe('ClientRequestHandler', () => {
     const utf8ToBase64 = (utf8: string): string =>
       pipe(utf8, getUtf8Codec().encode, getBase64Codec().decode);
 
-    const { address } = MOCK_SOLANA_KEYRING_ACCOUNT_0;
+    const { id: accountId, address } = MOCK_SOLANA_KEYRING_ACCOUNT_0;
     const mockTimestamp = 1736660000;
 
     // Helper function to create a request with a utf8 message. Defaults to a valid rewards message.
@@ -543,9 +543,7 @@ describe('ClientRequestHandler', () => {
       id: 1,
       method: ClientRequestMethod.SignRewardsMessage,
       params: {
-        account: {
-          address,
-        },
+        accountId,
         message: utf8ToBase64(
           utf8Message ?? `rewards,${address},${mockTimestamp}`,
         ),
@@ -570,7 +568,7 @@ describe('ClientRequestHandler', () => {
         signatureType: 'ed25519' as const,
       };
       jest
-        .spyOn(mockAccountsService, 'findByAddress')
+        .spyOn(mockAccountsService, 'findById')
         .mockResolvedValue(MOCK_SOLANA_KEYRING_ACCOUNT_0);
       jest.spyOn(mockWalletService, 'signMessage').mockResolvedValue(response);
 
@@ -595,7 +593,7 @@ describe('ClientRequestHandler', () => {
 
     it('throws an error if account is not found', async () => {
       const invalidAccountRequest = createRequest();
-      mockAccountsService.findByAddress.mockResolvedValue(null);
+      mockAccountsService.findById.mockResolvedValue(null);
 
       await expect(handler.handle(invalidAccountRequest)).rejects.toThrow(
         'Account not found',
@@ -604,7 +602,7 @@ describe('ClientRequestHandler', () => {
 
     it('throws an error if address in message does not match signing account', async () => {
       const signingAccount = MOCK_SOLANA_KEYRING_ACCOUNT_0;
-      mockAccountsService.findByAddress.mockResolvedValue(signingAccount);
+      mockAccountsService.findById.mockResolvedValue(signingAccount);
 
       // Use a valid Solana address format but different from the signing account
       const differentAddress = MOCK_SOLANA_KEYRING_ACCOUNT_1.address;

packages/snap/src/core/handlers/onClientRequest/ClientRequestHandler.ts

@@ -297,24 +297,21 @@ export class ClientRequestHandler {
     assert(request, SignRewardsMessageRequestStruct);
 
     const {
-      params: {
-        account: { address },
-        message,
-      },
+      params: { accountId, message },
     } = request;
 
-    const account = await this.#accountsService.findByAddress(address);
+    const account = await this.#accountsService.findById(accountId);
     if (!account) {
-      throw new InvalidParamsError(`Account not found: ${address}`) as Error;
+      throw new InvalidParamsError(`Account not found: ${accountId}`) as Error;
     }
 
     // Parse the rewards message to extract the address
     const { address: messageAddress } = parseRewardsMessage(message);
 
     // Validate that the address in the message matches the signing account
-    if (messageAddress !== address) {
+    if (messageAddress !== account.address) {
       throw new InvalidParamsError(
-        `Address in rewards message (${messageAddress}) does not match signing account address (${address})`,
+        `Address in rewards message (${messageAddress}) does not match signing account address (${account.address})`,
       ) as Error;
     }
 

packages/snap/src/core/handlers/onClientRequest/validation.ts

@@ -208,9 +208,7 @@ export const RewardsMessageStruct = refine(
 );
 
 export const SignRewardsMessageRequestParamsStruct = object({
-  account: object({
-    address: SolanaAddressStruct,
-  }),
+  accountId: UuidStruct,
   message: RewardsMessageStruct,
 });
 

packages/snap/src/core/handlers/onRpcRequest/index.ts

@@ -8,6 +8,7 @@ import {
   eventEmitter,
   keyring,
 } from '../../../snapContext';
+import { ClientRequestMethod } from '../onClientRequest';
 import { getFeeForTransaction } from './getFeeForTransaction';
 import { RpcRequestMethod, TestDappRpcRequestMethod } from './types';
 
@@ -57,4 +58,14 @@ export const handlers: Record<RpcRequestMethod, OnRpcRequestHandler> = {
     await clientRequestHandler.handle(request);
     return null;
   },
+  [TestDappRpcRequestMethod.SignRewardsMessage as any]: async ({
+    request,
+  }: {
+    request: JsonRpcRequest;
+  }) => {
+    return clientRequestHandler.handle({
+      ...request,
+      method: ClientRequestMethod.SignRewardsMessage,
+    });
+  },
 };

packages/snap/src/core/handlers/onRpcRequest/types.ts

@@ -16,4 +16,5 @@ export enum TestDappRpcRequestMethod {
   SynchronizeAccounts = 'synchronizeAccounts',
   SetAccountSelected = 'setAccountSelected',
   ConfirmSend = 'confirmSend',
+  SignRewardsMessage = 'signRewardsMessage',
 }

packages/snap/src/permissions.ts

@@ -46,6 +46,7 @@ const dappPermissions = isDev
       TestDappRpcRequestMethod.SynchronizeAccounts,
       TestDappRpcRequestMethod.SetAccountSelected,
       TestDappRpcRequestMethod.ConfirmSend,
+      TestDappRpcRequestMethod.SignRewardsMessage,
     ])
   : new Set([]);