@portal-hq/web 3.4.0 → 3.4.1-beta

package/lib/commonjs/index.js

@@ -333,6 +333,52 @@ class Portal {
             return this.getUniqueBackupMethod(allMethods);
         });
     }
+    receiveTestnetAsset(chainId, params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield ((_a = this.mpc) === null || _a === void 0 ? void 0 : _a.fund(chainId, params));
+        });
+    }
+    sendAsset(chain, params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                // Convert the chain to a chain ID
+                const chainId = this.convertChainToChainId(chain);
+                // Build the transaction
+                const buildTxResponse = yield this.buildTransaction(chainId, params.to, params.token, params.amount);
+                // Get the chain namespace
+                const chainNamespace = (_a = chainId.split(':')[0]) !== null && _a !== void 0 ? _a : '';
+                // Send the transaction based on chain namespace
+                let response;
+                switch (chainNamespace) {
+                    case 'eip155': {
+                        response = yield this.request({
+                            chainId,
+                            method: 'eth_sendTransaction',
+                            params: [buildTxResponse.transaction],
+                        });
+                        break;
+                    }
+                    case 'solana': {
+                        response = yield this.request({
+                            chainId,
+                            method: 'sol_signAndSendTransaction',
+                            params: [buildTxResponse.transaction],
+                        });
+                        break;
+                    }
+                    default: {
+                        throw new Error(`Unsupported chain namespace: ${chainNamespace}`);
+                    }
+                }
+                return response;
+            }
+            catch (error) {
+                throw new Error(`Failed to send asset: ${error.message}`);
+            }
+        });
+    }
     /****************************
      * Provider Methods
      ****************************/
@@ -718,6 +764,40 @@ class Portal {
     getUniqueBackupMethod(methods) {
         return Array.from(new Set(methods));
     }
+    convertChainToChainId(chain) {
+        // If the chain is not provided, throw an error.
+        if (!chain) {
+            throw new Error('You did not provide "chain" in the function call. Please provide a chain ID or friendly chain name.');
+        }
+        // If the chain is already in CAIP-2 format (e.g., "eip155:1"), return it as-is.
+        if (chain.includes(':')) {
+            return chain;
+        }
+        // A mapping of friendly chain names to CAIP-2 chain IDs.
+        const friendlyChainToChainId = {
+            ethereum: 'eip155:1',
+            sepolia: 'eip155:11155111',
+            base: 'eip155:8453',
+            'base-sepolia': 'eip155:84531',
+            polygon: 'eip155:137',
+            'polygon-mumbai': 'eip155:80001',
+            'polygon-amoy': 'eip155:80002',
+            solana: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp',
+            'solana-devnet': 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1',
+            optimism: 'eip155:10',
+            arbitrum: 'eip155:42161',
+            avalanche: 'eip155:43114',
+        };
+        // Convert the chain to lowercase to match the friendly chain names.
+        const lowerCaseChain = chain.toLowerCase();
+        // Get the CAIP-2 chain ID from the mapping, if it exists.
+        const chainId = friendlyChainToChainId[lowerCaseChain];
+        // If the chain is not supported, throw an error.
+        if (!chainId) {
+            throw new Error(`Unsupported chain: "${chain}". Please provide a supported chain, such as ${Object.keys(friendlyChainToChainId).join(', ')}`);
+        }
+        return chainId;
+    }
 }
 var mpc_2 = require("./mpc");
 Object.defineProperty(exports, "MpcError", { enumerable: true, get: function () { return mpc_2.MpcError; } });

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.4.0';
+const WEB_SDK_VERSION = '3.4.1-beta';
 class Mpc {
     get ready() {
         return this._ready;
@@ -475,6 +475,39 @@ class Mpc {
             });
         });
     }
