@0xsequence/provider 1.3.0 → 1.4.1

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

@@ -2709,7 +2709,7 @@ class WalletRequestHandler {
     }
 
     // Build session response for connect details
-    connectDetails.session = await this.walletSession(chainId);
+    connectDetails.session = this.walletSession(chainId);
     return connectDetails;
   }
   // sendMessageRequest will unwrap the ProviderMessageRequest and send it to the JsonRpcHandler
@@ -3533,7 +3533,7 @@ class SingleNetworkSequenceProvider extends SequenceProvider {
 
 var packageJson = {
 	name: "@0xsequence/provider",
-	version: "1.3.0",
+	version: "1.4.1",
 	description: "provider sub-package for Sequence",
 	repository: "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
 	source: "src/index.ts",
@@ -3661,11 +3661,12 @@ DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
  *  and it allows to perform all sequence specific (or write) operations related to the wallet.
  *s
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
- */
+ */ // TODO: rename Client to transport.. or something.. like SequenceTransport ..
 class SequenceClient {
-  constructor(transport, store, options) {
+  constructor(transport, store, options, projectAccessKey) {
     var _options$defaultEIP;
     this.callbacks = {};
+    this.projectAccessKey = projectAccessKey;
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
     } else if (isProviderTransport(transport)) {
@@ -3810,6 +3811,7 @@ class SequenceClient {
     if ((options == null ? void 0 : options.refresh) === true) {
       this.disconnect();
     }
+    options.projectAccessKey = this.projectAccessKey;
     if (options) {
       if (options.authorize) {
         if (!options.app) {
@@ -4005,6 +4007,10 @@ const DefaultProviderConfig = {
 let sequenceWalletProvider;
 const initWallet = partialConfig => {
   var _config$networks$filt, _config$networks, _findNetworkConfig;
+  const projectAccessKey = partialConfig == null ? void 0 : partialConfig.projectAccessKey;
+  if (!projectAccessKey) {
+    console.warn('Please pass a projectAccessKey in initWallet config as it will be required in near future.');
+  }
   if (sequenceWalletProvider) {
     return sequenceWalletProvider;
   }
@@ -4026,9 +4032,13 @@ const initWallet = partialConfig => {
     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);
+  }).concat(newNetworks).map(network => {
+    const toAppend = projectAccessKey ? `/${projectAccessKey}` : '';
+    network.rpcUrl = network.rpcUrl + toAppend;
+    return network;
+  });
 
-  // This build a "public rpc" on demand, we build them on demand because we don't want to
+  // This builds 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.
   const providerForChainId = chainId => {
     if (!rpcProviders[chainId]) {
@@ -4059,7 +4069,7 @@ const initWallet = partialConfig => {
   const client = new SequenceClient(config.transports, itemStore, {
     defaultChainId: defaultNetwork,
     defaultEIP6492: config.defaultEIP6492
-  });
+  }, projectAccessKey);
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId);
   return sequenceWalletProvider;
 };

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

@@ -2709,7 +2709,7 @@ class WalletRequestHandler {
     }
 
     // Build session response for connect details
-    connectDetails.session = await this.walletSession(chainId);
+    connectDetails.session = this.walletSession(chainId);
     return connectDetails;
   }
   // sendMessageRequest will unwrap the ProviderMessageRequest and send it to the JsonRpcHandler
@@ -3533,7 +3533,7 @@ class SingleNetworkSequenceProvider extends SequenceProvider {
 
 var packageJson = {
 	name: "@0xsequence/provider",
-	version: "1.3.0",
+	version: "1.4.1",
 	description: "provider sub-package for Sequence",
 	repository: "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
 	source: "src/index.ts",
@@ -3661,11 +3661,12 @@ DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
  *  and it allows to perform all sequence specific (or write) operations related to the wallet.
  *s
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
- */
+ */ // TODO: rename Client to transport.. or something.. like SequenceTransport ..
 class SequenceClient {
-  constructor(transport, store, options) {
+  constructor(transport, store, options, projectAccessKey) {
     var _options$defaultEIP;
     this.callbacks = {};
+    this.projectAccessKey = projectAccessKey;
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
     } else if (isProviderTransport(transport)) {
@@ -3810,6 +3811,7 @@ class SequenceClient {
     if ((options == null ? void 0 : options.refresh) === true) {
       this.disconnect();
     }
+    options.projectAccessKey = this.projectAccessKey;
     if (options) {
       if (options.authorize) {
         if (!options.app) {
@@ -4005,6 +4007,10 @@ const DefaultProviderConfig = {
 let sequenceWalletProvider;
 const initWallet = partialConfig => {
   var _config$networks$filt, _config$networks, _findNetworkConfig;
+  const projectAccessKey = partialConfig == null ? void 0 : partialConfig.projectAccessKey;
+  if (!projectAccessKey) {
+    console.warn('Please pass a projectAccessKey in initWallet config as it will be required in near future.');
+  }
   if (sequenceWalletProvider) {
     return sequenceWalletProvider;
   }
@@ -4026,9 +4032,13 @@ const initWallet = partialConfig => {
     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);
+  }).concat(newNetworks).map(network => {
+    const toAppend = projectAccessKey ? `/${projectAccessKey}` : '';
+    network.rpcUrl = network.rpcUrl + toAppend;
+    return network;
+  });
 
-  // This build a "public rpc" on demand, we build them on demand because we don't want to
+  // This builds 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.
   const providerForChainId = chainId => {
     if (!rpcProviders[chainId]) {
@@ -4059,7 +4069,7 @@ const initWallet = partialConfig => {
   const client = new SequenceClient(config.transports, itemStore, {
     defaultChainId: defaultNetwork,
     defaultEIP6492: config.defaultEIP6492
-  });
+  }, projectAccessKey);
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId);
   return sequenceWalletProvider;
 };

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

@@ -2705,7 +2705,7 @@ class WalletRequestHandler {
     }
 
     // Build session response for connect details
-    connectDetails.session = await this.walletSession(chainId);
+    connectDetails.session = this.walletSession(chainId);
     return connectDetails;
   }
   // sendMessageRequest will unwrap the ProviderMessageRequest and send it to the JsonRpcHandler
@@ -3529,7 +3529,7 @@ class SingleNetworkSequenceProvider extends SequenceProvider {
 
 var packageJson = {
 	name: "@0xsequence/provider",
-	version: "1.3.0",
+	version: "1.4.1",
 	description: "provider sub-package for Sequence",
 	repository: "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
 	source: "src/index.ts",
@@ -3657,11 +3657,12 @@ DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
  *  and it allows to perform all sequence specific (or write) operations related to the wallet.
  *s
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
- */
+ */ // TODO: rename Client to transport.. or something.. like SequenceTransport ..
 class SequenceClient {
-  constructor(transport, store, options) {
+  constructor(transport, store, options, projectAccessKey) {
     var _options$defaultEIP;
     this.callbacks = {};
+    this.projectAccessKey = projectAccessKey;
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
     } else if (isProviderTransport(transport)) {
@@ -3806,6 +3807,7 @@ class SequenceClient {
     if ((options == null ? void 0 : options.refresh) === true) {
       this.disconnect();
     }
+    options.projectAccessKey = this.projectAccessKey;
     if (options) {
       if (options.authorize) {
         if (!options.app) {
@@ -4001,6 +4003,10 @@ const DefaultProviderConfig = {
 let sequenceWalletProvider;
 const initWallet = partialConfig => {
   var _config$networks$filt, _config$networks, _findNetworkConfig;
+  const projectAccessKey = partialConfig == null ? void 0 : partialConfig.projectAccessKey;
+  if (!projectAccessKey) {
+    console.warn('Please pass a projectAccessKey in initWallet config as it will be required in near future.');
+  }
   if (sequenceWalletProvider) {
     return sequenceWalletProvider;
   }
@@ -4022,9 +4028,13 @@ const initWallet = partialConfig => {
     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);
+  }).concat(newNetworks).map(network => {
+    const toAppend = projectAccessKey ? `/${projectAccessKey}` : '';
+    network.rpcUrl = network.rpcUrl + toAppend;
+    return network;
+  });
 
-  // This build a "public rpc" on demand, we build them on demand because we don't want to
+  // This builds 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.
   const providerForChainId = chainId => {
     if (!rpcProviders[chainId]) {
@@ -4055,7 +4065,7 @@ const initWallet = partialConfig => {
   const client = new SequenceClient(config.transports, itemStore, {
     defaultChainId: defaultNetwork,
     defaultEIP6492: config.defaultEIP6492
-  });
+  }, projectAccessKey);
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId);
   return sequenceWalletProvider;
 };

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

@@ -44,12 +44,13 @@ export type SequenceClientOptions = {
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
  */
 export declare class SequenceClient {
+    projectAccessKey?: string | undefined;
     private readonly session;
     private readonly defaultChainId;
     private readonly callbacks;
     readonly transport: ProviderTransport;
     readonly defaultEIP6492: boolean;
-    constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, options?: SequenceClientOptions | number);
+    constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, options?: SequenceClientOptions | number, projectAccessKey?: string | undefined);
     registerCallback<K extends keyof WalletEventTypes>(eventName: K, callback: WalletEventTypes[K]): () => void;
     onOpen(callback: WalletEventTypes['open']): () => void;
     onClose(callback: WalletEventTypes['close']): () => void;

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

@@ -3,6 +3,7 @@ import { MuxTransportTemplate } from "./transports/index.js";
 import { ItemStore } from "./utils.js";
 import { SequenceProvider } from "./provider.js";
 export interface ProviderConfig {
+    projectAccessKey?: string;
     localStorage?: ItemStore;
     defaultNetwork?: ChainIdLike;
     defaultEIP6492?: boolean;

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

@@ -111,6 +111,9 @@ export interface ConnectOptions {
     /** origin hint of the dapp's host opening the wallet. This value will automatically
      * be determined and verified for integrity, and can be omitted. */
     origin?: string;
+    /** access key for the project that can be obtained from Sequence Builder on sequence.build.
+     * This value will be automatically populated using the key passed in initWallet. */
+    projectAccessKey?: string;
     /** expiry number (in seconds) that is used for ETHAuth proof. Default is 1 week in seconds. */
     expiry?: number;
     /** authorize will perform an ETHAuth eip712 signing and return the proof to the dapp. */

package/package.json

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

package/src/client.ts

@@ -125,6 +125,8 @@ export type SequenceClientOptions = {
  *s
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
  */
+
+// TODO: rename Client to transport.. or something.. like SequenceTransport ..
 export class SequenceClient {
   private readonly session: SequenceClientSession
   private readonly defaultChainId: DefaultChainIdTracker
@@ -134,7 +136,12 @@ export class SequenceClient {
 
   public readonly defaultEIP6492: boolean
 
-  constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, options?: SequenceClientOptions | number) {
+  constructor(
+    transport: ProviderTransport | MuxTransportTemplate,
+    store: ItemStore,
+    options?: SequenceClientOptions | number,
+    public projectAccessKey?: string
+  ) {
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport)
     } else if (isProviderTransport(transport)) {
@@ -302,6 +309,8 @@ export class SequenceClient {
       this.disconnect()
     }
 
+    options.projectAccessKey = this.projectAccessKey
+
     if (options) {
       if (options.authorize) {
         if (!options.app) {

package/src/init.ts

@@ -16,6 +16,9 @@ import { SequenceClient } from './client'
 import { SequenceProvider } from './provider'
 
 export interface ProviderConfig {
+  // Access key for the project that can be obtained from Sequence Builder on sequence.build
+  projectAccessKey?: string
+
   // The local storage dependency for the wallet provider, defaults to window.localStorage.
   // For example, this option should be used when using React Native since window.localStorage is not available.
   localStorage?: ItemStore
@@ -55,6 +58,12 @@ export const DefaultProviderConfig = {
 let sequenceWalletProvider: SequenceProvider | undefined
 
 export const initWallet = (partialConfig?: Partial<ProviderConfig>) => {
+  const projectAccessKey = partialConfig?.projectAccessKey
+
+  if (!projectAccessKey) {
+    console.warn('Please pass a projectAccessKey in initWallet config as it will be required in near future.')
+  }
+
   if (sequenceWalletProvider) {
     return sequenceWalletProvider
   }
@@ -84,8 +93,13 @@ export const initWallet = (partialConfig?: Partial<ProviderConfig>) => {
       return network ? { ...n, ...network } : n
     })
     .concat(newNetworks)
+    .map(network => {
+      const toAppend = projectAccessKey ? `/${projectAccessKey}` : ''
+      network.rpcUrl = network.rpcUrl + toAppend
+      return network
+    })
 
-  // This build a "public rpc" on demand, we build them on demand because we don't want to
+  // This builds 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.
   const providerForChainId = (chainId: number) => {
     if (!rpcProviders[chainId]) {
@@ -118,10 +132,15 @@ export const initWallet = (partialConfig?: Partial<ProviderConfig>) => {
   const itemStore = config.localStorage || useBestStore()
 
   // Create client, provider and return signer
-  const client = new SequenceClient(config.transports, itemStore, {
-    defaultChainId: defaultNetwork,
-    defaultEIP6492: config.defaultEIP6492
-  })
+  const client = new SequenceClient(
+    config.transports,
+    itemStore,
+    {
+      defaultChainId: defaultNetwork,
+      defaultEIP6492: config.defaultEIP6492
+    },
+    projectAccessKey
+  )
 
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId)
   return sequenceWalletProvider
@@ -138,6 +157,5 @@ export const getWallet = () => {
   if (!sequenceWalletProvider) {
     throw new Error('Wallet has not been initialized, call sequence.initWallet(config) first.')
   }
-
   return sequenceWalletProvider
 }

package/src/transports/wallet-request-handler.ts

@@ -180,7 +180,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
     }
 
     // Build session response for connect details
-    connectDetails.session = await this.walletSession(chainId)
+    connectDetails.session = this.walletSession(chainId)
 
     return connectDetails
   }

package/src/types.ts

@@ -165,6 +165,10 @@ export interface ConnectOptions {
    * be determined and verified for integrity, and can be omitted. */
   origin?: string
 
+  /** access key for the project that can be obtained from Sequence Builder on sequence.build.
+   * This value will be automatically populated using the key passed in initWallet. */
+  projectAccessKey?: string
+
   /** expiry number (in seconds) that is used for ETHAuth proof. Default is 1 week in seconds. */
   expiry?: number