Nwnt 381 solana snap initial websockets setup

.github/workflows/build-lint-test.yml

@@ -11,6 +11,14 @@ on:
         required: true
       RPC_URL_LOCALNET_LIST:
         required: true
+      RPC_WEB_SOCKET_URL_MAINNET:
+        required: true
+      RPC_WEB_SOCKET_URL_DEVNET:
+        required: true
+      RPC_WEB_SOCKET_URL_TESTNET:
+        required: true
+      RPC_WEB_SOCKET_URL_LOCALNET:
+        required: true
       PRICE_API_BASE_URL:
         required: true
       LOCAL_API_BASE_URL:
@@ -47,6 +55,10 @@ jobs:
       RPC_URL_DEVNET_LIST: ${{ secrets.RPC_URL_DEVNET_LIST }}
       RPC_URL_TESTNET_LIST: ${{ secrets.RPC_URL_TESTNET_LIST }}
       RPC_URL_LOCALNET_LIST: ${{ secrets.RPC_URL_LOCALNET_LIST }}
+      RPC_WEB_SOCKET_URL_MAINNET: ${{ secrets.RPC_WEB_SOCKET_URL_MAINNET }}
+      RPC_WEB_SOCKET_URL_DEVNET: ${{ secrets.RPC_WEB_SOCKET_URL_DEVNET }}
+      RPC_WEB_SOCKET_URL_TESTNET: ${{ secrets.RPC_WEB_SOCKET_URL_TESTNET }}
+      RPC_WEB_SOCKET_URL_LOCALNET: ${{ secrets.RPC_WEB_SOCKET_URL_LOCALNET }}
       EXPLORER_BASE_URL: ${{ secrets.EXPLORER_BASE_URL }}
       PRICE_API_BASE_URL: ${{ secrets.PRICE_API_BASE_URL }}
       LOCAL_API_BASE_URL: ${{ secrets.LOCAL_API_BASE_URL }}
@@ -94,6 +106,10 @@ jobs:
       RPC_URL_DEVNET_LIST: ${{ secrets.RPC_URL_DEVNET_LIST }}
       RPC_URL_TESTNET_LIST: ${{ secrets.RPC_URL_TESTNET_LIST }}
       RPC_URL_LOCALNET_LIST: ${{ secrets.RPC_URL_LOCALNET_LIST }}
+      RPC_WEB_SOCKET_URL_MAINNET: ${{ secrets.RPC_WEB_SOCKET_URL_MAINNET }}
+      RPC_WEB_SOCKET_URL_DEVNET: ${{ secrets.RPC_WEB_SOCKET_URL_DEVNET }}
+      RPC_WEB_SOCKET_URL_TESTNET: ${{ secrets.RPC_WEB_SOCKET_URL_TESTNET }}
+      RPC_WEB_SOCKET_URL_LOCALNET: ${{ secrets.RPC_WEB_SOCKET_URL_LOCALNET }}
       EXPLORER_BASE_URL: ${{ secrets.EXPLORER_BASE_URL }}
       PRICE_API_BASE_URL: ${{ secrets.PRICE_API_BASE_URL }}
       LOCAL_API_BASE_URL: ${{ secrets.LOCAL_API_BASE_URL }}

.github/workflows/create-release-pr.yml

@@ -59,6 +59,10 @@ jobs:
           RPC_URL_DEVNET_LIST: ${{ secrets.RPC_URL_DEVNET_LIST }}
           RPC_URL_TESTNET_LIST: ${{ secrets.RPC_URL_TESTNET_LIST }}
           RPC_URL_LOCALNET_LIST: ${{ secrets.RPC_URL_LOCALNET_LIST }}
