refactor: clean arch

Author: xavier-brochard

packages/snap/openrpc.json

@@ -1,7 +1,7 @@
 {
-  "openrpc": "1.0.0",
+  "openrpc": "1.2.4",
   "info": {
-    "title": "MetaMask Solana Wallet Snap JSON-RPC API",
+    "title": "MetaMask Solana Wallet Snap",
     "description": "JSON-RPC API of the MetaMask Solana Wallet Snap. This snap brings official Solana support to MetaMask. Create accounts, check balances, and use Solana dApps right from your MetaMask wallet. Simple, secure, and seamless.",
     "version": "1.0.0",
     "contact": {
@@ -21,7 +21,7 @@
     {
       "name": "client_signAndSendTransactionWithIntent",
       "summary": "Sign and send a transaction with verified intent",
-      "description": "Allows the client (MetaMask) to request the snap to sign and send a transaction with verified intent.\n\n**Process:**\n\n1. **Verify Backend Signature** - Ensures the payload `{ intent, signature }` was signed by the trusted Swaps API\n2. **Match Transaction to Intent** - Verifies the transaction performs exactly what the intent describes\n3. **Sign Transaction** - If all validation pass, signs the transaction with the user's account specified in the intent\n4. **Send Transaction** - Sends the transaction to the Solana network",
+      "description": "Allows the client (MetaMask) to request the snap to sign and send a transaction with verified intent.\n\n**Process:**\n\n1. **Verify Backend Signature** - Ensures that the payload **{ intent, signature }** was signed by the trusted Swaps API\n2. **Match Transaction to Intent** - Verifies that the transaction performs exactly what the intent describes\n3. **Sign Transaction** - If all validation pass, signs the transaction with the user's account specified in the intent\n4. **Send Transaction** - Sends the transaction to the Solana network",
       "params": [
         {
           "name": "intent",

packages/snap/src/core/domain/Intent.ts

@@ -0,0 +1,20 @@
+import type { Infer } from '@metamask/superstruct';
+import { object, string } from '@metamask/superstruct';
+import { CaipAssetTypeStruct } from '@metamask/utils';
+
+import { UuidStruct } from '../validation/structs';
+
+export const AssetAmountStruct = object({
+  assetType: CaipAssetTypeStruct,
+  amount: string(),
+});
+
+export const IntentStruct = object({
+  id: UuidStruct,
+  timestamp: string(),
+  accountId: string(),
+  from: AssetAmountStruct,
+  to: AssetAmountStruct,
+});
+
+export type Intent = Infer<typeof IntentStruct>;

packages/snap/src/core/domain/index.ts

@@ -0,0 +1 @@
+export * from './Intent';

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

@@ -2,16 +2,16 @@ import { type Json, type JsonRpcRequest } from '@metamask/snaps-sdk';
 import type { Struct } from '@metamask/superstruct';
 import { assert, enums } from '@metamask/superstruct';
 
+import type {
+  SignAndSendTransactionWithIntentUseCase,
+  UseCase,
+} from '../../use-cases';
 import type { ILogger } from '../../utils/logger';
-import type { SignAndSendTransactionWithIntentUseCase } from './SignAndSendTransactionWithIntentUseCase';
-import type { ClientRequestUseCase } from './types';
-import {
-  ClientRequestMethod,
-  SignAndSendTransactionWithIntentParamsStruct,
-} from './types';
+import { ClientRequestMethod } from './types';
+import { SignAndSendTransactionWithIntentParamsStruct } from './validation';
 
 export class ClientRequestHandler {
-  readonly #methodToUseCase: Record<ClientRequestMethod, ClientRequestUseCase>;
+  readonly #methodToUseCase: Record<ClientRequestMethod, UseCase>;
 
   readonly #methodToParamsStruct: Record<ClientRequestMethod, Struct<any, any>>;
 

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

@@ -1,3 +1,2 @@
 export * from './ClientRequestHandler';
-export * from './SignAndSendTransactionWithIntentUseCase';
 export * from './types';

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

@@ -1,41 +1,3 @@
-import type { Infer } from '@metamask/superstruct';
-import { object, string } from '@metamask/superstruct';
-import type { Json } from '@metamask/utils';
-import { CaipAssetTypeStruct } from '@metamask/utils';
-
-import { Base64Struct, UuidStruct } from '../../validation/structs';
-
 export enum ClientRequestMethod {
   SignAndSendTransactionWithIntent = 'client_signAndSendTransactionWithIntent',
 }
-
-export const AssetAmountStruct = object({
-  assetType: CaipAssetTypeStruct,
-  amount: string(),
-});
-
-export const IntentStruct = object({
-  id: UuidStruct,
-  timestamp: string(),
-  accountId: string(),
-  from: AssetAmountStruct,
-  to: AssetAmountStruct,
-});
-
-export const SignAndSendTransactionWithIntentParamsStruct = object({
-  intent: IntentStruct,
-  transaction: Base64Struct,
-  signature: string(),
-});
-
-export type AssetAmount = Infer<typeof AssetAmountStruct>;
-
-export type Intent = Infer<typeof IntentStruct>;
-
-export type SignAndSendTransactionWithIntentParams = Infer<
-  typeof SignAndSendTransactionWithIntentParamsStruct
->;
-
-export type ClientRequestUseCase<TParams = any> = {
-  execute: (params: TParams) => Promise<Json>;
-};

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

@@ -0,0 +1,10 @@
+import { string, tuple } from '@metamask/superstruct';
+
+import { IntentStruct } from '../../domain/Intent';
+import { Base64Struct } from '../../validation/structs';
+
+export const SignAndSendTransactionWithIntentParamsStruct = tuple([
+  IntentStruct, // params[0] = intent
+  Base64Struct, // params[1] = transaction
+  string(), // params[2] = signature
+]);

packages/snap/src/core/use-cases/SignAndSendTransactionWithIntent/SignAndSendTransactionWithIntentUseCase.test.ts

@@ -0,0 +1,7 @@
+import { SignAndSendTransactionWithIntentUseCase } from './SignAndSendTransactionWithIntentUseCase';
+
+describe('SignAndSendTransactionWithIntentUseCase', () => {
+  it('should be defined', () => {
+    expect(SignAndSendTransactionWithIntentUseCase).toBeDefined();
+  });
+});

…gnAndSendTransactionWithIntentUseCase.ts …gnAndSendTransactionWithIntentUseCase.tspackages/snap/src/core/handlers/onClientRequest/SignAndSendTransactionWithIntentUseCase.ts renamed to packages/snap/src/core/use-cases/SignAndSendTransactionWithIntent/SignAndSendTransactionWithIntentUseCase.ts packages/snap/src/core/handlers/onClientRequest/SignAndSendTransactionWithIntentUseCase.ts renamed to packages/snap/src/core/use-cases/SignAndSendTransactionWithIntent/SignAndSendTransactionWithIntentUseCase.ts

@@ -1,18 +1,13 @@
 import { SolMethod } from '@metamask/keyring-api';
 import { parseCaipAssetType, type Json } from '@metamask/utils';
 
+import type { Intent } from '../../domain';
+import type { SolanaKeyring } from '../../handlers/onKeyringRequest/Keyring';
 import type { WalletService } from '../../services/wallet/WalletService';
 import type { ILogger } from '../../utils/logger';
-import type { SolanaKeyring } from '../onKeyringRequest/Keyring';
-import type {
-  ClientRequestUseCase,
-  Intent,
-  SignAndSendTransactionWithIntentParams,
-} from './types';
-
-export class SignAndSendTransactionWithIntentUseCase
-  implements ClientRequestUseCase<SignAndSendTransactionWithIntentParams>
-{
+import type { UseCase } from '../UseCase';
+
+export class SignAndSendTransactionWithIntentUseCase implements UseCase {
   #keyring: SolanaKeyring;
 
   #walletService: WalletService;
@@ -34,16 +29,23 @@ export class SignAndSendTransactionWithIntentUseCase
    * This allows transactions to be executed without user confirmation
    * when they match a verified intent from the backend.
    *
-   * @param params - The validated parameters containing intent, transaction, and signature.
+   * @param intent - The validated intent.
+   * @param transaction - The validated transaction.
+   * @param signature - The validated signature.
    * @returns The transaction signature if successful.
    */
-  async execute(params: SignAndSendTransactionWithIntentParams): Promise<Json> {
+  async execute(
+    intent: Intent,
+    transaction: string,
+    signature: string,
+  ): Promise<Json> {
     this.#logger.log(
       '[SignAndSendTransactionWithIntentUseCase] execute',
-      params,
+      intent,
+      transaction,
+      signature,
     );
 
-    const { intent, transaction, signature } = params;
     const { accountId, from } = intent;
 
     // Verify that the backend signed the payload { intent, transaction }
@@ -113,7 +115,7 @@ export class SignAndSendTransactionWithIntentUseCase
    * @returns True if the signature is valid.
    */
   async #verifyBackendSignature(
-    intent: any,
+    intent: Intent,
     transaction: string,
     signature: string,
   ): Promise<boolean> {

packages/snap/src/core/use-cases/SignAndSendTransactionWithIntent/index.ts

@@ -0,0 +1 @@
+export * from './SignAndSendTransactionWithIntentUseCase';