@startale-scs/aa-sdk 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +64 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,74 @@
|
|
|
1
|
-
Based on Biconomy's abstractjs sdk
|
|
2
|
-
[](./LICENSE)
|
|
3
|
-
|
|
4
|
-
|
|
5
1
|
# Startale's scs-aa-sdk 🚀
|
|
6
|
-
## This is an early version distributed with launch of Account abstraction product.
|
|
7
2
|
|
|
8
|
-
|
|
3
|
+
[](./LICENSE)
|
|
4
|
+
[](https://www.npmjs.com/package/@startale/scs-aa-sdk)
|
|
5
|
+
[](https://www.npmjs.com/package/@startale/scs-aa-sdk)
|
|
6
|
+
|
|
7
|
+
A powerful toolkit for building decentralized applications (dApps) with **ERC4337 Account Abstraction** and **Smart Accounts**. This SDK is based on Biconomy's abstractjs sdk and enhanced for Startale's ecosystem.
|
|
9
8
|
|
|
10
9
|
## 📚 Table of Contents
|
|
11
10
|
|
|
12
|
-
- [
|
|
11
|
+
- [Installation](#installation)
|
|
12
|
+
- [Quick Start](#quick-start)
|
|
13
|
+
- [Features](#features)
|
|
14
|
+
- [Documentation](#documentation)
|
|
15
|
+
- [Examples](#examples)
|
|
16
|
+
- [Contributing](#contributing)
|
|
17
|
+
- [License](#license)
|
|
18
|
+
|
|
19
|
+
## 🚀 Installation
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install @startale/scs-aa-sdk
|
|
23
|
+
# or
|
|
24
|
+
yarn add @startale/scs-aa-sdk
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## ⚡ Quick Start
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { createSCSPaymasterClient, createSmartAccountClient, toStartaleSmartAccount } from "@startale-scs/aa-sdk";
|
|
31
|
+
|
|
32
|
+
// Initialize your smart account and client
|
|
33
|
+
const smartAccountClient = createSmartAccountClient({
|
|
34
|
+
account: await toStartaleSmartAccount({
|
|
35
|
+
signer: signer,
|
|
36
|
+
chain: chain,
|
|
37
|
+
transport: http(),
|
|
38
|
+
index: BigInt(2132)
|
|
39
|
+
}),
|
|
40
|
+
transport: http(bundlerUrl),
|
|
41
|
+
client: publicClient,
|
|
42
|
+
})
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## ✨ Features
|
|
47
|
+
|
|
48
|
+
- 🔐 **Account Abstraction**: Full support for ERC4337 Account Abstraction
|
|
49
|
+
- 💡 **Smart Account Management**: Easy creation and management of smart accounts
|
|
50
|
+
- 🔄 **Transaction Batching**: Bundle multiple transactions into a single operation
|
|
51
|
+
- 🔌 **Modular Design**: Flexible and extensible architecture
|
|
52
|
+
- 🌐 **Cross-Chain Support**: Compatible with multiple EVM chains
|
|
53
|
+
|
|
54
|
+
## 📖 Documentation
|
|
55
|
+
|
|
56
|
+
For detailed documentation, please visit our [documentation site](https://docs.startale.com/scs-aa-sdk).
|
|
57
|
+
|
|
58
|
+
## 🎯 Examples
|
|
59
|
+
|
|
60
|
+
Check out our [examples directory](./examples) for complete implementation examples.
|
|
61
|
+
|
|
62
|
+
## 🤝 Contributing
|
|
63
|
+
|
|
64
|
+
We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.
|
|
65
|
+
|
|
66
|
+
## 📄 License
|
|
13
67
|
|
|
14
|
-
|
|
68
|
+
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
|
|
15
69
|
|
|
16
|
-
|
|
70
|
+
---
|
|
17
71
|
|
|
18
|
-
|
|
72
|
+
Built with ❤️ by [Startale Labs](https://startale.com)
|
|
19
73
|
|
|
20
74
|
|