Git Product home page Git Product logo

biconomy-client-sdk's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.