@portal-hq/provider 0.2.7 → 0.2.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portal-hq/provider",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "license": "MIT",
   "main": "lib/commonjs/index",
   "module": "lib/esm/index",
@@ -17,7 +17,7 @@
     "prepare:esm": "tsc --outDir lib/esm --module es2015 --target es2015"
   },
   "dependencies": {
-    "@portal-hq/utils": "^0.2.7"
+    "@portal-hq/utils": "^0.2.9"
   },
   "devDependencies": {
     "typescript": "^4.8.4"

package/src/providers/index.ts

@@ -43,7 +43,7 @@ class Provider {
   public chainId: number
   public isMPC?: boolean
 
-  private _address: string
+  private _address: string = ''
   private apiUrl: string
   private autoApprove?: boolean
   private events: Record<string, RegisteredEventHandler[]>
@@ -108,6 +108,7 @@ class Provider {
     } else {
       // If MPC is disabled, initialize an HttpSigner, talking to whatever httpHost was provided
       this.signer = new HttpSigner({
+        keychain: this.keychain,
         portal: this.portal,
       })
     }
@@ -387,14 +388,6 @@ class Provider {
     })
   }
 
-  private async dispatchDisconnect(): Promise<void> {
-    this.emit('disconnect', {
-      error: new ProviderRpcError({
-        code: RpcErrorCodes.Disconnected,
-      }),
-    })
-  }
-
   /**
    * Determines the RPC URL to be used for the current chain
    *

package/src/requesters/http.ts

@@ -1,9 +1,9 @@
-import { HttpRequest } from '@portal-hq/utils'
 import {
+  HttpRequest,
   type HttpRequestOptions,
   type HttpOptions,
   type HttpRequesterOptions,
-} from '@portal-hq/utils/types'
+} from '@portal-hq/utils'
 
 class HttpRequester {
   private baseUrl: string

package/src/signers/abstract.ts

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

package/src/signers/http.ts

@@ -1,11 +1,10 @@
-import { Keychain } from '@portal-hq/keychain'
-import { MissingOptionError } from '@portal-hq/utils'
-
 import {
-  type HttpSignerOptions,
-  type SigningRequestArguments,
-  type SignResult,
-} from '../../types'
+  KeychainAdapter,
+  MissingOptionError,
+  SigningRequestArguments,
+} from '@portal-hq/utils'
+
+import { type HttpSignerOptions, type SignResult } from '../../types'
 
 import Signer from './abstract'
 import { Provider } from '../index'
@@ -13,7 +12,7 @@ import HttpRequester from '../requesters/http'
 
 class HttpSigner implements Signer {
   private portal: HttpRequester
-  private keychain: Keychain
+  private keychain: KeychainAdapter
 
   constructor(opts: HttpSignerOptions) {
     if (!opts.portal) {
@@ -23,7 +22,7 @@ class HttpSigner implements Signer {
       })
     }
 
-    this.keychain = new Keychain()
+    this.keychain = opts.keychain
     this.portal = opts.portal
   }
 
@@ -32,7 +31,6 @@ class HttpSigner implements Signer {
     provider: Provider,
   ): Promise<any> {
     const address = await this.keychain.getAddress()
-    const arrayMethods = ['personal_sign']
     const { chainId, method, params } = message
 
     switch (method) {

package/src/signers/mpc.ts

@@ -1,5 +1,9 @@
 import { NativeModules } from 'react-native'
-import { KeychainAdapter, MpcSigningError } from '@portal-hq/utils'
+import {
+  KeychainAdapter,
+  MpcSigningError,
+  type SigningRequestArguments,
+} from '@portal-hq/utils'
 
 import { Provider } from '../index'
 import Signer from './abstract'
@@ -7,12 +11,11 @@ import Signer from './abstract'
 import {
   type MpcSignerOptions,
   type PortalMobileMpc,
-  type SigningRequestArguments,
   type SigningResponse,
 } from '../../types'
 
 class MpcSigner implements Signer {
-  public _address: string
+  public _address: string = ''
   private keychain: KeychainAdapter
   private mpc: PortalMobileMpc
   private mpcUrl: string

package/types.d.ts

@@ -19,6 +19,7 @@ export interface HttpRequesterOptions {
 }
 
 export interface HttpSignerOptions extends SignerOptions {
+  keychain: KeychainAdapter
   portal: HttpRequester
 }
 
@@ -77,13 +78,6 @@ export interface SignResult {
 
 export interface SignerOptions {}
 
-export interface SigningRequestArguments {
-  readonly chainId?: number
-  readonly method: string
-  readonly params?: unknown[] | SigningRequestParams
-  readonly requestId?: string
-}
-
 export interface SigningRequestParams {
   gas?: string
 }

package/lib/commonjs/index.js

@@ -1,8 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Provider = void 0;
-var providers_1 = require("./providers");
-Object.defineProperty(exports, "Provider", { enumerable: true, get: function () { return __importDefault(providers_1).default; } });

package/lib/commonjs/providers/index.js

@@ -1,383 +0,0 @@
-"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 });
-const utils_1 = require("@portal-hq/utils");
-const requesters_1 = require("../requesters");
-const signers_1 = require("../signers");
-const passiveSignerMethods = [
-    'eth_accounts',
-    'eth_chainId',
-    'eth_requestAccounts',
-];
-const signerMethods = [
-    'eth_accounts',
-    'eth_chainId',
-    'eth_requestAccounts',
-    'eth_sendTransaction',
-    'eth_sign',
-    'eth_signTransaction',
-    'eth_signTypedData',
-    'personal_sign',
-];
-class Provider {
-    constructor({ 
-    // Required options
-    apiKey, chainId, keychain, 
-    // Optional options
-    apiUrl = 'api.portalhq.io', autoApprove = false, enableMpc = true, mpcUrl = 'mpc.portalhq.io', gatewayConfig = {}, }) {
-        // Handle required fields
-        if (!apiKey || apiKey.length === 0) {
-            throw new utils_1.InvalidApiKeyError();
-        }
-        if (!chainId) {
-            throw new utils_1.InvalidChainIdError();
-        }
-        if (!gatewayConfig) {
-            throw new utils_1.InvalidGatewayConfigError();
-        }
-        // Handle the stuff we can auto-set
-        this.apiKey = apiKey;
-        this.apiUrl = apiUrl;
-        this.autoApprove = autoApprove;
-        this.chainId = chainId;
-        this.events = {};
-        this.isMPC = enableMpc;
-        this.keychain = keychain;
-        this.log = console;
-        this.mpcUrl = mpcUrl;
-        this.portal = new requesters_1.HttpRequester({
-            baseUrl: this.apiUrl,
-        });
-        // Handle RPC Initialization
-        this.gatewayConfig = gatewayConfig;
-        this.rpc = new requesters_1.HttpRequester({
-            baseUrl: this.getRpcUrl(),
-        });
-        if (this.isMPC) {
-            // If MPC is enabled, initialize an MpcSigner
-            this.signer = new signers_1.MpcSigner({
-                mpcUrl: this.mpcUrl,
-                keychain: this.keychain,
-            });
-        }
-        else {
-            // If MPC is disabled, initialize an HttpSigner, talking to whatever httpHost was provided
-            this.signer = new signers_1.HttpSigner({
-                portal: this.portal,
-            });
-        }
-        this.dispatchConnect();
-    }
-    get address() {
-        return this._address;
-    }
-    set address(value) {
-        this._address = value;
-        if (this.signer && this.isMPC) {
-            ;
-            this.signer._address = value;
-        }
-    }
-    get rpcUrl() {
-        return this.getRpcUrl();
-    }
-    /**
-     * Invokes all registered event handlers with the data provided
-     * - If any `once` handlers exist, they are removed after all handlers are invoked
-     *
-     * @param event The name of the event to be handled
-     * @param data The data to be passed to registered event handlers
-     * @returns BaseProvider
-     */
-    emit(event, data) {
-        // Grab the registered event handlers if any are available
-        const handlers = this.events[event] || [];
-        // Execute every event handler
-        for (const registeredEventHandler of handlers) {
-            registeredEventHandler.handler(data);
-        }
-        // Remove any registered event handlers with the `once` flag
-        this.events[event] = handlers.filter((handler) => !handler.once);
-        return this;
-    }
-    /**
-     * Registers an event handler for the provided event
-     *
-     * @param event The event name to add a handler to
-     * @param callback The callback to be invoked when the event is emitted
-     * @returns BaseProvider
-     */
-    on(event, callback) {
-        // If no handlers are registered for this event, create an entry for the event
-        if (!this.events[event]) {
-            this.events[event] = [];
-        }
-        // Register event handler with the rudimentary event bus
-        if (typeof callback !== 'undefined') {
-            this.events[event].push({
-                handler: callback,
-                once: false,
-            });
-        }
-        return this;
-    }
-    /**
-     * Registers a single-execution event handler for the provided event
-     *
-     * @param event The event name to add a handler to
-     * @param callback The callback to be invoked the next time the event is emitted
-     * @returns BaseProvider
-     */
-    once(event, callback) {
-        // If no handlers are registered for this event, create an entry for the event
-        if (!this.events[event]) {
-            this.events[event] = [];
-        }
-        // Register event handler with the rudimentary event bus
-        if (typeof callback !== 'undefined') {
-            this.events[event].push({
-                handler: callback,
-                once: true,
-            });
-        }
-        return this;
-    }
-    removeEventListener(event, listenerToRemove) {
-        if (!this.events[event]) {
-            this.log.info(`[PortalProvider] Attempted to remove a listener from unregistered event '${event}'. Ignoring.`);
-            return;
-        }
-        if (!listenerToRemove) {
-            this.events[event] = [];
-        }
-        else {
-            const filterEventHandlers = (registeredEventHandler) => {
-                return registeredEventHandler.handler !== listenerToRemove;
-            };
-            this.events[event] = this.events[event].filter(filterEventHandlers);
-        }
-    }
-    /**
-     * Handles request routing in compliance with the EIP-1193 Ethereum Javascript Provider API
-     * - See here for more info: https://eips.ethereum.org/EIPS/eip-1193
-     *
-     * @param args The arguments of the request being made
-     * @returns Promise<any>
-     */
-    request({ method, params }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (method === 'eth_chainId') {
-                return this.chainId;
-            }
-            const isSignerMethod = signerMethods.includes(method);
-            let result;
-            if (!isSignerMethod && !method.startsWith('wallet_')) {
-                // Send to Gateway for RPC calls
-                const response = yield this.handleGatewayRequests({ method, params });
-                this.emit('portal_signatureReceived', {
-                    method,
-                    params,
-                    signature: response,
-                });
-                if (response.error) {
-                    throw new utils_1.ProviderRpcError(response.error);
-                }
-                result = response.result;
-            }
-            else if (isSignerMethod) {
-                // Handle signing
-                const transactionHash = yield this.handleSigningRequests({
-                    method,
-                    params,
-                });
-                if (transactionHash) {
-                    console.log(`Received transaction hash: `, transactionHash);
-                    this.emit('portal_signatureReceived', {
-                        method,
-                        params,
-                        signature: transactionHash,
-                    });
-                    result = transactionHash;
-                }
-            }
-            else {
-                // Unsupported method
-                throw new utils_1.ProviderRpcError({
-                    code: utils_1.RpcErrorCodes.UnsupportedMethod,
-                    data: {
-                        method,
-                        params,
-                    },
-                });
-            }
-            return result;
-        });
-    }
-    /**
-     * Updates the chainId of this instance and builds a new RPC HttpRequester for
-     * the gateway used for the new chain
-     *
-     * @param chainId A hex string of the chainId to use for this connection
-     * @returns BaseProvider
-     */
-    updateChainId(chainId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.chainId = Number(`${chainId}`);
-            this.rpc = new requesters_1.HttpRequester({
-                baseUrl: this.getRpcUrl(),
-            });
-            this.emit('chainChanged', { chainId });
-            return this;
-        });
-    }
-    /**
-     * Kicks off the approval flow for a given request
-     *
-     * @param args The arguments of the request being made
-     */
-    getApproval({ method, params, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // If autoApprove is enabled, just resolve to true
-            if (this.autoApprove) {
-                return true;
-            }
-            if (!this.events['portal_signingRequested']) {
-                throw new Error(`[PortalProvider] Auto-approve is disabled. Cannot perform signing requests without an event handler for the 'portal_signingRequested' event.`);
-            }
-            return new Promise((resolve) => {
-                // Remove already used listeners
-                this.removeEventListener('portal_signingApproved');
-                this.removeEventListener('portal_signingRejected');
-                // If the signing has been approved, resolve to true
-                this.once('portal_signingApproved', ({ method: approvedMethod, params: approvedParams }) => {
-                    console.log(`[PortalProvider] Signing Approved`, method, params);
-                    // Remove already used listeners
-                    this.removeEventListener('portal_signingApproved');
-                    this.removeEventListener('portal_signingRejected');
-                    // First verify that this is the same signing request
-                    if (method === approvedMethod &&
-                        JSON.stringify(params) === JSON.stringify(approvedParams)) {
-                        resolve(true);
-                    }
-                });
-                // If the signing request has been rejected, resolve to false
-                this.once('portal_signingRejected', ({ method: rejectedMethod, params: rejectedParams }) => {
-                    console.log(`[PortalProvider] Signing Approved`, method, params);
-                    // Remove already used listeners
-                    this.removeEventListener('portal_signingApproved');
-                    this.removeEventListener('portal_signingRejected');
-                    // First verify that this is the same signing request
-                    if (method === rejectedMethod &&
-                        JSON.stringify(params) === JSON.stringify(rejectedParams)) {
-                        resolve(false);
-                    }
-                });
-                // Tell any listening clients that signing has been requested
-                this.emit('portal_signingRequested', {
-                    method,
-                    params,
-                });
-            });
-        });
-    }
-    dispatchConnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            console.log(`[PortalProvider] Connected on chainId: 0x${this.chainId.toString(16)}`);
-            this.emit('connect', {
-                chainId: `0x${this.chainId.toString(16)}`,
-            });
-        });
-    }
-    dispatchDisconnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.emit('disconnect', {
-                error: new utils_1.ProviderRpcError({
-                    code: utils_1.RpcErrorCodes.Disconnected,
-                }),
-            });
-        });
-    }
-    /**
-     * Determines the RPC URL to be used for the current chain
-     *
-     * @returns string
-     */
-    getRpcUrl() {
-        if (typeof this.gatewayConfig === 'string') {
-            // If the gatewayConfig is just a static URL, return that
-            return this.gatewayConfig;
-        }
-        else if (typeof this.gatewayConfig === 'object' &&
-            !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}`);
-        }
-        // Get the entry for the current chainId from the gatewayConfig
-        const config = this.gatewayConfig[this.chainId];
-        if (typeof config === 'string') {
-            return config;
-        }
-        // 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}`);
-    }
-    /**
-     * Sends the provided request payload along to the RPC HttpRequester
-     *
-     * @param args The arguments of the request being made
-     * @returns Promise<any>
-     */
-    handleGatewayRequests({ method, params, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // Pass request off to the gateway
-            return yield this.rpc.post('', {
-                body: {
-                    jsonrpc: '2.0',
-                    id: this.chainId,
-                    method,
-                    params,
-                },
-            });
-        });
-    }
-    /**
-     * Sends the provided request payload along to the Signer
-     *
-     * @param args The arguments of the request being made
-     * @returns Promise<any>
-     */
-    handleSigningRequests({ method, params, }) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const isApproved = passiveSignerMethods.includes(method)
-                ? true
-                : yield this.getApproval({ method, params });
-            if (!isApproved) {
-                this.log.info(`[PortalProvider] Request for signing method '${method}' could not be completed because it was not approved by the user.`);
-                return;
-            }
-            switch (method) {
-                case 'eth_chainId':
-                    return `0x${this.chainId.toString(16)}`;
-                case 'eth_accounts':
-                case 'eth_requestAccounts':
-                case 'eth_sendTransaction':
-                case 'eth_sign':
-                case 'eth_signTransaction':
-                case 'eth_signTypedData':
-                case 'personal_sign':
-                    return yield ((_a = this.signer) === null || _a === void 0 ? void 0 : _a.sign({ chainId: this.chainId, method, params }, this));
-                default:
-                    throw new Error('[PortalProvider] Method "' + method + '" not supported');
-            }
-        });
-    }
-}
-exports.default = Provider;

