@etherspot/modular-sdk/README.md

Etherspot Modular SDK - build with ERC-7579 smart accounts modules

<div align="center">
  <h1 align="center">Etherspot Modular SDK</h1>
</div>

<div align="center">
  <img src="https://public.etherspot.io/assets/etherspot.gif" width="200" height="200">
  <p>
    <b>
      Etherspot Modular SDK 
    </b>
   </p>
</div>

--------------

>[!IMPORTANT]
>This repo/software is under active development.
>
>[![npm](https://img.shields.io/npm/v/@etherspot/modular-sdk)](https://www.npmjs.com/package/@etherspot/modular-sdk) 


## 🐞 Etherspot Modular

Etherspot Modular is a fully open source SDK which let's dapp developers easily get building with Account Abstraction.

The SDK makes it incredibly easy to get up and running with Account Abstraction. From social logins to transaction batching, using an Etherspot smart wallet can give your dapp a web2 like interface to ensure the user has a seamless experience.

## ⚙ Get started

You can either get started by installing the packages yourself here:

```bash
npm i @etherspot/modular-sdk
```

Or follow our introductory guide on our docs [here](https://etherspot.fyi/getting-started) which walk you through 
cloning down an example repo and setting up a dapp in your own environment. 

The testnet bundler API key `etherspot_public_key` is included in the example programs which is a public API key with rate limits, to get higher limits register to https://portal.etherspot.io

### Note: The smart wallet address differs on the `XDC Testnet` compared to other chains.

## 📖 Documentation

- [Quick Start](https://etherspot.fyi/getting-started)
- [Instantiate the SDK](https://etherspot.fyi/prime-sdk/instantiation)
- [Running SDK examples](https://etherspot.fyi/examples/intro)
- [Function List](https://etherspot.fyi/prime-sdk/function)
- [Batching Transactions](https://etherspot.fyi/prime-sdk/batching-transactions)

## 🔗 Important Links

- [Skandha Bundler](https://etherspot.fyi/skandha/intro)
- [Arka Paymaster](https://etherspot.fyi/arka/intro)
- [SDK Reference](https://sdk.etherspot.io/)

## 🏌️‍♂️ Contributions

Please feel free to open issues or PRs to this repo.

## 🔐 Security

To report security issues please follow [guide](./SECURITY.md)

## 💬 Contact

If you have any questions or feedback about Etherspot Modular, please feel free to reach out to us.

- [Follow on Twitter](https://twitter.com/etherspot)
- [Join our discord](https://discord.etherspot.io/)

## 📄 License

Licensed under the [MIT License](https://github.com/etherspot/etherspot-modular-sdk/blob/master/LICENSE).