+          RPC_WEB_SOCKET_URL_MAINNET: ${{ secrets.RPC_WEB_SOCKET_URL_MAINNET }}
+          RPC_WEB_SOCKET_URL_DEVNET: ${{ secrets.RPC_WEB_SOCKET_URL_DEVNET }}
+          RPC_WEB_SOCKET_URL_TESTNET: ${{ secrets.RPC_WEB_SOCKET_URL_TESTNET }}
+          RPC_WEB_SOCKET_URL_LOCALNET: ${{ secrets.RPC_WEB_SOCKET_URL_LOCALNET }}
           EXPLORER_BASE_URL: ${{ secrets.EXPLORER_BASE_URL }}
           PRICE_API_BASE_URL: ${{ secrets.PRICE_API_BASE_URL }}
           LOCAL_API_BASE_URL: ${{ secrets.LOCAL_API_BASE_URL }}

.github/workflows/main.yml

@@ -13,6 +13,10 @@ jobs:
       RPC_URL_DEVNET_LIST: ${{ secrets.RPC_URL_DEVNET_LIST }}
       RPC_URL_TESTNET_LIST: ${{ secrets.RPC_URL_TESTNET_LIST }}
       RPC_URL_LOCALNET_LIST: ${{ secrets.RPC_URL_LOCALNET_LIST }}
+      RPC_WEB_SOCKET_URL_MAINNET: ${{ secrets.RPC_WEB_SOCKET_URL_MAINNET }}
+      RPC_WEB_SOCKET_URL_DEVNET: ${{ secrets.RPC_WEB_SOCKET_URL_DEVNET }}
+      RPC_WEB_SOCKET_URL_TESTNET: ${{ secrets.RPC_WEB_SOCKET_URL_TESTNET }}
+      RPC_WEB_SOCKET_URL_LOCALNET: ${{ secrets.RPC_WEB_SOCKET_URL_LOCALNET }}
       EXPLORER_BASE_URL: ${{ secrets.EXPLORER_BASE_URL }}
       PRICE_API_BASE_URL: ${{ secrets.PRICE_API_BASE_URL }}
       LOCAL_API_BASE_URL: ${{ secrets.LOCAL_API_BASE_URL }}
@@ -87,6 +91,10 @@ jobs:
       RPC_URL_DEVNET_LIST: ${{ secrets.RPC_URL_DEVNET_LIST }}
       RPC_URL_TESTNET_LIST: ${{ secrets.RPC_URL_TESTNET_LIST }}
       RPC_URL_LOCALNET_LIST: ${{ secrets.RPC_URL_LOCALNET_LIST }}
+      RPC_WEB_SOCKET_URL_MAINNET: ${{ secrets.RPC_WEB_SOCKET_URL_MAINNET }}
+      RPC_WEB_SOCKET_URL_DEVNET: ${{ secrets.RPC_WEB_SOCKET_URL_DEVNET }}
+      RPC_WEB_SOCKET_URL_TESTNET: ${{ secrets.RPC_WEB_SOCKET_URL_TESTNET }}
+      RPC_WEB_SOCKET_URL_LOCALNET: ${{ secrets.RPC_WEB_SOCKET_URL_LOCALNET }}
       EXPLORER_BASE_URL: ${{ secrets.EXPLORER_BASE_URL }}
       PRICE_API_BASE_URL: ${{ secrets.PRICE_API_BASE_URL }}
       LOCAL_API_BASE_URL: ${{ secrets.LOCAL_API_BASE_URL }}

.github/workflows/pr.yml

@@ -27,6 +27,10 @@ jobs:
       RPC_URL_DEVNET_LIST: ${{ secrets.RPC_URL_DEVNET_LIST }}
       RPC_URL_TESTNET_LIST: ${{ secrets.RPC_URL_TESTNET_LIST }}
       RPC_URL_LOCALNET_LIST: ${{ secrets.RPC_URL_LOCALNET_LIST }}
+      RPC_WEB_SOCKET_URL_MAINNET: ${{ secrets.RPC_WEB_SOCKET_URL_MAINNET }}
+      RPC_WEB_SOCKET_URL_DEVNET: ${{ secrets.RPC_WEB_SOCKET_URL_DEVNET }}
+      RPC_WEB_SOCKET_URL_TESTNET: ${{ secrets.RPC_WEB_SOCKET_URL_TESTNET }}
+      RPC_WEB_SOCKET_URL_LOCALNET: ${{ secrets.RPC_WEB_SOCKET_URL_LOCALNET }}
       EXPLORER_BASE_URL: ${{ secrets.EXPLORER_BASE_URL }}
       PRICE_API_BASE_URL: ${{ secrets.PRICE_API_BASE_URL }}
       LOCAL_API_BASE_URL: ${{ secrets.LOCAL_API_BASE_URL }}

