{"_id":"@0xbigboss/permissionless","_rev":"3-8052dbf239c83c8d10811fb1587947ca","name":"@0xbigboss/permissionless","dist-tags":{"latest":"0.7.0-SNAPSHOT-1"},"versions":{"0.7.0-SNAPSHOT":{"name":"@0xbigboss/permissionless","version":"0.7.0-SNAPSHOT","keywords":["ethereum","erc-4337","eip-4337","paymaster","bundler"],"author":{"name":"Pimlico"},"license":"MIT","_id":"@0xbigboss/permissionless@0.7.0-SNAPSHOT","maintainers":[{"name":"0xbigboss","email":"0xbigboss@proton.me"}],"homepage":"https://docs.pimlico.io/permissionless","bugs":{"url":"https://github.com/0xbigboss/permissionless.js/issues"},"dist":{"shasum":"0c3c0d38499a98de35b112a3b1c3e7381736f2c6","tarball":"https://registry.npmjs.org/@0xbigboss/permissionless/-/permissionless-0.7.0-SNAPSHOT.tgz","fileCount":82,"integrity":"sha512-I2rN6BrLX6heO7uihl/fsESTuLjILVyaXptJRkHbJyc87nXpDry4qtS2jot2ihJMDROetGLw/3WrYZiCYJ9vuA==","signatures":[{"sig":"MEYCIQCc9w6Fr9z/pzjATNpz+kGIyolhuAnrrbYUtDTn2fPXfwIhALDFaONtbJatHi8R6w+BRlGABtgo4PPYYSbB/6uTEvRc","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":325526},"main":"./_cjs/index.js","type":"module","types":"./_types/index.d.ts","module":"./_esm/index.js","exports":{".":{"types":"./_types/index.d.ts","import":"./_esm/index.js","default":"./_cjs/index.js"},"./utils":{"types":"./_types/utils/index.d.ts","import":"./_esm/utils/index.js","default":"./_cjs/utils/index.js"},"./errors":{"types":"./_types/errors/index.d.ts","import":"./_esm/errors/index.js","default":"./_cjs/errors/index.js"},"./actions":{"types":"./_types/actions/index.d.ts","import":"./_esm/actions/index.js","default":"./_cjs/actions/index.js"},"./clients":{"types":"./_types/clients/index.d.ts","import":"./_esm/clients/index.js","default":"./_cjs/clients/index.js"},"./accounts":{"types":"./_types/accounts/index.d.ts","import":"./_esm/accounts/index.js","default":"./_cjs/accounts/index.js"},"./actions/pimlico":{"types":"./_types/actions/pimlico.d.ts","import":"./_esm/actions/pimlico.js","default":"./_cjs/actions/pimlico.js"},"./actions/stackup":{"types":"./_types/actions/stackup.d.ts","import":"./_esm/actions/stackup.js","default":"./_cjs/actions/stackup.js"},"./clients/pimlico":{"types":"./_types/clients/pimlico.d.ts","import":"./_esm/clients/pimlico.js","default":"./_cjs/clients/pimlico.js"},"./clients/stackup":{"types":"./_types/clients/stackup.d.ts","import":"./_esm/clients/stackup.js","default":"./_cjs/clients/stackup.js"},"./actions/smartAccount":{"types":"./_types/actions/smartAccount.d.ts","import":"./_esm/actions/smartAccount.js","default":"./_cjs/actions/smartAccount.js"}},"gitHead":"644fd2057ef0d9e437a3f4bda8d4eec58fb915ef","typings":"./_types/index.d.ts","_npmUser":{"name":"0xbigboss","email":"0xbigboss@proton.me"},"repository":{"url":"git+https://github.com/0xbigboss/permissionless.js.git","type":"git"},"_npmVersion":"10.2.4","description":"A utility library for working with ERC-4337","directories":{},"sideEffects":false,"_nodeVersion":"20.11.1","_hasShrinkwrap":false,"peerDependencies":{"viem":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/permissionless_0.7.0-SNAPSHOT_1708803460575_0.5790675022126093","host":"s3://npm-registry-packages"}},"0.7.0-SNAPSHOT-1":{"name":"@0xbigboss/permissionless","version":"0.7.0-SNAPSHOT-1","keywords":["ethereum","erc-4337","eip-4337","paymaster","bundler"],"author":{"name":"Pimlico"},"license":"MIT","_id":"@0xbigboss/permissionless@0.7.0-SNAPSHOT-1","maintainers":[{"name":"0xbigboss","email":"0xbigboss@proton.me"}],"homepage":"https://docs.pimlico.io/permissionless","bugs":{"url":"https://github.com/0xbigboss/permissionless.js/issues"},"dist":{"shasum":"ed1f18f956c71bd41a48e4c9a201d7a40d0c0465","tarball":"https://registry.npmjs.org/@0xbigboss/permissionless/-/permissionless-0.7.0-SNAPSHOT-1.tgz","fileCount":546,"integrity":"sha512-/D3hB3g+CVE45uZvVpyUDlQVuWXCeFnNk3M7Lbw2V0iAl/I3fmBn4Wdk78wcKzE5kscUBl5ip7r7pt5MbQJ7Ig==","signatures":[{"sig":"MEQCIB1jgm+fRgWd6KFI9hBuxXvr9hsK2onxFC8jFayYH6z2AiBrQO5ybJ6T6+5N4cGmvYcAswfZ2KwL2n7bUuGwQuSlPg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1160926},"main":"./_cjs/index.js","type":"module","types":"./_types/index.d.ts","module":"./_esm/index.js","exports":{".":{"types":"./_types/index.d.ts","import":"./_esm/index.js","default":"./_cjs/index.js"},"./utils":{"types":"./_types/utils/index.d.ts","import":"./_esm/utils/index.js","default":"./_cjs/utils/index.js"},"./errors":{"types":"./_types/errors/index.d.ts","import":"./_esm/errors/index.js","default":"./_cjs/errors/index.js"},"./actions":{"types":"./_types/actions/index.d.ts","import":"./_esm/actions/index.js","default":"./_cjs/actions/index.js"},"./clients":{"types":"./_types/clients/index.d.ts","import":"./_esm/clients/index.js","default":"./_cjs/clients/index.js"},"./accounts":{"types":"./_types/accounts/index.d.ts","import":"./_esm/accounts/index.js","default":"./_cjs/accounts/index.js"},"./actions/pimlico":{"types":"./_types/actions/pimlico.d.ts","import":"./_esm/actions/pimlico.js","default":"./_cjs/actions/pimlico.js"},"./actions/stackup":{"types":"./_types/actions/stackup.d.ts","import":"./_esm/actions/stackup.js","default":"./_cjs/actions/stackup.js"},"./clients/pimlico":{"types":"./_types/clients/pimlico.d.ts","import":"./_esm/clients/pimlico.js","default":"./_cjs/clients/pimlico.js"},"./clients/stackup":{"types":"./_types/clients/stackup.d.ts","import":"./_esm/clients/stackup.js","default":"./_cjs/clients/stackup.js"},"./actions/smartAccount":{"types":"./_types/actions/smartAccount.d.ts","import":"./_esm/actions/smartAccount.js","default":"./_cjs/actions/smartAccount.js"}},"gitHead":"644fd2057ef0d9e437a3f4bda8d4eec58fb915ef","typings":"./_types/index.d.ts","_npmUser":{"name":"0xbigboss","email":"0xbigboss@proton.me"},"repository":{"url":"git+https://github.com/0xbigboss/permissionless.js.git","type":"git"},"_npmVersion":"10.2.4","description":"A utility library for working with ERC-4337","directories":{},"sideEffects":false,"_nodeVersion":"20.11.1","_hasShrinkwrap":false,"peerDependencies":{"viem":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/permissionless_0.7.0-SNAPSHOT-1_1708806678569_0.15460369483992253","host":"s3://npm-registry-packages"}}},"time":{"created":"2024-02-24T19:37:40.486Z","modified":"2026-06-24T17:39:13.021Z","0.7.0-SNAPSHOT":"2024-02-24T19:37:40.740Z","0.7.0-SNAPSHOT-1":"2024-02-24T20:31:18.905Z"},"bugs":{"url":"https://github.com/0xbigboss/permissionless.js/issues"},"author":{"name":"Pimlico"},"license":"MIT","homepage":"https://docs.pimlico.io/permissionless","keywords":["ethereum","erc-4337","eip-4337","paymaster","bundler"],"repository":{"url":"git+https://github.com/0xbigboss/permissionless.js.git","type":"git"},"description":"A utility library for working with ERC-4337","maintainers":[{"email":"0xbigboss@proton.me","name":"alleneubank"}],"readme":"<p align=\"center\"><a href=\"https://docs.pimlico/permissionless\"><img width=\"1000\" title=\"Permissionless\" src='https://raw.githubusercontent.com/pimlicolabs/permissionless.js/main/assets/banner.png' /></a></p>\n\n# Permissionless.js\n\n![Node Version](https://img.shields.io/badge/node-20.x-green)\n\npermissionless.js is a TypeScript library built on top of [viem](https://viem.sh) for deploying and managing [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337) smart accounts, interacting with bundlers and paymasters, and leveraging custom signers.\n\n## Features\n\n- **High-Level Smart Account Support**: We support a high-level API for deploying and managing smart accounts, including some of the most popular implementations ([Safe](https://safe.global), [Kernel](https://zerodev.app), [Biconomy](https://biconomy.io), etc.)\n- **Bundler Support**: We support all bundler actions following [ERC-4337](https://eips.ethereum.org/EIPS/eip-4337#rpc-methods-eth-namespace).\n- **Gas Sponsorship**: We support paymaster actions to allow you to easily sponsor gas fees.\n- **User Operation Utility Functions**: We provide many low-level utility functions useful for dealing with User Operations.\n- **Modular and Extensible**: We allow you to easily create and plug in your own smart account systems, bundlers, paymasters, and signers.\n- **Built on & for viem**: permissionless.js is designed to be a thin wrapper around viem, maintaining the same style and overall feel viem provides.\n- and a lot more...\n\n## Documentation\n\n[Take a look at our documentation](https://docs.pimlico.io/permissionless) to learn more about permissionless.js.\n\n## Installation\n\nInstall [viem](https://viem.sh) as a peer dependency.\n\nThen install permissionless.js:\n\n```bash\nnpm install viem permissionless\n```\n\n```bash\nbun install viem permissionless\n```\n\n```bash\nyarn add viem permissionless\n```\n\n## Quick Start\n\n```typescript\n// Import the required modules.\nimport { createBundlerClient } from \"permissionless\"\nimport { sepolia } from \"viem/chains\"\nimport { http } from \"viem\"\n\n// Create the required clients.\nconst bundlerClient = createBundlerClient({\n    chain: sepolia,\n    transport: http(`https://api.pimlico.io/v1/sepolia/rpc?apikey=${pimlicoApiKey}`) // Use any bundler url\n})\n\n// Consume bundler, paymaster, and smart account actions!\nconst userOperationReceipt = await bundlerClient.getUserOperationReceipt({\n    hash: \"0x5faea6a3af76292c2b23468bbea96ef63fb31360848be195748437f0a79106c8\"\n})\n```\n\n## Contributors\n\nFor a full explanation of permissionless.js, please visit our [docs page](https://docs.pimlico.io/permissionless)\n\nBuild permissionless.js locally with:\n```bash\nbun run build\n```\n\n## License\n\nDistributed under an MIT License. See [LICENSE](./LICENSE) for more information.\n\n## Contact\n\nFeel free to ask any questions in our [Telegram group](https://t.me/pimlicoHQ)\n","readmeFilename":"README.md"}