@biconomy/sdk
v0.0.20
Published
SDK for Biconomy integration with support for account abstraction, smart accounts, ERC-4337.
Downloads
1,997
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.
📚 Table of Contents
🛠️ Quickstart
Installation
- Add the package:
bun add @biconomy/sdk viem @rhinestone/module-sdk
- Basic Usage:
import { createNexusClient } from "@biconomy/sdk";
import { http } from "viem";
const nexusClient = await createNexusClient({
signer: account,
chain,
transport: http(),
bundlerTransport: http(bundlerUrl),
});
const hash = await nexusClient.sendTransaction({
calls: [{ to: "0x...", value: 1 }]
});
const { status, transactionHash } = await nexusClient.waitForTransactionReceipt({ hash });
Testing
Prerequisites:
Setup:
bun install --frozen-lockfile
Running Tests:
# Run all tests
bun run test
# Run tests for a specific module
bun run test -t=smartSessions
For detailed information about the testing framework, network configurations, and debugging guidelines, please refer to our Testing Documentation.
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
License
This project is licensed under the MIT License. See the LICENSE file for details