.github/workflows/publish-release.yml

@@ -15,6 +15,14 @@ on:
         required: true
       RPC_URL_LOCALNET_LIST:
         required: true
+      RPC_WEB_SOCKET_URL_MAINNET:
+        required: true
+      RPC_WEB_SOCKET_URL_DEVNET:
+        required: true
+      RPC_WEB_SOCKET_URL_TESTNET:
+        required: true
+      RPC_WEB_SOCKET_URL_LOCALNET:
+        required: true
       PRICE_API_BASE_URL:
         required: true
       LOCAL_API_BASE_URL:
@@ -51,6 +59,10 @@ jobs:
           RPC_URL_DEVNET_LIST: ${{ secrets.RPC_URL_DEVNET_LIST }}
           RPC_URL_TESTNET_LIST: ${{ secrets.RPC_URL_TESTNET_LIST }}
           RPC_URL_LOCALNET_LIST: ${{ secrets.RPC_URL_LOCALNET_LIST }}
+          RPC_WEB_SOCKET_URL_MAINNET: ${{ secrets.RPC_WEB_SOCKET_URL_MAINNET }}
+          RPC_WEB_SOCKET_URL_DEVNET: ${{ secrets.RPC_WEB_SOCKET_URL_DEVNET }}
+          RPC_WEB_SOCKET_URL_TESTNET: ${{ secrets.RPC_WEB_SOCKET_URL_TESTNET }}
+          RPC_WEB_SOCKET_URL_LOCALNET: ${{ secrets.RPC_WEB_SOCKET_URL_LOCALNET }}
           EXPLORER_BASE_URL: ${{ secrets.EXPLORER_BASE_URL }}
           PRICE_API_BASE_URL: ${{ secrets.PRICE_API_BASE_URL }}
           LOCAL_API_BASE_URL: ${{ secrets.LOCAL_API_BASE_URL }}

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

@@ -1,6 +1,7 @@
 import { Text as ChakraText, Flex, Stack } from '@chakra-ui/react';
 
 import { OnProtocolRequest } from './OnProtocolRequest';
