0.0.0-main.20240729T124634 • Published 2 years ago

permissionless v0.0.0-main.20240729T124634

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

permissionless.js

Node Version

permissionless.js is a TypeScript library built on top of viem for deploying and managing ERC-4337 smart accounts, interacting with bundlers and paymasters, and leveraging custom signers.

Features

  • 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, Kernel, Biconomy, etc.)
  • Bundler Support: We support all bundler actions following ERC-4337.
  • Gas Sponsorship: We support paymaster actions to allow you to easily sponsor gas fees.
  • User Operation Utility Functions: We provide many low-level utility functions useful for dealing with User Operations.
  • Modular and Extensible: We allow you to easily create and plug in your own smart account systems, bundlers, paymasters, and signers.
  • Built on & for viem: permissionless.js is designed to be a thin wrapper around viem, maintaining the same style and overall feel viem provides.
  • and a lot more...

Documentation

Take a look at our documentation to learn more about permissionless.js.

Installation

Install viem as a peer dependency.

Then install permissionless.js:

npm install viem permissionless
bun install viem permissionless
yarn add viem permissionless

Quick Start

// Import the required modules.
import { createBundlerClient } from "permissionless"
import { sepolia } from "viem/chains"
import { http } from "viem"

// Create the required clients.
const bundlerClient = createBundlerClient({
    chain: sepolia,
    transport: http(`https://api.pimlico.io/v1/sepolia/rpc?apikey=${pimlicoApiKey}`) // Use any bundler url
})

// Consume bundler, paymaster, and smart account actions!
const userOperationReceipt = await bundlerClient.getUserOperationReceipt({
    hash: "0x5faea6a3af76292c2b23468bbea96ef63fb31360848be195748437f0a79106c8"
})

Contributors

For a full explanation of permissionless.js, please visit our docs page

Build permissionless.js locally with:

bun run build

License

Distributed under an MIT License. See LICENSE for more information.

Contact

Feel free to ask any questions in our Telegram group

@everything-registry/sub-chunk-2427walletcheckmagic-account-wagmi@wallchain/savings-sdk@web3auth/account-abstraction-provider@thesixnetwork/account-abstraction-sdk@toruslabs/ethereum-controllers@thesellouts/sellout-hooks@tria-sdk/aa@zerodev/magic-account@zerodev/yi-sdkaccount-abstraction-wallet-sdkaxr-erc4337-sdkffreed-sdkcarlos-menezes-test-sdkcoinbase-onchainkit-patchedcustom-connector@groupos/smart-accountszerodev-af8-passkey-validator@dynamic-labs/zerodev-extension@dynamic-labs/ethereum-aamicrochpaasskeys-serveronchain-app-templateokx-aa-sdkpolkamarkets-jssmart-capabilities@lightdotso/app@lightdotso/dialogs@latticexyz/entrykit@latticexyz/account-kit@openware/neodax-web-sdk@plumaa/signer@polygram/wallet@owlprotocol/backend-bundler@owlprotocol/clients@owlprotocol/contracts-account-abstraction@owlprotocol/core-provider@owlprotocol/core-trpc@parifi/sdk@0xnukeee/test-sdk@actalink/commonlib@alec-chen/onchainkit@cartesi/mock-verifying-paymaster@azuro-org/sdk-social-aa-connector@build-with-yi/wagmi@crossmint/client-sdk-aa@crossmint/client-sdk-aa-passkeys-beta@cometh/connect-core-sdk@cometh/connect-react-hooks@cometh/connect-sdk-4337@cometh/crosschain-sdk@cometh/keystore-sdk@cometh/session-keys@cyberlab/cyber-account-plugins@dappykit/sdk@defi-wonderland/sponsored-txs-hardhat-plugin@defi-wonderland/hardhat-account-abstraction@fourt/sdk@fuseio/fusebox-web-sdk@earnkit/sdk-wallet@eveworld/contexts@fileverse/agents@graphprotocol/grc-20@goat-sdk/wallet-safe@groupos/walletkit@helixbox/smartwallet-safehelper@helixbox/fluid@itsobvioustech/accounts@rainmakerresearch/core@maci-protocol/maci-coordinator@kriptonio/sdk@magic-account/wagmi@jiffy-labs/jiffy-hooks@jiffy-labs/web3a@remix-project/remix-lib
0.2.27

