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

• SDK 🚀

  • 📚 Table of Contents

  • 🛠️ Quickstart

    • Prerequisites
    • Installation

  • 📄 Documentation and Resources

  • 💼 Examples

  • License

  • Connect with Biconomy 🍊

🛠️ Quickstart

Installation

1. Add the package:

bun add @biconomy/sdk viem @rhinestone/module-sdk

2. Basic Usage:

import { createSmartAccountClient } from "@biconomy/sdk";
import { http } from "viem";

const nexusClient = await createSmartAccountClient({
  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:

• Node.js (v22 or higher)
• Bun package manager
• Foundry
• Yarn (must be 1.1.x, not 3.x). This is necessary because the nexus contracts repo relies on yarn.

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

Connect with Biconomy 🍊