@portal-hq/connect 1.0.5 → 1.1.0

package/lib/commonjs/components/scanner/index.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const react_native_1 = require("react-native");
+const WalletScanner = () => {
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement(react_native_1.Text, null, "Yo!")));
+};
+exports.default = WalletScanner;

package/lib/commonjs/index.js

@@ -9,18 +9,54 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionStates = void 0;
+const provider_1 = require("@portal-hq/provider");
 class PortalConnect {
-    constructor({ portal, websocketServer = 'connect.portalhq.io', }) {
-        this.connected = false;
+    constructor({ apiKey, chainId, keychain, gatewayConfig, 
+    // Optional
+    isSimulator = false, autoApprove = false, version = 'v4', apiHost = 'api.portalhq.io', mpcHost = 'mpc.portalhq.io', webSocketServer = 'connect.portalhq.io', }) {
+        this.connectionState = ConnectionStates.DISCONNECTED;
+        this.apiKey = apiKey;
         this.events = {};
-        this.portal = portal;
-        this.websocketServer = websocketServer;
+        this.websocketServer = webSocketServer;
+        this.provider = new provider_1.Provider({
+            apiKey,
+            chainId,
+            gatewayConfig,
+            keychain,
+            isSimulator,
+            autoApprove,
+            version,
+            apiHost,
+            mpcHost,
+        });
+        // Inbound from the Provider
+        this.on('portalConnect_signingRequested', (data) => {
+            this.emit('portal_signingRequested', data);
+        });
+        // Inbound from SDK consumers
+        this.on('portal_signingApproved', (data) => {
+            this.provider.emit('portal_signingApproved', data);
+        });
+        this.on('portal_signingRejected', (data) => {
+            this.provider.emit('portal_signingRejected', data);
+        });
         // Do the OG binding trick to preserve the `this` context
         this.handleSessionApproved = this.handleSessionApproved.bind(this);
         this.handleSessionRejected = this.handleSessionRejected.bind(this);
         this.handleSessionRequest = this.handleSessionRequest.bind(this);
         this.handleSigningRejected = this.handleSigningRejected.bind(this);
     }
+    get address() {
+        return this.provider.address;
+    }
+    get chainId() {
+        return this.provider.chainId;
+    }
+    get connected() {
+        return (this.connectionState === ConnectionStates.CONNECTED ||
+            this.connectionState === ConnectionStates.CONNECTING);
+    }
     /**
      * Establishes a websocket connection with the Connect Proxy and dispatches the binding
      * of websocket events for the newly established socket
@@ -38,7 +74,7 @@ class PortalConnect {
             // @ts-ignore
             {
                 headers: {
-                    Authorization: `Bearer ${this.portal.apiKey}`,
+                    Authorization: `Bearer ${this.apiKey}`,
                 },
             });
             this.bindToSocketEvents(this.socket, uri);
@@ -47,6 +83,9 @@ class PortalConnect {
     deinit() {
         this.events = {};
     }
+    disconnect() {
+        this.sendFinalMessageAndClose();
+    }
     /**
      * Invokes all registered event handlers with the data provided
      * - If any `once` handlers exist, they are removed after all handlers are invoked
@@ -135,7 +174,8 @@ 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* () {
-            const { address, chainId } = this.portal.provider;
+            const address = yield this.address;
+            const { chainId } = this.provider;
             // Tell the proxy server where to connect to downstream
             socket.send(JSON.stringify({
                 event: 'connect',
@@ -168,12 +208,13 @@ class PortalConnect {
                     this.emit('disconnect', message.data);
                     break;
                 case 'connected':
-                    this.connected = true;
+                    this.connectionState = ConnectionStates.CONNECTED;
+                    this.topic = message.data.topic;
                     this.emit('connect', message.data);
                     break;
                 case 'disconnect':
                     socket.close();
-                    this.connected = false;
+                    this.connectionState = ConnectionStates.DISCONNECTED;
                     this.emit('disconnect', message.data);
                     break;
                 case 'session_request':
@@ -203,28 +244,28 @@ class PortalConnect {
     handleProviderRequest(method, params, request) {
         return __awaiter(this, void 0, void 0, function* () {
             // Bind to potential signing rejection events
-            this.portal.provider.on('portal_signingRejected', this.handleSigningRejected);
+            this.provider.on('portal_signingRejected', this.handleSigningRejected);
             // Bind to potential signature received events
-            this.portal.provider.on('portal_signatureReceived', ({ method: signedMethod, params: signedParams, signature }) => {
+            this.provider.on('portal_signatureReceived', ({ method: signedMethod, params: signedParams, signature }) => {
                 if (signedMethod === method &&
                     JSON.stringify(signedParams) === JSON.stringify(params)) {
                     this.handleSignatureReceived(request, signature);
                 }
             });
             // Pass the request along to the provider
-            yield this.portal.provider.request({ method, params });
+            yield this.provider.request({ method, params, connect: this });
         });
     }
     handleSessionApproved(data, request) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const address = yield this.portal.keychain.getAddress();
+            const address = yield this.address;
             // Notify the proxy server that the session request was approved
             (_a = this.socket) === null || _a === void 0 ? void 0 : _a.send(JSON.stringify({
                 event: 'portal_dappSessionApproved',
                 data: {
                     address,
-                    chainId: this.portal.chainId,
+                    chainId: this.chainId,
                     topic: request.topic,
                     id: request.id,
                     params: data,
@@ -235,13 +276,13 @@ class PortalConnect {
     handleSessionRejected(data, request) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const address = yield this.portal.keychain.getAddress();
+            const address = yield this.address;
             // Notify the proxy server that the session request was rejected
             (_a = this.socket) === null || _a === void 0 ? void 0 : _a.send(JSON.stringify({
                 event: 'portal_dappSessionRejected',
                 data: {
                     address,
-                    chainId: this.portal.chainId,
+                    chainId: this.chainId,
                     topic: request.topic,
                     id: request.id,
                     params: data,
@@ -272,6 +313,8 @@ class PortalConnect {
                     transactionId: id,
                 },
             }));
+            // Let the SDK consumer know the transaction hash
+            this.emit('portal_signgatureReceived', txHash);
         });
     }
     handleSigningRejected(data) {
@@ -288,5 +331,28 @@ class PortalConnect {
             }));
         });
     }
+    sendFinalMessageAndClose() {
+        var _a;
+        if (this.socket) {
+            this.connectionState = ConnectionStates.DISCONNECTING;
+            this.socket.send(JSON.stringify({
+                event: 'disconnect',
+                data: {
+                    id: '',
+                    topic: this.topic,
+                },
+            }));
+            this.topic = undefined;
+            (_a = this.socket) === null || _a === void 0 ? void 0 : _a.close();
+            this.connectionState = ConnectionStates.DISCONNECTED;
+        }
+    }
 }
+var ConnectionStates;
+(function (ConnectionStates) {
+    ConnectionStates["CONNECTED"] = "CONNECTED";
+    ConnectionStates["CONNECTING"] = "CONNECTING";
+    ConnectionStates["DISCONNECTED"] = "DISCONNECTED";
+    ConnectionStates["DISCONNECTING"] = "DISCONNECTING";
+})(ConnectionStates = exports.ConnectionStates || (exports.ConnectionStates = {}));
 exports.default = PortalConnect;

package/lib/esm/components/scanner/index.js

@@ -0,0 +1,7 @@
+import React from 'react';
+import { Text } from 'react-native';
+const WalletScanner = () => {
+    return (React.createElement(React.Fragment, null,
+        React.createElement(Text, null, "Yo!")));
+};
+export default WalletScanner;

package/lib/esm/index.js

@@ -7,18 +7,53 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { Provider } from '@portal-hq/provider';
 class PortalConnect {
-    constructor({ portal, websocketServer = 'connect.portalhq.io', }) {
-        this.connected = false;
+    constructor({ apiKey, chainId, keychain, gatewayConfig, 
+    // Optional
+    isSimulator = false, autoApprove = false, version = 'v4', apiHost = 'api.portalhq.io', mpcHost = 'mpc.portalhq.io', webSocketServer = 'connect.portalhq.io', }) {
+        this.connectionState = ConnectionStates.DISCONNECTED;
+        this.apiKey = apiKey;
         this.events = {};
-        this.portal = portal;
-        this.websocketServer = websocketServer;
+        this.websocketServer = webSocketServer;
+        this.provider = new Provider({
+            apiKey,
+            chainId,
+            gatewayConfig,
+            keychain,
+            isSimulator,
+            autoApprove,
+            version,
+            apiHost,
+            mpcHost,
+        });
+        // Inbound from the Provider
+        this.on('portalConnect_signingRequested', (data) => {
+            this.emit('portal_signingRequested', data);
+        });
+        // Inbound from SDK consumers
+        this.on('portal_signingApproved', (data) => {
+            this.provider.emit('portal_signingApproved', data);
+        });
+        this.on('portal_signingRejected', (data) => {
+            this.provider.emit('portal_signingRejected', data);
+        });
         // Do the OG binding trick to preserve the `this` context
         this.handleSessionApproved = this.handleSessionApproved.bind(this);
         this.handleSessionRejected = this.handleSessionRejected.bind(this);
         this.handleSessionRequest = this.handleSessionRequest.bind(this);
         this.handleSigningRejected = this.handleSigningRejected.bind(this);
     }
+    get address() {
+        return this.provider.address;
+    }
+    get chainId() {
+        return this.provider.chainId;
+    }
+    get connected() {
+        return (this.connectionState === ConnectionStates.CONNECTED ||
+            this.connectionState === ConnectionStates.CONNECTING);
+    }
     /**
      * Establishes a websocket connection with the Connect Proxy and dispatches the binding
      * of websocket events for the newly established socket
@@ -36,7 +71,7 @@ class PortalConnect {
             // @ts-ignore
             {
                 headers: {
-                    Authorization: `Bearer ${this.portal.apiKey}`,
+                    Authorization: `Bearer ${this.apiKey}`,
                 },
             });
             this.bindToSocketEvents(this.socket, uri);
@@ -45,6 +80,9 @@ class PortalConnect {
     deinit() {
         this.events = {};
     }
+    disconnect() {
+        this.sendFinalMessageAndClose();
+    }
     /**
      * Invokes all registered event handlers with the data provided
      * - If any `once` handlers exist, they are removed after all handlers are invoked
@@ -133,7 +171,8 @@ 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* () {
-            const { address, chainId } = this.portal.provider;
+            const address = yield this.address;
+            const { chainId } = this.provider;
             // Tell the proxy server where to connect to downstream
             socket.send(JSON.stringify({
                 event: 'connect',
@@ -166,12 +205,13 @@ class PortalConnect {
                     this.emit('disconnect', message.data);
                     break;
                 case 'connected':
-                    this.connected = true;
+                    this.connectionState = ConnectionStates.CONNECTED;
+                    this.topic = message.data.topic;
                     this.emit('connect', message.data);
                     break;
                 case 'disconnect':
                     socket.close();
-                    this.connected = false;
+                    this.connectionState = ConnectionStates.DISCONNECTED;
                     this.emit('disconnect', message.data);
                     break;
                 case 'session_request':
@@ -201,28 +241,28 @@ class PortalConnect {
     handleProviderRequest(method, params, request) {
         return __awaiter(this, void 0, void 0, function* () {
             // Bind to potential signing rejection events
-            this.portal.provider.on('portal_signingRejected', this.handleSigningRejected);
+            this.provider.on('portal_signingRejected', this.handleSigningRejected);
             // Bind to potential signature received events
-            this.portal.provider.on('portal_signatureReceived', ({ method: signedMethod, params: signedParams, signature }) => {
+            this.provider.on('portal_signatureReceived', ({ method: signedMethod, params: signedParams, signature }) => {
                 if (signedMethod === method &&
                     JSON.stringify(signedParams) === JSON.stringify(params)) {
                     this.handleSignatureReceived(request, signature);
                 }
             });
             // Pass the request along to the provider
-            yield this.portal.provider.request({ method, params });
+            yield this.provider.request({ method, params, connect: this });
         });
     }
     handleSessionApproved(data, request) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const address = yield this.portal.keychain.getAddress();
+            const address = yield this.address;
             // Notify the proxy server that the session request was approved
             (_a = this.socket) === null || _a === void 0 ? void 0 : _a.send(JSON.stringify({
                 event: 'portal_dappSessionApproved',
                 data: {
                     address,
-                    chainId: this.portal.chainId,
+                    chainId: this.chainId,
                     topic: request.topic,
                     id: request.id,
                     params: data,
@@ -233,13 +273,13 @@ class PortalConnect {
     handleSessionRejected(data, request) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const address = yield this.portal.keychain.getAddress();
+            const address = yield this.address;
             // Notify the proxy server that the session request was rejected
             (_a = this.socket) === null || _a === void 0 ? void 0 : _a.send(JSON.stringify({
                 event: 'portal_dappSessionRejected',
                 data: {
                     address,
-                    chainId: this.portal.chainId,
+                    chainId: this.chainId,
                     topic: request.topic,
                     id: request.id,
                     params: data,
@@ -270,6 +310,8 @@ class PortalConnect {
                     transactionId: id,
                 },
             }));
+            // Let the SDK consumer know the transaction hash
+            this.emit('portal_signgatureReceived', txHash);
         });
     }
     handleSigningRejected(data) {
@@ -286,5 +328,28 @@ class PortalConnect {
             }));
         });
     }
+    sendFinalMessageAndClose() {
+        var _a;
+        if (this.socket) {
+            this.connectionState = ConnectionStates.DISCONNECTING;
+            this.socket.send(JSON.stringify({
+                event: 'disconnect',
+                data: {
+                    id: '',
+                    topic: this.topic,
+                },
+            }));
+            this.topic = undefined;
+            (_a = this.socket) === null || _a === void 0 ? void 0 : _a.close();
+            this.connectionState = ConnectionStates.DISCONNECTED;
+        }
+    }
 }
+export var ConnectionStates;
+(function (ConnectionStates) {
+    ConnectionStates["CONNECTED"] = "CONNECTED";
+    ConnectionStates["CONNECTING"] = "CONNECTING";
+    ConnectionStates["DISCONNECTED"] = "DISCONNECTED";
+    ConnectionStates["DISCONNECTING"] = "DISCONNECTING";
+})(ConnectionStates || (ConnectionStates = {}));
 export default PortalConnect;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portal-hq/connect",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "main": "lib/commonjs/index",
   "module": "lib/esm/index",
   "source": "src/index",
@@ -32,5 +32,5 @@
     "react": "*",
     "react-native": "*"
   },
-  "gitHead": "acac6640bcad15621912376d95c0bd09509387e1"
+  "gitHead": "b65beeaf1dd0423244a099aaa0f3d55734ae676a"
 }

package/src/index.ts

@@ -1,4 +1,4 @@
-import Portal from '@portal-hq/core'
+import { Provider } from '@portal-hq/provider'
 import type {
   EventHandler,
   PortalConnectOptions,
@@ -10,21 +10,73 @@ import type {
 } from '../types.d'
 
 class PortalConnect {
-  public connected: boolean
-  public portal: Portal
-  public socket?: WebSocket
-  public websocketServer: string
+  private apiKey: string
+  private connectionState: ConnectionStates = ConnectionStates.DISCONNECTED
+  private provider: Provider
+  private socket?: WebSocket
+  private topic?: string
+  private websocketServer: string
 
   private events: Record<string, RegisteredEventHandler[]>
 
+  private get address(): Promise<string | undefined> {
+    return this.provider.address
+  }
+
+  private get chainId(): number {
+    return this.provider.chainId
+  }
+
+  public get connected(): boolean {
+    return (
+      this.connectionState === ConnectionStates.CONNECTED ||
+      this.connectionState === ConnectionStates.CONNECTING
+    )
+  }
+
   constructor({
-    portal,
-    websocketServer = 'connect.portalhq.io',
+    apiKey,
+    chainId,
+    keychain,
+    gatewayConfig,
+
+    // Optional
+    isSimulator = false,
+    autoApprove = false,
+    version = 'v4',
+    apiHost = 'api.portalhq.io',
+    mpcHost = 'mpc.portalhq.io',
+    webSocketServer = 'connect.portalhq.io',
   }: PortalConnectOptions) {
-    this.connected = false
+    this.apiKey = apiKey
     this.events = {}
-    this.portal = portal
-    this.websocketServer = websocketServer
+    this.websocketServer = webSocketServer
+
+    this.provider = new Provider({
+      apiKey,
+      chainId,
+      gatewayConfig,
+      keychain,
+      isSimulator,
+      autoApprove,
+      version,
+      apiHost,
+      mpcHost,
+    })
+
+    // Inbound from the Provider
+    this.on('portalConnect_signingRequested', (data) => {
+      this.emit('portal_signingRequested', data)
+    })
+
+    // Inbound from SDK consumers
+    this.on('portal_signingApproved', (data) => {
+      this.provider.emit('portal_signingApproved', data)
+    })
+
+    this.on('portal_signingRejected', (data) => {
+      this.provider.emit('portal_signingRejected', data)
+    })
 
     // Do the OG binding trick to preserve the `this` context
     this.handleSessionApproved = this.handleSessionApproved.bind(this)
@@ -52,16 +104,20 @@ class PortalConnect {
       // @ts-ignore
       {
         headers: {
-          Authorization: `Bearer ${this.portal.apiKey}`,
+          Authorization: `Bearer ${this.apiKey}`,
         },
       },
     )
     this.bindToSocketEvents(this.socket, uri)
   }
 
-public deinit() {
-  this.events = {}
-}
+  public deinit() {
+    this.events = {}
+  }
+
+  public disconnect() {
+    this.sendFinalMessageAndClose()
+  }
 
   /**
    * Invokes all registered event handlers with the data provided
@@ -168,7 +224,8 @@ public deinit() {
      * - Fires a subsequent call over the websocket to notify the proxy of the uri to connect to
      */
     socket.onopen = async () => {
-      const { address, chainId } = this.portal.provider
+      const address = await this.address
+      const { chainId } = this.provider
 
       // Tell the proxy server where to connect to downstream
       socket.send(
@@ -209,12 +266,13 @@ public deinit() {
           this.emit('disconnect', message.data)
           break
         case 'connected':
-          this.connected = true
+          this.connectionState = ConnectionStates.CONNECTED
+          this.topic = message.data.topic
           this.emit('connect', message.data)
           break
         case 'disconnect':
           socket.close()
-          this.connected = false
+          this.connectionState = ConnectionStates.DISCONNECTED
           this.emit('disconnect', message.data)
 
           break
@@ -255,13 +313,10 @@ public deinit() {
     request: SessionRequest,
   ): Promise<void> {
     // Bind to potential signing rejection events
-    this.portal.provider.on(
-      'portal_signingRejected',
-      this.handleSigningRejected,
-    )
+    this.provider.on('portal_signingRejected', this.handleSigningRejected)
 
     // Bind to potential signature received events
-    this.portal.provider.on(
+    this.provider.on(
       'portal_signatureReceived',
       ({ method: signedMethod, params: signedParams, signature }) => {
         if (
@@ -274,14 +329,14 @@ public deinit() {
     )
 
     // Pass the request along to the provider
-    await this.portal.provider.request({ method, params })
+    await this.provider.request({ method, params, connect: this })
   }
 
   private async handleSessionApproved(
     data: SessionProposalOrMetadata,
     request: SessionRequest,
   ): Promise<void> {
-    const address = await this.portal.keychain.getAddress()
+    const address = await this.address
 
     // Notify the proxy server that the session request was approved
     this.socket?.send(
@@ -289,7 +344,7 @@ public deinit() {
         event: 'portal_dappSessionApproved',
         data: {
           address,
-          chainId: this.portal.chainId,
+          chainId: this.chainId,
           topic: request.topic,
           id: request.id,
           params: data,
@@ -302,7 +357,7 @@ public deinit() {
     data: SessionProposalOrMetadata,
     request: SessionRequest,
   ): Promise<void> {
-    const address = await this.portal.keychain.getAddress()
+    const address = await this.address
 
     // Notify the proxy server that the session request was rejected
     this.socket?.send(
@@ -310,7 +365,7 @@ public deinit() {
         event: 'portal_dappSessionRejected',
         data: {
           address,
-          chainId: this.portal.chainId,
+          chainId: this.chainId,
           topic: request.topic,
           id: request.id,
           params: data,
@@ -341,6 +396,7 @@ public deinit() {
     txHash: any,
   ): Promise<void> {
     const { id, topic } = data
+
     // Let the server know the transaction hash
     this.socket?.send(
       JSON.stringify({
@@ -352,6 +408,9 @@ public deinit() {
         },
       }),
     )
+
+    // Let the SDK consumer know the transaction hash
+    this.emit('portal_signgatureReceived', txHash)
   }
 
   private async handleSigningRejected(data: SessionRequest): Promise<void> {
@@ -367,6 +426,34 @@ public deinit() {
       } as WebsocketMessage),
     )
   }
+
+  private sendFinalMessageAndClose() {
+    if (this.socket) {
+      this.connectionState = ConnectionStates.DISCONNECTING
+      this.socket.send(
+        JSON.stringify({
+          event: 'disconnect',
+          data: {
+            id: '',
+            topic: this.topic,
+          },
+        } as WebsocketMessage),
+      )
+
+      this.topic = undefined
+
+      this.socket?.close()
+
+      this.connectionState = ConnectionStates.DISCONNECTED
+    }
+  }
+}
+
+export enum ConnectionStates {
+  CONNECTED = 'CONNECTED',
+  CONNECTING = 'CONNECTING',
+  DISCONNECTED = 'DISCONNECTED',
+  DISCONNECTING = 'DISCONNECTING',
 }
 
 export type {

package/types.d.ts

@@ -1,4 +1,5 @@
 import Portal from '@portal-hq/core'
+import { KeychainAdapter } from '@portal-hq/utils'
 
 export type EventHandler = (data: any) => void
 export type SessionProposalOrMetadata = SessionProposal | PeerMetadata
@@ -41,8 +42,18 @@ export interface PeerMetadata {
 }
 
 export interface PortalConnectOptions {
-  portal: Portal
-  websocketServer?: string
+  apiKey: string
+  chainId: number
+  keychain: KeychainAdapter
+  gatewayConfig: GatewayLike
+
+  // Optional
+  isSimulator?: boolean
+  autoApprove?: boolean
+  webSocketServer?: string
+  apiHost?: string
+  mpcHost?: string
+  version?: string
 }
 
 export interface ProtocolOptions {
@@ -103,9 +114,5 @@ export interface SigningResult {
 
 export interface WebsocketMessage {
   event: string
-  data:
-    | ConnectResult
-    | DisconnectResult
-    | SessionRequest
-    | SigningResult
+  data: ConnectResult | DisconnectResult | SessionRequest | SigningResult
 }