@polkadot/extension-dapp 0.44.8 → 0.45.1

package/cjs/bundle.js

@@ -1,299 +1,246 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isWeb3Injected = void 0;
-Object.defineProperty(exports, "packageInfo", {
-  enumerable: true,
-  get: function () {
-    return _packageInfo.packageInfo;
-  }
-});
-Object.defineProperty(exports, "unwrapBytes", {
-  enumerable: true,
-  get: function () {
-    return _wrapBytes.unwrapBytes;
-  }
-});
-exports.web3Accounts = web3Accounts;
-exports.web3AccountsSubscribe = web3AccountsSubscribe;
-exports.web3Enable = web3Enable;
-exports.web3EnablePromise = void 0;
-exports.web3FromAddress = web3FromAddress;
-exports.web3FromSource = web3FromSource;
-exports.web3ListRpcProviders = web3ListRpcProviders;
-exports.web3UseRpcProvider = web3UseRpcProvider;
-Object.defineProperty(exports, "wrapBytes", {
-  enumerable: true,
-  get: function () {
-    return _wrapBytes.wrapBytes;
-  }
-});
-var _util = require("@polkadot/util");
-var _utilCrypto = require("@polkadot/util-crypto");
-var _util2 = require("./util");
-var _packageInfo = require("./packageInfo");
-var _wrapBytes = require("./wrapBytes");
-// Copyright 2019-2023 @polkadot/extension-dapp authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-// expose utility functions
-
-// just a helper (otherwise we cast all-over, so shorter and more readable)
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.web3UseRpcProvider = exports.web3ListRpcProviders = exports.web3FromAddress = exports.web3FromSource = exports.web3AccountsSubscribe = exports.web3Accounts = exports.web3Enable = exports.web3EnablePromise = exports.isWeb3Injected = exports.wrapBytes = exports.unwrapBytes = exports.packageInfo = void 0;
+const util_1 = require("@polkadot/util");
+const util_crypto_1 = require("@polkadot/util-crypto");
+const util_2 = require("./util");
+var packageInfo_1 = require("./packageInfo");
+Object.defineProperty(exports, "packageInfo", { enumerable: true, get: function () { return packageInfo_1.packageInfo; } });
+var wrapBytes_1 = require("./wrapBytes");
+Object.defineProperty(exports, "unwrapBytes", { enumerable: true, get: function () { return wrapBytes_1.unwrapBytes; } });
+Object.defineProperty(exports, "wrapBytes", { enumerable: true, get: function () { return wrapBytes_1.wrapBytes; } });
 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
