{"_id":"@belongnet/metakeep-wagmi-connector","_rev":"5-780fc66f24bb1398ef4cd6940dacd2af","name":"@belongnet/metakeep-wagmi-connector","dist-tags":{"latest":"0.5.2"},"versions":{"0.3.0":{"name":"@belongnet/metakeep-wagmi-connector","version":"0.3.0","keywords":["metakeep","wagmi","connector"],"author":{"name":"reslear","email":"reslear@gmail.com"},"license":"MIT","_id":"@belongnet/metakeep-wagmi-connector@0.3.0","maintainers":[{"name":"reslear","email":"reslear@gmail.com"},{"name":"belongfoundation","email":"join@belong.net"}],"homepage":"https://github.com/belongnet/metakeep-wagmi-connector#readme","bugs":{"url":"https://github.com/belongnet/metakeep-wagmi-connector/issues"},"dist":{"shasum":"b05bf675e8493ea27221a3c1f6d76977650cad05","tarball":"https://registry.npmjs.org/@belongnet/metakeep-wagmi-connector/-/metakeep-wagmi-connector-0.3.0.tgz","fileCount":13,"integrity":"sha512-RJycYoy6SGaMdxLCukqBHzm2Qkn7JH6i4/3fpMoJ5QMyrf4+TlQ4u30dFmqUFhqcWuLFUA67HUS6bgy875hS4A==","signatures":[{"sig":"MEYCIQD0n7qHIRL2Mi3GUsNsOFJ2Vq1pTsvHBtEtlmFA4lnRBAIhAJ12dW/lG0nTuE1xIP/Ty8f74QPBAE0PK6UEegYzVnSV","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@belongnet%2fmetakeep-wagmi-connector@0.3.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":29828},"main":"dist/esm/index.js","type":"module","types":"dist/types/index.d.ts","exports":{".":{"types":"./dist/types/index.d.ts","default":"./dist/esm/index.js"}},"gitHead":"d5022b685541009a8b4a068a500c70a8e9d86064","scripts":{"dev":"cd playground && pnpm dev","build":"pnpm run clean && pnpm run build:esm+types","clean":"rm -rf dist tsconfig.tsbuildinfo","prepublishOnly":"pnpm build","build:esm+types":"tsc --outDir ./dist/esm --declaration --declarationMap --declarationDir ./dist/types"},"_npmUser":{"name":"reslear","email":"reslear@gmail.com"},"repository":{"url":"git+https://github.com/belongnet/metakeep-wagmi-connector.git","type":"git"},"_npmVersion":"10.5.2","description":"Metakeep connector for Wagmi","directories":{},"sideEffects":false,"_nodeVersion":"20.13.1","dependencies":{"metakeep":"^2.2.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"viem":"^2.10.9","prettier":"^3.2.5","typescript":"^5.4.5","@wagmi/core":"2.10.2"},"peerDependencies":{"viem":"2.x","typescript":">=5.0.4","@wagmi/core":"2.x"},"peerDependenciesMeta":{"typescript":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/metakeep-wagmi-connector_0.3.0_1715946252915_0.07416490992494262","host":"s3://npm-registry-packages"}},"0.4.0":{"name":"@belongnet/metakeep-wagmi-connector","version":"0.4.0","keywords":["metakeep","wagmi","connector"],"author":{"name":"reslear","email":"reslear@gmail.com"},"license":"MIT","_id":"@belongnet/metakeep-wagmi-connector@0.4.0","maintainers":[{"name":"reslear","email":"reslear@gmail.com"},{"name":"belongfoundation","email":"join@belong.net"}],"homepage":"https://github.com/belongnet/metakeep-wagmi-connector#readme","bugs":{"url":"https://github.com/belongnet/metakeep-wagmi-connector/issues"},"dist":{"shasum":"ce1f8f48f4e3ad350931c5df915617c18a14b491","tarball":"https://registry.npmjs.org/@belongnet/metakeep-wagmi-connector/-/metakeep-wagmi-connector-0.4.0.tgz","fileCount":13,"integrity":"sha512-CnO+jEh+0ROkl+tCZiLIu9od7rFiToCHshk78NrwiULv1ZaQ0GhJ41SZl1LzaRdb2DEFt2L1xPzpQO+gjgf+9Q==","signatures":[{"sig":"MEYCIQDOHfVPzAHRxDZMvCF00F52XN8dS1Fxqg1mtsB+DIhwygIhANwgDHM1MywV3KzgXKr9vaM8TPwr49ycumDSeQC2Bqom","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@belongnet%2fmetakeep-wagmi-connector@0.4.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":29242},"main":"dist/esm/index.js","type":"module","types":"dist/types/index.d.ts","exports":{".":{"types":"./dist/types/index.d.ts","default":"./dist/esm/index.js"}},"gitHead":"aea16306b7e3bfa0718cc0c73dffdf09aff3fe0f","scripts":{"dev":"cd playground && pnpm dev","build":"pnpm run clean && pnpm run build:esm+types","clean":"rm -rf dist tsconfig.tsbuildinfo","prepublishOnly":"pnpm build","build:esm+types":"tsc --outDir ./dist/esm --declaration --declarationMap --declarationDir ./dist/types"},"_npmUser":{"name":"reslear","email":"reslear@gmail.com"},"repository":{"url":"git+https://github.com/belongnet/metakeep-wagmi-connector.git","type":"git"},"_npmVersion":"10.8.1","description":"Metakeep connector for Wagmi","directories":{},"sideEffects":false,"_nodeVersion":"20.16.0","dependencies":{"metakeep":"^2.2.6"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"viem":"^2.19.2","prettier":"^3.3.3","typescript":"^5.5.4","@wagmi/core":"2.13.3"},"peerDependencies":{"viem":"2.x","typescript":">=5.0.4","@wagmi/core":"2.x"},"peerDependenciesMeta":{"typescript":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/metakeep-wagmi-connector_0.4.0_1723144962650_0.5654750116602871","host":"s3://npm-registry-packages"}},"0.5.0":{"name":"@belongnet/metakeep-wagmi-connector","version":"0.5.0","keywords":["metakeep","wagmi","connector"],"author":{"name":"reslear","email":"reslear@gmail.com"},"license":"MIT","_id":"@belongnet/metakeep-wagmi-connector@0.5.0","maintainers":[{"name":"reslear","email":"reslear@gmail.com"},{"name":"belongfoundation","email":"join@belong.net"}],"homepage":"https://github.com/belongnet/metakeep-wagmi-connector#readme","bugs":{"url":"https://github.com/belongnet/metakeep-wagmi-connector/issues"},"dist":{"shasum":"7bccb1e04c4ee2ef48b06397e47849c6cde26d34","tarball":"https://registry.npmjs.org/@belongnet/metakeep-wagmi-connector/-/metakeep-wagmi-connector-0.5.0.tgz","fileCount":13,"integrity":"sha512-gIWSxWVlEyiRItQwzOchP5Qckhej7/gWRXtZM4h01gDAOlD52KpIG6YKu5jMR7SugNZ2h0yexYCvzZnZzJfcWQ==","signatures":[{"sig":"MEUCIAawgwKr3cQQbOWuLxp6L/sXmr3MUYwxbOjHeDkMi8RBAiEA0Rvkq6OYcq/fk7MDdVO1uGthJDfhno8YcuPh3bYiG70=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@belongnet%2fmetakeep-wagmi-connector@0.5.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":29459},"main":"dist/esm/index.js","type":"module","types":"dist/types/index.d.ts","exports":{".":{"types":"./dist/types/index.d.ts","default":"./dist/esm/index.js"}},"gitHead":"4f7c7c6ba17a60aa7e662544a6e4dc6380390a5a","scripts":{"dev":"pnpm build:esm+types -w --preserveWatchOutput","build":"pnpm run clean && pnpm run build:esm+types","clean":"rm -rf dist tsconfig.tsbuildinfo","prepublishOnly":"pnpm build","build:esm+types":"tsc --outDir ./dist/esm --declaration --declarationMap --declarationDir ./dist/types"},"_npmUser":{"name":"reslear","email":"reslear@gmail.com"},"repository":{"url":"git+https://github.com/belongnet/metakeep-wagmi-connector.git","type":"git"},"_npmVersion":"10.8.1","description":"Metakeep connector for Wagmi","directories":{},"sideEffects":false,"_nodeVersion":"20.16.0","dependencies":{"metakeep":"2.2.3"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"viem":"^2.19.2","prettier":"^3.3.3","typescript":"^5.5.4","@wagmi/core":"2.13.3"},"peerDependencies":{"viem":"2.x","typescript":">=5.0.4","@wagmi/core":"2.x"},"peerDependenciesMeta":{"typescript":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/metakeep-wagmi-connector_0.5.0_1723154339577_0.7173823580323813","host":"s3://npm-registry-packages"}},"0.5.2":{"name":"@belongnet/metakeep-wagmi-connector","version":"0.5.2","description":"Metakeep connector for Wagmi","keywords":["metakeep","wagmi","connector"],"repository":{"type":"git","url":"git+https://github.com/belongnet/metakeep-wagmi-connector.git"},"license":"MIT","author":{"name":"reslear","email":"reslear@gmail.com"},"sideEffects":false,"type":"module","exports":{".":{"types":"./dist/types/index.d.ts","default":"./dist/esm/index.js"}},"main":"dist/esm/index.js","types":"dist/types/index.d.ts","scripts":{"dev":"pnpm build:esm+types -w --preserveWatchOutput","build":"pnpm run clean && pnpm run build:esm+types","build:esm+types":"tsc --outDir ./dist/esm --declaration --declarationMap --declarationDir ./dist/types","clean":"rm -rf dist tsconfig.tsbuildinfo","prepublishOnly":"pnpm build"},"dependencies":{"metakeep":"2.2.8"},"devDependencies":{"@wagmi/core":"2.14.4","prettier":"^3.3.3","typescript":"^5.6.3","viem":"^2.21.44"},"peerDependencies":{"@wagmi/core":"2.x","typescript":">=5.0.4","viem":"2.x"},"peerDependenciesMeta":{"typescript":{"optional":true}},"publishConfig":{"access":"public"},"_id":"@belongnet/metakeep-wagmi-connector@0.5.2","gitHead":"c4081ea7eefaaab21bcc655705a455e246f77681","bugs":{"url":"https://github.com/belongnet/metakeep-wagmi-connector/issues"},"homepage":"https://github.com/belongnet/metakeep-wagmi-connector#readme","_nodeVersion":"20.18.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-0gnAOJffHQLMu1VoLczyXgEwuW4LFYnVnIfGP5FnuJX74oB8F15rgG+kKx9VgjxgPOmuTcDXF4+2he8MQKyMEw==","shasum":"09627ecaf6735f5c35c1c6430a9e0cf0d53a4576","tarball":"https://registry.npmjs.org/@belongnet/metakeep-wagmi-connector/-/metakeep-wagmi-connector-0.5.2.tgz","fileCount":13,"unpackedSize":30158,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@belongnet%2fmetakeep-wagmi-connector@0.5.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD4MRVHsDmP5PkLOThPmcAJ0mTRe2Or1Ib1Eq1z6ld2BAIgRPSYJgKBvLdFFwxxta809KSqzqMUdokzUK4G1mtfXa0="}]},"_npmUser":{"name":"reslear","email":"reslear@gmail.com"},"directories":{},"maintainers":[{"name":"reslear","email":"reslear@gmail.com"},{"name":"belongfoundation","email":"join@belong.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/metakeep-wagmi-connector_0.5.2_1731336739555_0.7814091097400682"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-17T11:44:12.829Z","modified":"2024-11-11T14:52:20.166Z","0.3.0":"2024-05-17T11:44:13.197Z","0.3.1":"2024-08-08T18:58:53.715Z","0.4.0":"2024-08-08T19:22:42.799Z","0.5.0":"2024-08-08T21:58:59.720Z","0.5.2":"2024-11-11T14:52:19.766Z"},"bugs":{"url":"https://github.com/belongnet/metakeep-wagmi-connector/issues"},"author":{"name":"reslear","email":"reslear@gmail.com"},"license":"MIT","homepage":"https://github.com/belongnet/metakeep-wagmi-connector#readme","keywords":["metakeep","wagmi","connector"],"repository":{"type":"git","url":"git+https://github.com/belongnet/metakeep-wagmi-connector.git"},"description":"Metakeep connector for Wagmi","maintainers":[{"name":"reslear","email":"reslear@gmail.com"},{"name":"belongfoundation","email":"join@belong.net"}],"readme":"# metakeep-wagmi-connector\n\n<p align=\"center\">\n  <img src=\"./docs/cover.gif\" alt=\"metakeep-wagmi-connector\" width=\"696\" />\n</p>\n\n[![Version](https://img.shields.io/npm/v/@belongnet/metakeep-wagmi-connector)](https://www.npmjs.com/package/@belongnet/metakeep-wagmi-connector)\n[![Downloads](https://img.shields.io/npm/dw/@belongnet/metakeep-wagmi-connector)](https://www.npmjs.com/package/@belongnet/metakeep-wagmi-connector)\n[![install size](https://packagephobia.com/badge?p=@belongnet/metakeep-wagmi-connector)](https://packagephobia.com/result?p=@belongnet/metakeep-wagmi-connector)\n\nConnector for integrating [wagmi v2.x](https://wagmi.sh/) with the [MetaKeep.xyz](https://metakeep.xyz/) platform.\n\n- [👀 Demo](https://belongnet.github.io/metakeep-wagmi-connector/)\n\n**Features:**\n\n- ⚙ Connects with [wagmi v2](https://wagmi.sh/)\n- 🔮 Supports [Reown AppKit](https://github.com/reown-com/appkit) (Web3Modal)\n- 📐 Session validations and caching\n- 🔐 Supports One-Click Auth / SIWE\n- 💡 Lightweight ~26kB\n- ✍️ TypeScript/ESM/Dynamic import\n\n## Installation\n\nYou can install **metakeep-wagmi-connector** using npm, yarn, or pnpm:\n\n```bash\npnpm add @belongnet/metakeep-wagmi-connector\n```\n\nOnce installed, add **metakeep** to your wagmi configuration as a connector. Here's a sample configuration:\n\n```ts\nimport { metaKeep } from '@belongnet/metakeep-wagmi-connector'\n\nconst config = createConfig({\n  // ...\n  connectors: [\n    metaKeep({\n      appId: import.meta.env.VITE_META_KEEP_APP_ID,\n    }),\n  ],\n})\n```\n\nMake sure to set the `appId` in your environment variables, for example in a `.env` file:\n\n```env\nVITE_META_KEEP_APP_ID=your-app-id\n```\n\nEnjoy!\n\n## Usage\n\nThe connector will automatically handle the authentication process with wagmi. see the [wagmi documentation](https://wagmi.sh/) for more information.\n\n```ts\nconst { connect } = useConnect()\n\nconnect({ connector: 'metakeep' })\n```\n\n### Metakeep Provider access\n\nYou can use the [useAccount](https://wagmi.sh/react/api/hooks/useAccount#connector) hook to access the native connector provider.\n\n> [!WARNING]\n> Use this only if you know what you're doing. Instead, it's better to utilize methods at the wagmi level.\n\n```ts\nimport type { MetaKeepProvider } from '@belongnet/metakeep-wagmi-connector'\n\nconst { connector } = useAccount()\n\nconst provider = <MetaKeepProvider>await connector.value?.getProvider()\n\nconst authorizedUser = provider.getUser()\nconsole.log(authorizedUser)\n```\n\n## Config\n\nThe connector accepts the following options:\n\n### `appId` - MetaKeep App ID\n\nYou can get the `appId` from the MetaKeep dashboard.\n\n```ts\nmetaKeep({\n  appId: import.meta.env.VITE_META_KEEP_APP_ID,\n}),\n```\n\n### `name` - Custom connector name\n\nYou can set a custom name for the connector, by default it's `MetaKeep`.\n\n```ts\nmetaKeep({\n  name: 'MyMetaKeep',\n}),\n```\n\n## Migration Guide\n\n- [Migrate from Wagmi v1 to v2](docs/migration-guide.md)\n\n## Links\n\n- https://docs.metakeep.xyz/reference/web3-provider\n- https://github.com/PassbirdCo\n\n# Related connectors\n\n- https://wagmi.sh/dev/creating-connectors\n- https://github.com/blocto/blocto-sdk/blob/develop/adapters/wagmi-connector/src/connector.ts\n- https://github.com/magiclabs/wagmi-magic-connector/blob/main/src/lib/connectors/dedicatedWalletConnector.ts\n- https://github.com/Web3Auth/web3auth-wagmi-connector/blob/master/src/lib/connector.ts\n\n## License\n\nThis project is licensed under the terms of the [MIT license](LICENSE).\n","readmeFilename":"README.md"}