Skip to content

Commit 32dda93

Browse files
authored
Merge pull request #191 from HasToBeJames/codex/175-181-184-187-smart-wallet-docs
feat: encapsulate smart wallet deploy flow and Soroban docs
2 parents 2bc2ba9 + 5f5096a commit 32dda93

File tree

15 files changed

+1310
-1033
lines changed

15 files changed

+1310
-1033
lines changed

README.md

Lines changed: 41 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
### The Problem We Solve
2121

2222
Integrating Stellar into your application is complex:
23+
2324
- Managing private keys and wallets is complicated and risky
2425
- Each DeFi protocol has its own interface and logic
2526
- Setting up transactions requires deep blockchain knowledge
@@ -46,28 +47,36 @@ Galaxy DevKit abstracts all this complexity:
4647
## 💡 Use Cases
4748

4849
### 🏦 Financial Applications
50+
4951
Add DeFi capabilities to your fintech or payment apps:
52+
5053
- Automated lending and borrowing
5154
- Asset swapping
5255
- Cross-border payments
5356
- Staking and yield generation
5457

5558
### 🎮 Gaming & NFTs
59+
5660
Integrate blockchain economy into your game or platform:
61+
5762
- Frictionless user wallets
5863
- In-game asset trading
5964
- Automated crypto rewards
6065
- NFT marketplaces
6166

6267
### 📱 Mobile & Web Apps
68+
6369
Add Web3 capabilities to your existing application:
70+
6471
- Wallet-based authentication (passwordless)
6572
- Peer-to-peer payments
6673
- Crypto subscriptions
6774
- Tokenized loyalty programs
6875

6976
### 🤖 DeFi Automation
77+
7078
Create automated investment strategies:
79+
7180
- Automatic portfolio rebalancing
7281
- Condition-based trading (price, volume)
7382
- Automated yield farming
@@ -78,27 +87,35 @@ Create automated investment strategies:
7887
## 🚀 What's Included
7988

8089
### 🔐 Invisible Wallet System
90+
8191
Secure wallets without user complexity:
92+
8293
- No need to handle private keys directly
8394
- Secure encryption and storage
8495
- Mnemonic phrase recovery
8596
- Multi-device management
8697

8798
### 💰 Integrated DeFi Protocols
99+
88100
Unified access to major Stellar protocols:
89-
- **Blend Protocol** - Lending and borrowing *(Coming Soon)*
90-
- **Soroswap** - Decentralized exchange *(Coming Soon)*
101+
102+
- **Blend Protocol** - Lending and borrowing _(Coming Soon)_
103+
- **Soroswap** - Decentralized exchange _(Coming Soon)_
91104
- **Base Infrastructure** - Ready for new protocol implementations
92105

93106
### 🤖 Automation Engine
107+
94108
Automate DeFi operations without complex code:
95-
- Time-based triggers
109+
110+
- Time-based triggers
96111
- Price and volume conditions
97112
- Complex logic (AND/OR)
98113
- Swaps, payments, and contract calls
99114

100115
### 📊 Multiple API Options
116+
101117
Choose your preferred interface:
118+
102119
- **REST API** - Traditional HTTP endpoints
103120
- **GraphQL API** - Flexible queries and subscriptions
104121
- **WebSocket API** - Real-time updates
@@ -125,14 +142,14 @@ import { WalletManager } from '@galaxy-kj/core-invisible-wallet';
125142
// Create a wallet for your user
126143
const wallet = await WalletManager.createWallet({
127144
userId: 'user123',
128-
encrypted: true // Automatic encryption
145+
encrypted: true, // Automatic encryption
129146
});
130147

