@portal-hq/provider 2.0.3 → 2.0.6

package/lib/commonjs/providers/index.js

@@ -32,7 +32,7 @@ class Provider {
     // Required
     apiKey, chainId, keychain, gatewayConfig, 
     // Optional
-    isSimulator = false, autoApprove = false, apiHost = 'api.portalhq.io', mpcHost = 'mpc.portalhq.io', version = 'v4', }) {
+    isSimulator = false, autoApprove = false, apiHost = 'api.portalhq.io', mpcHost = 'mpc.portalhq.io', version = 'v4', featureFlags = { optimized: false }, }) {
         // Handle required fields
         if (!apiKey || apiKey.length === 0) {
             throw new utils_1.InvalidApiKeyError();
@@ -65,9 +65,10 @@ class Provider {
         });
         // Initialize an MpcSigner
         this.signer = new signers_1.MpcSigner({
-            mpcHost: mpcHost,
-            keychain: keychain,
-            version: version,
+            mpcHost,
+            keychain,
+            version,
+            featureFlags,
         });
     }
     get address() {
@@ -106,6 +107,7 @@ class Provider {
             return this.gatewayConfig;
         }
         else if (typeof this.gatewayConfig === 'object' &&
+            // eslint-disable-next-line no-prototype-builtins
             !this.gatewayConfig.hasOwnProperty(this.chainId)) {
             // If there's no explicit mapping for the current chainId, error out
             throw new Error(`[PortalProvider] No RPC endpoint configured for chainId: ${this.chainId}`);
@@ -257,7 +259,7 @@ class Provider {
             }
             // Dispatch 'connect' event
             this.dispatchConnect();
-            return this;
+            return new Promise((resolve) => resolve(this));
         });
     }
     /**
@@ -320,10 +322,8 @@ class Provider {
         });
     }
     dispatchConnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.emit('connect', {
-                chainId: `0x${this.chainId.toString(16)}`,
-            });
+        this.emit('connect', {
+            chainId: `0x${this.chainId.toString(16)}`,
         });
     }
     /**
@@ -371,7 +371,7 @@ class Provider {
                 case 'eth_signTransaction':
                 case 'eth_signTypedData_v3':
                 case 'eth_signTypedData_v4':
-                case 'personal_sign':
+                case 'personal_sign': {
                     const result = yield ((_a = this.signer) === null || _a === void 0 ? void 0 : _a.sign({ chainId: this.chainId, method, params }, this));
                     if (result) {
                         try {
@@ -393,6 +393,7 @@ class Provider {
                         }
                     }
                     return result;
+                }
                 default:
                     throw new Error('[PortalProvider] Method "' + method + '" not supported');
             }

package/lib/commonjs/signers/abstract.js

@@ -1,19 +1,8 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 class Signer {
     sign(_, __) {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new Error('[Portal] sign() method must be implemented in a subclass of Signer');
-        });
+        throw new Error('[Portal] sign() method must be implemented in a subclass of Signer');
     }
 }
 exports.default = Signer;

package/lib/commonjs/signers/mpc.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const react_native_1 = require("react-native");
 const utils_1 = require("@portal-hq/utils");
 class MpcSigner {
-    constructor({ keychain, isSimulator = false, mpcHost = 'mpc.portalhq.io', version = 'v4', }) {
+    constructor({ keychain, isSimulator = false, mpcHost = 'mpc.portalhq.io', version = 'v4', featureFlags = { optimized: false }, }) {
         this.version = 'v4';
         this.buildParams = (method, txParams) => {
             let params = txParams;
@@ -37,6 +37,7 @@ class MpcSigner {
         this.mpc = react_native_1.NativeModules.PortalMobileMpc;
         this.mpcHost = mpcHost;
         this.version = version;
+        this.featureFlags = featureFlags;
         if (!this.mpc) {
             throw new Error(`[Portal.Provider.MpcSigner] The MPC module could not be found by the signer. This is usually an issue with React Native linking. Please verify that the 'PortalReactNative' module is properly linked to this project.`);
         }
@@ -64,6 +65,7 @@ class MpcSigner {
             const metadata = JSON.stringify({
                 clientPlatform: 'REACT_NATIVE',
                 mpcServerVersion: this.version,
+                optimized: this.featureFlags.optimized,
             });
             const result = yield this.mpc.sign(apiKey, this.mpcHost, signingShare, message.method, JSON.stringify(this.buildParams(method, params)), provider.gatewayUrl, provider.chainId.toString(), metadata);
             const { data, error } = JSON.parse(String(result));

package/lib/esm/providers/index.js

@@ -30,7 +30,7 @@ class Provider {
     // Required
     apiKey, chainId, keychain, gatewayConfig, 
     // Optional
-    isSimulator = false, autoApprove = false, apiHost = 'api.portalhq.io', mpcHost = 'mpc.portalhq.io', version = 'v4', }) {
+    isSimulator = false, autoApprove = false, apiHost = 'api.portalhq.io', mpcHost = 'mpc.portalhq.io', version = 'v4', featureFlags = { optimized: false }, }) {
         // Handle required fields
         if (!apiKey || apiKey.length === 0) {
             throw new InvalidApiKeyError();
@@ -63,9 +63,10 @@ class Provider {
         });
         // Initialize an MpcSigner
         this.signer = new MpcSigner({
-            mpcHost: mpcHost,
-            keychain: keychain,
-            version: version,
+            mpcHost,
+            keychain,
+            version,
+            featureFlags,
         });
     }
     get address() {
@@ -104,6 +105,7 @@ class Provider {
             return this.gatewayConfig;
         }
         else if (typeof this.gatewayConfig === 'object' &&
+            // eslint-disable-next-line no-prototype-builtins
             !this.gatewayConfig.hasOwnProperty(this.chainId)) {
             // If there's no explicit mapping for the current chainId, error out
             throw new Error(`[PortalProvider] No RPC endpoint configured for chainId: ${this.chainId}`);
@@ -255,7 +257,7 @@ class Provider {
             }
             // Dispatch 'connect' event
             this.dispatchConnect();
-            return this;
+            return new Promise((resolve) => resolve(this));
         });
     }
     /**
@@ -318,10 +320,8 @@ class Provider {
         });
     }
     dispatchConnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.emit('connect', {
-                chainId: `0x${this.chainId.toString(16)}`,
-            });
+        this.emit('connect', {
+            chainId: `0x${this.chainId.toString(16)}`,
         });
     }
     /**
@@ -369,7 +369,7 @@ class Provider {
                 case 'eth_signTransaction':
                 case 'eth_signTypedData_v3':
                 case 'eth_signTypedData_v4':
-                case 'personal_sign':
+                case 'personal_sign': {
                     const result = yield ((_a = this.signer) === null || _a === void 0 ? void 0 : _a.sign({ chainId: this.chainId, method, params }, this));
                     if (result) {
                         try {
@@ -391,6 +391,7 @@ class Provider {
                         }
                     }
                     return result;
+                }
                 default:
                     throw new Error('[PortalProvider] Method "' + method + '" not supported');
             }

package/lib/esm/signers/abstract.js

@@ -1,17 +1,6 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 class Signer {
     sign(_, __) {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new Error('[Portal] sign() method must be implemented in a subclass of Signer');
-        });
+        throw new Error('[Portal] sign() method must be implemented in a subclass of Signer');
     }
 }
 export default Signer;

package/lib/esm/signers/mpc.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { NativeModules } from 'react-native';
 import { PortalMpcError, } from '@portal-hq/utils';
 class MpcSigner {
-    constructor({ keychain, isSimulator = false, mpcHost = 'mpc.portalhq.io', version = 'v4', }) {
+    constructor({ keychain, isSimulator = false, mpcHost = 'mpc.portalhq.io', version = 'v4', featureFlags = { optimized: false }, }) {
         this.version = 'v4';
         this.buildParams = (method, txParams) => {
             let params = txParams;
@@ -35,6 +35,7 @@ class MpcSigner {
         this.mpc = NativeModules.PortalMobileMpc;
         this.mpcHost = mpcHost;
         this.version = version;
+        this.featureFlags = featureFlags;
         if (!this.mpc) {
             throw new Error(`[Portal.Provider.MpcSigner] The MPC module could not be found by the signer. This is usually an issue with React Native linking. Please verify that the 'PortalReactNative' module is properly linked to this project.`);
         }
@@ -62,6 +63,7 @@ class MpcSigner {
             const metadata = JSON.stringify({
                 clientPlatform: 'REACT_NATIVE',
                 mpcServerVersion: this.version,
+                optimized: this.featureFlags.optimized,
             });
             const result = yield this.mpc.sign(apiKey, this.mpcHost, signingShare, message.method, JSON.stringify(this.buildParams(method, params)), provider.gatewayUrl, provider.chainId.toString(), metadata);
             const { data, error } = JSON.parse(String(result));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portal-hq/provider",
-  "version": "2.0.3",
+  "version": "2.0.6",
   "license": "MIT",
   "main": "lib/commonjs/index",
   "module": "lib/esm/index",
@@ -19,8 +19,8 @@
     "test": "jest"
   },
   "dependencies": {
-    "@portal-hq/connect": "^2.0.3",
-    "@portal-hq/utils": "^2.0.3"
+    "@portal-hq/connect": "^2.0.6",
+    "@portal-hq/utils": "^2.0.6"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.18.6",
@@ -30,5 +30,5 @@
     "ts-jest": "^29.0.3",
     "typescript": "^4.8.4"
   },
-  "gitHead": "c333fe5280f16a5c5f70b7ae768f112baf7156ba"
+  "gitHead": "d933407992d91fd46d22b003233626dcb06dbf5b"
 }

package/src/providers/index.ts

@@ -20,6 +20,7 @@ import {
   type SwitchEthereumChainParameter,
 } from '../../types'
 import PortalConnect from '@portal-hq/connect'
+import { RpcErrorOptions } from '@portal-hq/utils/types'
 
 const passiveSignerMethods = [
   'eth_accounts',
@@ -74,6 +75,7 @@ class Provider implements IPortalProvider {
     apiHost = 'api.portalhq.io',
     mpcHost = 'mpc.portalhq.io',
     version = 'v4',
+    featureFlags = { optimized: false },
   }: ProviderOptions) {
     // Handle required fields
     if (!apiKey || apiKey.length === 0) {
@@ -112,9 +114,10 @@ class Provider implements IPortalProvider {
 
     // Initialize an MpcSigner
     this.signer = new MpcSigner({
-      mpcHost: mpcHost,
-      keychain: keychain,
-      version: version,
+      mpcHost,
+      keychain,
+      version,
+      featureFlags,
     })
   }
 
@@ -152,11 +155,12 @@ class Provider implements IPortalProvider {
       return this.gatewayConfig
     } else if (
       typeof this.gatewayConfig === 'object' &&
+      // eslint-disable-next-line no-prototype-builtins
       !this.gatewayConfig.hasOwnProperty(this.chainId)
     ) {
       // If there's no explicit mapping for the current chainId, error out
       throw new Error(
-        `[PortalProvider] No RPC endpoint configured for chainId: ${this.chainId}`,
+        `[PortalProvider] No RPC endpoint configured for chainId: ${this.chainId}`
       )
     }
 
@@ -169,7 +173,7 @@ class Provider implements IPortalProvider {
 
     // If we got this far, there's no way to support the chain with the current config
     throw new Error(
-      `[PortalProvider] Could not find a valid gatewayConfig entry for chainId: ${this.chainId}`,
+      `[PortalProvider] Could not find a valid gatewayConfig entry for chainId: ${this.chainId}`
     )
   }
 
@@ -223,7 +227,7 @@ class Provider implements IPortalProvider {
 
   public removeEventListener(
     event: string,
-    listenerToRemove?: EventHandler,
+    listenerToRemove?: EventHandler
   ): void {
     if (!this.events[event]) {
       return
@@ -233,7 +237,7 @@ class Provider implements IPortalProvider {
       this.events[event] = []
     } else {
       const filterEventHandlers = (
-        registeredEventHandler: RegisteredEventHandler,
+        registeredEventHandler: RegisteredEventHandler
       ) => {
         return registeredEventHandler.handler !== listenerToRemove
       }
@@ -273,7 +277,7 @@ class Provider implements IPortalProvider {
       })
 
       if (response.error) {
-        throw new ProviderRpcError(response.error)
+        throw new ProviderRpcError(response.error as RpcErrorOptions)
       }
 
       result = response.result
@@ -318,7 +322,7 @@ class Provider implements IPortalProvider {
    */
   public async setChainId(
     chainId: number,
-    connect?: PortalConnect,
+    connect?: PortalConnect
   ): Promise<Provider> {
     // Update the chainId
     this.chainId = chainId
@@ -341,7 +345,7 @@ class Provider implements IPortalProvider {
     // Dispatch 'connect' event
     this.dispatchConnect()
 
-    return this
+    return new Promise((resolve) => resolve(this))
   }
 
   /**
@@ -364,7 +368,7 @@ class Provider implements IPortalProvider {
 
     if (!connect && (!signingHandlers || signingHandlers.length === 0)) {
       throw new Error(
-        `[PortalProvider] Auto-approve is disabled. Cannot perform Provider signing requests without an event handler for the 'portal_signingRequested' event.`,
+        `[PortalProvider] Auto-approve is disabled. Cannot perform Provider signing requests without an event handler for the 'portal_signingRequested' event.`
       )
     }
 
@@ -388,7 +392,7 @@ class Provider implements IPortalProvider {
           ) {
             resolve(true)
           }
-        },
+        }
       )
 
       // If the signing request has been rejected, resolve to false
@@ -406,7 +410,7 @@ class Provider implements IPortalProvider {
           ) {
             resolve(false)
           }
-        },
+        }
       )
 
       // Tell any listening clients that signing has been requested
@@ -426,7 +430,7 @@ class Provider implements IPortalProvider {
     })
   }
 
-  private async dispatchConnect(): Promise<void> {
+  private dispatchConnect() {
     this.emit('connect', {
       chainId: `0x${this.chainId.toString(16)}`,
     })
@@ -471,7 +475,7 @@ class Provider implements IPortalProvider {
 
     if (!isApproved) {
       this.log.info(
-        `[PortalProvider] Request for signing method '${method}' could not be completed because it was not approved by the user.`,
+        `[PortalProvider] Request for signing method '${method}' could not be completed because it was not approved by the user.`
       )
       return
     }
@@ -486,10 +490,10 @@ class Provider implements IPortalProvider {
       case 'eth_signTransaction':
       case 'eth_signTypedData_v3':
       case 'eth_signTypedData_v4':
-      case 'personal_sign':
+      case 'personal_sign': {
         const result = await this.signer?.sign(
           { chainId: this.chainId, method, params },
-          this,
+          this
         )
 
         if (result) {
@@ -512,9 +516,10 @@ class Provider implements IPortalProvider {
         }
 
         return result
+      }
       default:
         throw new Error(
-          '[PortalProvider] Method "' + method + '" not supported',
+          '[PortalProvider] Method "' + method + '" not supported'
         )
     }
   }

package/src/signers/abstract.ts

@@ -2,9 +2,9 @@ import { SigningRequestArguments } from '@portal-hq/utils'
 import { type SignResult } from '../../types'
 
 abstract class Signer {
-  public async sign(_: SigningRequestArguments, __?: any): Promise<SignResult> {
+  public sign(_: SigningRequestArguments, __?: any): Promise<SignResult> {
     throw new Error(
-      '[Portal] sign() method must be implemented in a subclass of Signer',
+      '[Portal] sign() method must be implemented in a subclass of Signer'
     )
   }
 }

package/src/signers/mpc.ts

@@ -13,13 +13,15 @@ import {
   type PortalMobileMpc,
   type SigningResponse,
 } from '../../types'
+import { FeatureFlags } from '@portal-hq/core/types'
 
 class MpcSigner implements Signer {
   private isSimulator: boolean
   private keychain: KeychainAdapter
   private mpc: PortalMobileMpc
   private mpcHost: string // should we add a default here mpc.portalhq.io
-  private version: string = 'v4'
+  private version = 'v4'
+  private featureFlags: FeatureFlags
 
   private get address(): Promise<string | undefined> {
     return this.keychain.getAddress(this.isSimulator)
@@ -34,23 +36,25 @@ class MpcSigner implements Signer {
     isSimulator = false,
     mpcHost = 'mpc.portalhq.io',
     version = 'v4',
+    featureFlags = { optimized: false },
   }: MpcSignerOptions) {
     this.isSimulator = isSimulator
     this.keychain = keychain
     this.mpc = NativeModules.PortalMobileMpc
     this.mpcHost = mpcHost
     this.version = version
+    this.featureFlags = featureFlags
 
     if (!this.mpc) {
       throw new Error(
-        `[Portal.Provider.MpcSigner] The MPC module could not be found by the signer. This is usually an issue with React Native linking. Please verify that the 'PortalReactNative' module is properly linked to this project.`,
+        `[Portal.Provider.MpcSigner] The MPC module could not be found by the signer. This is usually an issue with React Native linking. Please verify that the 'PortalReactNative' module is properly linked to this project.`
       )
     }
   }
 
   public async sign(
     message: SigningRequestArguments,
-    provider: IPortalProvider,
+    provider: IPortalProvider
   ): Promise<any> {
     const address = await this.address
     const apiKey = provider.apiKey
@@ -71,6 +75,7 @@ class MpcSigner implements Signer {
     const metadata = JSON.stringify({
       clientPlatform: 'REACT_NATIVE',
       mpcServerVersion: this.version,
+      optimized: this.featureFlags.optimized,
     })
 
     const result = await this.mpc.sign(
@@ -81,7 +86,7 @@ class MpcSigner implements Signer {
       JSON.stringify(this.buildParams(method, params)),
       provider.gatewayUrl,
       provider.chainId.toString(),
-      metadata,
+      metadata
     )
 
     const { data, error } = JSON.parse(String(result)) as SigningResponse

package/types.d.ts

@@ -22,25 +22,27 @@ export interface MpcSignerOptions extends SignerOptions {
   isSimulator?: boolean
   mpcHost?: string
   version?: string
+  featureFlags?: FeatureFlags
 }
 
 export interface PortalMobileMpcMetadata {
   clientPlatform: string
   mpcServerVersion: string
+  optimized: boolean
 }
 
 export interface PortalMobileMpc {
   generate: (
     clientApiKey: string,
     mpcApiUrl: string,
-    metadata: string,
+    metadata: string
   ) => Promise<string>
   rotate: (
     clientApiKey: string,
     mpcApiUrl: string,
     isSim: boolean,
     dkgResult?: string,
-    metadata: string,
+    metadata: string
   ) => Promise<string>
   sign: (
     clientApiKey: string,
@@ -50,7 +52,7 @@ export interface PortalMobileMpc {
     requestId: string,
     mpcUrl: string,
     chainId: string,
-    metadata: string,
+    metadata: string
   ) => Promise<string>
 }
 
@@ -67,6 +69,7 @@ export interface ProviderOptions {
   apiHost?: string
   mpcHost?: string
   version?: string
+  featureFlags?: FeatureFlags
 }
 
 export interface RegisteredEventHandler {