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

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

@@ -79,6 +79,8 @@ const ErrSignedInRequired = new ProviderError('Wallet is not signed in. Connect
 
 // TODO: lets build some nice error handling tools, prob in /utils ...
 
+// This is required by viem, it expects a provider to have an EIP-1193 compliant `request` attribute.
+
 const PROVIDER_OPEN_TIMEOUT = 30000; // in ms
 
 let _messageIdx = 0;
@@ -3091,7 +3093,7 @@ class WalletUtils {
 }
 
 class SequenceProvider extends ethers.ethers.providers.BaseProvider {
-  constructor(client, providerFor) {
+  constructor(client, providerFor, networks = network.allNetworks) {
     var _this;
     // We support a lot of networks
     // but we start with the default one
@@ -3101,6 +3103,7 @@ class SequenceProvider extends ethers.ethers.providers.BaseProvider {
     this._isSequenceProvider = true;
     this.client = client;
     this.providerFor = providerFor;
+    this.networks = networks;
     client.onDefaultChainIdChanged(async function (chainId) {
       // TODO: Maybe we should emit more events here
       _this.emit('chainChanged', chainId);
@@ -3175,7 +3178,7 @@ class SequenceProvider extends ethers.ethers.providers.BaseProvider {
     if (chainId === undefined) {
       return undefined;
     }
-    const resolved = network.findNetworkConfig(network.allNetworks, chainId);
+    const resolved = network.findNetworkConfig(this.networks, chainId);
     if (!resolved) {
       throw new Error(`Unsupported network ${chainId}`);
     }
@@ -3263,9 +3266,12 @@ class SequenceProvider extends ethers.ethers.providers.BaseProvider {
   send(method, params) {
     return this.perform(method, params);
   }
+  request(request) {
+    return this.perform(request.method, request.params);
+  }
   async detectNetwork() {
     const chainId = this.client.getChainId();
-    const network$1 = network.findNetworkConfig(network.allNetworks, chainId);
+    const network$1 = network.findNetworkConfig(this.networks, chainId);
     if (!network$1) {
       throw new Error(`Unknown network ${chainId}`);
     }
@@ -3788,7 +3794,7 @@ const DefaultProviderConfig = {
 };
 let sequenceWalletProvider;
 const initWallet = partialConfig => {
-  var _config$networks, _findNetworkConfig;
+  var _config$networks$filt, _config$networks, _findNetworkConfig;
   if (sequenceWalletProvider) {
     return sequenceWalletProvider;
   }
@@ -3799,21 +3805,18 @@ const initWallet = partialConfig => {
   });
   const rpcProviders = {};
 
-  // We can't allow the dapp to define networks that aren't already defined in sequence.js
-  // we may in the future, but the issue is that wallet-webapp won't have these new networks
-  // either, so it will fail to connect to them.
-  if ((_config$networks = config.networks) != null && _config$networks.some(n => {
-    return !network.allNetworks.find(cn => cn.chainId === n.chainId);
-  })) {
-    throw new Error('networks config must only contain networks defined in sequence.js');
-  }
+  // Find any new networks that aren't already defined in sequence.js
+  // and add them to the list of networks, (they must have a rpcUrl and chainId)
+  const newNetworks = (_config$networks$filt = (_config$networks = config.networks) == null ? void 0 : _config$networks.filter(n => {
+    n.rpcUrl !== undefined && n.chainId !== undefined && !network.allNetworks.find(an => an.chainId === n.chainId);
+  })) != null ? _config$networks$filt : [];
 
   // Override any information about the networks using the config
   const combinedNetworks = network.allNetworks.map(n => {
     var _config$networks2;
     const network = (_config$networks2 = config.networks) == null ? void 0 : _config$networks2.find(cn => cn.chainId === n.chainId);
     return network ? _extends({}, n, network) : n;
-  });
+  }).concat(newNetworks);
 
   // This build a "public rpc" on demand, we build them on demand because we don't want to
   // generate a bunch of providers for networks that aren't used.

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

@@ -79,6 +79,8 @@ const ErrSignedInRequired = new ProviderError('Wallet is not signed in. Connect
 
 // TODO: lets build some nice error handling tools, prob in /utils ...
 
+// This is required by viem, it expects a provider to have an EIP-1193 compliant `request` attribute.
+
 const PROVIDER_OPEN_TIMEOUT = 30000; // in ms
 
 let _messageIdx = 0;
@@ -3091,7 +3093,7 @@ class WalletUtils {
 }
 
 class SequenceProvider extends ethers.ethers.providers.BaseProvider {
-  constructor(client, providerFor) {
+  constructor(client, providerFor, networks = network.allNetworks) {
     var _this;
     // We support a lot of networks
     // but we start with the default one
@@ -3101,6 +3103,7 @@ class SequenceProvider extends ethers.ethers.providers.BaseProvider {
     this._isSequenceProvider = true;
     this.client = client;
     this.providerFor = providerFor;
+    this.networks = networks;
     client.onDefaultChainIdChanged(async function (chainId) {
       // TODO: Maybe we should emit more events here
       _this.emit('chainChanged', chainId);
@@ -3175,7 +3178,7 @@ class SequenceProvider extends ethers.ethers.providers.BaseProvider {
     if (chainId === undefined) {
       return undefined;
     }
-    const resolved = network.findNetworkConfig(network.allNetworks, chainId);
+    const resolved = network.findNetworkConfig(this.networks, chainId);
     if (!resolved) {
       throw new Error(`Unsupported network ${chainId}`);
     }
@@ -3263,9 +3266,12 @@ class SequenceProvider extends ethers.ethers.providers.BaseProvider {
   send(method, params) {
     return this.perform(method, params);
   }
+  request(request) {
+    return this.perform(request.method, request.params);
+  }
   async detectNetwork() {
     const chainId = this.client.getChainId();
-    const network$1 = network.findNetworkConfig(network.allNetworks, chainId);
+    const network$1 = network.findNetworkConfig(this.networks, chainId);
     if (!network$1) {
       throw new Error(`Unknown network ${chainId}`);
     }
@@ -3788,7 +3794,7 @@ const DefaultProviderConfig = {
 };
 let sequenceWalletProvider;
 const initWallet = partialConfig => {
-  var _config$networks, _findNetworkConfig;
+  var _config$networks$filt, _config$networks, _findNetworkConfig;
   if (sequenceWalletProvider) {
     return sequenceWalletProvider;
   }
@@ -3799,21 +3805,18 @@ const initWallet = partialConfig => {
   });
   const rpcProviders = {};
 
-  // We can't allow the dapp to define networks that aren't already defined in sequence.js
-  // we may in the future, but the issue is that wallet-webapp won't have these new networks
-  // either, so it will fail to connect to them.
-  if ((_config$networks = config.networks) != null && _config$networks.some(n => {
-    return !network.allNetworks.find(cn => cn.chainId === n.chainId);
-  })) {
-    throw new Error('networks config must only contain networks defined in sequence.js');
-  }
+  // Find any new networks that aren't already defined in sequence.js
+  // and add them to the list of networks, (they must have a rpcUrl and chainId)
+  const newNetworks = (_config$networks$filt = (_config$networks = config.networks) == null ? void 0 : _config$networks.filter(n => {
+    n.rpcUrl !== undefined && n.chainId !== undefined && !network.allNetworks.find(an => an.chainId === n.chainId);
+  })) != null ? _config$networks$filt : [];
 
   // Override any information about the networks using the config
   const combinedNetworks = network.allNetworks.map(n => {
     var _config$networks2;
     const network = (_config$networks2 = config.networks) == null ? void 0 : _config$networks2.find(cn => cn.chainId === n.chainId);
     return network ? _extends({}, n, network) : n;
-  });
+  }).concat(newNetworks);
 
   // This build a "public rpc" on demand, we build them on demand because we don't want to
   // generate a bunch of providers for networks that aren't used.

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

@@ -1,7 +1,7 @@
 import { EventEmitter2 } from 'eventemitter2';
 import { logger, encodeMessageDigest, encodeTypedDataDigest, sanitizeNumberString, sanitizeHost, sanitizeAlphanumeric, base64EncodeObject, base64DecodeObject } from '@0xsequence/utils';
 import { ethers, BigNumber } from 'ethers';
-import { findSupportedNetwork, findNetworkConfig, allNetworks, JsonRpcRouter, loggingProviderMiddleware, exceptionProviderMiddleware, CachedProvider, JsonRpcSender } from '@0xsequence/network';
+import { findSupportedNetwork, allNetworks, findNetworkConfig, JsonRpcRouter, loggingProviderMiddleware, exceptionProviderMiddleware, CachedProvider, JsonRpcSender } from '@0xsequence/network';
 import { commons } from '@0xsequence/core';
 import { signAuthorization } from '@0xsequence/auth';
 
@@ -75,6 +75,8 @@ const ErrSignedInRequired = new ProviderError('Wallet is not signed in. Connect
 
 // TODO: lets build some nice error handling tools, prob in /utils ...
 
+// This is required by viem, it expects a provider to have an EIP-1193 compliant `request` attribute.
+
 const PROVIDER_OPEN_TIMEOUT = 30000; // in ms
 
 let _messageIdx = 0;
@@ -3087,7 +3089,7 @@ class WalletUtils {
 }
 
 class SequenceProvider extends ethers.providers.BaseProvider {
-  constructor(client, providerFor) {
+  constructor(client, providerFor, networks = allNetworks) {
     var _this;
     // We support a lot of networks
     // but we start with the default one
@@ -3097,6 +3099,7 @@ class SequenceProvider extends ethers.providers.BaseProvider {
     this._isSequenceProvider = true;
     this.client = client;
     this.providerFor = providerFor;
+    this.networks = networks;
     client.onDefaultChainIdChanged(async function (chainId) {
       // TODO: Maybe we should emit more events here
       _this.emit('chainChanged', chainId);
@@ -3171,7 +3174,7 @@ class SequenceProvider extends ethers.providers.BaseProvider {
     if (chainId === undefined) {
       return undefined;
     }
-    const resolved = findNetworkConfig(allNetworks, chainId);
+    const resolved = findNetworkConfig(this.networks, chainId);
     if (!resolved) {
       throw new Error(`Unsupported network ${chainId}`);
     }
@@ -3259,9 +3262,12 @@ class SequenceProvider extends ethers.providers.BaseProvider {
   send(method, params) {
     return this.perform(method, params);
   }
+  request(request) {
+    return this.perform(request.method, request.params);
+  }
   async detectNetwork() {
     const chainId = this.client.getChainId();
-    const network = findNetworkConfig(allNetworks, chainId);
+    const network = findNetworkConfig(this.networks, chainId);
     if (!network) {
       throw new Error(`Unknown network ${chainId}`);
     }
@@ -3784,7 +3790,7 @@ const DefaultProviderConfig = {
 };
 let sequenceWalletProvider;
 const initWallet = partialConfig => {
-  var _config$networks, _findNetworkConfig;
+  var _config$networks$filt, _config$networks, _findNetworkConfig;
   if (sequenceWalletProvider) {
     return sequenceWalletProvider;
   }
@@ -3795,21 +3801,18 @@ const initWallet = partialConfig => {
   });
   const rpcProviders = {};
 
-  // We can't allow the dapp to define networks that aren't already defined in sequence.js
-  // we may in the future, but the issue is that wallet-webapp won't have these new networks
-  // either, so it will fail to connect to them.
-  if ((_config$networks = config.networks) != null && _config$networks.some(n => {
-    return !allNetworks.find(cn => cn.chainId === n.chainId);
-  })) {
-    throw new Error('networks config must only contain networks defined in sequence.js');
-  }
+  // Find any new networks that aren't already defined in sequence.js
+  // and add them to the list of networks, (they must have a rpcUrl and chainId)
+  const newNetworks = (_config$networks$filt = (_config$networks = config.networks) == null ? void 0 : _config$networks.filter(n => {
+    n.rpcUrl !== undefined && n.chainId !== undefined && !allNetworks.find(an => an.chainId === n.chainId);
+  })) != null ? _config$networks$filt : [];
 
   // Override any information about the networks using the config
   const combinedNetworks = allNetworks.map(n => {
     var _config$networks2;
     const network = (_config$networks2 = config.networks) == null ? void 0 : _config$networks2.find(cn => cn.chainId === n.chainId);
     return network ? _extends({}, n, network) : n;
-  });
+  }).concat(newNetworks);
 
   // This build a "public rpc" on demand, we build them on demand because we don't want to
   // generate a bunch of providers for networks that aren't used.

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

@@ -1,7 +1,7 @@
 import { ethers } from "ethers";
 import { SequenceClient } from "./client.js";
 import { ChainIdLike, NetworkConfig } from "@0xsequence/network";
-import { ConnectDetails, ConnectOptions, OpenWalletIntent, OptionalChainIdLike, WalletSession } from "./types.js";
+import { ConnectDetails, ConnectOptions, EIP1193Provider, OpenWalletIntent, OptionalChainIdLike, WalletSession } from "./types.js";
 import { commons } from "@0xsequence/core";
 import { WalletUtils } from "./utils/index.js";
 import { SequenceSigner, SingleNetworkSequenceSigner } from "./signer.js";
@@ -29,14 +29,15 @@ export interface ISequenceProvider {
     getWalletConfig(chainId?: ChainIdLike): Promise<commons.config.Config>;
     utils: WalletUtils;
 }
-export declare class SequenceProvider extends ethers.providers.BaseProvider implements ISequenceProvider {
+export declare class SequenceProvider extends ethers.providers.BaseProvider implements ISequenceProvider, EIP1193Provider {
     readonly client: SequenceClient;
     private readonly providerFor;
+    readonly networks: NetworkConfig[];
     private readonly singleNetworkProviders;
     readonly _isSequenceProvider = true;
     readonly utils: WalletUtils;
     readonly signer: SequenceSigner;
-    constructor(client: SequenceClient, providerFor: (networkId: number) => ethers.providers.JsonRpcProvider);
+    constructor(client: SequenceClient, providerFor: (networkId: number) => ethers.providers.JsonRpcProvider, networks?: NetworkConfig[]);
     getSigner(): SequenceSigner;
     getSigner(chainId: ChainIdLike): SingleNetworkSequenceSigner;
     getSigner(chainId?: ChainIdLike): SequenceSigner | SingleNetworkSequenceSigner;
@@ -78,6 +79,10 @@ export declare class SequenceProvider extends ethers.providers.BaseProvider impl
     _getSubprovider(chainId?: ChainIdLike): Promise<ethers.providers.JsonRpcProvider>;
     perform(method: string, params: any): Promise<any>;
     send(method: string, params: any): Promise<any>;
+    request(request: {
+        method: string;
+        params?: any[] | undefined;
+    }): Promise<any>;
     detectNetwork(): Promise<ethers.providers.Network>;
     waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number, optionals?: OptionalChainIdLike): Promise<ethers.providers.TransactionReceipt>;
     getBlockNumber(optionals?: OptionalChainIdLike): Promise<number>;

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

@@ -244,4 +244,10 @@ export type OptionalChainId = {
 export type OptionalEIP6492 = {
     eip6492?: boolean;
 } | undefined;
+export interface EIP1193Provider {
+    request: (request: {
+        method: string;
+        params?: Array<any>;
+    }) => Promise<any>;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "0.0.0-20230726160744",
+  "version": "0.0.0-20230726172246",
   "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-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"
+    "@0xsequence/abi": "0.0.0-20230726172246",
+    "@0xsequence/core": "0.0.0-20230726172246",
+    "@0xsequence/auth": "0.0.0-20230726172246",
+    "@0xsequence/migration": "0.0.0-20230726172246",
+    "@0xsequence/account": "0.0.0-20230726172246",
+    "@0xsequence/network": "0.0.0-20230726172246",
+    "@0xsequence/utils": "0.0.0-20230726172246",
+    "@0xsequence/wallet": "0.0.0-20230726172246",
+    "@0xsequence/relayer": "0.0.0-20230726172246"
   },
   "peerDependencies": {
     "ethers": ">=5.5 < 6"

package/src/init.ts

@@ -61,20 +61,19 @@ export const initWallet = (
 
   const rpcProviders: Record<number, ethers.providers.JsonRpcProvider> = {}
 
-  // We can't allow the dapp to define networks that aren't already defined in sequence.js
-  // we may in the future, but the issue is that wallet-webapp won't have these new networks
-  // either, so it will fail to connect to them.
-  if (config.networks?.some((n) => {
-    return !allNetworks.find((cn) => cn.chainId === n.chainId)
-  })) {
-    throw new Error('networks config must only contain networks defined in sequence.js')
-  }
+  // Find any new networks that aren't already defined in sequence.js
+  // and add them to the list of networks, (they must have a rpcUrl and chainId)
+  const newNetworks = (config.networks?.filter((n) => {
+    n.rpcUrl !== undefined &&
+    n.chainId !== undefined &&
+    !allNetworks.find((an) => an.chainId === n.chainId)
+  }) ?? []) as NetworkConfig[]
 
   // Override any information about the networks using the config
   const combinedNetworks = allNetworks.map((n) => {
     const network = config.networks?.find((cn) => cn.chainId === n.chainId)
     return network ? { ...n, ...network } : n
-  })
+  }).concat(newNetworks)
 
   // This build a "public rpc" on demand, we build them on demand because we don't want to
   // generate a bunch of providers for networks that aren't used.

package/src/provider.ts

@@ -2,7 +2,7 @@
 import { ethers } from "ethers"
 import { SequenceClient } from "./client"
 import { ChainIdLike, NetworkConfig, allNetworks, findNetworkConfig } from "@0xsequence/network"
-import { ConnectDetails, ConnectOptions, OpenWalletIntent, OptionalChainIdLike, WalletSession } from "./types"
+import { ConnectDetails, ConnectOptions, EIP1193Provider, OpenWalletIntent, OptionalChainIdLike, WalletSession } from "./types"
 import { commons } from "@0xsequence/core"
 import { WalletUtils } from "./utils/index"
 import { SequenceSigner, SingleNetworkSequenceSigner } from "./signer"
@@ -47,7 +47,7 @@ export interface ISequenceProvider {
   utils: WalletUtils
 }
 
-export class SequenceProvider extends ethers.providers.BaseProvider implements ISequenceProvider {
+export class SequenceProvider extends ethers.providers.BaseProvider implements ISequenceProvider, EIP1193Provider {
   private readonly singleNetworkProviders: { [chainId: number]: SingleNetworkSequenceProvider } = {}
 
   readonly _isSequenceProvider = true
@@ -57,7 +57,8 @@ export class SequenceProvider extends ethers.providers.BaseProvider implements I
 
   constructor (
     public readonly client: SequenceClient,
-    private readonly providerFor: (networkId: number) => ethers.providers.JsonRpcProvider
+    private readonly providerFor: (networkId: number) => ethers.providers.JsonRpcProvider,
+    public readonly networks: NetworkConfig[] = allNetworks
   ) {
     // We support a lot of networks
     // but we start with the default one
@@ -158,7 +159,7 @@ export class SequenceProvider extends ethers.providers.BaseProvider implements I
       return undefined
     }
   
-    const resolved = findNetworkConfig(allNetworks, chainId as ChainIdLike)
+    const resolved = findNetworkConfig(this.networks, chainId as ChainIdLike)
   
     if (!resolved) {
       throw new Error(`Unsupported network ${chainId}`)
@@ -268,9 +269,13 @@ export class SequenceProvider extends ethers.providers.BaseProvider implements I
     return this.perform(method, params)
   }
 
+  request (request: { method: string; params?: any[] | undefined }) {
+    return this.perform(request.method, request.params)
+  }
+
   async detectNetwork(): Promise<ethers.providers.Network> {
     const chainId = this.client.getChainId()
-    const network = findNetworkConfig(allNetworks, chainId)
+    const network = findNetworkConfig(this.networks, chainId)
 
     if (!network) {
       throw new Error(`Unknown network ${chainId}`)

package/src/types.ts

@@ -340,3 +340,8 @@ export type OptionalChainId = {
 export type OptionalEIP6492 = {
   eip6492?: boolean
 } | undefined
+
+// This is required by viem, it expects a provider to have an EIP-1193 compliant `request` attribute.
+export interface EIP1193Provider {
+  request: (request: { method: string, params?: Array<any> }) => Promise<any>
+}