131148
// Send a payment
132149
await wallet.sendPayment({
133150
destination: 'GDESTINATION...',
134151
amount: '100',
135-
asset: 'USDC'
152+
asset: 'USDC',
136153
});
137154
```
138155

@@ -145,16 +162,16 @@ import { getProtocolFactory } from '@galaxy-kj/core-defi-protocols';
145162
const factory = getProtocolFactory();
146163
const protocol = factory.createProtocol({
147164
protocolId: 'blend',
148-
network: 'testnet'
165+
network: 'testnet',
149166
});
150167

151168
// Get protocol statistics
152169
const stats = await protocol.getStats();
153170
console.log('Total Value Locked:', stats.tvl);
154171

155172
// Perform operations
156-
await protocol.supply('USDC', '1000'); // Deposit USDC
157-
await protocol.borrow('XLM', '500'); // Borrow XLM
173+
await protocol.supply('USDC', '1000'); // Deposit USDC
174+
await protocol.borrow('XLM', '500'); // Borrow XLM
158175
```
159176

160177
### Example: Automation
@@ -171,14 +188,14 @@ automation.createRule({
171188
type: 'price',
172189
asset: 'XLM',
173190
condition: 'above',
174-
value: 0.15
191+
value: 0.15,
175192
},
176193
action: {
177194
type: 'swap',
178195
from: 'XLM',
179196
to: 'USDC',
180-
amount: '100'
181-
}
197+
amount: '100',
198+
},
182199
});
183200
```
184201

@@ -200,16 +217,25 @@ For more information, see the [complete documentation](docs/README.md).
200217
## 📚 Documentation
201218

202219
### Getting Started
220+
203221
- [Quick Start Guide](docs/README.md) - Get started in 5 minutes
204222
- [Code Examples](docs/examples/) - Real-world examples
205223

206224
### Package Documentation
225+
207226
- [DeFi Protocols](packages/core/defi-protocols/README.md) - DeFi integration guide
208227
- [Invisible Wallet](packages/core/invisible-wallet/README.md) - Wallet management
209228
- [Automation](packages/core/automation/README.md) - Automation engine
210229

211230
### Additional Resources
231+
212232
- [System Architecture](docs/ARCHITECTURE.md) - Design and patterns
233+
- [Architecture Overview](docs/architecture/architecture.md) - Current wallet, session key, and DeFi flow diagrams
234+
- [Smart Wallet Auth Flow](docs/architecture/smart-wallet-auth-flow.md) - WebAuthn and Soroban auth sequence
235+
- [Session Key Flow](docs/architecture/session-key-flow.md) - Session signer lifecycle
236+
- [DeFi Aggregation Flow](docs/architecture/defi-aggregation-flow.md) - Quote routing and execution path
237+
- [Smart Wallet Contract Guide](docs/contracts/smart-wallet-contract.md) - Factory and wallet contract reference
238+
- [Contract Deployment Guide](docs/contracts/deployment.md) - Soroban build and testnet deploy guide
213239
- [Roadmap](docs/ROADMAP.md) - Development phases and progress
214240
- [GitHub Issues](https://github.com/galaxy-devkit/galaxy-devkit/issues) - Report bugs or request features
215241

@@ -218,23 +244,27 @@ For more information, see the [complete documentation](docs/README.md).
218244
## 🛣️ Roadmap
219245

220246
### ✅ Phase 1: Foundation (Completed)
247+
221248
- Invisible wallet system
222249
- Base architecture for DeFi protocols
223250
- Automation engine
224251
- APIs and testing infrastructure
225252

226253
### 🚧 Phase 2: DeFi Integration (In Progress)
254+
227255
- Blend Protocol integration (lending/borrowing)
228256
- Soroswap integration (DEX)
229257
- DEX aggregator
230258
- Oracle system
231259

232260
### 📋 Phase 3: Advanced Features
261+
233262
- Automated yield strategies
234263
- Analytics dashboard
235264
- Advanced risk management
236265

237266
### 📋 Phase 4: Enterprise
267+
238268
- Multi-signature wallets
239269
- Team accounts
240270
- Complete audit logging

0 commit comments

Comments
 (0)