Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 3.08 KB

README.md

File metadata and controls

71 lines (46 loc) · 3.08 KB
Raw

Biconomy SDK: Your Gateway to ERC4337 Account Abstraction & Smart Accounts 🛠️

Biconomy SDK TypeScript Test Coverage

Biconomy SDK Banner

Introduction

The Biconomy SDK is your all-in-one toolkit for building decentralized applications (dApps) with ERC4337 Account Abstraction and Smart Accounts. This SDK is designed for seamless user experiences and offers non-custodial solutions for ERC6900 compliant user onboarding, transaction management, and gas abstraction.

Biconomy SDK Diagram

🌟 Features

  • ERC4337 Account Abstraction: Simplify user operations and gas payments.
  • Smart Accounts: Enhance user experience with ERC6900 compliant accounts.
  • Paymaster Service: Enable third-party gas sponsorship.
  • Bundler Infrastructure: Ensure efficient and reliable transaction bundling.
  • Backend Node: Manage chain configurations and gas estimations.

📦 Packages

Account

Unlock the full potential of ERC4337 Account Abstraction with methods that simplify the creation and dispatch of UserOperations, streamlining dApp development and management.

const biconomyAccount = new BiconomySmartAccount(biconomySmartAccountConfig);
const biconomySmartAccount = await biconomyAccount.init();
console.log("owner: ", biconomySmartAccount.owner);
console.log("address: ", biconomySmartAccount.address);

Bundler

Leverage standardized bundler infrastructure for efficient operation of account abstraction across EVM networks.

const bundler: IBundler = new Bundler({
    bundlerUrl: '', // From Biconomy Dashboard
    chainId: ChainId.POLYGON_MUMBAI,
    entryPointAddress: DEFAULT_ENTRYPOINT_ADDRESS,
});

Paymaster

Acting as third-party intermediaries, Paymasters have the capability to sponsor gas fees for an account, provided specific predefined conditions are met. Additionally, they can accept gas payments in ERC20 tokens from users' smart accounts, with the Paymaster managing the conversion to native tokens for gas payment.

const paymaster: IPaymaster = new BiconomyPaymaster({
    paymasterUrl: '' // From Biconomy Dashboard
});

🛠️ Quickstart

For a step-by-step guide on integrating ERC4337 Account Abstraction and Smart Accounts into your dApp using the Biconomy SDK, refer to the official documentation.

📚 Resources

🤝 Contributing

Community contributions are welcome! For guidelines on contributing, please read our contribution guidelines.

📜 License

This project is licensed under the MIT License. See the LICENSE.md file for details.