+    fund(chainId, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const handleFund = (event) => {
+                    const { type, data } = event.data;
+                    const { origin } = event;
+                    // Ignore any broadcast postMessages
+                    if (origin !== this.getOrigin()) {
+                        return;
+                    }
+                    if (type === 'portal:fundError') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleFund);
+                        // Reject the promise with the error
+                        return reject(new errors_1.PortalMpcError(data));
+                    }
+                    else if (type === 'portal:fundResult') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleFund);
+                        // Resolve the promise with the result
+                        resolve(data);
+                    }
+                };
+                // Bind the function to the message event
+                window.addEventListener('message', handleFund);
+                // Send the request to the iframe
+                this.postMessage({
+                    type: 'portal:fund',
+                    data: { chainId, params },
+                });
+            });
+        });
+    }
     getClient() {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {

package/lib/esm/index.js

@@ -304,6 +304,52 @@ class Portal {
             return this.getUniqueBackupMethod(allMethods);
         });
     }
+    receiveTestnetAsset(chainId, params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield ((_a = this.mpc) === null || _a === void 0 ? void 0 : _a.fund(chainId, params));
+        });
+    }
+    sendAsset(chain, params) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                // Convert the chain to a chain ID
+                const chainId = this.convertChainToChainId(chain);
+                // Build the transaction
+                const buildTxResponse = yield this.buildTransaction(chainId, params.to, params.token, params.amount);
+                // Get the chain namespace
+                const chainNamespace = (_a = chainId.split(':')[0]) !== null && _a !== void 0 ? _a : '';
+                // Send the transaction based on chain namespace
+                let response;
+                switch (chainNamespace) {
+                    case 'eip155': {
+                        response = yield this.request({
+                            chainId,
+                            method: 'eth_sendTransaction',
+                            params: [buildTxResponse.transaction],
+                        });
+                        break;
+                    }
+                    case 'solana': {
+                        response = yield this.request({
+                            chainId,
+                            method: 'sol_signAndSendTransaction',
+                            params: [buildTxResponse.transaction],
+                        });
+                        break;
+                    }
+                    default: {
+                        throw new Error(`Unsupported chain namespace: ${chainNamespace}`);
+                    }
+                }
+                return response;
+            }
+            catch (error) {
+                throw new Error(`Failed to send asset: ${error.message}`);
+            }
+        });
+    }
     /****************************
      * Provider Methods
      ****************************/
@@ -689,6 +735,40 @@ class Portal {
     getUniqueBackupMethod(methods) {
         return Array.from(new Set(methods));
     }
+    convertChainToChainId(chain) {
+        // If the chain is not provided, throw an error.
+        if (!chain) {
+            throw new Error('You did not provide "chain" in the function call. Please provide a chain ID or friendly chain name.');
+        }
+        // If the chain is already in CAIP-2 format (e.g., "eip155:1"), return it as-is.
+        if (chain.includes(':')) {
+            return chain;
+        }
+        // A mapping of friendly chain names to CAIP-2 chain IDs.
+        const friendlyChainToChainId = {
+            ethereum: 'eip155:1',
+            sepolia: 'eip155:11155111',
+            base: 'eip155:8453',
+            'base-sepolia': 'eip155:84531',
+            polygon: 'eip155:137',
+            'polygon-mumbai': 'eip155:80001',
+            'polygon-amoy': 'eip155:80002',
+            solana: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp',
+            'solana-devnet': 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1',
+            optimism: 'eip155:10',
+            arbitrum: 'eip155:42161',
+            avalanche: 'eip155:43114',
+        };
+        // Convert the chain to lowercase to match the friendly chain names.
+        const lowerCaseChain = chain.toLowerCase();
+        // Get the CAIP-2 chain ID from the mapping, if it exists.
+        const chainId = friendlyChainToChainId[lowerCaseChain];
+        // If the chain is not supported, throw an error.
+        if (!chainId) {
+            throw new Error(`Unsupported chain: "${chain}". Please provide a supported chain, such as ${Object.keys(friendlyChainToChainId).join(', ')}`);
+        }
+        return chainId;
+    }
 }
 export { MpcError, MpcErrorCodes } from './mpc';
 export { RequestMethod } from './provider';

package/lib/esm/mpc/index.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { PortalMpcError } from './errors';
 import { BackupMethods, } from '../index';
-const WEB_SDK_VERSION = '3.4.0';
+const WEB_SDK_VERSION = '3.4.1-beta';
 class Mpc {
     get ready() {
         return this._ready;
@@ -472,6 +472,39 @@ class Mpc {
             });
         });
     }
