@portal-hq/web 3.2.3 → 3.3.1

package/README.md

@@ -19,7 +19,7 @@ For a comprehensive guide and API reference, please visit our [documentation por
 
 - Node.js and npm or yarn installed.
 - Basic knowledge of TypeScript and React.
-- Access to a Portal Account. 
+- Access to a Portal Account.
 
 ### Installation
 

package/lib/commonjs/index.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 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) {
@@ -12,23 +35,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PortalCurve = exports.GetTransactionsOrder = exports.BackupMethods = exports.MpcStatuses = exports.MpcErrorCodes = exports.MpcError = void 0;
+exports.ChainNamespace = exports.PortalCurve = exports.GetTransactionsOrder = exports.BackupMethods = exports.MpcStatuses = exports.RequestMethod = exports.MpcErrorCodes = exports.MpcError = void 0;
 const web3_js_1 = require("@solana/web3.js");
 const mpc_1 = __importDefault(require("./mpc"));
-const provider_1 = __importDefault(require("./provider"));
+const provider_1 = __importStar(require("./provider"));
 class Portal {
+    get ready() {
+        return this.mpc.ready;
+    }
     constructor({ 
     // Required
     rpcConfig, 
     // Optional
-    apiKey, authToken, authUrl, autoApprove = false, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v6', mpcHost = 'mpc-client.portalhq.io', featureFlags = {}, }) {
-        this.ready = false;
+    apiKey, authToken, authUrl, autoApprove = false, gdrive, passkey, host = 'web.portalhq.io', mpcVersion = 'v6', mpcHost = 'mpc-client.portalhq.io', featureFlags = {}, chainId, }) {
         this.errorCallbacks = [];
         this.readyCallbacks = [];
         this.sendEth = ({ chainId, to, value, }) => __awaiter(this, void 0, void 0, function* () {
             return this.provider.request({
                 chainId,
-                method: 'eth_sendTransaction',
+                method: provider_1.RequestMethod.eth_sendTransaction,
                 params: [
                     {
                         from: this.address,
@@ -58,6 +83,7 @@ class Portal {
         });
         this.provider = new provider_1.default({
             portal: this,
+            chainId: chainId ? Number(chainId) : undefined,
         });
     }
     /*****************************
@@ -225,6 +251,60 @@ class Portal {
             return sharesOnDevice.ED25519 && sharesOnDevice.SECP256K1;
         });
     }
+    isWalletBackedUp(chainId) {
+        var _a, _b, _c, _d, _e;
+        return __awaiter(this, void 0, void 0, function* () {
+            const client = yield ((_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getClient());
+            if (chainId) {
+                const namespace = ((_b = chainId === null || chainId === void 0 ? void 0 : chainId.split(':')) === null || _b === void 0 ? void 0 : _b[0]) || '';
+                const curve = (_e = (_d = (_c = client === null || client === void 0 ? void 0 : client.metadata) === null || _c === void 0 ? void 0 : _c.namespaces) === null || _d === void 0 ? void 0 : _d[namespace]) === null || _e === void 0 ? void 0 : _e.curve;
+                if (!curve) {
+                    return false;
+                }
+                const wallet = client === null || client === void 0 ? void 0 : client.wallets.find((w) => w.curve === curve);
+                if (!wallet) {
+                    return false;
+                }
+                return wallet.backupSharePairs.some((share) => share.status === 'completed');
+            }
+            else {
+                return client === null || client === void 0 ? void 0 : client.wallets.some((wallet) => wallet.backupSharePairs.some((share) => share.status === 'completed'));
+            }
+        });
+    }
+    isWalletRecoverable(chainId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const availableRecoveryMethods = yield this.availableRecoveryMethods(chainId);
+            return availableRecoveryMethods.length > 0;
+        });
+    }
+    availableRecoveryMethods(chainId) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            const client = yield ((_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getClient());
+            // If the client is not found, return an empty array.
+            if (!client) {
+                return [];
+            }
+            // If a chainId is provided, return the recovery methods for that chain.
+            if (chainId) {
+                const namespace = chainId.split(':')[0] || '';
+                const curve = (_d = (_c = (_b = client.metadata) === null || _b === void 0 ? void 0 : _b.namespaces) === null || _c === void 0 ? void 0 : _c[namespace]) === null || _d === void 0 ? void 0 : _d.curve;
+                if (!curve) {
+                    return [];
+                }
+                const wallet = client.wallets.find((w) => w.curve === curve);
+                if (!wallet) {
+                    return [];
+                }
+                const methods = this.extractBackupMethod(wallet);
+                return this.getUniqueBackupMethod(methods);
+            }
+            // Otherwise, return the recovery methods for all wallets.
+            const allMethods = client.wallets.flatMap((wallet) => this.extractBackupMethod(wallet));
+            return this.getUniqueBackupMethod(allMethods);
+        });
+    }
     /****************************
      * Provider Methods
      ****************************/
@@ -233,6 +313,9 @@ class Portal {
             return this.provider.request(request);
         });
     }
+    updateChain(newChainId) {
+        this.provider.setChainId(Number(newChainId));
+    }
     /**
      * Estimates the amount of gas that will be required to execute an Ethereum transaction.
      *
@@ -247,7 +330,7 @@ class Portal {
             console.warn('"portal.ethEstimateGas" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
-                method: 'eth_estimateGas',
+                method: provider_1.RequestMethod.eth_estimateGas,
                 params: transaction,
             });
         });
@@ -265,7 +348,7 @@ class Portal {
             console.warn('"portal.ethGasPrice" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
-                method: 'eth_gasPrice',
+                method: provider_1.RequestMethod.eth_gasPrice,
                 params: [],
             });
         });
@@ -283,7 +366,7 @@ class Portal {
             console.warn('"portal.ethGetBalance" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
-                method: 'eth_getBalance',
+                method: provider_1.RequestMethod.eth_getBalance,
                 params: [this.address, 'latest'],
             });
         });
@@ -302,7 +385,7 @@ class Portal {
             console.warn('"portal.ethSendTransaction" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
-                method: 'eth_sendTransaction',
+                method: provider_1.RequestMethod.eth_sendTransaction,
                 params: transaction,
             });
         });
@@ -321,7 +404,7 @@ class Portal {
             console.warn('"portal.ethSignTransaction" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
-                method: 'eth_signTransaction',
+                method: provider_1.RequestMethod.eth_signTransaction,
                 params: transaction,
             });
         });
@@ -340,7 +423,7 @@ class Portal {
             console.warn('"portal.ethSignTypedData" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
-                method: 'eth_signTypedData',
+                method: provider_1.RequestMethod.eth_signTypedData,
                 params: [this.address, data],
             });
         });
@@ -359,7 +442,7 @@ class Portal {
             console.warn('"portal.ethSignTypedDataV3" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
-                method: 'eth_signTypedData_v3',
+                method: provider_1.RequestMethod.eth_signTypedData_v3,
                 params: [this.address, data],
             });
         });
@@ -378,7 +461,7 @@ class Portal {
             console.warn('"portal.ethSignTypedDataV4" is deprecated. Use "portal.request" instead.');
             return this.provider.request({
                 chainId,
-                method: 'eth_signTypedData_v4',
+                method: provider_1.RequestMethod.eth_signTypedData_v4,
                 params: [this.address, data],
             });
         });
@@ -388,7 +471,7 @@ class Portal {
             console.warn('"portal.personalSign" is deprecated. Use "portal.request" instead.');
             return (yield this.provider.request({
                 chainId,
-                method: 'personal_sign',
+                method: provider_1.RequestMethod.personal_sign,
                 params: [this.stringToHex(message), this.address],
             }));
         });
@@ -417,7 +500,7 @@ class Portal {
             // Get the most recent blockhash.
             const blockhashResponse = yield this.provider.request({
                 chainId: chainId,
-                method: 'getLatestBlockhash',
+                method: provider_1.RequestMethod.sol_getLatestBlockhash,
                 params: [],
             });
             const blockhash = ((_a = blockhashResponse === null || blockhashResponse === void 0 ? void 0 : blockhashResponse.value) === null || _a === void 0 ? void 0 : _a.blockhash) || '';
@@ -464,7 +547,7 @@ class Portal {
             // Attempt to sign and send the transaction
             const transactionResult = yield this.provider.request({
                 chainId: chainId,
-                method: 'sol_signAndSendTransaction',
+                method: provider_1.RequestMethod.sol_signAndSendTransaction,
                 params: [formattedTransaction],
             });
             // If we didn't get a transactionResult, throw an error.
@@ -478,6 +561,9 @@ class Portal {
     /*******************************
      * API Methods
      *******************************/
+    /**
+     * @deprecated This method is deprecated. Use `portal.getAssets` instead.
+     */
     getBalances(chainId) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -490,6 +576,9 @@ class Portal {
             return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getClient();
         });
     }
+    /**
+     * @deprecated This method is deprecated. Use `portal.getNFTAssets` instead.
+     */
     getNFTs(chainId) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -502,12 +591,39 @@ class Portal {
             return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getTransactions(chainId, limit, offset, order);
         });
     }
+    /**
+     * @deprecated This method is deprecated. Use `portal.evaluateTransaction` instead.
+     */
     simulateTransaction(chainId, transaction) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.simulateTransaction(transaction, chainId);
         });
     }