+import { WebSockets } from './WebSockets';
 
 export const Handlers = () => (
   <Flex direction="column" width="full" marginBottom="5">
@@ -9,6 +10,7 @@ export const Handlers = () => (
     </ChakraText>
     <Stack direction="row" gap="5" wrap="wrap">
       <OnProtocolRequest />
+      <WebSockets />
     </Stack>
   </Flex>
 );

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

@@ -0,0 +1,68 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { Button, Card, Flex } from '@chakra-ui/react';
+
+import { TestDappRpcRequestMethod } from '../../../../snap/src/core/handlers/onRpcRequest/types';
+import { useInvokeSnap } from '../../hooks';
+import { useShowToasterForResponse } from '../../hooks/useToasterForResponse';
+
+export const WebSockets = () => {
+  const invokeSnap = useInvokeSnap();
+  const { showToasterForResponse } = useShowToasterForResponse();
+
+  const setupAllConnections = async () => {
+    showToasterForResponse(
+      { result: 'ok' },
+      {
+        title: 'Initiated WebSocket connections to all active networks',
+        description: `Inspect the offscreen console`,
+      },
+    );
+
+    await invokeSnap({
+      method: TestDappRpcRequestMethod.TestSetupAllConnections,
+    });
+  };
+
+  const subscribeToAccount = async () => {
+    await invokeSnap({
+      method: TestDappRpcRequestMethod.TestSubscribeToAccount,
+    });
+
+    showToasterForResponse(
+      { result: 'ok' },
+      {
+        title:
+          'Initiated subscription to account 8A4AptCThfbuknsbteHgGKXczfJpfjuVA9SLTSGaaLGC',
+        description: `Inspect the offscreen console`,
+      },
+    );
+  };
+
+  return (
+    <Card.Root>
+      <Card.Header>
+        <Card.Title>WebSockets</Card.Title>
+      </Card.Header>
+      <Card.Body gap="2">
+        <Flex>
+          <Button
+            variant="outline"
+            onClick={setupAllConnections}
+            marginRight="1"
+          >
+            Setup All Connections
+          </Button>
+        </Flex>
+        <Flex>
+          <Button
+            variant="outline"
+            onClick={subscribeToAccount}
+            marginRight="1"
+          >
+            Subscribe to account
+          </Button>
+        </Flex>
+      </Card.Body>
+    </Card.Root>
+  );
+};

packages/snap/.env.sample

@@ -10,6 +10,12 @@ RPC_URL_MAINNET_LIST=
 RPC_URL_DEVNET_LIST=
 RPC_URL_TESTNET_LIST=
 RPC_URL_LOCALNET_LIST=
+
+RPC_WEB_SOCKET_URL_MAINNET=
+RPC_WEB_SOCKET_URL_DEVNET=
+RPC_WEB_SOCKET_URL_TESTNET=
+RPC_WEB_SOCKET_URL_LOCALNET=
+
 EXPLORER_BASE_URL=
 
 PRICE_API_BASE_URL=

packages/snap/snap.config.ts

@@ -11,6 +11,10 @@ const environment = {
   RPC_URL_DEVNET_LIST: process.env.RPC_URL_DEVNET_LIST ?? '',
   RPC_URL_TESTNET_LIST: process.env.RPC_URL_TESTNET_LIST ?? '',
   RPC_URL_LOCALNET_LIST: process.env.RPC_URL_LOCALNET_LIST ?? '',
+  RPC_WEB_SOCKET_URL_MAINNET: process.env.RPC_WEB_SOCKET_URL_MAINNET ?? '',
+  RPC_WEB_SOCKET_URL_DEVNET: process.env.RPC_WEB_SOCKET_URL_DEVNET ?? '',
+  RPC_WEB_SOCKET_URL_TESTNET: process.env.RPC_WEB_SOCKET_URL_TESTNET ?? '',
+  RPC_WEB_SOCKET_URL_LOCALNET: process.env.RPC_WEB_SOCKET_URL_LOCALNET ?? '',
   EXPLORER_BASE_URL: process.env.EXPLORER_BASE_URL ?? '',
   PRICE_API_BASE_URL: process.env.PRICE_API_BASE_URL ?? '',
   TOKEN_API_BASE_URL: process.env.TOKEN_API_BASE_URL ?? '',

packages/snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/snap-solana-wallet.git"
   },
   "source": {
-    "shasum": "U6qs3tA3phhscX54m+BAD5Mi1aBgT9p9g3qQ2qHrCsQ=",
+    "shasum": "XSE/gfpj/gSu5aA9IihnjJ+IczHvXAdJN1Z/EegXk7w=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/snap/src/core/clients/price-api/PriceApiClient.test.ts

@@ -264,7 +264,9 @@ describe('PriceApiClient', () => {
             mockFetch,
             mockLogger,
           ),
-      ).toThrow('URL must use http or https protocol');
+      ).toThrow(
+        'URL must use one of the following protocols: http:,https:,wss:',
+      );
     });
 
     it('rejects tokenCaip19Ids that are invalid or that include malicious inputs', async () => {

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

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

packages/snap/src/core/handlers/onCronjob/cronjobs/refreshSend.tsx

@@ -1,10 +1,10 @@
 import type { CaipAssetType, OnCronjobHandler } from '@metamask/snaps-sdk';
-import { type SpotPrices } from 'src/core/clients/price-api/types';
 
 import { DEFAULT_SEND_CONTEXT } from '../../../../features/send/render';
 import { Send } from '../../../../features/send/Send';
 import type { SendContext } from '../../../../features/send/types';
 import { priceApiClient, state } from '../../../../snapContext';
+import type { SpotPrices } from '../../../clients/price-api/types';
 import type { UnencryptedStateValue } from '../../../services/state/State';
 import {
   getInterfaceContextOrThrow,

packages/snap/src/core/handlers/onKeyringRequest/Keyring.test.ts

@@ -219,6 +219,7 @@ describe('SolanaKeyring', () => {
         metadata: {},
         tokenPrices: {},
         signatures: {},
+        subscriptions: {},
       });
       // Start with no accounts
       keyring = new SolanaKeyring({

packages/snap/src/core/handlers/onKeyringRequest/Keyring.ts

@@ -38,7 +38,7 @@ import {
   asStrictKeyringAccount,
   type SolanaKeyringAccount,
 } from '../../../entities';
-import { type Network } from '../../constants/solana';
+import type { Network } from '../../constants/solana';
 import type { AssetsService } from '../../services/assets/AssetsService';
 import type { ConfirmationHandler } from '../../services/confirmation/ConfirmationHandler';
 import type { IStateManager } from '../../services/state/IStateManager';

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

@@ -1,10 +1,21 @@
 import { type OnRpcRequestHandler } from '@metamask/snaps-sdk';
 
 import { renderSend } from '../../../features/send/render';
+import { eventEmitter } from '../../../snapContext';
 import { getFeeForTransaction } from './getFeeForTransaction';
-import { RpcRequestMethod } from './types';
+import { RpcRequestMethod, TestDappRpcRequestMethod } from './types';
 
 export const handlers: Record<RpcRequestMethod, OnRpcRequestHandler> = {
   [RpcRequestMethod.StartSendTransactionFlow]: renderSend,
   [RpcRequestMethod.GetFeeForTransaction]: getFeeForTransaction,
+
+  // Methods specific to the test dapp
+  [TestDappRpcRequestMethod.TestSetupAllConnections as any]: async () => {
+    await eventEmitter.emitSync('onTestSetupAllConnections');
+    return null;
+  },
+  [TestDappRpcRequestMethod.TestSubscribeToAccount as any]: async () => {
+    await eventEmitter.emitSync('onTestSubscribeToAccount');
+    return null;
+  },
 };

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

@@ -2,3 +2,12 @@ export enum RpcRequestMethod {
   StartSendTransactionFlow = 'startSendTransactionFlow',
   GetFeeForTransaction = 'getFeeForTransaction',
 }
+
+/**
+ * Methods specific to the test dapp,
+ * to allow specific flows for manual testing.
+ */
+export enum TestDappRpcRequestMethod {
+  TestSetupAllConnections = 'testSetupAllConnections',
+  TestSubscribeToAccount = 'testSubscribeToAccount',
+}

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

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

packages/snap/src/core/ports/subscriptions/ConnectionManagerPort.ts

@@ -0,0 +1,30 @@
+import type { Network } from '../../constants/solana';
+
+/**
+ * Port interface for managing the lifecycle of JSON-RPC subscription connections.
+ * It is responsible for opening and closing connections for each network,
+ * and for re-opening connections when they are dropped.
+ */
+export type ConnectionManagerPort = {
+  /**
+   * Sets up connections for all networks.
+   * - Opens the connections for all enabled networks that are not already open.
+   * - Closes the connections for all disabled networks.
+   * @returns A promise that resolves when the connections are setup.
+   */
+  setupAllConnections(): Promise<void>;
+
+  /**
+   * Registers a callback to be called when connection is recovered.
+   * @param network - The network to register the callback for.
+   * @param callback - The callback function to register.
+   */
+  onConnectionRecovery(network: Network, callback: () => Promise<void>): void;
+
+  /**
+   * Gets the connection ID for the specified network.
+   * @param network - The network to get the connection ID for.
+   * @returns The connection ID, or null if no connection exists for the network.
+   */
+  getConnectionIdByNetwork(network: Network): Promise<string | null>;
+};