@portal-hq/connect 2.0.2 → 2.0.3

package/lib/commonjs/index.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConnectionStates = void 0;
+exports.ConnectionStates = exports.ConnectError = void 0;
 const provider_1 = require("@portal-hq/provider");
 class PortalConnect {
     constructor({ apiKey, chainId, keychain, gatewayConfig, 
@@ -19,6 +19,7 @@ class PortalConnect {
         this.apiKey = apiKey;
         this.events = {};
         this.websocketServer = webSocketServer;
+        this.gatewayConfig = gatewayConfig;
         this.provider = new provider_1.Provider({
             apiKey,
             chainId,
@@ -172,6 +173,36 @@ class PortalConnect {
             this.events[event] = this.events[event].filter(filterEventHandlers);
         }
     }
+    /**
+     * Adds chains from gateway config to the session proposal
+     * @param proposal
+     * @returns session proposal with chains from gateway config added
+     */
+    addChainsToProposal(proposal) {
+        if (!('params' in proposal) || !('requiredNamespaces' in proposal.params)) {
+            throw new Error('Invalid proposal structure.');
+        }
+        // Ensure eip155 is present in requiredNamespaces
+        if (!proposal.params.requiredNamespaces.eip155) {
+            proposal.params.requiredNamespaces.eip155 = {
+                chains: [],
+                methods: [],
+                events: [],
+                rpcMap: {},
+            };
+        }
+        // Get chains from gatewayConfig with 'eip155:' prefix, but only if they're not already in the proposal
+        const existingChains = proposal.params.requiredNamespaces.eip155.chains;
+        const newChains = Object.keys(this.gatewayConfig)
+            .map((chain) => `eip155:${chain}`)
+            .filter((chain) => !existingChains.includes(chain));
+        // Append new chains to the existing chains
+        proposal.params.requiredNamespaces.eip155.chains = [
+            ...existingChains,
+            ...newChains,
+        ];
+        return proposal;
+    }
     /**
      * Adds event bindings to a websocket connection
      * - on open, a `connect` event is dispatched via the socket to establish a bridge connection
@@ -185,6 +216,7 @@ class PortalConnect {
          * - Fires a subsequent call over the websocket to notify the proxy of the uri to connect to
          */
         socket.onopen = () => __awaiter(this, void 0, void 0, function* () {
+            this.connectionState = ConnectionStates.CONNECTING;
             const address = yield this.address;
             const { chainId } = this.provider;
             // Tell the proxy server where to connect to downstream
@@ -215,7 +247,12 @@ class PortalConnect {
                 // Check if the event is an ErrorEvent
                 errorMessage = event.message; // Access the error message from the ErrorEvent
             }
-            this.emit('portal_connectError', new Error(errorMessage));
+            this.emit('portal_connectError', {
+                id: '0',
+                topic: this.topic,
+                params: new ConnectError(errorMessage, 500),
+            });
+            this.connectionState = ConnectionStates.DISCONNECTED;
         });
         /**
          * Handles all incoming messages over the websocket connection
@@ -244,14 +281,17 @@ class PortalConnect {
                     const request = message.data;
                     const params = request.params;
                     // Sign the transaction and get back a transaction hash
-                    yield this.handleProviderRequest(params.request.method, params.request.params, request);
+                    yield this.handleProviderRequest(params.request.method, params.request.params, params.chainId, request);
                     break;
                 case 'portal_dappSessionRequested':
                 case 'portal_dappSessionRequestedV1':
                     this.handleSessionRequest(message);
                     break;
+                case 'portal_connectError':
+                    this.emit('portal_connectError', message.data);
+                    break;
                 default:
-                    console.log(`Recieved unsupported event "${message.event}". Ignoring.`);
+                    console.log(`Received unsupported event "${message.event}". Ignoring.`);
                     break;
             }
         });
@@ -264,7 +304,7 @@ class PortalConnect {
      *
      * @returns The result of the provider request
      */
-    handleProviderRequest(method, params, request) {
+    handleProviderRequest(method, params, chainId, request) {
         return __awaiter(this, void 0, void 0, function* () {
             // Bind to potential signing rejection events
             this.provider.on('portal_signingRejected', this.handleSigningRejected);
@@ -276,7 +316,7 @@ class PortalConnect {
                 }
             });
             // Pass the request along to the provider
-            yield this.provider.request({ method, params, connect: this });
+            yield this.provider.request({ method, params, chainId, connect: this });
         });
     }
     handleSessionApproved(data, request) {
@@ -371,6 +411,15 @@ class PortalConnect {
         }
     }
 }
+class ConnectError extends Error {
+    constructor(message, code) {
+        super(message);
+        this.code = code;
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, ConnectError.prototype);
+    }
+}
+exports.ConnectError = ConnectError;
 var ConnectionStates;
 (function (ConnectionStates) {
     ConnectionStates["CONNECTED"] = "CONNECTED";

package/lib/esm/index.js

@@ -16,6 +16,7 @@ class PortalConnect {
         this.apiKey = apiKey;
         this.events = {};
         this.websocketServer = webSocketServer;
+        this.gatewayConfig = gatewayConfig;
         this.provider = new Provider({
             apiKey,
             chainId,
@@ -169,6 +170,36 @@ class PortalConnect {
             this.events[event] = this.events[event].filter(filterEventHandlers);
         }
     }
+    /**
+     * Adds chains from gateway config to the session proposal
+     * @param proposal
+     * @returns session proposal with chains from gateway config added
+     */
+    addChainsToProposal(proposal) {
+        if (!('params' in proposal) || !('requiredNamespaces' in proposal.params)) {
+            throw new Error('Invalid proposal structure.');
+        }
+        // Ensure eip155 is present in requiredNamespaces
+        if (!proposal.params.requiredNamespaces.eip155) {
+            proposal.params.requiredNamespaces.eip155 = {
+                chains: [],
+                methods: [],
+                events: [],
+                rpcMap: {},
+            };
+        }
+        // Get chains from gatewayConfig with 'eip155:' prefix, but only if they're not already in the proposal
+        const existingChains = proposal.params.requiredNamespaces.eip155.chains;
+        const newChains = Object.keys(this.gatewayConfig)
+            .map((chain) => `eip155:${chain}`)
+            .filter((chain) => !existingChains.includes(chain));
+        // Append new chains to the existing chains
+        proposal.params.requiredNamespaces.eip155.chains = [
+            ...existingChains,
+            ...newChains,
+        ];
+        return proposal;
+    }
     /**
      * Adds event bindings to a websocket connection
      * - on open, a `connect` event is dispatched via the socket to establish a bridge connection
@@ -182,6 +213,7 @@ class PortalConnect {
          * - Fires a subsequent call over the websocket to notify the proxy of the uri to connect to
          */
         socket.onopen = () => __awaiter(this, void 0, void 0, function* () {
+            this.connectionState = ConnectionStates.CONNECTING;
             const address = yield this.address;
             const { chainId } = this.provider;
             // Tell the proxy server where to connect to downstream
@@ -212,7 +244,12 @@ class PortalConnect {
                 // Check if the event is an ErrorEvent
                 errorMessage = event.message; // Access the error message from the ErrorEvent
             }
-            this.emit('portal_connectError', new Error(errorMessage));
+            this.emit('portal_connectError', {
+                id: '0',
+                topic: this.topic,
+                params: new ConnectError(errorMessage, 500),
+            });
+            this.connectionState = ConnectionStates.DISCONNECTED;
         });
         /**
          * Handles all incoming messages over the websocket connection
@@ -241,14 +278,17 @@ class PortalConnect {
                     const request = message.data;
                     const params = request.params;
                     // Sign the transaction and get back a transaction hash
-                    yield this.handleProviderRequest(params.request.method, params.request.params, request);
+                    yield this.handleProviderRequest(params.request.method, params.request.params, params.chainId, request);
                     break;
                 case 'portal_dappSessionRequested':
                 case 'portal_dappSessionRequestedV1':
                     this.handleSessionRequest(message);
                     break;
+                case 'portal_connectError':
+                    this.emit('portal_connectError', message.data);
+                    break;
                 default:
-                    console.log(`Recieved unsupported event "${message.event}". Ignoring.`);
+                    console.log(`Received unsupported event "${message.event}". Ignoring.`);
                     break;
             }
         });
@@ -261,7 +301,7 @@ class PortalConnect {
      *
      * @returns The result of the provider request
      */
-    handleProviderRequest(method, params, request) {
+    handleProviderRequest(method, params, chainId, request) {
         return __awaiter(this, void 0, void 0, function* () {
             // Bind to potential signing rejection events
             this.provider.on('portal_signingRejected', this.handleSigningRejected);
@@ -273,7 +313,7 @@ class PortalConnect {
                 }
             });
             // Pass the request along to the provider
-            yield this.provider.request({ method, params, connect: this });
+            yield this.provider.request({ method, params, chainId, connect: this });
         });
     }
     handleSessionApproved(data, request) {
@@ -368,6 +408,14 @@ class PortalConnect {
         }
     }
 }
+export class ConnectError extends Error {
+    constructor(message, code) {
+        super(message);
+        this.code = code;
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, ConnectError.prototype);
+    }
+}
 export var ConnectionStates;
 (function (ConnectionStates) {
     ConnectionStates["CONNECTED"] = "CONNECTED";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portal-hq/connect",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "main": "lib/commonjs/index",
   "module": "lib/esm/index",
   "source": "src/index",
@@ -32,5 +32,5 @@
     "react": "*",
     "react-native": "*"
   },
-  "gitHead": "8ce39a2867dacd6403db80b5fc51aa40c3b3c205"
+  "gitHead": "c333fe5280f16a5c5f70b7ae768f112baf7156ba"
 }

package/src/index.ts

@@ -1,5 +1,6 @@
 import { Provider } from '@portal-hq/provider'
 import type {
+  ErrorResult,
   EventHandler,
   PortalConnectOptions,
   ProviderRequestPayload,
@@ -9,12 +10,16 @@ import type {
   WebsocketMessage,
 } from '../types.d'
 import { IPortalProvider } from '@portal-hq/utils'
-import { SwitchEthereumChainParameter } from '@portal-hq/provider/types'
+import {
+  GatewayConfig,
+  SwitchEthereumChainParameter,
+} from '@portal-hq/provider/types'
 
 class PortalConnect {
   private apiKey: string
   private connectionState: ConnectionStates = ConnectionStates.DISCONNECTED
   private provider: IPortalProvider
+  private gatewayConfig: GatewayConfig
   private socket?: WebSocket
   private topic?: string
   private uri?: string
@@ -54,7 +59,7 @@ class PortalConnect {
     this.apiKey = apiKey
     this.events = {}
     this.websocketServer = webSocketServer
-
+    this.gatewayConfig = gatewayConfig
     this.provider = new Provider({
       apiKey,
       chainId,
@@ -224,6 +229,43 @@ class PortalConnect {
     }
   }
 
+  /**
+   * Adds chains from gateway config to the session proposal
+   * @param proposal
+   * @returns session proposal with chains from gateway config added
+   */
+  public addChainsToProposal(
+    proposal: SessionProposalOrMetadata,
+  ): SessionProposalOrMetadata {
+    if (!('params' in proposal) || !('requiredNamespaces' in proposal.params)) {
+      throw new Error('Invalid proposal structure.')
+    }
+
+    // Ensure eip155 is present in requiredNamespaces
+    if (!proposal.params.requiredNamespaces.eip155) {
+      proposal.params.requiredNamespaces.eip155 = {
+        chains: [],
+        methods: [],
+        events: [],
+        rpcMap: {},
+      }
+    }
+
+    // Get chains from gatewayConfig with 'eip155:' prefix, but only if they're not already in the proposal
+    const existingChains = proposal.params.requiredNamespaces.eip155.chains
+    const newChains = Object.keys(this.gatewayConfig)
+      .map((chain) => `eip155:${chain}`)
+      .filter((chain) => !existingChains.includes(chain))
+
+    // Append new chains to the existing chains
+    proposal.params.requiredNamespaces.eip155.chains = [
+      ...existingChains,
+      ...newChains,
+    ]
+
+    return proposal
+  }
+
   /**
    * Adds event bindings to a websocket connection
    * - on open, a `connect` event is dispatched via the socket to establish a bridge connection
@@ -237,6 +279,7 @@ class PortalConnect {
      * - Fires a subsequent call over the websocket to notify the proxy of the uri to connect to
      */
     socket.onopen = async () => {
+      this.connectionState = ConnectionStates.CONNECTING
       const address = await this.address
       const { chainId } = this.provider
 
@@ -275,7 +318,12 @@ class PortalConnect {
         errorMessage = event.message // Access the error message from the ErrorEvent
       }
 
-      this.emit('portal_connectError', new Error(errorMessage))
+      this.emit('portal_connectError', {
+        id: '0',
+        topic: this.topic,
+        params: new ConnectError(errorMessage, 500),
+      } as ErrorResult)
+      this.connectionState = ConnectionStates.DISCONNECTED
     }
 
     /**
@@ -310,6 +358,7 @@ class PortalConnect {
           await this.handleProviderRequest(
             params.request.method,
             params.request.params,
+            params.chainId,
             request,
           )
           break
@@ -317,9 +366,12 @@ class PortalConnect {
         case 'portal_dappSessionRequestedV1':
           this.handleSessionRequest(message)
           break
+        case 'portal_connectError':
+          this.emit('portal_connectError', message.data as ErrorResult)
+          break
         default:
           console.log(
-            `Recieved unsupported event "${message.event}". Ignoring.`,
+            `Received unsupported event "${message.event}". Ignoring.`,
           )
           break
       }
@@ -337,6 +389,7 @@ class PortalConnect {
   private async handleProviderRequest(
     method: string,
     params: any,
+    chainId: string,
     request: SessionRequest,
   ): Promise<void> {
     // Bind to potential signing rejection events
@@ -356,7 +409,7 @@ class PortalConnect {
     )
 
     // Pass the request along to the provider
-    await this.provider.request({ method, params, connect: this })
+    await this.provider.request({ method, params, chainId, connect: this })
   }
 
   private async handleSessionApproved(
@@ -476,6 +529,17 @@ class PortalConnect {
   }
 }
 
+export class ConnectError extends Error {
+  code: number
+
+  constructor(message: string, code: number) {
+    super(message)
+    this.code = code
+    // Set the prototype explicitly.
+    Object.setPrototypeOf(this, ConnectError.prototype)
+  }
+}
+
 export enum ConnectionStates {
   CONNECTED = 'CONNECTED',
   CONNECTING = 'CONNECTING',

package/types.d.ts

@@ -1,5 +1,6 @@
 import Portal from '@portal-hq/core'
 import { KeychainAdapter } from '@portal-hq/utils'
+import { ConnectError } from 'src'
 
 export type EventHandler = (data: any) => void
 export type SessionProposalOrMetadata = SessionProposal | PeerMetadata
@@ -10,6 +11,12 @@ export interface ConnectRequest {
   topic: string
 }
 
+export interface ErrorResult {
+  id: string
+  params: ConnectError
+  topic: string
+}
+
 export interface ConnectResult {
   active: boolean
   expiry: number
@@ -114,5 +121,10 @@ export interface SigningResult {
 
 export interface WebsocketMessage {
   event: string
-  data: ConnectResult | DisconnectResult | SessionRequest | SigningResult
+  data:
+    | ConnectResult
+    | DisconnectResult
+    | SessionRequest
+    | SigningResult
+    | ErrorResult
 }