+    evaluateTransaction(chainId, transaction, operationType = 'all') {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.evaluateTransaction(chainId, transaction, operationType);
+        });
+    }
+    getAssets(chainId, includeNfts = false) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getAssets(chainId, includeNfts);
+        });
+    }
+    getNFTAssets(chainId) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.getNFTAssets(chainId);
+        });
+    }
+    buildTransaction(chainId, to, token, amount) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return (_a = this.mpc) === null || _a === void 0 ? void 0 : _a.buildTransaction(chainId, to, token, amount);
+        });
+    }
     /*******************************
      * Swaps Methods
      *******************************/
@@ -554,9 +670,6 @@ class Portal {
         // Otherwise, something is wrong with the configuration.
         throw new Error(`[Portal] Could not find a valid rpcConfig entry for chainId: ${chainId}`);
     }
-    /**************************
-     * RPC Encoding Methods
-     **************************/
     stringToHex(str) {
         if (str.startsWith('0x')) {
             return str;
@@ -569,10 +682,20 @@ class Portal {
         }
         return hex;
     }
+    extractBackupMethod(wallet) {
+        return wallet.backupSharePairs
+            .filter((share) => share.status === 'completed')
+            .map((share) => share.backupMethod);
+    }
+    getUniqueBackupMethod(methods) {
+        return Array.from(new Set(methods));
+    }
 }
 var mpc_2 = require("./mpc");
 Object.defineProperty(exports, "MpcError", { enumerable: true, get: function () { return mpc_2.MpcError; } });
 Object.defineProperty(exports, "MpcErrorCodes", { enumerable: true, get: function () { return mpc_2.MpcErrorCodes; } });
+var provider_2 = require("./provider");
+Object.defineProperty(exports, "RequestMethod", { enumerable: true, get: function () { return provider_2.RequestMethod; } });
 var MpcStatuses;
 (function (MpcStatuses) {
     MpcStatuses["DecryptingShare"] = "Decrypting share";
@@ -602,4 +725,9 @@ var PortalCurve;
     PortalCurve["ED25519"] = "ED25519";
     PortalCurve["SECP256K1"] = "SECP256K1";
 })(PortalCurve = exports.PortalCurve || (exports.PortalCurve = {}));
+var ChainNamespace;
+(function (ChainNamespace) {
+    ChainNamespace["EIP155"] = "eip155";
+    ChainNamespace["SOLANA"] = "solana";
+})(ChainNamespace = exports.ChainNamespace || (exports.ChainNamespace = {}));
 exports.default = Portal;