\n\nThis package implements the discovery protocol that browsers use to find compliant browser extensions. It introduces a set of window `CustomEvent`s to provide a two-way communication protocol between Pezkuwi Wallet Provider libraries and injected scripts provided by browser extensions.\n\n## Main Export\n\nThe main export is a function called `getProviders`. This function dispatches an event on the window object that compliant browser extensions (or similar) may respond to by providing back an interface of the correct shape. An array of all such interfaces that we get back will be given back to the caller of `getProviders`.\n\n## How It Works\n\nThe discovery protocol is quite simple and can be implemented in these steps:\n\n1. The extension injects an inpage script that registers a listener for the `bizinikiwiDiscovery:requestProvider` event.\n2. The listener announces the provider by invoking the `onProvider` callback from the event payload synchronously.\n3. Optionally, the script can dispatch the `bizinikiwiDiscovery:announceProvider` event with the provider details when the script is loaded.\n\nRefer to `src/index.ts` in this package for an implementation of this protocol.\n\n## Basic Usage Example\n\n```ts\nimport { getProviders } from \"@bizinikiwi/discovery\"\n\nconst providers = getProviders()\nconst firstProvider = providers.length > 0 ? providers[0].provider : null\n\nconsole.log(firstProvider)\n```\n\n## Example with rDNS Filter\n\nThis example demonstrates how to filter providers based on a specific rDNS value. This approach is useful when you need to target specific extensions rather than all extensions matching a certain interface.\n\n```ts\nimport { getProviders } from \"@bizinikiwi/discovery\"\n\nconst provider = getProviders()\n .filter((detail) =>\n detail.info.rdns.startsWith(\"io.github.pezkuwichain.BizinikiwiConnect\"),\n )\n .map((detail) => detail.provider)[0]\n\nconsole.log(provider)\n```\n\n## React Example\n\n```tsx\nimport React, { useEffect, useState } from \"react\"\nimport { getProviders } from \"@bizinikiwi/discovery\"\n\nconst SmoldotProviderComponent = () => {\n const [provider, setProvider] = useState(null)\n\n useEffect(() => {\n const providers = getProviders()\n if (providers.length > 0) {\n setProvider(providers[0].provider)\n }\n }, [])\n\n return (\n
\n {provider ?
Provider: {provider}
:
Loading provider...
}\n
\n )\n}\n\nexport default SmoldotProviderComponent\n```\n\n## Extension Example\n\n```ts\nimport { getLightClientProvider } from \"@bizinikiwi/light-client-extension-helpers/web-page\"\n\nconst rpc = createRpc(\n (msg: any) =>\n window.postMessage({ msg, origin: \"bizinikiwi-wallet-template/web\" }),\n handlers,\n).withClient()\nwindow.addEventListener(\"message\", ({ data }) => {\n if (data?.origin !== \"bizinikiwi-wallet-template/extension\") return\n rpc.handle(data.msg, undefined)\n})\n\nconst provider = await getLightClientProvider(CHANNEL_ID).then(\n (lightClientProvider) => ({\n ...lightClientProvider,\n async getAccounts(chainId: string) {\n return rpc.client.getAccounts(chainId)\n },\n async createTx(chainId: string, from: string, callData: string) {\n return rpc.client.createTx(chainId, from, callData)\n },\n }),\n)\n\nwindow.addEventListener(\n \"bizinikiwiDiscovery:requestProvider\",\n ({ detail: { onProvider } }) => onProvider(detail),\n)\n\nwindow.dispatchEvent(\n new CustomEvent(\"bizinikiwiDiscovery:announceProvider\", {\n detail,\n }),\n)\n```\n\n## Notes\n\n- The `detail.provider` can be a promise, depending on the library implementation which allows announcing provider details while the provider is being initialized.\n- The `bizinikiwiDiscovery:requestProvider` event payload uses an `onProvider` callback to respond with the provider details synchronously to the DApp, allowing to get all the providers without needing to wait for any macrotasks (e.g., `setTimeout`), microtasks, or any arbitrary time to listen to an event (e.g., `bizinikiwiDiscovery:announceProvider`).\n","readmeFilename":"README.md","_rev":"1-962958cfa19fa4f0d19780b86dedb103"}
![\"npm\"](\"https://img.shields.io/npm/v/@bizinikiwi/discovery\")
\n ![\"GPL-3.0-or-later\"](\"https://img.shields.io/npm/l/@bizinikiwi/discovery\")
\n