@portal-hq/provider 2.0.2 → 2.0.4

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() {
@@ -181,7 +182,7 @@ class Provider {
      * @param args The arguments of the request being made
      * @returns Promise<any>
      */
-    request({ method, params, connect, }) {
+    request({ method, params, chainId, connect, }) {
         return __awaiter(this, void 0, void 0, function* () {
             if (method === 'eth_chainId') {
                 return this.chainId;
@@ -206,6 +207,7 @@ class Provider {
                 const transactionHash = yield this.handleSigningRequests({
                     method,
                     params,
+                    chainId,
                     connect,
                 });
                 if (transactionHash) {
@@ -249,7 +251,7 @@ class Provider {
             this.emit('chainChanged', {
                 chainId: this.chainId,
             });
-            if (connect) {
+            if (connect && connect.connected) {
                 connect.emit('portalConnect_chainChanged', {
                     chainId: this.chainId,
                 });
@@ -264,7 +266,7 @@ class Provider {
      *
      * @param args The arguments of the request being made
      */
-    getApproval({ method, params, connect, }) {
+    getApproval({ method, params, chainId, connect, }) {
         return __awaiter(this, void 0, void 0, function* () {
             // If autoApprove is enabled, just resolve to true
             if (this.autoApprove) {
@@ -305,12 +307,14 @@ class Provider {
                     connect.emit('portalConnect_signingRequested', {
                         method,
                         params,
+                        chainId,
                     });
                 }
                 else {
                     this.emit('portal_signingRequested', {
                         method,
                         params,
+                        chainId,
                     });
                 }
             });
@@ -348,12 +352,12 @@ class Provider {
      * @param args The arguments of the request being made
      * @returns Promise<any>
      */
-    handleSigningRequests({ method, params, connect, }) {
+    handleSigningRequests({ method, params, chainId, connect, }) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const isApproved = passiveSignerMethods.includes(method)
                 ? true
-                : yield this.getApproval({ method, params, connect });
+                : yield this.getApproval({ method, params, chainId, connect });
             if (!isApproved) {
                 this.log.info(`[PortalProvider] Request for signing method '${method}' could not be completed because it was not approved by the user.`);
                 return;

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.`);
         }
@@ -61,7 +62,12 @@ class MpcSigner {
                     break;
             }
             const signingShare = yield this.signingShare;
-            const result = yield this.mpc.sign(apiKey, this.mpcHost, signingShare, message.method, JSON.stringify(this.buildParams(method, params)), provider.gatewayUrl, provider.chainId.toString(), this.version);
+            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));
             if (error && error.code > 0) {
                 throw new utils_1.PortalMpcError(error);

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() {
@@ -179,7 +180,7 @@ class Provider {
      * @param args The arguments of the request being made
      * @returns Promise<any>
      */
-    request({ method, params, connect, }) {
+    request({ method, params, chainId, connect, }) {
         return __awaiter(this, void 0, void 0, function* () {
             if (method === 'eth_chainId') {
                 return this.chainId;
@@ -204,6 +205,7 @@ class Provider {
                 const transactionHash = yield this.handleSigningRequests({
                     method,
                     params,
+                    chainId,
                     connect,
                 });
                 if (transactionHash) {
@@ -247,7 +249,7 @@ class Provider {
             this.emit('chainChanged', {
                 chainId: this.chainId,
             });
-            if (connect) {
+            if (connect && connect.connected) {
                 connect.emit('portalConnect_chainChanged', {
                     chainId: this.chainId,
                 });
@@ -262,7 +264,7 @@ class Provider {
      *
      * @param args The arguments of the request being made
      */
-    getApproval({ method, params, connect, }) {
+    getApproval({ method, params, chainId, connect, }) {
         return __awaiter(this, void 0, void 0, function* () {
             // If autoApprove is enabled, just resolve to true
             if (this.autoApprove) {
@@ -303,12 +305,14 @@ class Provider {
                     connect.emit('portalConnect_signingRequested', {
                         method,
                         params,
+                        chainId,
                     });
                 }
                 else {
                     this.emit('portal_signingRequested', {
                         method,
                         params,
+                        chainId,
                     });
                 }
             });
@@ -346,12 +350,12 @@ class Provider {
      * @param args The arguments of the request being made
      * @returns Promise<any>
      */
-    handleSigningRequests({ method, params, connect, }) {
+    handleSigningRequests({ method, params, chainId, connect, }) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const isApproved = passiveSignerMethods.includes(method)
                 ? true
-                : yield this.getApproval({ method, params, connect });
+                : yield this.getApproval({ method, params, chainId, connect });
             if (!isApproved) {
                 this.log.info(`[PortalProvider] Request for signing method '${method}' could not be completed because it was not approved by the user.`);
                 return;

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.`);
         }
@@ -59,7 +60,12 @@ class MpcSigner {
                     break;
             }
             const signingShare = yield this.signingShare;
-            const result = yield this.mpc.sign(apiKey, this.mpcHost, signingShare, message.method, JSON.stringify(this.buildParams(method, params)), provider.gatewayUrl, provider.chainId.toString(), this.version);
+            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));
             if (error && error.code > 0) {
                 throw new PortalMpcError(error);

package/package.json

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

package/src/providers/index.ts

@@ -74,6 +74,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 +113,10 @@ class Provider implements IPortalProvider {
 
     // Initialize an MpcSigner
     this.signer = new MpcSigner({
-      mpcHost: mpcHost,
-      keychain: keychain,
-      version: version,
+      mpcHost,
+      keychain,
+      version,
+      featureFlags,
     })
   }
 
@@ -252,6 +254,7 @@ class Provider implements IPortalProvider {
   public async request({
     method,
     params,
+    chainId,
     connect,
   }: RequestArguments): Promise<any> {
     if (method === 'eth_chainId') {
@@ -281,6 +284,7 @@ class Provider implements IPortalProvider {
       const transactionHash = await this.handleSigningRequests({
         method,
         params,
+        chainId,
         connect,
       })
 
@@ -314,7 +318,10 @@ class Provider implements IPortalProvider {
    * @param chainId The numerical ID of the chain to switch to
    * @returns BaseProvider
    */
-  public async setChainId(chainId: number, connect?: PortalConnect): Promise<Provider> {
+  public async setChainId(
+    chainId: number,
+    connect?: PortalConnect,
+  ): Promise<Provider> {
     // Update the chainId
     this.chainId = chainId
 
@@ -328,8 +335,7 @@ class Provider implements IPortalProvider {
       chainId: this.chainId,
     } as SwitchEthereumChainParameter)
 
-
-    if (connect) {
+    if (connect && connect.connected) {
       connect.emit('portalConnect_chainChanged', {
         chainId: this.chainId,
       } as SwitchEthereumChainParameter)
@@ -348,6 +354,7 @@ class Provider implements IPortalProvider {
   protected async getApproval({
     method,
     params,
+    chainId,
     connect,
   }: RequestArguments): Promise<boolean> {
     // If autoApprove is enabled, just resolve to true
@@ -409,11 +416,13 @@ class Provider implements IPortalProvider {
         connect.emit('portalConnect_signingRequested', {
           method,
           params,
+          chainId,
         })
       } else {
         this.emit('portal_signingRequested', {
           method,
           params,
+          chainId,
         })
       }
     })
@@ -455,11 +464,12 @@ class Provider implements IPortalProvider {
   private async handleSigningRequests({
     method,
     params,
+    chainId,
     connect,
   }: RequestArguments): Promise<any> {
     const isApproved = passiveSignerMethods.includes(method)
       ? true
-      : await this.getApproval({ method, params, connect })
+      : await this.getApproval({ method, params, chainId, connect })
 
     if (!isApproved) {
       this.log.info(

package/src/signers/mpc.ts

@@ -13,6 +13,7 @@ import {
   type PortalMobileMpc,
   type SigningResponse,
 } from '../../types'
+import { FeatureFlags } from '@portal-hq/core/types'
 
 class MpcSigner implements Signer {
   private isSimulator: boolean
@@ -20,6 +21,7 @@ class MpcSigner implements Signer {
   private mpc: PortalMobileMpc
   private mpcHost: string // should we add a default here mpc.portalhq.io
   private version: string = 'v4'
+  private featureFlags: FeatureFlags
 
   private get address(): Promise<string | undefined> {
     return this.keychain.getAddress(this.isSimulator)
@@ -34,12 +36,14 @@ 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(
@@ -68,6 +72,12 @@ class MpcSigner implements Signer {
 
     const signingShare = await this.signingShare
 
+    const metadata = JSON.stringify({
+      clientPlatform: 'REACT_NATIVE',
+      mpcServerVersion: this.version,
+      optimized: this.featureFlags.optimized,
+    })
+
     const result = await this.mpc.sign(
       apiKey,
       this.mpcHost,
@@ -76,7 +86,7 @@ class MpcSigner implements Signer {
       JSON.stringify(this.buildParams(method, params)),
       provider.gatewayUrl,
       provider.chainId.toString(),
-      this.version,
+      metadata,
     )
 
     const { data, error } = JSON.parse(String(result)) as SigningResponse

package/types.d.ts

@@ -22,20 +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,
-    mpcVersion: string,
+    metadata: string,
   ) => Promise<string>
   rotate: (
     clientApiKey: string,
     mpcApiUrl: string,
     isSim: boolean,
     dkgResult?: string,
-    mpcVersion: string,
+    metadata: string,
   ) => Promise<string>
   sign: (
     clientApiKey: string,
@@ -45,7 +52,7 @@ export interface PortalMobileMpc {
     requestId: string,
     mpcUrl: string,
     chainId: string,
-    mpcVersion: string,
+    metadata: string,
   ) => Promise<string>
 }
 
@@ -62,6 +69,7 @@ export interface ProviderOptions {
   apiHost?: string
   mpcHost?: string
   version?: string
+  featureFlags?: FeatureFlags
 }
 
 export interface RegisteredEventHandler {