@portal-hq/web 3.10.0 → 3.11.0-alpha.0

package/README.md

@@ -8,6 +8,7 @@ Welcome to the `@portal-hq/web` SDK, the official TypeScript library for integra
 - **PortalContext Provider**: Expose the Portal instance to your React component tree.
 - **usePortal Hook**: Consume the Portal instance within your child components for easy access and interaction.
 - **Types and Enums**: Utilize helper types and enums for efficient development with the Portal SDK.
+- **Configurable Log Level**: Control SDK logging via `logLevel` and `logger` options and the `setLogLevel` / `getLogLevel` methods.
 
 ## Documentation
 

package/lib/commonjs/index.js

@@ -45,6 +45,7 @@ const security_1 = __importDefault(require("./integrations/security"));
 const delegations_1 = __importDefault(require("./integrations/delegations"));
 const passkeys_1 = __importDefault(require("./passkeys"));
 const evmAccountType_1 = require("./namespaces/evmAccountType");
+const logger_1 = require("./logger");
 class Portal {
     get ready() {
         return this.mpc.ready;
@@ -53,9 +54,10 @@ class Portal {
     // Required
     rpcConfig, 
     // Optional
-    apiKey, authToken, authUrl, autoApprove = false, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v6', mpcHost = 'mpc-client.portalhq.io', featureFlags = {}, chainId, }) {
+    apiKey, authToken, authUrl, autoApprove = false, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v6', mpcHost = 'mpc-client.portalhq.io', featureFlags = {}, chainId, logLevel = 'none', logger = console, }) {
         this.errorCallbacks = [];
         this.readyCallbacks = [];
+        this.logger = console;
         this.sendEth = ({ chainId, to, value, }) => __awaiter(this, void 0, void 0, function* () {
             return this.provider.request({
                 chainId,
@@ -78,6 +80,10 @@ class Portal {
         this.mpcHost = mpcHost;
         this.mpcVersion = mpcVersion;
         this.featureFlags = featureFlags;
+        this.logger = logger;
+        // SDK logging is global: one shared logger for the entire runtime. The last Portal
+        // created or the last setLogLevel() call wins for all instances.
+        logger_1.sdkLogger.configure(logLevel, logger);
         if (gdrive) {
             this.gDriveConfig = gdrive;
         }
@@ -97,6 +103,27 @@ class Portal {
         });
         this.evmAccountType = new evmAccountType_1.EvmAccountType({ mpc: this.mpc });
     }
+    /***********************************
+     * Logging
+     ***********************************/
+    /**
+     * Set the SDK log level. Use this to enable or disable SDK logging at runtime.
+     * Note: Logging configuration is global for the entire SDK runtime. Changing the
+     * level on one Portal instance affects all Portal instances and all SDK log output.
+     * @example
+     * portal.setLogLevel('debug') // Enable verbose logging
+     * portal.setLogLevel('none')  // Disable all logs
+     */
+    setLogLevel(level) {
+        logger_1.sdkLogger.configure(level, this.logger);
+    }
+    /**
+     * Get the current SDK log level.
+     * Note: This returns the global SDK log level (shared across all Portal instances).
+     */
+    getLogLevel() {
+        return logger_1.sdkLogger.getLogLevel();
+    }
     /*****************************
      * Initialization Methods
      *****************************/
@@ -463,6 +490,7 @@ class Portal {
                             method: 'eth_sendTransaction',
                             params: [buildTxResponse.transaction],
                             sponsorGas: params.sponsorGas,
+                            signatureApprovalMemo: params.signatureApprovalMemo,
                         });
                         break;
                     }
@@ -472,6 +500,7 @@ class Portal {
                             method: 'sol_signAndSendTransaction',
                             params: [buildTxResponse.transaction],
                             sponsorGas: params.sponsorGas,
+                            signatureApprovalMemo: params.signatureApprovalMemo,
                         });
                         break;
                     }
@@ -508,7 +537,7 @@ class Portal {
      */
     ethEstimateGas(chainId, transaction) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.warn('"portal.ethEstimateGas" is deprecated. Use "portal.request" instead.');
+            logger_1.sdkLogger.warn('"portal.ethEstimateGas" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
                 method: provider_1.RequestMethod.eth_estimateGas,
@@ -526,7 +555,7 @@ class Portal {
      */
     ethGasPrice(chainId) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.warn('"portal.ethGasPrice" is deprecated. Use "portal.request" instead.');
+            logger_1.sdkLogger.warn('"portal.ethGasPrice" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
                 method: provider_1.RequestMethod.eth_gasPrice,
@@ -544,7 +573,7 @@ class Portal {
      */
     ethGetBalance(chainId) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.warn('"portal.ethGetBalance" is deprecated. Use "portal.request" instead.');
+            logger_1.sdkLogger.warn('"portal.ethGetBalance" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
                 method: provider_1.RequestMethod.eth_getBalance,
@@ -563,7 +592,7 @@ class Portal {
      */
     ethSendTransaction(chainId, transaction) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.warn('"portal.ethSendTransaction" is deprecated. Use "portal.request" instead.');
+            logger_1.sdkLogger.warn('"portal.ethSendTransaction" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
                 method: provider_1.RequestMethod.eth_sendTransaction,
@@ -582,7 +611,7 @@ class Portal {
      */
     ethSignTransaction(chainId, transaction) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.warn('"portal.ethSignTransaction" is deprecated. Use "portal.request" instead.');
+            logger_1.sdkLogger.warn('"portal.ethSignTransaction" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
                 method: provider_1.RequestMethod.eth_signTransaction,
@@ -601,7 +630,7 @@ class Portal {
      */
     ethSignTypedData(chainId, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.warn('"portal.ethSignTypedData" is deprecated. Use "portal.request" instead.');
+            logger_1.sdkLogger.warn('"portal.ethSignTypedData" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
                 method: provider_1.RequestMethod.eth_signTypedData,
@@ -620,7 +649,7 @@ class Portal {
      */
     ethSignTypedDataV3(chainId, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.warn('"portal.ethSignTypedDataV3" is deprecated. Use "portal.request" instead.');
+            logger_1.sdkLogger.warn('"portal.ethSignTypedDataV3" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
                 method: provider_1.RequestMethod.eth_signTypedData_v3,
@@ -639,7 +668,7 @@ class Portal {
      */
     ethSignTypedDataV4(chainId, data) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.warn('"portal.ethSignTypedDataV4" is deprecated. Use "portal.request" instead.');
+            logger_1.sdkLogger.warn('"portal.ethSignTypedDataV4" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
                 method: provider_1.RequestMethod.eth_signTypedData_v4,
@@ -649,7 +678,7 @@ class Portal {
     }
     personalSign(chainId, message) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.warn('"portal.personalSign" is deprecated. Use "portal.request" instead.');
+            logger_1.sdkLogger.warn('"portal.personalSign" is deprecated. Use "portal.request" instead.');
             return (yield this.provider.request({
                 chainId,
                 method: provider_1.RequestMethod.personal_sign,
@@ -657,9 +686,9 @@ class Portal {
             }));
         });
     }
-    rawSign(curve, param) {
+    rawSign(curve, param, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.mpc.rawSign(curve, param);
+            const response = yield this.mpc.rawSign(curve, param, options);
             return response;
         });
     }

package/lib/commonjs/index.test.js

@@ -701,6 +701,22 @@ describe('Portal', () => {
             expect(portal.mpc.storedClientBackupShare).toHaveBeenCalledWith(true, _1.BackupMethods.password);
         }));
     });
+    describe('Logging', () => {
+        it('should default log level to "none"', () => {
+            expect(portal.getLogLevel()).toBe('none');
+        });
+        it('should use logLevel from constructor options', () => {
+            const p = new _1.default({ rpcConfig: constants_1.mockRpcConfig, logLevel: 'debug' });
+            expect(p.getLogLevel()).toBe('debug');
+        });
+        it('should update log level when setLogLevel is called', () => {
+            expect(portal.getLogLevel()).toBe('none');
+            portal.setLogLevel('warn');
+            expect(portal.getLogLevel()).toBe('warn');
+            portal.setLogLevel('error');
+            expect(portal.getLogLevel()).toBe('error');
+        });
+    });
     describe('getRpcUrl', () => {
         it('should return the correct rpc url for the given chainId', () => {
             expect(portal.getRpcUrl('eip155:1')).toEqual(constants_1.mockEthRpcUrl);

package/lib/commonjs/logger/index.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SdkLogger = exports.sdkLogger = void 0;
+const LOG_LEVEL_PRIORITY = {
+    none: 0,
+    error: 1,
+    warn: 2,
+    info: 3,
+    debug: 4,
+};
+class SdkLogger {
+    constructor() {
+        this.logLevel = 'none';
+        this.logger = console;
+    }
+    configure(logLevel, logger = console) {
+        this.logLevel = logLevel;
+        this.logger = logger;
+    }
+    getLogLevel() {
+        return this.logLevel;
+    }
+    shouldLog(level) {
+        return LOG_LEVEL_PRIORITY[level] <= LOG_LEVEL_PRIORITY[this.logLevel];
+    }
+    log(level, args) {
+        if (!this.shouldLog(level))
+            return;
+        try {
+            this.logger[level](...args);
+        }
+        catch (err) {
+            console.error('[Portal SDK] Logger error, falling back to console', {
+                level,
+                error: err,
+            });
+            console[level](...args);
+        }
+    }
+    error(...args) {
+        this.log('error', args);
+    }
+    warn(...args) {
+        this.log('warn', args);
+    }
+    info(...args) {
+        this.log('info', args);
+    }
+    debug(...args) {
+        this.log('debug', args);
+    }
+}
+exports.SdkLogger = SdkLogger;
+const sdkLogger = new SdkLogger();
+exports.sdkLogger = sdkLogger;

package/lib/commonjs/mpc/index.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MpcErrorCodes = exports.MpcError = void 0;
 const errors_1 = require("./errors");
 const index_1 = require("../index");
-const WEB_SDK_VERSION = '3.10.0';
+const WEB_SDK_VERSION = '3.11.0-alpha.0';
 class Mpc {
     get ready() {
         return this._ready;
@@ -150,16 +150,16 @@ class Mpc {
             });
         });
     }
-    rawSign(curve, param) {
+    rawSign(curve, param, options) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.handleRequestToIframeAndPost({
                 methodMessage: 'portal:mpc:rawSign',
                 errorMessage: 'portal:mpc:rawSignError',
                 resultMessage: 'portal:mpc:rawSignResult',
-                data: {
-                    curve,
-                    param,
-                },
+                data: Object.assign({ curve,
+                    param }, ((options === null || options === void 0 ? void 0 : options.signatureApprovalMemo) !== undefined && {
+                    signatureApprovalMemo: options.signatureApprovalMemo,
+                })),
             });
         });
     }

package/lib/commonjs/namespaces/evmAccountType/index.js

@@ -30,6 +30,22 @@ class EvmAccountType {
             });
         });
     }
+    /**
+     * Get EOA and smart contract addresses for the wallet on the given chain.
+     * Returns addresses from the account-type API.
+     * @param {EvmAccountTypeGetStatusRequest} params - The request parameters (chain id, e.g. eip155:1)
+     * @returns {Promise<GetAddressesResponse>} The EOA and smart contract addresses
+     */
+    getAddresses({ chain, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.mpc.handleRequestToIframeAndPost({
+                methodMessage: 'portal:evmAccountType:getAddresses',
+                errorMessage: 'portal:evmAccountType:getAddressesError',
+                resultMessage: 'portal:evmAccountType:getAddressesResult',
+                data: { chain },
+            });
+        });
+    }
     /**
      * Build the authorization list for a given chain.
      * @param {BuildAuthorizationListRequest} params - The request parameters

package/lib/commonjs/namespaces/evmAccountType/index.test.js

@@ -91,6 +91,73 @@ describe('EvmAccountType', () => {
             });
         });
     });
+    /*******************************
+     * getAddresses Tests
+     *******************************/
+    describe('getAddresses', () => {
+        const args = constants_1.mockGetAddressesRequest;
+        const res = constants_1.mockGetAddressesResponse;
+        it('should successfully get EVM addresses', (done) => {
+            var _a;
+            jest
+                .spyOn((_a = mpc.iframe) === null || _a === void 0 ? void 0 : _a.contentWindow, 'postMessage')
+                .mockImplementation((message, origin) => {
+                const { type, data } = message;
+                expect(type).toEqual('portal:evmAccountType:getAddresses');
+                expect(data).toEqual(args);
+                expect(origin).toEqual(mockHostOrigin);
+                window.dispatchEvent(new MessageEvent('message', {
+                    origin: mockHostOrigin,
+                    data: {
+                        type: 'portal:evmAccountType:getAddressesResult',
+                        data: res,
+                    },
+                }));
+            });
+            evmAccountType
+                .getAddresses(args)
+                .then((data) => {
+                expect(data).toEqual(res);
+                done();
+            })
+                .catch((_) => {
+                expect(0).toEqual(1);
+                done();
+            });
+        });
+        it('should error out if the iframe sends an error message', (done) => {
+            var _a;
+            jest
+                .spyOn((_a = mpc.iframe) === null || _a === void 0 ? void 0 : _a.contentWindow, 'postMessage')
+                .mockImplementationOnce((message, origin) => {
+                const { type, data } = message;
+                expect(type).toEqual('portal:evmAccountType:getAddresses');
+                expect(data).toEqual(args);
+                expect(origin).toEqual(mockHostOrigin);
+                window.dispatchEvent(new MessageEvent('message', {
+                    origin: mockHostOrigin,
+                    data: {
+                        type: 'portal:evmAccountType:getAddressesError',
+                        data: {
+                            code: 1,
+                            message: 'test',
+                        },
+                    },
+                }));
+            });
+            evmAccountType
+                .getAddresses(args)
+                .then((_) => {
+                expect(0).toEqual(1);
+                done();
+            })
+                .catch((error) => {
+                expect(error).toBeInstanceOf(errors_1.PortalMpcError);
+                expect(error.message).toEqual('test');
+                done();
+            });
+        });
+    });
     /*******************************
      * buildAuthorizationList Tests
      *******************************/

package/lib/commonjs/passkeys/index.js

@@ -21,6 +21,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PasskeyService = void 0;
+const logger_1 = require("../logger");
 class PasskeyService {
     constructor({ defaultDomain, getJwt, fetchImpl }) {
         this.defaultDomain = defaultDomain;
@@ -201,7 +202,7 @@ class PasskeyService {
                 return data.status;
             }
             catch (error) {
-                console.warn('[Portal] Failed to fetch passkey status', error);
+                logger_1.sdkLogger.warn('[Portal] Failed to fetch passkey status', error);
                 return undefined;
             }
         });

package/lib/commonjs/provider/index.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestMethod = void 0;
 const errors_1 = require("./errors");
+const logger_1 = require("../logger");
 var RequestMethod;
 (function (RequestMethod) {
     RequestMethod["eth_accounts"] = "eth_accounts";
@@ -260,7 +261,7 @@ class Provider {
      * @param args The arguments of the request being made
      * @returns Promise<any>
      */
-    request({ chainId: requestChainId, method, params, sponsorGas, }) {
+    request({ chainId: requestChainId, method, params, sponsorGas, signatureApprovalMemo, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const isSignerMethod = signerMethods.includes(method);
             const chainId = this.getCAIP2ChainId(requestChainId);
@@ -289,6 +290,7 @@ class Provider {
                     method,
                     params,
                     sponsorGas,
+                    signatureApprovalMemo,
                 });
                 if (transactionHash) {
                     this.emit('portal_signatureReceived', {
@@ -326,7 +328,7 @@ class Provider {
      *
      * @param args The arguments of the request being made
      */
-    getApproval({ method, params, }) {
+    getApproval({ method, params, signatureApprovalMemo, }) {
         return __awaiter(this, void 0, void 0, function* () {
             // If autoApprove is enabled, just resolve to true
             if (this.portal.autoApprove) {
@@ -365,10 +367,10 @@ class Provider {
                 // If the signing request has been rejected, resolve to false
                 this.on('portal_signingRejected', handleRejection);
                 // Tell any listening clients that signing has been requested
-                this.emit('portal_signingRequested', {
-                    method,
-                    params,
-                });
+                const signingRequestedPayload = signatureApprovalMemo !== undefined
+                    ? { method, params, signatureApprovalMemo }
+                    : { method, params };
+                this.emit('portal_signingRequested', signingRequestedPayload);
             });
         });
     }
@@ -404,13 +406,13 @@ class Provider {
      * @param args The arguments of the request being made
      * @returns Promise<any>
      */
-    handleSigningRequest({ chainId, method, params, sponsorGas, }) {
+    handleSigningRequest({ chainId, method, params, sponsorGas, signatureApprovalMemo, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const isApproved = passiveSignerMethods.includes(method)
                 ? true
-                : yield this.getApproval({ method, params });
+                : yield this.getApproval({ method, params, signatureApprovalMemo });
             if (!isApproved) {
-                console.warn(`[PortalProvider] Request for signing method '${method}' could not be completed because it was not approved by the user.`);
+                logger_1.sdkLogger.warn(`[PortalProvider] Request for signing method '${method}' could not be completed because it was not approved by the user.`);
                 return;
             }
             switch (method) {
@@ -431,13 +433,9 @@ class Provider {
                 case RequestMethod.eth_signTypedData_v4:
                 case RequestMethod.personal_sign: {
                     this.enforceEip155ChainId(chainId);
-                    const result = yield this.portal.mpc.sign({
-                        chainId: chainId,
-                        method,
-                        params: this.buildParams(method, params),
-                        rpcUrl: this.portal.getRpcUrl(chainId),
-                        sponsorGas,
-                    });
+                    const result = yield this.portal.mpc.sign(Object.assign({ chainId: chainId, method, params: this.buildParams(method, params), rpcUrl: this.portal.getRpcUrl(chainId), sponsorGas }, (signatureApprovalMemo !== undefined && {
+                        signatureApprovalMemo,
+                    })));
                     return result;
                 }
                 case RequestMethod.sol_signAndConfirmTransaction:
@@ -451,6 +449,7 @@ class Provider {
                         params: this.buildParams(method, params),
                         rpcUrl: this.portal.getRpcUrl(chainId),
                         sponsorGas,
+                        signatureApprovalMemo,
                     });
                     return result;
                 }

package/lib/commonjs/provider/index.test.js

@@ -21,6 +21,7 @@ const constants_1 = require("../__mocks/constants");
 const errors_1 = require("./errors");
 const __1 = require("../");
 const mpc_1 = __importDefault(require("../__mocks/portal/mpc"));
+const logger_1 = require("../logger");
 describe('Provider', () => {
     beforeEach(() => {
         portal_1.default.autoApprove = true;
@@ -495,11 +496,15 @@ describe('Provider', () => {
             const mockSignatureReceivedHandler = jest.fn();
             const mockConsoleWarn = jest.spyOn(global.console, 'warn');
             beforeEach(() => {
+                logger_1.sdkLogger.configure('warn', console);
                 provider = new _1.default({ portal: portal_1.default });
                 portal_1.default.autoApprove = false;
                 provider.on('portal_signingRequested', mockSigningRequestedHandler);
                 provider.on('portal_signatureReceived', mockSignatureReceivedHandler);
             });
+            afterEach(() => {
+                logger_1.sdkLogger.configure('none');
+            });
             describe('eth_chainId', () => {
                 it('should successfully handle an eth_chainId request', () => __awaiter(void 0, void 0, void 0, function* () {
                     const result = yield provider.request({