+let isWeb3Injected = web3IsInjected();
+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 {
-      connect,
-      enable
-    } = _ref;
-    return !!(connect || enable);
-  }).length !== 0;
+    return Object
+        .values(win.injectedWeb3)
+        .filter(({ connect, enable }) => !!(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}`);
+    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 {
-      address,
-      genesisHash,
-      name,
-      type
-    } = _ref2;
-    return {
-      address: address.length === 42 ? address : (0, _utilCrypto.encodeAddress)((0, _utilCrypto.decodeAddress)(address), ss58Format),
-      meta: {
-        genesisHash,
-        name,
-        source
-      },
-      type
-    };
-  });
+    return list.map(({ address, genesisHash, name, type }) => ({
+        address: address.length === 42
+            ? address
+            : (0, util_crypto_1.encodeAddress)((0, util_crypto_1.decodeAddress)(address), ss58Format),
+        meta: { genesisHash, name, source },
+        type
+    }));
 }
-
-// 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));
+    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, {
-      connect,
-      enable,
-      version
-    }] = _ref3;
-    return Promise.resolve().then(() => connect
-    // new style, returning all info
-    ? connect(originName) : enable
-    // previous interface, leakages on name/version
-    ? enable(originName).then(e => (0, _util.objectSpread)({
-      name: nameOrHash,
-      version: version || 'unknown'
-    }, e)) : Promise.reject(new Error('No connect(..) or enable(...) hook found'))).catch(_ref4 => {
-      let {
-        message
-      } = _ref4;
-      console.error(`Error initializing ${nameOrHash}: ${message}`);
-    });
-  })).then(exts => exts.filter(e => !!e));
+    return Promise
+        .all(Object
+        .entries(win.injectedWeb3)
+        .map(([nameOrHash, { connect, enable, version }]) => Promise
+        .resolve()
+        .then(() => connect
+        // new style, returning all info
+        ? connect(originName)
+        : enable
+            // previous interface, leakages on name/version
+            ? enable(originName).then((e) => (0, util_1.objectSpread)({ name: nameOrHash, version: version || 'unknown' }, e))
+            : Promise.reject(new Error('No connect(..) or enable(...) hook found')))
+        .catch(({ message }) => {
+        console.error(`Error initializing ${nameOrHash}: ${message}`);
+    })))
+        .then((exts) => exts.filter((e) => !!e));
 }
-
-// enables all the providers found on the injected window interface
-function web3Enable(originName) {
-  let compatInits = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-  if (!originName) {
-    throw new Error('You must pass a name for your app to the web3Enable function');
-  }
-  const initCompat = compatInits.length ? Promise.all(compatInits.map(c => c().catch(() => false))) : Promise.resolve([true]);
-  exports.web3EnablePromise = web3EnablePromise = (0, _util2.documentReadyPromise)(() => initCompat.then(() => getWindowExtensions(originName).then(values => values.map(e => {
-    // if we don't have an accounts subscriber, add a single-shot version
-    if (!e.accounts.subscribe) {
-      e.accounts.subscribe = cb => {
-        e.accounts.get().then(cb).catch(console.error);
-        return () => {
-          // no ubsubscribe needed, this is a single-shot
-        };
-      };
+/** @internal Ensure the enable promise is resolved and filter by extensions */
+async function filterEnable(caller, extensions) {
+    if (!web3EnablePromise) {
+        return throwError(caller);
     }
-    return e;
-  })).catch(() => []).then(values => {
-    const names = values.map(_ref5 => {
-      let {
-        name,
-        version
-      } = _ref5;
-      return `${name}/${version}`;
-    });
-    exports.isWeb3Injected = isWeb3Injected = web3IsInjected();
-    console.info(`web3Enable: Enabled ${values.length} extension${values.length !== 1 ? 's' : ''}: ${names.join(', ')}`);
-    return values;
-  })));
-  return web3EnablePromise;
+    const sources = await web3EnablePromise;
+    return sources.filter(({ name }) => !extensions ||
+        extensions.includes(name));
 }
-
-// retrieve all the accounts across all providers
-async function web3Accounts() {
-  let {
-    accountType,
-    extensions,
-    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 => {
-    let {
-      accounts,
-      name: source
-    } = _ref7;
-    try {
-      const list = await accounts.get();
-      return mapAccounts(source, filterAccounts(list, genesisHash, accountType), ss58Format);
-    } catch (error) {
-      // cannot handle this one
-      return [];
+/**
+ * @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, compatInits = []) {
+    if (!originName) {
+        throw new Error('You must pass a name for your app to the web3Enable function');
     }
-  }));
-  retrieved.forEach(result => {
-    accounts.push(...result);
-  });
-  console.info(`web3Accounts: Found ${accounts.length} address${accounts.length !== 1 ? 'es' : ''}`);
-  return accounts;
+    const initCompat = compatInits.length
+        ? Promise.all(compatInits.map((c) => c().catch(() => false)))
+        : Promise.resolve([true]);
+    exports.web3EnablePromise = web3EnablePromise = (0, util_2.documentReadyPromise)(() => initCompat.then(() => getWindowExtensions(originName)
+        .then((values) => values.map((e) => {
+        // if we don't have an accounts subscriber, add a single-shot version
+        if (!e.accounts.subscribe) {
+            e.accounts.subscribe = (cb) => {
+                e.accounts
+                    .get()
+                    .then(cb)
+                    .catch(console.error);
+                return () => {
+                    // no ubsubscribe needed, this is a single-shot
+                };
+            };
+        }
+        return e;
+    }))
+        .catch(() => [])
+        .then((values) => {
+        const names = values.map(({ name, version }) => `${name}/${version}`);
+        exports.isWeb3Injected = isWeb3Injected = web3IsInjected();
+        console.info(`web3Enable: Enabled ${values.length} extension${values.length !== 1 ? 's' : ''}: ${names.join(', ')}`);
+        return values;
+    })));
+    return web3EnablePromise;
 }
-async function web3AccountsSubscribe(cb) {
-  let {
-    accountType,
-    extensions,
-    genesisHash,
-    ss58Format
-  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  if (!web3EnablePromise) {
-    return throwError('web3AccountsSubscribe');
-  }
-  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 => {
-    let {
-      accounts: {
-        subscribe
-      },
-      name: source
-    } = _ref10;
-    return subscribe(result => {
-      accounts[source] = result;
-      try {
-        const result = triggerUpdate();
-        if (result && (0, _util.isPromise)(result)) {
-          result.catch(console.error);
+exports.web3Enable = web3Enable;
+/**
+ * @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({ accountType, extensions, genesisHash, ss58Format } = {}) {
+    const accounts = [];
+    const sources = await filterEnable('web3Accounts', extensions);
+    const retrieved = await Promise.all(sources.map(async ({ accounts, name: source }) => {
+        try {
+            const list = await accounts.get();
+            return mapAccounts(source, filterAccounts(list, genesisHash, accountType), ss58Format);
         }
-      } catch (error) {
-        console.error(error);
-      }
-    });
-  });
-  return () => {
-    unsubs.forEach(unsub => {
-      unsub();
+        catch (error) {
+            // cannot handle this one
+            return [];
+        }
+    }));
+    retrieved.forEach((result) => {
+        accounts.push(...result);
     });
-  };
+    console.info(`web3Accounts: Found ${accounts.length} address${accounts.length !== 1 ? 'es' : ''}`);
+    return accounts;
+}
+exports.web3Accounts = web3Accounts;
+/**
+ * @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, { accountType, extensions, genesisHash, ss58Format } = {}) {
+    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 unsubs = sources.map(({ accounts: { subscribe }, name: source }) => subscribe((result) => {
+        accounts[source] = result;
+        try {
+            const result = triggerUpdate();
+            if (result && (0, util_1.isPromise)(result)) {
+                result.catch(console.error);
+            }
+        }
+        catch (error) {
+            console.error(error);
+        }
+    }));
+    return () => {
+        unsubs.forEach((unsub) => {
+            unsub();
+        });
+    };
 }
-
-// find a specific provider based on the name
+exports.web3AccountsSubscribe = web3AccountsSubscribe;
+/**
+ * @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 => {
-    let {
-      name
-    } = _ref11;
-    return name === source;
-  });
-  if (!found) {
-    throw new Error(`web3FromSource: Unable to find an injected ${source}`);
-  }
-  return found;
+    if (!web3EnablePromise) {
+        return throwError('web3FromSource');
+    }
+    const sources = await web3EnablePromise;
+    const found = source && sources.find(({ name }) => name === source);
+    if (!found) {
+        throw new Error(`web3FromSource: Unable to find an injected ${source}`);
+    }
+    return found;
 }
-
-// find a specific provider based on an address
+exports.web3FromSource = web3FromSource;
+/**
+ * @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');
-  }
-  const accounts = await web3Accounts();
-  let found;
-  if (address) {
-    const accountU8a = (0, _utilCrypto.decodeAddress)(address);
-    found = accounts.find(account => (0, _util.u8aEq)((0, _utilCrypto.decodeAddress)(account.address), accountU8a));
-  }
-  if (!found) {
-    throw new Error(`web3FromAddress: Unable to find injected ${address}`);
-  }
-  return web3FromSource(found.meta.source);
+    if (!web3EnablePromise) {
+        return throwError('web3FromAddress');
+    }
+    const accounts = await web3Accounts();
+    let found;
+    if (address) {
+        const accountU8a = (0, util_crypto_1.decodeAddress)(address);
+        found = accounts.find((account) => (0, util_1.u8aEq)((0, util_crypto_1.decodeAddress)(account.address), accountU8a));
+    }
+    if (!found) {
+        throw new Error(`web3FromAddress: Unable to find injected ${address}`);
+    }
+    return web3FromSource(found.meta.source);
 }
-
-// retrieve all providers exposed by one source
+exports.web3FromAddress = web3FromAddress;
+/**
+ * @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
-  } = await web3FromSource(source);
-  if (!provider) {
-    console.warn(`Extension ${source} does not expose any provider`);
-    return null;
-  }
-  return provider.listProviders();
+    const { provider } = await web3FromSource(source);
+    if (!provider) {
+        console.warn(`Extension ${source} does not expose any provider`);
+        return null;
+    }
+    return provider.listProviders();
 }
-
-// retrieve all providers exposed by one source
+exports.web3ListRpcProviders = web3ListRpcProviders;
+/**
+ * @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
-  } = await web3FromSource(source);
-  if (!provider) {
-    throw new Error(`Extension ${source} does not expose any provider`);
-  }
-  const meta = await provider.startProvider(key);
-  return {
-    meta,
-    provider
-  };
-}
+    const { provider } = await web3FromSource(source);
+    if (!provider) {
+        throw new Error(`Extension ${source} does not expose any provider`);
+    }
+    const meta = await provider.startProvider(key);
+    return { meta, provider };
+}
+exports.web3UseRpcProvider = web3UseRpcProvider;

package/cjs/detectOther.js

@@ -1,11 +1,4 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _packageInfo = require("@polkadot/extension-inject/cjs/packageInfo");
-// Copyright 2017-2023 @polkadot/extension-dapp authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-var _default = [_packageInfo.packageInfo];
-exports.default = _default;
+Object.defineProperty(exports, "__esModule", { value: true });
+const packageInfo_1 = require("@polkadot/extension-inject/cjs/packageInfo");
+exports.default = [packageInfo_1.packageInfo];

package/cjs/detectPackage.js

@@ -1,12 +1,7 @@
 "use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _util = require("@polkadot/util");
-var _detectOther = _interopRequireDefault(require("./detectOther"));
-var _packageInfo = require("./packageInfo");
-// Copyright 2017-2023 @polkadot/extension-dapp authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-// Do not edit, auto-generated by @polkadot/dev
-
-(0, _util.detectPackage)(_packageInfo.packageInfo, null, _detectOther.default);
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const util_1 = require("@polkadot/util");
+const detectOther_1 = tslib_1.__importDefault(require("./detectOther"));
+const packageInfo_1 = require("./packageInfo");
+(0, util_1.detectPackage)(packageInfo_1.packageInfo, null, detectOther_1.default);

package/cjs/index.js

@@ -1,16 +1,4 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _bundle = require("./bundle");
-Object.keys(_bundle).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _bundle[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _bundle[key];
-    }
-  });
-});
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./bundle"), exports);

package/cjs/packageInfo.js

@@ -1,18 +1,4 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageInfo = void 0;
-// Copyright 2017-2023 @polkadot/extension-dapp authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-// Do not edit, auto-generated by @polkadot/dev
-
-const packageInfo = {
-  name: '@polkadot/extension-dapp',
-  path: typeof __dirname === 'string' ? __dirname : 'auto',
-  type: 'cjs',
-  version: '0.44.8'
-};
-exports.packageInfo = packageInfo;
+exports.packageInfo = { name: '@polkadot/extension-dapp', path: typeof __dirname === 'string' ? __dirname : 'auto', type: 'cjs', version: '0.45.1' };

package/cjs/util.js

@@ -1,18 +1,14 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.documentReadyPromise = documentReadyPromise;
-// Copyright 2019-2023 @polkadot/extension-dapp authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.documentReadyPromise = void 0;
 function documentReadyPromise(creator) {
-  return new Promise(resolve => {
-    if (document.readyState === 'complete') {
-      resolve(creator());
-    } else {
-      window.addEventListener('load', () => resolve(creator()));
-    }
-  });
-}
+    return new Promise((resolve) => {
+        if (document.readyState === 'complete') {
+            resolve(creator());
+        }
+        else {
+            window.addEventListener('load', () => resolve(creator()));
+        }
+    });
+}
+exports.documentReadyPromise = documentReadyPromise;

package/cjs/wrapBytes.js

@@ -1,22 +1,10 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.wrapBytes = exports.unwrapBytes = exports.isWrapped = exports.PREFIX = exports.POSTFIX = exports.ETHEREUM = void 0;
-var _util = require("@polkadot/util");
-// Copyright 2019-2023 @polkadot/extension authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-const ETHEREUM = _util.U8A_WRAP_ETHEREUM;
-exports.ETHEREUM = ETHEREUM;
-const POSTFIX = _util.U8A_WRAP_POSTFIX;
-exports.POSTFIX = POSTFIX;
-const PREFIX = _util.U8A_WRAP_PREFIX;
-exports.PREFIX = PREFIX;
-const isWrapped = _util.u8aIsWrapped;
-exports.isWrapped = isWrapped;
-const unwrapBytes = _util.u8aUnwrapBytes;
-exports.unwrapBytes = unwrapBytes;
-const wrapBytes = _util.u8aWrapBytes;
-exports.wrapBytes = wrapBytes;
+const util_1 = require("@polkadot/util");
+exports.ETHEREUM = util_1.U8A_WRAP_ETHEREUM;
+exports.POSTFIX = util_1.U8A_WRAP_POSTFIX;
+exports.PREFIX = util_1.U8A_WRAP_PREFIX;
+exports.isWrapped = util_1.u8aIsWrapped;
+exports.unwrapBytes = util_1.u8aUnwrapBytes;
+exports.wrapBytes = util_1.u8aWrapBytes;