+    fund(chainId, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                const handleFund = (event) => {
+                    const { type, data } = event.data;
+                    const { origin } = event;
+                    // Ignore any broadcast postMessages
+                    if (origin !== this.getOrigin()) {
+                        return;
+                    }
+                    if (type === 'portal:fundError') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleFund);
+                        // Reject the promise with the error
+                        return reject(new PortalMpcError(data));
+                    }
+                    else if (type === 'portal:fundResult') {
+                        // Remove the event listener
+                        window.removeEventListener('message', handleFund);
+                        // Resolve the promise with the result
+                        resolve(data);
+                    }
+                };
+                // Bind the function to the message event
+                window.addEventListener('message', handleFund);
+                // Send the request to the iframe
+                this.postMessage({
+                    type: 'portal:fund',
+                    data: { chainId, params },
+                });
+            });
+        });
+    }
     getClient() {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {

package/package.json

@@ -3,7 +3,7 @@
   "description": "Portal MPC Support for Web",
   "author": "Portal Labs, Inc.",
   "homepage": "https://portalhq.io/",
-  "version": "3.4.0",
+  "version": "3.4.1-beta",
   "license": "MIT",
   "main": "lib/commonjs/index",
   "module": "lib/esm/index",
@@ -49,5 +49,6 @@
   },
   "dependencies": {
     "@solana/web3.js": "^1.91.8"
-  }
+  },
+  "stableVersion": "3.4.0"
 }

package/src/index.ts

@@ -12,8 +12,12 @@ import {
   EvaluateTransactionOperationType,
   EvaluateTransactionParam,
   EvaluatedTransaction,
+  FundParams,
+  FundResponse,
   NFTAsset,
   OrgBackupShares,
+  SendAssetParams,
+  SendAssetResponse,
   type BackupConfigs,
   type BackupResponse,
   type Balance,
@@ -419,6 +423,62 @@ class Portal {
     return this.getUniqueBackupMethod(allMethods)
   }
 
+  public async receiveTestnetAsset(
+    chainId: string,
+    params: FundParams,
+  ): Promise<FundResponse> {
+    return await this.mpc?.fund(chainId, params)
+  }
+
+  public async sendAsset(
+    chain: string,
+    params: SendAssetParams,
+  ): Promise<SendAssetResponse> {
+    try {
+      // Convert the chain to a chain ID
+      const chainId = this.convertChainToChainId(chain)
+
+      // Build the transaction
+      const buildTxResponse = await this.buildTransaction(
+        chainId,
+        params.to,
+        params.token,
+        params.amount,
+      )
+
+      // Get the chain namespace
+      const chainNamespace = chainId.split(':')[0] ?? ''
+
+      // Send the transaction based on chain namespace
+      let response
+      switch (chainNamespace) {
+        case 'eip155': {
+          response = await this.request({
+            chainId,
+            method: 'eth_sendTransaction',
+            params: [buildTxResponse.transaction],
+          })
+          break
+        }
+        case 'solana': {
+          response = await this.request({
+            chainId,
+            method: 'sol_signAndSendTransaction',
+            params: [buildTxResponse.transaction],
+          })
+          break
+        }
+        default: {
+          throw new Error(`Unsupported chain namespace: ${chainNamespace}`)
+        }
+      }
+
+      return response
+    } catch (error: any) {
+      throw new Error(`Failed to send asset: ${error.message}`)
+    }
+  }
+
   /****************************
    * Provider Methods
    ****************************/
@@ -908,6 +968,54 @@ class Portal {
   private getUniqueBackupMethod(methods: BackupMethods[]): BackupMethods[] {
     return Array.from(new Set(methods))
   }
+
+  private convertChainToChainId(chain: string): string {
+    // If the chain is not provided, throw an error.
+    if (!chain) {
+      throw new Error(
+        'You did not provide "chain" in the function call. Please provide a chain ID or friendly chain name.',
+      )
+    }
+
+    // If the chain is already in CAIP-2 format (e.g., "eip155:1"), return it as-is.
+    if (chain.includes(':')) {
+      return chain
+    }
+
+    // A mapping of friendly chain names to CAIP-2 chain IDs.
+    const friendlyChainToChainId = {
+      ethereum: 'eip155:1',
+      sepolia: 'eip155:11155111',
+      base: 'eip155:8453',
+      'base-sepolia': 'eip155:84531',
+      polygon: 'eip155:137',
+      'polygon-mumbai': 'eip155:80001',
+      'polygon-amoy': 'eip155:80002',
+      solana: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp',
+      'solana-devnet': 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1',
+      optimism: 'eip155:10',
+      arbitrum: 'eip155:42161',
+      avalanche: 'eip155:43114',
+    }
+
+    // Convert the chain to lowercase to match the friendly chain names.
+    const lowerCaseChain =
+      chain.toLowerCase() as keyof typeof friendlyChainToChainId
+
+    // Get the CAIP-2 chain ID from the mapping, if it exists.
+    const chainId = friendlyChainToChainId[lowerCaseChain]
+
+    // If the chain is not supported, throw an error.
+    if (!chainId) {
+      throw new Error(
+        `Unsupported chain: "${chain}". Please provide a supported chain, such as ${Object.keys(
+          friendlyChainToChainId,
+        ).join(', ')}`,
+      )
+    }
+
+    return chainId
+  }
 }
 
 export { MpcError, MpcErrorCodes } from './mpc'

package/src/mpc/index.ts

@@ -37,9 +37,11 @@ import type {
   BuiltTransaction,
   EjectPrivateKeysArgs,
   EjectPrivateKeysResult,
+  FundParams,
+  FundResponse,
 } from '../../types'
 
-const WEB_SDK_VERSION = '3.4.0'
+const WEB_SDK_VERSION = '3.4.1-beta'
 
 class Mpc {
   public iframe?: HTMLIFrameElement
@@ -574,6 +576,46 @@ class Mpc {
     })
   }
 
