@pezkuwi/extension-dapp 0.62.7 → 0.62.8

package/src/bundle.ts

@@ -0,0 +1,319 @@
+// Copyright 2019-2025 @pezkuwi/extension-dapp authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { InjectedAccount, InjectedAccountWithMeta, InjectedExtension, InjectedProviderWithMeta, InjectedWindow, ProviderList, Unsubcall, Web3AccountsOptions } from '@pezkuwi/extension-inject/types';
+
+import { isPromise, objectSpread, u8aEq } from '@pezkuwi/util';
+import { decodeAddress, encodeAddress } from '@pezkuwi/util-crypto';
+
+import { documentReadyPromise } from './util.js';
+
+// expose utility functions
+export { packageInfo } from './packageInfo.js';
+export { unwrapBytes, wrapBytes } from './wrapBytes.js';
+
+// just a helper (otherwise we cast all-over, so shorter and more readable)
+const win = window as Window & InjectedWindow;
+
+// don't clobber the existing object, but ensure non-undefined
+win.injectedWeb3 = win.injectedWeb3 || {};
+
+// have we found a properly constructed window.injectedWeb3
+let isWeb3Injected = web3IsInjected();
+
+// we keep the last promise created around (for queries)
+let web3EnablePromise: Promise<InjectedExtension[]> | null = null;
+
+export { isWeb3Injected, web3EnablePromise };
+
+/** @internal true when anything has been injected and is available */
+function web3IsInjected (): boolean {
+  return Object
+    .values(win.injectedWeb3)
+    .filter(({ connect, enable }) => !!(connect || enable))
+    .length !== 0;
+}
+
+/** @internal throw a consistent error when not extensions have not been enabled */
+function throwError (method: string): never {
+  throw new Error(`${method}: web3Enable(originName) needs to be called before ${method}`);
+}
+
+/** @internal map from Array<InjectedAccount> to Array<InjectedAccountWithMeta> */
+function mapAccounts (source: string, list: InjectedAccount[], ss58Format?: number): InjectedAccountWithMeta[] {
+  return list.map(({ address, genesisHash, name, type }): InjectedAccountWithMeta => ({
+    address: address.length === 42
+      ? address
+      : encodeAddress(decodeAddress(address), ss58Format),
+    meta: { genesisHash, name, source },
+    type
+  }));
+}
+
+/** @internal filter accounts based on genesisHash and type of account */
+function filterAccounts (list: InjectedAccount[], genesisHash?: string | null, type?: string[]): InjectedAccount[] {
+  return list.filter((a) =>
+    (!a.type || !type || type.includes(a.type)) &&
+    (!a.genesisHash || !genesisHash || a.genesisHash === genesisHash)
+  );
+}
+
+/** @internal retrieves all the extensions available on the window */
+function getWindowExtensions (originName: string): Promise<InjectedExtension[]> {
+  return Promise
+    .all(
+      Object
+        .entries(win.injectedWeb3)
+        .map(([nameOrHash, { connect, enable, version }]): Promise<(InjectedExtension | void)> =>
+          Promise
+            .resolve()
+            .then(() =>
+              connect
+                // new style, returning all info
+                ? connect(originName)
+                : enable
+                  // previous interface, leakages on name/version
+                  ? enable(originName).then((e) =>
+                    objectSpread<InjectedExtension>({ name: nameOrHash, version: version || 'unknown' }, e)
+                  )
+                  : Promise.reject(new Error('No connect(..) or enable(...) hook found'))
+            )
+            .catch(({ message }: Error): void => {
+              console.error(`Error initializing ${nameOrHash}: ${message}`);
+            })
+        )
+    )
+    .then((exts) => exts.filter((e): e is InjectedExtension => !!e));
+}
+
+/** @internal Ensure the enable promise is resolved and filter by extensions */
+async function filterEnable (caller: 'web3Accounts' | 'web3AccountsSubscribe', extensions?: string[]): Promise<InjectedExtension[]> {
+  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: string, compatInits: (() => Promise<boolean>)[] = []): Promise<InjectedExtension[]> {
+  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]);
+
+  web3EnablePromise = documentReadyPromise(
+    (): Promise<InjectedExtension[]> =>
+      initCompat.then(() =>
+        getWindowExtensions(originName)
+          .then((values): InjectedExtension[] =>
+            values.map((e): InjectedExtension => {
+              // if we don't have an accounts subscriber, add a single-shot version
+              if (!e.accounts.subscribe) {
+                e.accounts.subscribe = (cb: (accounts: InjectedAccount[]) => void | Promise<void>): Unsubcall => {
+                  e.accounts
+                    .get()
+                    .then(cb)
+                    .catch(console.error);
+
+                  return (): void => {
+                    // no ubsubscribe needed, this is a single-shot
+                  };
+                };
+              }
+
+              return e;
+            })
+          )
+          .catch((): InjectedExtension[] => [])
+          .then((values): InjectedExtension[] => {
+            const names = values.map(({ name, version }): string => `${name}/${version}`);
+
+            isWeb3Injected = web3IsInjected();
+            console.info(`web3Enable: Enabled ${values.length} extension${values.length !== 1 ? 's' : ''}: ${names.join(', ')}`);
+
+            return values;
+          })
+      )
+  );
+
+  return web3EnablePromise;
+}
+
+/**
+ * @summary Retrieves all the accounts across all providers
+ * @description
+ * This returns the full list of account available (across all extensions) to
+ * the page. Filtering 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 }: Web3AccountsOptions = {}): Promise<InjectedAccountWithMeta[]> {
+  const accounts: InjectedAccountWithMeta[] = [];
+  const sources = await filterEnable('web3Accounts', extensions);
+  const retrieved = await Promise.all(
+    sources.map(async ({ accounts, name: source }): Promise<InjectedAccountWithMeta[]> => {
+      try {
+        const list = await accounts.get();
+
+        return mapAccounts(source, filterAccounts(list, genesisHash, accountType), ss58Format);
+      } catch {
+        // cannot handle this one
+        return [];
+      }
+    })
+  );
+
+  retrieved.forEach((result): void => {
+    accounts.push(...result);
+  });
+
+  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: (accounts: InjectedAccountWithMeta[]) => void | Promise<void>, { accountType, extensions, genesisHash, ss58Format }: Web3AccountsOptions = {}): Promise<Unsubcall> {
+  const sources = await filterEnable('web3AccountsSubscribe', extensions);
+  const accounts: Record<string, InjectedAccount[]> = {};
+
+  const triggerUpdate = (): void | Promise<void> =>
+    cb(
+      Object
+        .entries(accounts)
+        .reduce((result: InjectedAccountWithMeta[], [source, list]): InjectedAccountWithMeta[] => {
+          result.push(...mapAccounts(source, filterAccounts(list, genesisHash, accountType), ss58Format));
+
+          return result;
+        }, [])
+    );
+
+  const unsubs = sources.map(({ accounts: { subscribe }, name: source }): Unsubcall =>
+    subscribe((result): void => {
+      accounts[source] = result;
+
+      try {
+        const result = triggerUpdate();
+
+        if (result && isPromise(result)) {
+          result.catch(console.error);
+        }
+      } catch (error) {
+        console.error(error);
+      }
+    })
+  );
+
+  return (): void => {
+    unsubs.forEach((unsub): void => {
+      unsub();
+    });
+  };
+}
+
+/**
+ * @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: string): Promise<InjectedExtension> {
+  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;
+}
+
+/**
+ * @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: string): Promise<InjectedExtension> {
+  if (!web3EnablePromise) {
+    return throwError('web3FromAddress');
+  }
+
+  const accounts = await web3Accounts();
+  let found: InjectedAccountWithMeta | undefined;
+
+  if (address) {
+    const accountU8a = decodeAddress(address);
+
+    found = accounts.find((account): boolean => u8aEq(decodeAddress(account.address), accountU8a));
+  }
+
+  if (!found) {
+    throw new Error(`web3FromAddress: Unable to find injected ${address}`);
+  }
+
+  return web3FromSource(found.meta.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: string): Promise<ProviderList | null> {
+  const { provider } = await web3FromSource(source);
+
+  if (!provider) {
+    console.warn(`Extension ${source} does not expose any provider`);
+
+    return null;
+  }
+
+  return provider.listProviders();
+}
+
+/**
+ * @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: string, key: string): Promise<InjectedProviderWithMeta> {
+  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 };
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+// Copyright 2019-2025 @pezkuwi/extension-dapp authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Since we inject into pages, we skip this
+// import './packageDetect.js';
+
+export * from './bundle.js';

package/src/packageDetect.ts

@@ -0,0 +1,12 @@
+// Copyright 2017-2025 @pezkuwi/extension-dapp authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Do not edit, auto-generated by @pezkuwi/dev
+// (packageInfo imports will be kept as-is, user-editable)
+
+import { packageInfo as injectInfo } from '@pezkuwi/extension-inject/packageInfo';
+import { detectPackage } from '@pezkuwi/util';
+
+import { packageInfo } from './packageInfo.js';
+
+detectPackage(packageInfo, null, [injectInfo]);

package/src/packageInfo.ts

@@ -0,0 +1,6 @@
+// Copyright 2017-2025 @pezkuwi/extension-dapp authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Do not edit, auto-generated by @pezkuwi/dev
+
+export const packageInfo = { name: '@pezkuwi/extension-dapp', path: 'auto', type: 'auto', version: '0.62.6' };

package/src/util.ts

@@ -0,0 +1,12 @@
+// Copyright 2019-2025 @pezkuwi/extension-dapp authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+export function documentReadyPromise <T> (creator: () => Promise<T>): Promise<T> {
+  return new Promise((resolve): void => {
+    if (document.readyState === 'complete') {
+      resolve(creator());
+    } else {
+      window.addEventListener('load', () => resolve(creator()));
+    }
+  });
+}

package/src/wrapBytes.spec.ts

@@ -0,0 +1,137 @@
+// Copyright 2019-2025 @pezkuwi/extension authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type * as _ from '@pezkuwi/dev-test/globals.d.ts';
+
+import { u8aConcat, u8aEq, u8aToString } from '@pezkuwi/util';
+
+import { ETHEREUM, POSTFIX, PREFIX, unwrapBytes, wrapBytes } from './wrapBytes.js';
+
+const TEST_DATA = 'this is just some random message that we expect to be wrapped along the way';
+const TEST_ETH = u8aConcat(ETHEREUM, TEST_DATA);
+const TEST_WRAP_EMPTY = `${u8aToString(PREFIX)}${u8aToString(POSTFIX)}`;
+const TEST_WRAP_FULL = `${u8aToString(PREFIX)}${TEST_DATA}${u8aToString(POSTFIX)}`;
+const TEST_WARP_HALF_PRE = `${u8aToString(PREFIX)}${TEST_DATA}`;
+const TEST_WRAP_HALF_POST = `${TEST_DATA}${u8aToString(POSTFIX)}`;
+
+describe('wrapBytes', (): void => {
+  it('wraps empty bytes', (): void => {
+    expect(
+      u8aEq(
+        wrapBytes(new Uint8Array()),
+        u8aConcat(PREFIX, POSTFIX)
+      )
+    ).toBe(true);
+  });
+
+  it('wraps when no wrapping is detected', (): void => {
+    expect(
+      u8aToString(
+        wrapBytes(TEST_DATA)
+      )
+    ).toEqual(TEST_WRAP_FULL);
+  });
+
+  it('wraps when only start wrap is detected', (): void => {
+    expect(
+      u8aToString(
+        wrapBytes(TEST_WARP_HALF_PRE)
+      )
+    ).toEqual(`${u8aToString(PREFIX)}${TEST_WARP_HALF_PRE}${u8aToString(POSTFIX)}`);
+  });
+
+  it('wraps when only end wrap is detected', (): void => {
+    expect(
+      u8aToString(
+        wrapBytes(TEST_WRAP_HALF_POST)
+      )
+    ).toEqual(`${u8aToString(PREFIX)}${TEST_WRAP_HALF_POST}${u8aToString(POSTFIX)}`);
+  });
+
+  it('does not re-wrap when a wrap is already present', (): void => {
+    expect(
+      u8aToString(
+        wrapBytes(TEST_WRAP_FULL)
+      )
+    ).toEqual(TEST_WRAP_FULL);
+  });
+
+  it('does not re-wrap when a wrap (empty data) is already present', (): void => {
+    expect(
+      u8aToString(
+        wrapBytes(TEST_WRAP_EMPTY)
+      )
+    ).toEqual(TEST_WRAP_EMPTY);
+  });
+});
+
+describe('unwrapBytes', (): void => {
+  it('unwraps empty bytes', (): void => {
+    expect(
+      u8aEq(
+        unwrapBytes(new Uint8Array()),
+        new Uint8Array()
+      )
+    ).toBe(true);
+  });
+
+  it('unwraps when no wrapping is detected', (): void => {
+    expect(
+      u8aToString(
+        unwrapBytes(TEST_DATA)
+      )
+    ).toEqual(TEST_DATA);
+  });
+
+  it('unwraps when no wrapping is detected (only start)', (): void => {
+    expect(
+      u8aToString(
+        unwrapBytes(TEST_WARP_HALF_PRE)
+      )
+    ).toEqual(TEST_WARP_HALF_PRE);
+  });
+
+  it('unwraps when no wrapping is detected (only end)', (): void => {
+    expect(
+      u8aToString(
+        unwrapBytes(TEST_WRAP_HALF_POST)
+      )
+    ).toEqual(TEST_WRAP_HALF_POST);
+  });
+
+  it('unwraps when a wrap is present', (): void => {
+    expect(
+      u8aToString(
+        unwrapBytes(TEST_WRAP_FULL)
+      )
+    ).toEqual(TEST_DATA);
+  });
+
+  it('unwraps when a an empty wrap is present', (): void => {
+    expect(
+      u8aToString(
+        unwrapBytes(TEST_WRAP_EMPTY)
+      )
+    ).toEqual('');
+  });
+
+  describe('Ethereum-style', (): void => {
+    it('does not wrap an Ethereum wrap', (): void => {
+      expect(
+        u8aEq(
+          wrapBytes(TEST_ETH),
+          TEST_ETH
+        )
+      ).toBe(true);
+    });
+
+    it('does not unwrap an Ethereum wrap', (): void => {
+      expect(
+        u8aEq(
+          unwrapBytes(TEST_ETH),
+          TEST_ETH
+        )
+      ).toBe(true);
+    });
+  });
+});

package/{wrapBytes.js → src/wrapBytes.ts}

@@ -1,7 +1,12 @@
-import { U8A_WRAP_ETHEREUM, U8A_WRAP_POSTFIX, U8A_WRAP_PREFIX, u8aIsWrapped, u8aUnwrapBytes, u8aWrapBytes } from '@polkadot/util';
+// Copyright 2019-2025 @pezkuwi/extension authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { U8A_WRAP_ETHEREUM, U8A_WRAP_POSTFIX, U8A_WRAP_PREFIX, u8aIsWrapped, u8aUnwrapBytes, u8aWrapBytes } from '@pezkuwi/util';
+
 export const ETHEREUM = U8A_WRAP_ETHEREUM;
 export const POSTFIX = U8A_WRAP_POSTFIX;
 export const PREFIX = U8A_WRAP_PREFIX;
+
 export const isWrapped = u8aIsWrapped;
 export const unwrapBytes = u8aUnwrapBytes;
 export const wrapBytes = u8aWrapBytes;

package/tsconfig.build.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": "..",
+    "outDir": "./build",
+    "rootDir": "./src"
+  },
+  "exclude": [
+    "**/*.spec.ts"
+  ],
+  "references": [
+    { "path": "../extension-inject/tsconfig.build.json" }
+  ]
+}