@polkadot/extension-dapp 0.44.8 → 0.44.9

package/bundle-polkadot-extension-dapp.js

@@ -20,7 +20,7 @@
     name: '@polkadot/extension-dapp',
     path: (({ url: (typeof document === 'undefined' && typeof location === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : typeof document === 'undefined' ? location.href : (document.currentScript && document.currentScript.src || new URL('bundle-polkadot-extension-dapp.js', document.baseURI).href)) }) && (typeof document === 'undefined' && typeof location === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : typeof document === 'undefined' ? location.href : (document.currentScript && document.currentScript.src || new URL('bundle-polkadot-extension-dapp.js', document.baseURI).href))) ? new URL((typeof document === 'undefined' && typeof location === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : typeof document === 'undefined' ? location.href : (document.currentScript && document.currentScript.src || new URL('bundle-polkadot-extension-dapp.js', document.baseURI).href))).pathname.substring(0, new URL((typeof document === 'undefined' && typeof location === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : typeof document === 'undefined' ? location.href : (document.currentScript && document.currentScript.src || new URL('bundle-polkadot-extension-dapp.js', document.baseURI).href))).pathname.lastIndexOf('/') + 1) : 'auto',
     type: 'esm',
-    version: '0.44.8'
+    version: '0.44.9'
   };
 
   const unwrapBytes = util.u8aUnwrapBytes;
@@ -28,6 +28,8 @@
 
   const win = window;
   win.injectedWeb3 = win.injectedWeb3 || {};
