Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bcnmy/biconomy-client-sdk
Biconomy SDK is a plug & play toolkit for dApps to build transaction legos that enable a highly customised one-click experience for their users
https://github.com/bcnmy/biconomy-client-sdk
Last synced: 2 months ago
JSON representation
Biconomy SDK is a plug & play toolkit for dApps to build transaction legos that enable a highly customised one-click experience for their users
- Host: GitHub
- URL: https://github.com/bcnmy/biconomy-client-sdk
- Owner: bcnmy
- License: mit
- Created: 2022-06-29T10:19:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-11T14:27:41.000Z (4 months ago)
- Last Synced: 2024-11-16T22:29:45.566Z (2 months ago)
- Language: TypeScript
- Size: 16.9 MB
- Stars: 76
- Watchers: 8
- Forks: 78
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-account-abstraction - bcnmy/biconomy-client-sdk
README
[](https://biconomy.io) [](./LICENSE) [](https://codecov.io/gh/bcnmy/biconomy-client-sdk)
# SDK 🚀
[](https://codespaces.new/bcnmy/biconomy-client-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](https://github.com/bcnmy/useAA)
## 📚 Table of Contents
- [SDK 🚀](#sdk-)
- [📚 Table of Contents](#-table-of-contents)
- [🛠️ Quickstart](#-quickstart)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [📄 Documentation and Resources](#-documentation-and-resources)
- [💼 Examples](#-examples)
- [License](#license)
- [Connect with Biconomy 🍊](#connect-with-biconomy-🍊)
## 🛠️ Quickstart
### Installation
1. **Add the package and install dependencies:**
```bash
bun add @biconomy/account viem
```
2. **Install dependencies:**
```bash
bun i
```
```typescript
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**](https://docs.biconomy.io)
- [**Biconomy Dashboard**](https://dashboard.biconomy.io)
- [**API Documentation**](https://bcnmy.github.io/biconomy-client-sdk)
- [**Contributing Guidelines**](./CONTRIBUTING.md): Learn how to contribute to our project, from code contributions to documentation improvements.
- [**Code of Conduct**](./CODE_OF_CONDUCT.md): Our commitment to fostering an open and welcoming environment.
- [**Security Policy**](./SECURITY.md): Guidelines for reporting security vulnerabilities.
- [**Changelog**](./CHANGELOG.md): Stay updated with the changes and versions
## 💼 Examples
- [Initialise a smartAccount](examples/INITIALISE_A_SMART_CONTRACT.md)
- [send some eth with sponsorship](examples/SEND_SOME_ETH_WITH_SPONSORSHIP.md)
- [send a multi tx and pay gas with an erc20 token](examples/SEND_A_MULTI_TX_AND_PAY_GAS_WITH_TOKEN.md)
- [create and use a session](examples/CREATE_AND_USE_A_SESSION.md)
- [create and use a batch session](examples/CREATE_AND_USE_A_BATCH_SESSION.md)
## License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details
## Connect with Biconomy 🍊
[](https://biconomy.io) [](https://t.me/biconomy) [](https://twitter.com/biconomy) [](https://www.linkedin.com/company/biconomy) [](https://discord.gg/biconomy) [](https://www.youtube.com/channel/UC0CtA-Dw9yg-ENgav_VYjRw) [](https://github.com/bcnmy/)