1 year ago

0.2.26

1 year ago

0.2.25

1 year ago

0.2.24

1 year ago

0.2.23

1 year ago

0.2.22

1 year ago

0.2.21

1 year ago

0.2.20

1 year ago

0.2.19

1 year ago

0.2.18

1 year ago

0.2.17

1 year ago

0.1.49

1 year ago

0.1.47

1 year ago

0.1.48

1 year ago

0.2.16

1 year ago

0.2.15

1 year ago

0.2.14

1 year ago

0.2.30

1 year ago

0.2.36

11 months ago

0.2.35

12 months ago

0.2.34

12 months ago

0.2.33

1 year ago

0.2.32

1 year ago

0.2.31

1 year ago

0.2.29

1 year ago

0.2.28

1 year ago

0.1.46

1 year ago

0.2.13

1 year ago

0.2.12

1 year ago

0.2.11

1 year ago

0.2.0-rc-5

1 year ago

0.2.0-rc-2

1 year ago

0.2.0-rc-1

1 year ago

0.2.0-rc-4

1 year ago

0.2.0-rc-3

1 year ago

0.2.10

1 year ago

0.2.1

1 year ago

0.2.0

1 year ago

0.2.7

1 year ago

0.2.6

1 year ago

0.2.9

1 year ago

0.2.8

1 year ago

0.2.3

1 year ago

0.2.2

1 year ago

0.2.5

1 year ago

0.2.4

1 year ago

0.1.41

2 years ago

0.1.42

2 years ago

0.1.43

2 years ago

0.1.44

2 years ago

0.1.45

1 year ago

0.1.40

2 years ago

0.1.38

2 years ago

0.1.39

2 years ago

0.1.30

2 years ago

0.1.31

2 years ago

0.1.32

2 years ago

0.1.33

2 years ago

0.1.34

2 years ago

0.1.35

2 years ago

0.1.36

2 years ago

0.1.29

2 years ago

0.1.27

2 years ago

0.1.28

2 years ago

0.1.26

2 years ago

0.1.25

2 years ago

0.1.23

2 years ago

0.1.24

2 years ago

0.1.22

2 years ago

0.1.21

2 years ago

0.1.20

2 years ago

0.1.19

2 years ago

0.1.18

2 years ago

0.1.17

2 years ago

0.1.15

2 years ago

0.1.16

2 years ago

0.1.13

2 years ago

0.1.14

2 years ago

0.1.12

2 years ago

0.1.11

2 years ago

0.1.10

2 years ago

0.1.9

2 years ago

0.1.8

2 years ago

0.1.7

2 years ago

0.1.6

2 years ago

0.1.5

2 years ago

0.1.0

2 years ago

0.1.2

2 years ago

0.1.1

2 years ago

0.1.4

2 years ago

0.1.3

2 years ago

0.0.36

2 years ago

0.0.35

2 years ago

0.0.34

2 years ago

0.0.32

2 years ago

0.0.33

2 years ago

0.0.31

2 years ago

0.0.30

2 years ago

0.0.29

2 years ago

0.0.28

2 years ago

0.0.26

2 years ago

0.0.27

2 years ago

0.0.22

2 years ago

0.0.23

2 years ago

0.0.24

2 years ago

0.0.25

2 years ago

0.0.21

2 years ago

0.0.20

2 years ago

0.0.19

2 years ago

0.0.18

2 years ago

0.0.17

2 years ago

0.0.16

2 years ago

0.0.15

2 years ago

0.0.14

2 years ago

0.0.10

2 years ago

0.0.11

2 years ago

0.0.12

2 years ago

0.0.13

2 years ago

0.0.9

2 years ago

0.0.8

2 years ago

0.0.5

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.4

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

2 years ago