+  exports.isWeb3Injected = web3IsInjected();
+  exports.web3EnablePromise = null;
   function web3IsInjected() {
     return Object.values(win.injectedWeb3).filter(({
       connect,
@@ -56,8 +58,6 @@
   function filterAccounts(list, genesisHash, type) {
     return list.filter(a => (!a.type || !type || type.includes(a.type)) && (!a.genesisHash || !genesisHash || a.genesisHash === genesisHash));
   }
-  exports.isWeb3Injected = web3IsInjected();
-  exports.web3EnablePromise = null;
   function getWindowExtensions(originName) {
     return Promise.all(Object.entries(win.injectedWeb3).map(([nameOrHash, {
       connect,
@@ -74,6 +74,15 @@
       console.error(`Error initializing ${nameOrHash}: ${message}`);
     }))).then(exts => exts.filter(e => !!e));
   }
+  async function filterEnable(caller, extensions) {
+    if (!exports.web3EnablePromise) {
+      return throwError(caller);
+    }
+    const sources = await exports.web3EnablePromise;
+    return sources.filter(({
+      name
+    }) => !extensions || extensions.includes(name));
+  }
   function web3Enable(originName, compatInits = []) {
     if (!originName) {
       throw new Error('You must pass a name for your app to the web3Enable function');
@@ -105,14 +114,9 @@
     genesisHash,
     ss58Format
   } = {}) {
-    if (!exports.web3EnablePromise) {
-      return throwError('web3Accounts');
-    }
     const accounts = [];
-    const sources = await exports.web3EnablePromise;
-    const retrieved = await Promise.all(sources.filter(({
-      name: source
-    }) => !extensions || extensions.includes(source)).map(async ({
+    const sources = await filterEnable('web3Accounts', extensions);
+    const retrieved = await Promise.all(sources.map(async ({
       accounts,
       name: source
     }) => {
@@ -135,18 +139,13 @@
     genesisHash,
     ss58Format
   } = {}) {
-    if (!exports.web3EnablePromise) {
-      return throwError('web3AccountsSubscribe');
-    }
+    const sources = await filterEnable('web3AccountsSubscribe', extensions);
     const accounts = {};
     const triggerUpdate = () => cb(Object.entries(accounts).reduce((result, [source, list]) => {
       result.push(...mapAccounts(source, filterAccounts(list, genesisHash, accountType), ss58Format));
       return result;
     }, []));
-    const sources = await exports.web3EnablePromise;
-    const unsubs = sources.filter(({
-      name: source
-    }) => !extensions || extensions.includes(source)).map(({
+    const unsubs = sources.map(({
       accounts: {
         subscribe
       },

package/bundle.d.ts

@@ -4,10 +4,58 @@ export { unwrapBytes, wrapBytes } from './wrapBytes';
 declare let isWeb3Injected: boolean;
 declare let web3EnablePromise: Promise<InjectedExtension[]> | null;
 export { isWeb3Injected, web3EnablePromise };
+/**
+ * @summary Enables all the providers found on the injected window interface
+ * @description
+ * Enables all injected extensions that has been found on the page. This
+ * should be called before making use of any other web3* functions.
+ */
 export declare function web3Enable(originName: string, compatInits?: (() => Promise<boolean>)[]): Promise<InjectedExtension[]>;
+/**
+ * @summary Retrieves all the accounts across all providers
+ * @description
+ * This returns the full list of account available (accross all extensions) to
+ * the page. Filtereing options are available of a per-extension, per type and
+ * per-genesisHash basis. Optionally the accounts can be encoded with the provided
+ * ss58Format
+ */
 export declare function web3Accounts({ accountType, extensions, genesisHash, ss58Format }?: Web3AccountsOptions): Promise<InjectedAccountWithMeta[]>;
+/**
+ * @summary Subscribes to all the accounts across all providers
+ * @description
+ * This is the subscription version of the web3Accounts interface with
+ * updates as to when new accounts do become available. The list of filtering
+ * options are the same as for the web3Accounts interface.
+ */
 export declare function web3AccountsSubscribe(cb: (accounts: InjectedAccountWithMeta[]) => void | Promise<void>, { accountType, extensions, genesisHash, ss58Format }?: Web3AccountsOptions): Promise<Unsubcall>;
+/**
+ * @summary Finds a specific provider based on the name
+ * @description
+ * This retrieves a specific source (extension) based on the name. In most
+ * cases it should not be needed to call it directly (e.g. it is used internally
+ * by calls such as web3FromAddress) but would allow operation on a specific
+ * known extension.
+ */
 export declare function web3FromSource(source: string): Promise<InjectedExtension>;
+/**
+ * @summary Find a specific provider that provides a specific address
+ * @description
+ * Based on an address, return the provider that has makes this address
+ * available to the page.
+ */
 export declare function web3FromAddress(address: string): Promise<InjectedExtension>;
+/**
+ * @summary List all providers exposed by one source
+ * @description
+ * For extensions that supply RPC providers, this call would return the list
+ * of RPC providers that any extension may supply.
+ */
 export declare function web3ListRpcProviders(source: string): Promise<ProviderList | null>;
+/**
+ * @summary Start an RPC provider provider by a specific source
+ * @description
+ * For extensions that supply RPC providers, this call would return an
+ * enabled provider (initialized with the specific key) from the
+ * specified extension source.
+ */
 export declare function web3UseRpcProvider(source: string, key: string): Promise<InjectedProviderWithMeta>;

package/bundle.js

@@ -15,7 +15,14 @@ const win = window;
 // don't clobber the existing object, but ensure non-undefined
 win.injectedWeb3 = win.injectedWeb3 || {};
 
-// true when anything has been injected and is available
+// have we found a properly constructed window.injectedWeb3
+let isWeb3Injected = web3IsInjected();
+
+// we keep the last promise created around (for queries)
+let web3EnablePromise = null;
+export { isWeb3Injected, web3EnablePromise };
+
+/** @internal true when anything has been injected and is available */
 function web3IsInjected() {
   return Object.values(win.injectedWeb3).filter(({
     connect,
@@ -23,12 +30,12 @@ function web3IsInjected() {
   }) => !!(connect || enable)).length !== 0;
 }
 
-// helper to throw a consistent error when not enabled
+/** @internal throw a consistent error when not extensions have not been enabled */
 function throwError(method) {
   throw new Error(`${method}: web3Enable(originName) needs to be called before ${method}`);
 }
 
-// internal helper to map from Array<InjectedAccount> -> Array<InjectedAccountWithMeta>
+/** @internal map from Array<InjectedAccount> to Array<InjectedAccountWithMeta> */
 function mapAccounts(source, list, ss58Format) {
   return list.map(({
     address,
@@ -46,17 +53,12 @@ function mapAccounts(source, list, ss58Format) {
   }));
 }
 
-// internal helper to filter accounts
+/** @internal filter accounts based on genesisHash and type of account */
 function filterAccounts(list, genesisHash, type) {
   return list.filter(a => (!a.type || !type || type.includes(a.type)) && (!a.genesisHash || !genesisHash || a.genesisHash === genesisHash));
 }
 
-// have we found a properly constructed window.injectedWeb3
-let isWeb3Injected = web3IsInjected();
-
-// we keep the last promise created around (for queries)
-let web3EnablePromise = null;
-export { isWeb3Injected, web3EnablePromise };
+/** @internal retrieves all the extensions available on the window */
 function getWindowExtensions(originName) {
   return Promise.all(Object.entries(win.injectedWeb3).map(([nameOrHash, {
     connect,
@@ -76,7 +78,23 @@ function getWindowExtensions(originName) {
   }))).then(exts => exts.filter(e => !!e));
 }
 
-// enables all the providers found on the injected window interface
+/** @internal Ensure the enable promise is resolved and filter by extensions */
+async function filterEnable(caller, extensions) {
+  if (!web3EnablePromise) {
+    return throwError(caller);
+  }
+  const sources = await web3EnablePromise;
+  return sources.filter(({
+    name
+  }) => !extensions || extensions.includes(name));
+}
+
+/**
+ * @summary Enables all the providers found on the injected window interface
+ * @description
+ * Enables all injected extensions that has been found on the page. This
+ * should be called before making use of any other web3* functions.
+ */
 export function web3Enable(originName, compatInits = []) {
   if (!originName) {
     throw new Error('You must pass a name for your app to the web3Enable function');
@@ -105,21 +123,23 @@ export function web3Enable(originName, compatInits = []) {
   return web3EnablePromise;
 }
 
-// retrieve all the accounts across all providers
+/**
+ * @summary Retrieves all the accounts across all providers
+ * @description
+ * This returns the full list of account available (accross all extensions) to
+ * the page. Filtereing options are available of a per-extension, per type and
+ * per-genesisHash basis. Optionally the accounts can be encoded with the provided
+ * ss58Format
+ */
 export async function web3Accounts({
   accountType,
   extensions,
   genesisHash,
   ss58Format
 } = {}) {
-  if (!web3EnablePromise) {
-    return throwError('web3Accounts');
-  }
   const accounts = [];
-  const sources = await web3EnablePromise;
-  const retrieved = await Promise.all(sources.filter(({
-    name: source
-  }) => !extensions || extensions.includes(source)).map(async ({
+  const sources = await filterEnable('web3Accounts', extensions);
+  const retrieved = await Promise.all(sources.map(async ({
     accounts,
     name: source
   }) => {
@@ -137,24 +157,27 @@ export async function web3Accounts({
   console.info(`web3Accounts: Found ${accounts.length} address${accounts.length !== 1 ? 'es' : ''}`);
   return accounts;
 }
+
+/**
+ * @summary Subscribes to all the accounts across all providers
+ * @description
+ * This is the subscription version of the web3Accounts interface with
+ * updates as to when new accounts do become available. The list of filtering
+ * options are the same as for the web3Accounts interface.
+ */
 export async function web3AccountsSubscribe(cb, {
   accountType,
   extensions,
   genesisHash,
   ss58Format
 } = {}) {
-  if (!web3EnablePromise) {
-    return throwError('web3AccountsSubscribe');
-  }
+  const sources = await filterEnable('web3AccountsSubscribe', extensions);
   const accounts = {};
   const triggerUpdate = () => cb(Object.entries(accounts).reduce((result, [source, list]) => {
     result.push(...mapAccounts(source, filterAccounts(list, genesisHash, accountType), ss58Format));
     return result;
   }, []));
-  const sources = await web3EnablePromise;
-  const unsubs = sources.filter(({
-    name: source
-  }) => !extensions || extensions.includes(source)).map(({
+  const unsubs = sources.map(({
     accounts: {
       subscribe
     },
@@ -177,7 +200,14 @@ export async function web3AccountsSubscribe(cb, {
   };
 }
 
-// find a specific provider based on the name
+/**
+ * @summary Finds a specific provider based on the name
+ * @description
+ * This retrieves a specific source (extension) based on the name. In most
+ * cases it should not be needed to call it directly (e.g. it is used internally
+ * by calls such as web3FromAddress) but would allow operation on a specific
+ * known extension.
+ */
 export async function web3FromSource(source) {
   if (!web3EnablePromise) {
     return throwError('web3FromSource');
@@ -192,7 +222,12 @@ export async function web3FromSource(source) {
   return found;
 }
 
-// find a specific provider based on an address
+/**
+ * @summary Find a specific provider that provides a specific address
+ * @description
+ * Based on an address, return the provider that has makes this address
+ * available to the page.
+ */
 export async function web3FromAddress(address) {
   if (!web3EnablePromise) {
     return throwError('web3FromAddress');
@@ -209,7 +244,12 @@ export async function web3FromAddress(address) {
   return web3FromSource(found.meta.source);
 }
 
-// retrieve all providers exposed by one source
+/**
+ * @summary List all providers exposed by one source
+ * @description
+ * For extensions that supply RPC providers, this call would return the list
+ * of RPC providers that any extension may supply.
+ */
 export async function web3ListRpcProviders(source) {
   const {
     provider
@@ -221,7 +261,13 @@ export async function web3ListRpcProviders(source) {
   return provider.listProviders();
 }
 
-// retrieve all providers exposed by one source
+/**
+ * @summary Start an RPC provider provider by a specific source
+ * @description
+ * For extensions that supply RPC providers, this call would return an
+ * enabled provider (initialized with the specific key) from the
+ * specified extension source.
+ */
 export async function web3UseRpcProvider(source, key) {
   const {
     provider

package/cjs/bundle.js

@@ -46,7 +46,14 @@ const win = window;
 // don't clobber the existing object, but ensure non-undefined
 win.injectedWeb3 = win.injectedWeb3 || {};
 
-// true when anything has been injected and is available
+// have we found a properly constructed window.injectedWeb3
+let isWeb3Injected = web3IsInjected();
+
+// we keep the last promise created around (for queries)
+exports.isWeb3Injected = isWeb3Injected;
+let web3EnablePromise = null;
+exports.web3EnablePromise = web3EnablePromise;
+/** @internal true when anything has been injected and is available */
 function web3IsInjected() {
   return Object.values(win.injectedWeb3).filter(_ref => {
     let {
@@ -57,12 +64,12 @@ function web3IsInjected() {
   }).length !== 0;
 }
 
-// helper to throw a consistent error when not enabled
+/** @internal throw a consistent error when not extensions have not been enabled */
 function throwError(method) {
   throw new Error(`${method}: web3Enable(originName) needs to be called before ${method}`);
 }
 
-// internal helper to map from Array<InjectedAccount> -> Array<InjectedAccountWithMeta>
+/** @internal map from Array<InjectedAccount> to Array<InjectedAccountWithMeta> */
 function mapAccounts(source, list, ss58Format) {
   return list.map(_ref2 => {
     let {
@@ -83,18 +90,12 @@ function mapAccounts(source, list, ss58Format) {
   });
 }
 
-// internal helper to filter accounts
+/** @internal filter accounts based on genesisHash and type of account */
 function filterAccounts(list, genesisHash, type) {
   return list.filter(a => (!a.type || !type || type.includes(a.type)) && (!a.genesisHash || !genesisHash || a.genesisHash === genesisHash));
 }
 
-// have we found a properly constructed window.injectedWeb3
-let isWeb3Injected = web3IsInjected();
-
-// we keep the last promise created around (for queries)
-exports.isWeb3Injected = isWeb3Injected;
-let web3EnablePromise = null;
-exports.web3EnablePromise = web3EnablePromise;
+/** @internal retrieves all the extensions available on the window */
 function getWindowExtensions(originName) {
   return Promise.all(Object.entries(win.injectedWeb3).map(_ref3 => {
     let [nameOrHash, {
@@ -118,7 +119,26 @@ function getWindowExtensions(originName) {
   })).then(exts => exts.filter(e => !!e));
 }
 
-// enables all the providers found on the injected window interface
+/** @internal Ensure the enable promise is resolved and filter by extensions */
+async function filterEnable(caller, extensions) {
+  if (!web3EnablePromise) {
+    return throwError(caller);
+  }
+  const sources = await web3EnablePromise;
+  return sources.filter(_ref5 => {
+    let {
+      name
+    } = _ref5;
+    return !extensions || extensions.includes(name);
+  });
+}
+
+/**
+ * @summary Enables all the providers found on the injected window interface
+ * @description
+ * Enables all injected extensions that has been found on the page. This
+ * should be called before making use of any other web3* functions.
+ */
 function web3Enable(originName) {
   let compatInits = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   if (!originName) {
@@ -137,11 +157,11 @@ function web3Enable(originName) {
     }
     return e;
   })).catch(() => []).then(values => {
-    const names = values.map(_ref5 => {
+    const names = values.map(_ref6 => {
       let {
         name,
         version
-      } = _ref5;
+      } = _ref6;
       return `${name}/${version}`;
     });
     exports.isWeb3Injected = isWeb3Injected = web3IsInjected();
@@ -151,7 +171,14 @@ function web3Enable(originName) {
   return web3EnablePromise;
 }
 
-// retrieve all the accounts across all providers
+/**
+ * @summary Retrieves all the accounts across all providers
+ * @description
+ * This returns the full list of account available (accross all extensions) to
+ * the page. Filtereing options are available of a per-extension, per type and
+ * per-genesisHash basis. Optionally the accounts can be encoded with the provided
+ * ss58Format
+ */
 async function web3Accounts() {
   let {
     accountType,
@@ -159,17 +186,9 @@ async function web3Accounts() {
     genesisHash,
     ss58Format
   } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  if (!web3EnablePromise) {
-    return throwError('web3Accounts');
-  }
   const accounts = [];
-  const sources = await web3EnablePromise;
-  const retrieved = await Promise.all(sources.filter(_ref6 => {
-    let {
-      name: source
-    } = _ref6;
-    return !extensions || extensions.includes(source);
-  }).map(async _ref7 => {
+  const sources = await filterEnable('web3Accounts', extensions);
+  const retrieved = await Promise.all(sources.map(async _ref7 => {
     let {
       accounts,
       name: source
@@ -188,6 +207,14 @@ async function web3Accounts() {
   console.info(`web3Accounts: Found ${accounts.length} address${accounts.length !== 1 ? 'es' : ''}`);
   return accounts;
 }
+
+/**
+ * @summary Subscribes to all the accounts across all providers
+ * @description
+ * This is the subscription version of the web3Accounts interface with
+ * updates as to when new accounts do become available. The list of filtering
+ * options are the same as for the web3Accounts interface.
+ */
 async function web3AccountsSubscribe(cb) {
   let {
     accountType,
@@ -195,28 +222,20 @@ async function web3AccountsSubscribe(cb) {
     genesisHash,
     ss58Format
   } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  if (!web3EnablePromise) {
-    return throwError('web3AccountsSubscribe');
-  }
+  const sources = await filterEnable('web3AccountsSubscribe', extensions);
   const accounts = {};
   const triggerUpdate = () => cb(Object.entries(accounts).reduce((result, _ref8) => {
     let [source, list] = _ref8;
     result.push(...mapAccounts(source, filterAccounts(list, genesisHash, accountType), ss58Format));
     return result;
   }, []));
-  const sources = await web3EnablePromise;
-  const unsubs = sources.filter(_ref9 => {
-    let {
-      name: source
-    } = _ref9;
-    return !extensions || extensions.includes(source);
-  }).map(_ref10 => {
+  const unsubs = sources.map(_ref9 => {
     let {
       accounts: {
         subscribe
       },
       name: source
-    } = _ref10;
+    } = _ref9;
     return subscribe(result => {
       accounts[source] = result;
       try {
@@ -236,16 +255,23 @@ async function web3AccountsSubscribe(cb) {
   };
 }
 
-// find a specific provider based on the name
+/**
+ * @summary Finds a specific provider based on the name
+ * @description
+ * This retrieves a specific source (extension) based on the name. In most
+ * cases it should not be needed to call it directly (e.g. it is used internally
+ * by calls such as web3FromAddress) but would allow operation on a specific
+ * known extension.
+ */
 async function web3FromSource(source) {
   if (!web3EnablePromise) {
     return throwError('web3FromSource');
   }
   const sources = await web3EnablePromise;
-  const found = source && sources.find(_ref11 => {
+  const found = source && sources.find(_ref10 => {
     let {
       name
-    } = _ref11;
+    } = _ref10;
     return name === source;
   });
   if (!found) {
@@ -254,7 +280,12 @@ async function web3FromSource(source) {
   return found;
 }
 
-// find a specific provider based on an address
+/**
+ * @summary Find a specific provider that provides a specific address
+ * @description
+ * Based on an address, return the provider that has makes this address
+ * available to the page.
+ */
 async function web3FromAddress(address) {
   if (!web3EnablePromise) {
     return throwError('web3FromAddress');
@@ -271,7 +302,12 @@ async function web3FromAddress(address) {
   return web3FromSource(found.meta.source);
 }
 
-// retrieve all providers exposed by one source
+/**
+ * @summary List all providers exposed by one source
+ * @description
+ * For extensions that supply RPC providers, this call would return the list
+ * of RPC providers that any extension may supply.
+ */
 async function web3ListRpcProviders(source) {
   const {
     provider
@@ -283,7 +319,13 @@ async function web3ListRpcProviders(source) {
   return provider.listProviders();
 }
 
-// retrieve all providers exposed by one source
+/**
+ * @summary Start an RPC provider provider by a specific source
+ * @description
+ * For extensions that supply RPC providers, this call would return an
+ * enabled provider (initialized with the specific key) from the
+ * specified extension source.
+ */
 async function web3UseRpcProvider(source, key) {
   const {
     provider

package/cjs/packageInfo.js

@@ -13,6 +13,6 @@ const packageInfo = {
   name: '@polkadot/extension-dapp',
   path: typeof __dirname === 'string' ? __dirname : 'auto',
   type: 'cjs',
-  version: '0.44.8'
+  version: '0.44.9'
 };
 exports.packageInfo = packageInfo;

package/package.json

@@ -17,7 +17,7 @@
     "./cjs/detectPackage.js"
   ],
   "type": "module",
-  "version": "0.44.8",
+  "version": "0.44.9",
   "main": "./cjs/index.js",
   "module": "./index.js",
   "types": "./index.d.ts",
@@ -67,10 +67,10 @@
     }
   },
   "dependencies": {
-    "@babel/runtime": "^7.20.7",
-    "@polkadot/extension-inject": "^0.44.8",
-    "@polkadot/util": "^10.2.3",
-    "@polkadot/util-crypto": "^10.2.3"
+    "@babel/runtime": "^7.20.13",
+    "@polkadot/extension-inject": "^0.44.9",
+    "@polkadot/util": "^10.4.2",
+    "@polkadot/util-crypto": "^10.4.2"
   },
   "peerDependencies": {
     "@polkadot/api": "*",

package/packageInfo.js

@@ -7,5 +7,5 @@ export const packageInfo = {
   name: '@polkadot/extension-dapp',
   path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto',
   type: 'esm',
-  version: '0.44.8'
+  version: '0.44.9'
 };