package/lib/commonjs/requesters/http.js

@@ -1,52 +0,0 @@
-"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 });
-const utils_1 = require("@portal-hq/utils");
-class HttpRequester {
-    constructor({ baseUrl }) {
-        this.baseUrl = baseUrl.startsWith('https://')
-            ? baseUrl
-            : `https://${baseUrl}`;
-    }
-    get(path, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = {
-                method: 'GET',
-                url: `${this.baseUrl}${path}`,
-            };
-            if (options && options.headers) {
-                requestOptions.headers = this.buildHeaders(options.headers);
-            }
-            const request = new utils_1.HttpRequest(requestOptions);
-            const response = (yield request.send());
-            return response;
-        });
-    }
-    post(path, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const requestOptions = {
-                method: 'POST',
-                url: `${this.baseUrl}${path}`,
-            };
-            requestOptions.headers = this.buildHeaders(options && options.headers ? options.headers : {});
-            if (options && options.body) {
-                requestOptions.body = options.body;
-            }
-            const request = new utils_1.HttpRequest(requestOptions);
-            const response = (yield request.send());
-            return response;
-        });
-    }
-    buildHeaders(headers) {
-        return Object.assign({ 'Content-Type': 'application/json' }, headers);
-    }
-}
-exports.default = HttpRequester;

package/lib/commonjs/requesters/index.js

@@ -1,8 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpRequester = void 0;
-var http_1 = require("./http");
-Object.defineProperty(exports, "HttpRequester", { enumerable: true, get: function () { return __importDefault(http_1).default; } });

package/lib/commonjs/signers/abstract.js

@@ -1,19 +0,0 @@
-"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(message, provider) {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new Error('[Portal] sign() method must be implemented in a child of BaseSigner');
-        });
-    }
-}
-exports.default = Signer;