+  public async fund(
+    chainId: string,
+    params: FundParams,
+  ): Promise<FundResponse> {
+    return new Promise((resolve, reject) => {
+      const handleFund = (event: MessageEvent<WorkerResult>) => {
+        const { type, data } = event.data
+        const { origin } = event
+
+        // Ignore any broadcast postMessages
+        if (origin !== this.getOrigin()) {
+          return
+        }
+
+        if (type === 'portal:fundError') {
+          // Remove the event listener
+          window.removeEventListener('message', handleFund)
+
+          // Reject the promise with the error
+          return reject(new PortalMpcError(data as PortalError))
+        } else if (type === 'portal:fundResult') {
+          // Remove the event listener
+          window.removeEventListener('message', handleFund)
+
+          // Resolve the promise with the result
+          resolve(data as FundResponse)
+        }
+      }
+
+      // Bind the function to the message event
+      window.addEventListener('message', handleFund)
+
+      // Send the request to the iframe
+      this.postMessage({
+        type: 'portal:fund',
+        data: { chainId, params },
+      })
+    })
+  }
+
   public async getClient(): Promise<ClientResponse> {
     return new Promise((resolve, reject) => {
       const handleGetClient = (event: MessageEvent<WorkerResult>) => {

package/types.d.ts

@@ -69,6 +69,49 @@ export interface Balance {
   balance: string
 }
 
+export interface SendAssetParams {
+  amount: string
+  to: string
+  token: string
+}
+
+export interface SendAssetResponse {
+  transactionHash: string
+  metadata: {
+    amount?: string
+    lastValidBlockHeight?: string
+    rawAmount?: string
+    tokenAddress?: string
+    tokenDecimals?: number
+    tokenSymbol?: string
+  }
+}
+
+export interface FundParams {
+  amount: string
+  token: string
+}
+
+export interface FundResponseData {
+  explorerUrl: string
+  txHash: string
+}
+
+export interface FundResponseMetadata {
+  amount: string
+  chainId: string
+  clientId: string
+  custodianId: string
+  environmentId: string
+  token: string
+}
+
+export interface FundResponse {
+  data?: FundResponseData
+  metadata: FundResponseMetadata
+  error?: string
+}
+
 export interface SharesOnDeviceResponse {
   ED25519: boolean
   SECP256K1: boolean