@0xsequence/provider 0.0.0-20230726105834 → 0.0.0-20230726160744

package/dist/0xsequence-provider.cjs.dev.js

@@ -24,6 +24,10 @@ function _extends() {
   return _extends.apply(this, arguments);
 }
 
+function isProviderTransport(transport) {
+  return transport && typeof transport === 'object' && typeof transport.register === 'function' && typeof transport.unregister === 'function' && typeof transport.openWallet === 'function' && typeof transport.closeWallet === 'function' && typeof transport.isOpened === 'function' && typeof transport.isConnected === 'function' && typeof transport.on === 'function';
+}
+
 // ProviderMessageCallback is used to respond to ProviderMessage requests. The error
 // argument is for exceptions during the execution, and response is the response payload
 // which may contain the result or an error payload from the wallet.
@@ -3524,8 +3528,10 @@ class SequenceClient {
     this.callbacks = {};
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
-    } else {
+    } else if (isProviderTransport(transport)) {
       this.transport = transport;
+    } else {
+      throw new Error('Invalid transport');
     }
     this.session = new SequenceClientSession(store);
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId);
@@ -3602,7 +3608,7 @@ class SequenceClient {
   // Proxy transport methods
 
   async openWallet(path, intent) {
-    this.transport.openWallet(path, intent, 1);
+    this.transport.openWallet(path, intent, this.getChainId());
     await this.transport.waitUntilOpened();
     return this.isOpened();
   }
@@ -3644,7 +3650,9 @@ class SequenceClient {
     }
     await this.openWallet(undefined, {
       type: 'connect',
-      options
+      options: _extends({}, options, {
+        networkId: this.getChainId()
+      })
     });
     const connectDetails = await this.transport.waitUntilConnected().catch(error => {
       if (error instanceof Error) {
@@ -3659,6 +3667,12 @@ class SequenceClient {
         };
       }
     });
+
+    // Normalize chainId into a decimal string
+    // TODO: Remove this once wallet-webapp returns chainId as a string
+    if (connectDetails.chainId) {
+      connectDetails.chainId = ethers.ethers.BigNumber.from(connectDetails.chainId).toString();
+    }
     if (connectDetails.connected) {
       if (!connectDetails.session) {
         throw new Error('impossible state, connect response is missing session');
@@ -3780,7 +3794,9 @@ const initWallet = partialConfig => {
   }
 
   // Combine both the provided config and the default config
-  const config = _extends({}, DefaultProviderConfig, partialConfig);
+  const config = _extends({}, DefaultProviderConfig, partialConfig, {
+    transports: _extends({}, DefaultProviderConfig.transports, partialConfig == null ? void 0 : partialConfig.transports)
+  });
   const rpcProviders = {};
 
   // We can't allow the dapp to define networks that aren't already defined in sequence.js
@@ -3881,6 +3897,7 @@ exports.getWallet = getWallet;
 exports.initWallet = initWallet;
 exports.isBrowserExtension = isBrowserExtension;
 exports.isMuxTransportTemplate = isMuxTransportTemplate;
+exports.isProviderTransport = isProviderTransport;
 exports.isUnityPlugin = isUnityPlugin;
 exports.isValidMessageSignature = isValidMessageSignature;
 exports.isValidSignature = isValidSignature;

package/dist/0xsequence-provider.cjs.prod.js

@@ -24,6 +24,10 @@ function _extends() {
   return _extends.apply(this, arguments);
 }
 
+function isProviderTransport(transport) {
+  return transport && typeof transport === 'object' && typeof transport.register === 'function' && typeof transport.unregister === 'function' && typeof transport.openWallet === 'function' && typeof transport.closeWallet === 'function' && typeof transport.isOpened === 'function' && typeof transport.isConnected === 'function' && typeof transport.on === 'function';
+}
+
 // ProviderMessageCallback is used to respond to ProviderMessage requests. The error
 // argument is for exceptions during the execution, and response is the response payload
 // which may contain the result or an error payload from the wallet.
@@ -3524,8 +3528,10 @@ class SequenceClient {
     this.callbacks = {};
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
-    } else {
+    } else if (isProviderTransport(transport)) {
       this.transport = transport;
+    } else {
+      throw new Error('Invalid transport');
     }
     this.session = new SequenceClientSession(store);
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId);
@@ -3602,7 +3608,7 @@ class SequenceClient {
   // Proxy transport methods
 
   async openWallet(path, intent) {
-    this.transport.openWallet(path, intent, 1);
+    this.transport.openWallet(path, intent, this.getChainId());
     await this.transport.waitUntilOpened();
     return this.isOpened();
   }
@@ -3644,7 +3650,9 @@ class SequenceClient {
     }
     await this.openWallet(undefined, {
       type: 'connect',
-      options
+      options: _extends({}, options, {
+        networkId: this.getChainId()
+      })
     });
     const connectDetails = await this.transport.waitUntilConnected().catch(error => {
       if (error instanceof Error) {
@@ -3659,6 +3667,12 @@ class SequenceClient {
         };
       }
     });
+
+    // Normalize chainId into a decimal string
+    // TODO: Remove this once wallet-webapp returns chainId as a string
+    if (connectDetails.chainId) {
+      connectDetails.chainId = ethers.ethers.BigNumber.from(connectDetails.chainId).toString();
+    }
     if (connectDetails.connected) {
       if (!connectDetails.session) {
         throw new Error('impossible state, connect response is missing session');
@@ -3780,7 +3794,9 @@ const initWallet = partialConfig => {
   }
 
   // Combine both the provided config and the default config
-  const config = _extends({}, DefaultProviderConfig, partialConfig);
+  const config = _extends({}, DefaultProviderConfig, partialConfig, {
+    transports: _extends({}, DefaultProviderConfig.transports, partialConfig == null ? void 0 : partialConfig.transports)
+  });
   const rpcProviders = {};
 
   // We can't allow the dapp to define networks that aren't already defined in sequence.js
@@ -3881,6 +3897,7 @@ exports.getWallet = getWallet;
 exports.initWallet = initWallet;
 exports.isBrowserExtension = isBrowserExtension;
 exports.isMuxTransportTemplate = isMuxTransportTemplate;
+exports.isProviderTransport = isProviderTransport;
 exports.isUnityPlugin = isUnityPlugin;
 exports.isValidMessageSignature = isValidMessageSignature;
 exports.isValidSignature = isValidSignature;

package/dist/0xsequence-provider.esm.js

@@ -20,6 +20,10 @@ function _extends() {
   return _extends.apply(this, arguments);
 }
 
+function isProviderTransport(transport) {
+  return transport && typeof transport === 'object' && typeof transport.register === 'function' && typeof transport.unregister === 'function' && typeof transport.openWallet === 'function' && typeof transport.closeWallet === 'function' && typeof transport.isOpened === 'function' && typeof transport.isConnected === 'function' && typeof transport.on === 'function';
+}
+
 // ProviderMessageCallback is used to respond to ProviderMessage requests. The error
 // argument is for exceptions during the execution, and response is the response payload
 // which may contain the result or an error payload from the wallet.
@@ -3520,8 +3524,10 @@ class SequenceClient {
     this.callbacks = {};
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
-    } else {
+    } else if (isProviderTransport(transport)) {
       this.transport = transport;
+    } else {
+      throw new Error('Invalid transport');
     }
     this.session = new SequenceClientSession(store);
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId);
@@ -3598,7 +3604,7 @@ class SequenceClient {
   // Proxy transport methods
 
   async openWallet(path, intent) {
-    this.transport.openWallet(path, intent, 1);
+    this.transport.openWallet(path, intent, this.getChainId());
     await this.transport.waitUntilOpened();
     return this.isOpened();
   }
@@ -3640,7 +3646,9 @@ class SequenceClient {
     }
     await this.openWallet(undefined, {
       type: 'connect',
-      options
+      options: _extends({}, options, {
+        networkId: this.getChainId()
+      })
     });
     const connectDetails = await this.transport.waitUntilConnected().catch(error => {
       if (error instanceof Error) {
@@ -3655,6 +3663,12 @@ class SequenceClient {
         };
       }
     });
+
+    // Normalize chainId into a decimal string
+    // TODO: Remove this once wallet-webapp returns chainId as a string
+    if (connectDetails.chainId) {
+      connectDetails.chainId = ethers.BigNumber.from(connectDetails.chainId).toString();
+    }
     if (connectDetails.connected) {
       if (!connectDetails.session) {
         throw new Error('impossible state, connect response is missing session');
@@ -3776,7 +3790,9 @@ const initWallet = partialConfig => {
   }
 
   // Combine both the provided config and the default config
-  const config = _extends({}, DefaultProviderConfig, partialConfig);
+  const config = _extends({}, DefaultProviderConfig, partialConfig, {
+    transports: _extends({}, DefaultProviderConfig.transports, partialConfig == null ? void 0 : partialConfig.transports)
+  });
   const rpcProviders = {};
 
   // We can't allow the dapp to define networks that aren't already defined in sequence.js
@@ -3840,4 +3856,4 @@ const getWallet = () => {
   return sequenceWalletProvider;
 };
 
-export { BaseInjectedTransport, BaseProviderTransport, BaseWalletTransport, CHANNEL_ID, DefaultChainIdTracker, DefaultProviderConfig, ErrSignedInRequired, EventType, ExtensionMessageHandler, ExtensionMessageProvider, InitState, LocalStorage, MemoryItemStore, MuxMessageProvider, OpenState, PROVIDER_OPEN_TIMEOUT, ProviderError, ProxyMessageChannel, ProxyMessageChannelPort, ProxyMessageHandler, ProxyMessageProvider, SequenceClient, SequenceClientSession, SequenceProvider, SequenceSigner, SingleNetworkSequenceProvider, SingleNetworkSequenceSigner, UnrealMessageHandler, UnrealMessageProvider, WalletRequestHandler, WindowMessageHandler, WindowMessageProvider, WindowSessionParams, getWallet, initWallet, isBrowserExtension, isMuxTransportTemplate, isUnityPlugin, isValidMessageSignature, isValidSignature, isValidTypedDataSignature, isWalletUpToDate, messageToBytes, nextMessageIdx, prefixEIP191Message, resolveArrayProperties, trimEIP191Prefix, unregisterWallet, useBestStore };
+export { BaseInjectedTransport, BaseProviderTransport, BaseWalletTransport, CHANNEL_ID, DefaultChainIdTracker, DefaultProviderConfig, ErrSignedInRequired, EventType, ExtensionMessageHandler, ExtensionMessageProvider, InitState, LocalStorage, MemoryItemStore, MuxMessageProvider, OpenState, PROVIDER_OPEN_TIMEOUT, ProviderError, ProxyMessageChannel, ProxyMessageChannelPort, ProxyMessageHandler, ProxyMessageProvider, SequenceClient, SequenceClientSession, SequenceProvider, SequenceSigner, SingleNetworkSequenceProvider, SingleNetworkSequenceSigner, UnrealMessageHandler, UnrealMessageProvider, WalletRequestHandler, WindowMessageHandler, WindowMessageProvider, WindowSessionParams, getWallet, initWallet, isBrowserExtension, isMuxTransportTemplate, isProviderTransport, isUnityPlugin, isValidMessageSignature, isValidSignature, isValidTypedDataSignature, isWalletUpToDate, messageToBytes, nextMessageIdx, prefixEIP191Message, resolveArrayProperties, trimEIP191Prefix, unregisterWallet, useBestStore };

package/dist/declarations/src/types.d.ts

@@ -15,6 +15,7 @@ export interface ProviderTransport extends JsonRpcHandler, ProviderMessageTransp
     waitUntilOpened(): Promise<WalletSession | undefined>;
     waitUntilConnected(): Promise<ConnectDetails>;
 }
+export declare function isProviderTransport(transport: any): transport is ProviderTransport;
 export interface WalletTransport extends JsonRpcHandler, ProviderMessageTransport, ProviderMessageRequestHandler {
     register(): void;
     unregister(): void;
@@ -126,6 +127,12 @@ export interface ConnectOptions {
     /** Options to further customize the wallet experience. */
     settings?: Settings;
 }
+export interface NetworkedConnectOptions extends ConnectOptions {
+    /** chainId is the chainId to connect to. If not specified, the default chainId
+     * will be used. This does not define a default chain id, it is only used for the connect
+     * authorization signature. */
+    networkId?: string | number;
+}
 /** Options to further customize the wallet experience. */
 export interface Settings {
     /** Specify a wallet theme. `light` and `dark` are the main themes, to use other available
@@ -189,7 +196,7 @@ export interface ConnectDetails {
 export type PromptConnectDetails = Pick<ConnectDetails, 'chainId' | 'error' | 'connected' | 'proof' | 'email'>;
 export type OpenWalletIntent = {
     type: 'connect';
-    options?: ConnectOptions;
+    options?: NetworkedConnectOptions;
 } | {
     type: 'openWithOptions';
     options?: ConnectOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "0.0.0-20230726105834",
+  "version": "0.0.0-20230726160744",
   "description": "provider sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
   "source": "src/index.ts",
@@ -11,15 +11,15 @@
   "dependencies": {
     "eventemitter2": "^6.4.5",
     "webextension-polyfill": "^0.10.0",
-    "@0xsequence/abi": "0.0.0-20230726105834",
-    "@0xsequence/auth": "0.0.0-20230726105834",
-    "@0xsequence/core": "0.0.0-20230726105834",
-    "@0xsequence/migration": "0.0.0-20230726105834",
-    "@0xsequence/account": "0.0.0-20230726105834",
-    "@0xsequence/relayer": "0.0.0-20230726105834",
-    "@0xsequence/network": "0.0.0-20230726105834",
-    "@0xsequence/utils": "0.0.0-20230726105834",
-    "@0xsequence/wallet": "0.0.0-20230726105834"
+    "@0xsequence/abi": "0.0.0-20230726160744",
+    "@0xsequence/auth": "0.0.0-20230726160744",
+    "@0xsequence/core": "0.0.0-20230726160744",
+    "@0xsequence/migration": "0.0.0-20230726160744",
+    "@0xsequence/account": "0.0.0-20230726160744",
+    "@0xsequence/network": "0.0.0-20230726160744",
+    "@0xsequence/utils": "0.0.0-20230726160744",
+    "@0xsequence/relayer": "0.0.0-20230726160744",
+    "@0xsequence/wallet": "0.0.0-20230726160744"
   },
   "peerDependencies": {
     "ethers": ">=5.5 < 6"

package/src/client.ts

@@ -1,5 +1,5 @@
 import { JsonRpcRequest, JsonRpcResponse, NetworkConfig } from "@0xsequence/network"
-import { ConnectDetails, ConnectOptions, ItemStore, MuxMessageProvider, MuxTransportTemplate, OpenWalletIntent, OptionalChainId, OptionalEIP6492, ProviderTransport, WalletSession, isMuxTransportTemplate } from "."
+import { ConnectDetails, ConnectOptions, ItemStore, MuxMessageProvider, MuxTransportTemplate, OpenWalletIntent, OptionalChainId, OptionalEIP6492, ProviderTransport, WalletSession, isMuxTransportTemplate, isProviderTransport } from "."
 import { commons } from "@0xsequence/core"
 import { TypedData } from "@0xsequence/utils"
 import { toExtended } from "./extended"
@@ -134,8 +134,10 @@ export class SequenceClient {
   ) {
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport)
-    } else {
+    } else if (isProviderTransport(transport)) {
       this.transport = transport
+    } else {
+      throw new Error('Invalid transport')
     }
 
     this.session = new SequenceClientSession(store)
@@ -222,7 +224,7 @@ export class SequenceClient {
   // Proxy transport methods
 
   async openWallet(path?: string, intent?: OpenWalletIntent) {
-    this.transport.openWallet(path, intent, 1)
+    this.transport.openWallet(path, intent, this.getChainId())
     await this.transport.waitUntilOpened()
     return this.isOpened()
   }
@@ -271,7 +273,7 @@ export class SequenceClient {
       }
     }
 
-    await this.openWallet(undefined, { type: 'connect', options })
+    await this.openWallet(undefined, { type: 'connect', options: { ...options, networkId: this.getChainId() } })
 
     const connectDetails = await this.transport.waitUntilConnected().catch((error): ConnectDetails => {
       if (error instanceof Error) {
@@ -281,6 +283,12 @@ export class SequenceClient {
       }
     })
 
+    // Normalize chainId into a decimal string
+    // TODO: Remove this once wallet-webapp returns chainId as a string
+    if (connectDetails.chainId) {
+      connectDetails.chainId = ethers.BigNumber.from(connectDetails.chainId).toString()
+    }
+
     if (connectDetails.connected) {
       if (!connectDetails.session) {
         throw new Error('impossible state, connect response is missing session')

package/src/init.ts

@@ -50,7 +50,15 @@ export const initWallet = (
   }
 
   // Combine both the provided config and the default config
-  const config = { ...DefaultProviderConfig, ...partialConfig }
+  const config = {
+    ...DefaultProviderConfig,
+    ...partialConfig,
+    transports: {
+      ...DefaultProviderConfig.transports,
+      ...partialConfig?.transports,
+    }
+  }
+
   const rpcProviders: Record<number, ethers.providers.JsonRpcProvider> = {}
 
   // We can't allow the dapp to define networks that aren't already defined in sequence.js

package/src/types.ts

@@ -21,6 +21,20 @@ export interface ProviderTransport extends JsonRpcHandler, ProviderMessageTransp
   waitUntilConnected(): Promise<ConnectDetails>
 }
 
+export function isProviderTransport(transport: any): transport is ProviderTransport {
+  return (
+    transport &&
+    typeof transport === 'object' &&
+    typeof transport.register === 'function' &&
+    typeof transport.unregister === 'function' &&
+    typeof transport.openWallet === 'function' &&
+    typeof transport.closeWallet === 'function' &&
+    typeof transport.isOpened === 'function' &&
+    typeof transport.isConnected === 'function' &&
+    typeof transport.on === 'function'
+  )
+}
+
 export interface WalletTransport extends JsonRpcHandler, ProviderMessageTransport, ProviderMessageRequestHandler {
   register(): void
   unregister(): void
@@ -167,6 +181,13 @@ export interface ConnectOptions {
   settings?: Settings
 }
 
+export interface NetworkedConnectOptions extends ConnectOptions {
+  /** chainId is the chainId to connect to. If not specified, the default chainId
+   * will be used. This does not define a default chain id, it is only used for the connect
+   * authorization signature. */
+  networkId?: string | number;
+}
+
 /** Options to further customize the wallet experience. */
 export interface Settings {
   /** Specify a wallet theme. `light` and `dark` are the main themes, to use other available
@@ -252,7 +273,7 @@ export interface ConnectDetails {
 export type PromptConnectDetails = Pick<ConnectDetails, 'chainId' | 'error' | 'connected' | 'proof' | 'email'>
 
 export type OpenWalletIntent =
-  | { type: 'connect'; options?: ConnectOptions }
+  | { type: 'connect'; options?: NetworkedConnectOptions }
   | { type: 'openWithOptions'; options?: ConnectOptions }
   | { type: 'jsonRpcRequest'; method: string }