@0xsequence/provider 1.6.2 → 1.7.0

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

@@ -3573,7 +3573,7 @@ class SingleNetworkSequenceProvider extends SequenceProvider {
 
 var packageJson = {
 	name: "@0xsequence/provider",
-	version: "1.6.2",
+	version: "1.7.0",
 	description: "provider sub-package for Sequence",
 	repository: "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
 	source: "src/index.ts",
@@ -4051,11 +4051,19 @@ const DefaultProviderConfig = {
   defaultNetwork: 1
 };
 let sequenceWalletProvider;
-const initWallet = partialConfig => {
+
+/**
+ * Initializes a wallet with the provided project access key and optional configuration.
+ *
+ * @param projectAccessKey - Access key for the project that can be obtained from Sequence Builder on sequence.build
+ * @param partialConfig - Optional partial configuration for the wallet.
+ * @returns The initialized wallet provider.
+ * @throws Error if projectAccessKey is not provided, empty string or is not string.
+ */
+const initWallet = (projectAccessKey, 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 (!projectAccessKey || typeof projectAccessKey !== 'string') {
+    throw new Error('Please pass a projectAccessKey in initWallet.');
   }
   if (sequenceWalletProvider) {
     return sequenceWalletProvider;
@@ -4079,8 +4087,7 @@ const initWallet = partialConfig => {
     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).map(network => {
-    const toAppend = projectAccessKey ? `/${projectAccessKey}` : '';
-    network.rpcUrl = network.rpcUrl + toAppend;
+    network.rpcUrl = network.rpcUrl + `/${projectAccessKey}`;
     return network;
   });
 

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

@@ -3573,7 +3573,7 @@ class SingleNetworkSequenceProvider extends SequenceProvider {
 
 var packageJson = {
 	name: "@0xsequence/provider",
-	version: "1.6.2",
+	version: "1.7.0",
 	description: "provider sub-package for Sequence",
 	repository: "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
 	source: "src/index.ts",
@@ -4051,11 +4051,19 @@ const DefaultProviderConfig = {
   defaultNetwork: 1
 };
 let sequenceWalletProvider;
-const initWallet = partialConfig => {
+
+/**
+ * Initializes a wallet with the provided project access key and optional configuration.
+ *
+ * @param projectAccessKey - Access key for the project that can be obtained from Sequence Builder on sequence.build
+ * @param partialConfig - Optional partial configuration for the wallet.
+ * @returns The initialized wallet provider.
+ * @throws Error if projectAccessKey is not provided, empty string or is not string.
+ */
+const initWallet = (projectAccessKey, 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 (!projectAccessKey || typeof projectAccessKey !== 'string') {
+    throw new Error('Please pass a projectAccessKey in initWallet.');
   }
   if (sequenceWalletProvider) {
     return sequenceWalletProvider;
@@ -4079,8 +4087,7 @@ const initWallet = partialConfig => {
     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).map(network => {
-    const toAppend = projectAccessKey ? `/${projectAccessKey}` : '';
-    network.rpcUrl = network.rpcUrl + toAppend;
+    network.rpcUrl = network.rpcUrl + `/${projectAccessKey}`;
     return network;
   });
 

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

@@ -3569,7 +3569,7 @@ class SingleNetworkSequenceProvider extends SequenceProvider {
 
 var packageJson = {
 	name: "@0xsequence/provider",
-	version: "1.6.2",
+	version: "1.7.0",
 	description: "provider sub-package for Sequence",
 	repository: "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
 	source: "src/index.ts",
@@ -4047,11 +4047,19 @@ const DefaultProviderConfig = {
   defaultNetwork: 1
 };
 let sequenceWalletProvider;
-const initWallet = partialConfig => {
+
+/**
+ * Initializes a wallet with the provided project access key and optional configuration.
+ *
+ * @param projectAccessKey - Access key for the project that can be obtained from Sequence Builder on sequence.build
+ * @param partialConfig - Optional partial configuration for the wallet.
+ * @returns The initialized wallet provider.
+ * @throws Error if projectAccessKey is not provided, empty string or is not string.
+ */
+const initWallet = (projectAccessKey, 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 (!projectAccessKey || typeof projectAccessKey !== 'string') {
+    throw new Error('Please pass a projectAccessKey in initWallet.');
   }
   if (sequenceWalletProvider) {
     return sequenceWalletProvider;
@@ -4075,8 +4083,7 @@ const initWallet = partialConfig => {
     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).map(network => {
-    const toAppend = projectAccessKey ? `/${projectAccessKey}` : '';
-    network.rpcUrl = network.rpcUrl + toAppend;
+    network.rpcUrl = network.rpcUrl + `/${projectAccessKey}`;
     return network;
   });
 

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

@@ -3,7 +3,6 @@ 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;
@@ -22,6 +21,14 @@ export declare const DefaultProviderConfig: {
     };
     defaultNetwork: number;
 };
-export declare const initWallet: (partialConfig?: Partial<ProviderConfig>) => SequenceProvider;
+/**
+ * Initializes a wallet with the provided project access key and optional configuration.
+ *
+ * @param projectAccessKey - Access key for the project that can be obtained from Sequence Builder on sequence.build
+ * @param partialConfig - Optional partial configuration for the wallet.
+ * @returns The initialized wallet provider.
+ * @throws Error if projectAccessKey is not provided, empty string or is not string.
+ */
+export declare const initWallet: (projectAccessKey: string, partialConfig?: Partial<ProviderConfig>) => SequenceProvider;
 export declare const unregisterWallet: () => void;
 export declare const getWallet: () => SequenceProvider;

package/package.json

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

package/src/init.ts

@@ -16,9 +16,6 @@ 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
@@ -57,11 +54,17 @@ 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.')
+/**
+ * Initializes a wallet with the provided project access key and optional configuration.
+ *
+ * @param projectAccessKey - Access key for the project that can be obtained from Sequence Builder on sequence.build
+ * @param partialConfig - Optional partial configuration for the wallet.
+ * @returns The initialized wallet provider.
+ * @throws Error if projectAccessKey is not provided, empty string or is not string.
+ */
+export const initWallet = (projectAccessKey: string, partialConfig?: Partial<ProviderConfig>) => {
+  if (!projectAccessKey || typeof projectAccessKey !== 'string') {
+    throw new Error('Please pass a projectAccessKey in initWallet.')
   }
 
   if (sequenceWalletProvider) {
@@ -94,8 +97,7 @@ export const initWallet = (partialConfig?: Partial<ProviderConfig>) => {
     })
     .concat(newNetworks)
     .map(network => {
-      const toAppend = projectAccessKey ? `/${projectAccessKey}` : ''
-      network.rpcUrl = network.rpcUrl + toAppend
+      network.rpcUrl = network.rpcUrl + `/${projectAccessKey}`
       return network
     })