@biconomy/account
v4.5.7
Published
SDK for Biconomy integration with support for account abstraction, smart accounts, ERC-4337.
Downloads
11,597
Readme
SDK 🚀
The Biconomy SDK is your all-in-one toolkit for building decentralized applications (dApps) with ERC4337 Account Abstraction and Smart Accounts. It is designed for seamless user experiences and offers non-custodial solutions for user onboarding, sending transactions (userOps), gas sponsorship and much more.
:warning: Building with React?: Use our hooks package
📚 Table of Contents
🛠️ Quickstart
Installation
- Add the package and install dependencies:
bun add @biconomy/account viem
- Install dependencies:
bun i
import { createSmartAccountClient } from "@biconomy/account";
const smartAccount = await createSmartAccountClient({
signer: viemWalletOrEthersSigner,
bundlerUrl: "", // From dashboard.biconomy.io
paymasterUrl: "", // From dashboard.biconomy.io
});
const { wait } = await smartAccount.sendTransaction({ to: "0x...", value: 1 });
const {
receipt: { transactionHash },
success,
} = await wait();
Documentation and Resources
For a comprehensive understanding of our project and to contribute effectively, please refer to the following resources:
- Biconomy Documentation
- Biconomy Dashboard
- API Documentation
- Contributing Guidelines: Learn how to contribute to our project, from code contributions to documentation improvements.
- Code of Conduct: Our commitment to fostering an open and welcoming environment.
- Security Policy: Guidelines for reporting security vulnerabilities.
- Changelog: Stay updated with the changes and versions
💼 Examples
- Initialise a smartAccount
- send some eth with sponsorship
- send a multi tx and pay gas with an erc20 token
- create and use a session
- create and use a batch session
License
This project is licensed under the MIT License. See the LICENSE file for details