{"id":20619792,"url":"https://github.com/wevm/mipd","last_synced_at":"2025-08-02T22:07:26.963Z","repository":{"id":177729659,"uuid":"657412888","full_name":"wevm/mipd","owner":"wevm","description":"TypeScript Utilities for EIP-6963: Multi Injected Provider Discovery","archived":false,"fork":false,"pushed_at":"2024-12-01T09:10:37.000Z","size":141,"stargazers_count":116,"open_issues_count":2,"forks_count":15,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-07-14T18:36:32.888Z","etag":null,"topics":["eip6963","ethereum","typescript","wallets"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wevm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["wevm"],"custom":["drips.network/wevm.eth"]}},"created_at":"2023-06-23T02:27:14.000Z","updated_at":"2025-07-07T07:51:30.000Z","dependencies_parsed_at":"2023-11-27T16:00:59.840Z","dependency_job_id":"dcd4b66c-bcd7-4e39-89c2-ad365b4b2b3c","html_url":"https://github.com/wevm/mipd","commit_stats":null,"previous_names":["wagmi-dev/mipd","wevm/mipd"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/wevm/mipd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wevm%2Fmipd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wevm%2Fmipd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wevm%2Fmipd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wevm%2Fmipd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wevm","download_url":"https://codeload.github.com/wevm/mipd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wevm%2Fmipd/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268464875,"owners_count":24254197,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eip6963","ethereum","typescript","wallets"],"created_at":"2024-11-16T12:12:31.730Z","updated_at":"2025-08-02T22:07:26.923Z","avatar_url":"https://github.com/wevm.png","language":"TypeScript","readme":"\u003cbr/\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cpicture\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/wagmi-dev/mipd/blob/main/.github/mipd-dark-hug.svg\"\u003e\n      \u003cimg alt=\"mipd logo\" src=\"https://github.com/wagmi-dev/mipd/blob/main/.github/mipd-light-hug.svg\" width=\"auto\" height=\"60\"\u003e\n    \u003c/picture\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  TypeScript Utilities for \u003ca href=\"https://eips.ethereum.org/EIPS/eip-6963\"\u003eEIP-6963: Multi Injected Provider Discovery\u003c/a\u003e\n\u003cp\u003e\n\n## Contents\n\n- [Install](#install)\n- [Store](#store)\n- [Utilities](#utilities)\n  - [`requestProviders`](#requestproviders)\n  - [`announceProvider`](#announceprovider)\n- [`window` Type Polyfill](#window-polyfill)\n- [Types](#types)\n- [Configuration](#configuration)\n\n## Install\n\n```bash\nnpm i mipd\n```\n\n```bash\npnpm add mipd\n```\n\n```bash\nyarn add mipd\n```\n\n## Store\n\nThe MIPD Store stores the Providers that have been emitted by a Wallet (or other source), and provides a way to subscribe to the store and retrieve the Providers.\n\n### Overview\n\n```ts\nimport { createStore } from 'mipd'\n\n// Set up a MIPD Store, and request Providers.\nconst store = createStore()\n\n// Subscribe to the MIPD Store.\nstore.subscribe(providerDetails =\u003e {\n  console.log(providerDetails)\n  // =\u003e [EIP6963ProviderDetail, EIP6963ProviderDetail, ...]\n})\n\n// Retrieve emitted Providers.\nstore.getProviders()\n// =\u003e [EIP6963ProviderDetail, EIP6963ProviderDetail, ...]\n\n// Find a Provider Detail.\nstore.findProvider({ rdns: 'com.example' })\n// =\u003e EIP6963ProviderDetail | undefined\n\n// Clear the store, including all Providers.\nstore.clear()\n\n// Reset the store, and emit an event to request Providers.\nstore.reset()\n\n// Destroy the store, and remove all Providers and event listeners.\nstore.destroy()\n```\n\n### Usage\n\n#### Vanilla JS\n\n```tsx\nimport { createStore } from 'mipd'\n\nconst store = createStore()\n\nlet providers = store.getProviders()\nstore.subscribe(providerDetails =\u003e (providers = providerDetails))\n```\n\n#### React\n\n```tsx\nimport { useSyncExternalStore } from 'react'\nimport { createStore } from 'mipd'\n\nconst store = createStore()\n\nfunction Example() {\n  const providers = useSyncExternalStore(store.subscribe, store.getProviders)\n  // ...\n}\n```\n\n#### Svelte\n\n```html\n\u003cscript lang=\"ts\"\u003e\n  import { readable } from 'svelte/store'\n  import { createStore } from 'mipd'\n  \n  const store = createStore()\n  const providers = readable(store.getProviders(), store.subscribe)\n\u003c/script\u003e\n\n\u003c!-- ... --\u003e\n```\n\n#### Vue\n\n```html\n\u003cscript setup lang=\"ts\"\u003e\n  import { reactive } from 'vue'\n  import { createStore } from 'mipd'\n\n  const store = createStore()\n  const state = reactive({ providers: store.getProviders() })\n  store.subscribe(providers =\u003e (state.providers = providers))\n\u003c/script\u003e\n\n\u003c!-- ... --\u003e\n```\n\n### API\n\n#### createStore()\n\nCreates a MIPD Store, and emits an event to request Providers from the Wallet(s).\n\n```ts\nconst store = createStore()\n```\n\n#### store.subscribe(listener, args)\n\nSubscribes to the MIPD Store, and returns a function to unsubscribe.\n\n```ts\nconst unsubscribe = store.subscribe(providers =\u003e {\n  console.log(providers)\n  // =\u003e [EIP6963ProviderDetail, EIP6963ProviderDetail, ...]\n})\n```\n\n**Definition**\n\n```ts\nexport type Listener = (\n  // The updated Providers store.\n  providerDetails: EIP6963ProviderDetail[],\n  meta?: {\n    // The Providers that were added to the store.\n    added?: EIP6963ProviderDetail[]\n    // The Providers that were removed from the store.\n    removed?: EIP6963ProviderDetail[]\n  },\n) =\u003e void\n\nfunction subscribe(\n  // The listener function.\n  listener: Listener, \n  args?: { \n    // If `true`, the listener will be called immediately with the stored Providers.\n    emitImmediately?: boolean \n  }\n): () =\u003e void // Returns an unsubscribe function.\n```\n\n#### store.getProviders()\n\nReturns the current Providers.\n\n```ts\nconst providers = store.getProviders()\n// =\u003e [EIP6963ProviderDetail, EIP6963ProviderDetail, ...]\n```\n\n**Definition**\n\n```ts\nfunction getProviders(): EIP6963ProviderDetail[]\n```\n\n#### store.findProvider(args)\n\nFinds a provider detail by its RDNS (Reverse Domain Name Identifier).\n\n```ts\nconst provider = store.findProvider({ rdns: 'com.example' })\n```\n\n**Definition**\n\n```ts\nfunction findProvider(args: { \n  // The RDNS of the Provider Detail to find.\n  rdns: string \n}): EIP6963ProviderDetail | undefined\n```\n\n#### store.clear()\n\nClears the store, including all Providers.\n\n```ts\nstore.clear()\n```\n\n**Definition**\n\n```ts\nfunction clear(): void\n```\n\n#### store.reset()\n\nResets the store, and emits an event to request Providers from the Wallet(s).\n\n```ts\nstore.reset()\n```\n\n**Definition**\n\n```ts\nfunction reset(): void\n```\n\n#### store.destroy()\n\nDestroys the store, and removes all Providers and event listeners.\n\n```ts\nstore.destroy()\n```\n\n**Definition**\n\n```ts\nfunction destroy(): void\n```\n\n## Utilities\n\n### requestProviders\n\nThe `requestProviders` utility emits an event to request Providers from the Wallet(s). It returns an `unsubscribe` function to clean up event listeners.\n\n```ts\nimport { requestProviders } from 'mipd'\n\nlet providers = []\n\nconst unsubscribe = requestProviders(providerDetail =\u003e providers.push(providerDetail))\n```\n\n**Definition**\n\n```ts\nfunction requestProviders(\n  // The listener.\n  listener: (providerDetail: EIP6963ProviderDetail) =\u003e void\n// Unsubscribe function to clean up the listener.\n): () =\u003e void\n```\n\n### announceProvider\n\nThe `announceProvider` utility emits an event to announce a Provider to the Wallet(s), and also listen for incoming requests. It returns an `unsubscribe` function to clean up event listeners.\n\n```ts\nimport { announceProvider } from 'mipd'\n\nconst unsubscribe = announceProvider({\n  info: {\n    icon: 'data:image/svg+xml,\u003csvg width=\"32px\" height=\"32px\" viewBox=\"0 0 32 32\"/\u003e',\n    name: 'Example',\n    rdns: 'com.example',\n    uuid: '00000000-0000-0000-0000-000000000000'\n  },\n  provider: new EIP1193Provider()\n})\n```\n\n**Definition**\n\n```ts\nfunction requestProviders(\n  // The EIP-1193 Provider and Provider Info.\n  detail: EIP6963ProviderDetail\n// Unsubscribe function to clean up the listener.\n): () =\u003e void\n```\n\n## `window` Polyfill\n\nBy importing the `mipd/window` Polyfill, the types on `window.addEventListener` will be inferred to include the `EIP6963AnnounceProviderEvent` and `EIP6963RequestProviderEvent` types.\n\n```ts\nimport 'mipd/window'\n\nwindow.addEventListener(\n  'eip6963:announceProvider'\n  // ^? 'eip6963:announceProvider' | 'eip6963:requestProvider' | 'click' | ...\n\n  event =\u003e {\n  // ^? EIP6963AnnounceProviderEvent\n\n    event.type\n    //    ^? 'eip6963:announceProvider'\n    event.detail\n    //    ^? EIP6963ProviderDetail\n    event.detail.info\n    //           ^? EIP6963ProviderInfo\n    event.detail.provider\n    //           ^? EIP1193Provider\n  }\n)\n\nwindow.addEventListener(\n  'eip6963:requestProvider'\n  // ^? 'eip6963:announceProvider' | 'eip6963:requestProvider' | 'click' | ...\n\n  event =\u003e {\n  // ^? EIP6963RequestProviderEvent\n\n    event.type\n    //    ^? 'eip6963:requestProvider'\n  }\n)\n```\n\n## Types\n\n### EIP6963ProviderDetail\n\nEvent detail from `eip6963:announceProvider`.\n\n#### Import\n\n```ts\nimport { type EIP6963ProviderDetail } from 'mipd'\n```\n\n#### Definition\n\n```ts\nexport interface EIP6963ProviderDetail\u003cTProvider = Config['EIP1193Provider']\u003e {\n  info: EIP6963ProviderInfo\n  provider: TProvider\n}\n```\n\n### EIP6963ProviderInfo\n\nMetadata of the EIP-1193 Provider.\n\n#### Import\n\n```ts\nimport { type EIP6963ProviderInfo } from 'mipd'\n```\n\n#### Definition\n\n```ts\nexport interface EIP6963ProviderInfo {\n  icon: string\n  name: string\n  rdns?: ... | (string \u0026 {})\n  uuid: string\n}\n```\n\n### EIP6963AnnounceProviderEvent\n\nEvent type to announce an EIP-1193 Provider.\n\n#### Import\n\n```ts\nimport { type EIP6963AnnounceProviderEvent } from 'mipd'\n```\n\n#### Definition\n\n```ts\nexport interface EIP6963AnnounceProviderEvent\u003cTProvider = DefaultProvider\u003e\n  extends CustomEvent\u003cEIP6963ProviderDetail\u003cTProvider\u003e\u003e {\n  type: 'eip6963:announceProvider'\n}\n```\n\n### EIP6963RequestProviderEvent\n\nEvent type to request EIP-1193 Providers.\n\n#### Import\n\n```ts\nimport { type EIP6963RequestProviderEvent } from 'mipd'\n```\n\n#### Definition\n\n```ts\nexport interface EIP6963RequestProviderEvent extends Event {\n  type: 'eip6963:requestProvider'\n}\n```\n\n## Configuration\n\nIn some cases you might want to tune the global types (e.g. the `EIP1193Provider`). To do this, the following configuration options are available:\n\n| Type                | Default                                                        | Description            |\n| ------------------- | -------------------------------------------------------------- | ---------------------- |\n| `provider`          | `import('viem').EIP1193Provider`                               | The EIP-1193 Provider. |\n| `rdns`              | `'com.coinbase' \\| 'com.enkrypt' \\| 'io.metamask' \\| 'io.zerion' \\| (string \u0026 {})` | Deterministic identifier for the Provider in the form of an rDNS (Reverse Domain Name Notation) |\n\nConfiguration options are customizable using [declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html). Extend the `Register` interface either directly in your code or in a `d.ts` file (e.g. `eip6963.d.ts`):\n\n```ts\nimport { type EIP1193Provider } from './eip1193-provider'\n\ndeclare module 'mipd' {\n  interface Register {\n    provider: EIP1193Provider\n  }\n}\n```\n\n## Authors\n\n- [@jxom](https://github.com/jxom) (jxom.eth, [Twitter](https://twitter.com/jakemoxey))\n- [@tmm](https://github.com/tmm) (awkweb.eth, [Twitter](https://twitter.com/awkweb))\n\n## License\n\n[MIT](/LICENSE) License\n","funding_links":["https://github.com/sponsors/wevm","drips.network/wevm.eth"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwevm%2Fmipd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwevm%2Fmipd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwevm%2Fmipd/lists"}