Skip to content

Commit 653e492

Browse files
committed
docs: improve writing style and remove AI-sounding language
- Replace formal phrases like "enables", "comprehensive", "designed to" - Remove Oxford commas before "and" in simple lists - Use contractions (can't, doesn't) for natural tone - Simplify introductory sentences across all README files - Make descriptions more direct and conversational
1 parent bdae974 commit 653e492

13 files changed

Lines changed: 44 additions & 86 deletions

File tree

README.md

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# MPC Agent Wallet SDK
22

3-
A **2-of-3 threshold MPC wallet SDK** designed for AI agents. Enables secure transaction signing where the AI agent cannot act alone - requiring approval from either a user or recovery guardian.
3+
A **2-of-3 threshold MPC wallet SDK** built for AI agents. The AI agent can't sign transactions alone - it needs approval from either a user or recovery guardian.
44

55
## Key Features
66

77
- **2-of-3 Threshold Signing**: AI agent holds 1 share, user holds 1 share, recovery guardian holds 1 share. Any 2 can sign.
88
- **Policy Engine**: Configurable rules enforced before signing (spending limits, whitelists, time bounds)
99
- **Rust Core**: High-performance cryptographic operations with WASM compilation support
10-
- **Chain Agnostic**: Designed for EVM, Solana, and Bitcoin support
10+
- **Chain Agnostic**: Works with EVM, Solana and Bitcoin
1111

1212
## Architecture
1313

@@ -255,48 +255,6 @@ mpc-agent-wallet/
255255
└── README.md
256256
```
257257

258-
## Roadmap
259-
260-
### Phase 1: Core MPC Engine [Complete]
261-
- [x] DKLs23 adaptation for 2-of-3 threshold
262-
- [x] Policy engine with spending limits, whitelists
263-
- [x] Key share storage interface
264-
265-
### Phase 2: Chain Adapters [Complete]
266-
- [x] EVM adapter with EIP-1559 support
267-
- [x] Solana adapter
268-
- [x] ERC-4337 smart account module
269-
270-
### Phase 3: WASM + SDKs [Complete]
271-
- [x] WASM compilation with wasm-bindgen
272-
- [x] TypeScript SDK (`@mpc-wallet/sdk`)
273-
- [x] Python SDK (`mpc-wallet`)
274-
275-
### Phase 4: Relay Service [Complete]
276-
- [x] WebSocket relay
277-
- [x] Approval flow
278-
- [x] Webhook notifications
279-
280-
### Phase 5: Smart Contracts [Complete]
281-
- [x] MpcSmartAccount - ERC-4337 smart account with MPC signature validation
282-
- [x] MpcRecoveryModule - Time-delayed MPC key recovery
283-
- [x] MpcSpendingLimitHook - On-chain spending limit enforcement
284-
- [x] MpcSmartAccountFactory - CREATE2 counterfactual deployment
285-
- [x] 71 passing tests
286-
287-
### Phase 6: Testing & Security [Complete]
288-
- [x] Comprehensive test suite (198+ tests)
289-
- [x] Fuzz testing for policy engine and signing
290-
- [x] Security checklist documentation
291-
292-
### Phase 7: Documentation & Examples [Complete]
293-
- [x] Quick start guide
294-
- [x] Architecture documentation
295-
- [x] Security model documentation
296-
- [x] Integration guide for AI frameworks
297-
- [x] TypeScript & Python API reference
298-
- [x] Example integrations (ElizaOS, LangChain, Telegram, DeFi Agent)
299-
300258
## Documentation
301259

302260
| Document | Description |
@@ -350,4 +308,4 @@ Contributions welcome! Please read the contributing guidelines first.
350308

351309
---
352310

353-
Built for AI agents that need secure, controlled access to blockchain operations.
311+
Built for AI agents that need secure blockchain access with human oversight.

contracts/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ ERC-4337 smart account contracts secured by MPC threshold signatures for AI agen
5151
|----------|-------------|
5252
| `MpcSmartAccount` | ERC-4337 smart account with MPC signature validation and policy enforcement |
5353
| `MpcSmartAccountFactory` | Factory for deploying MPC smart account proxies with CREATE2 |
54-
| `MpcRecoveryModule` | Enables MPC key recovery with time-delayed execution |
54+
| `MpcRecoveryModule` | Handles MPC key recovery with time-delayed execution |
5555
| `MpcSpendingLimitHook` | Spending limit enforcement hook for transaction policies |
5656

5757
## Features
@@ -197,11 +197,11 @@ account.cancelRecovery(accountAddress); // Only account or guardians
197197

198198
## Security Considerations
199199

200-
1. **Key Share Distribution**: Store key shares on separate devices/locations
201-
2. **Guardian Selection**: Choose diverse, trusted guardians
202-
3. **Time Delay**: Allows detection of malicious recovery attempts
203-
4. **Spending Limits**: Mitigate damage from compromised AI agents
204-
5. **Whitelist**: Restrict interaction to known-good contracts
200+
1. **Key Share Distribution**: Store key shares on separate devices
201+
2. **Guardian Selection**: Pick diverse and trusted guardians
202+
3. **Time Delay**: Gives time to detect malicious recovery attempts
203+
4. **Spending Limits**: Limits damage from compromised AI agents
204+
5. **Whitelist**: Only allow known-good contracts
205205

206206
## License
207207

docs/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# MPC Agent Wallet SDK - Quick Start Guide
22

3-
Welcome to the MPC Agent Wallet SDK! This guide will help you get started with building secure, AI-controlled wallets using threshold MPC cryptography.
3+
This guide covers everything you need to build secure AI-controlled wallets using threshold MPC cryptography.
44

55
## What is MPC Agent Wallet?
66

7-
MPC Agent Wallet is a **2-of-3 threshold Multi-Party Computation (MPC) wallet SDK** designed specifically for AI agents. It enables AI applications to securely manage cryptocurrency wallets while maintaining human oversight.
7+
MPC Agent Wallet is a **2-of-3 threshold Multi-Party Computation (MPC) wallet SDK** built for AI agents. It lets AI applications manage cryptocurrency wallets while keeping humans in control.
88

99
### Key Benefits
1010

11-
- **AI agents cannot act alone** - Requires approval from user or recovery guardian
12-
- **Policy enforcement** - Spending limits, whitelists, and time restrictions
13-
- **Multi-chain support** - EVM, Solana, and Bitcoin compatible
14-
- **Developer-friendly** - TypeScript, Python, and Rust SDKs
11+
- **AI agents can't act alone** - Needs approval from user or recovery guardian
12+
- **Policy enforcement** - Spending limits, whitelists and time restrictions
13+
- **Multi-chain support** - Works with EVM, Solana and Bitcoin
14+
- **Developer-friendly** - TypeScript, Python and Rust SDKs
1515

1616
## Installation
1717

@@ -193,9 +193,9 @@ print(f"Wallet address: {address}")
193193

194194
## Next Steps
195195

196-
- [Architecture Guide](./architecture.md) - Deep dive into system design
197-
- [Security Model](./security-model.md) - Understand the threat model
198-
- [Integration Guide](./integration-guide.md) - Integrate with AI frameworks
196+
- [Architecture Guide](./architecture.md) - Learn how the system works
197+
- [Security Model](./security-model.md) - Threat model and protections
198+
- [Integration Guide](./integration-guide.md) - Connect with AI frameworks
199199
- [TypeScript API Reference](./api-reference/typescript.md)
200200
- [Python API Reference](./api-reference/python.md)
201201

@@ -217,4 +217,4 @@ print(f"Wallet address: {address}")
217217

218218
---
219219

220-
Built for AI agents that need secure, controlled access to blockchain operations.
220+
Built for AI agents that need secure blockchain access with human oversight.

docs/SECURITY_CHECKLIST.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ This document outlines the security measures and verification checklist for the
143143
- [x] **Memory Safety**: Written in Rust with safe defaults
144144
- [x] **No Unsafe Code**: Minimal unsafe code, all reviewed
145145
- [x] **Dependency Audit**: Dependencies audited with `cargo audit`
146-
- [x] **Test Coverage**: Comprehensive unit, integration, and fuzz tests
146+
- [x] **Test Coverage**: Unit, integration and fuzz tests
147147

148148
#### Testing Framework
149149

@@ -191,7 +191,7 @@ Test categories:
191191

192192
### Testing
193193

194-
- [x] Unit tests comprehensive (>80% coverage target)
194+
- [x] Unit tests complete (>80% coverage target)
195195
- [x] Integration tests for all flows
196196
- [x] Fuzz testing for edge cases
197197
- [x] Invariant tests for critical properties

docs/api-reference/python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -671,7 +671,7 @@ asyncio.run(main())
671671

672672
## Type Hints
673673

674-
The package includes comprehensive type hints and supports mypy/pyright:
674+
The package includes full type hints and supports mypy/pyright:
675675

676676
```python
677677
from mpc_wallet import MpcAgentWallet, TransactionRequest, PolicyDecision

docs/architecture.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Architecture Guide
22

3-
This document provides a comprehensive overview of the MPC Agent Wallet SDK architecture, design decisions, and component interactions.
3+
This guide covers the MPC Agent Wallet SDK architecture, design decisions and how components work together.
44

55
## System Overview
66

@@ -108,7 +108,7 @@ pub enum PolicyDecision {
108108

109109
### 3. Chain Adapters
110110

111-
Blockchain-agnostic interface for multi-chain support.
111+
A common interface that works across different blockchains.
112112

113113
```rust
114114
#[async_trait]
@@ -419,6 +419,6 @@ class SlackNotifier implements NotificationChannel {
419419

420420
## Related Documentation
421421

422-
- [Security Model](./security-model.md) - Detailed threat model and mitigations
422+
- [Security Model](./security-model.md) - Threat model and protections
423423
- [Integration Guide](./integration-guide.md) - AI framework integrations
424-
- [API Reference](./api-reference/) - Complete API documentation
424+
- [API Reference](./api-reference/) - Full API documentation

docs/integration-guide.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Integration Guide
22

3-
This guide explains how to integrate the MPC Agent Wallet SDK with popular AI frameworks and applications.
3+
Learn how to connect the MPC Agent Wallet SDK with popular AI frameworks.
44

55
## Table of Contents
66

@@ -15,7 +15,7 @@ This guide explains how to integrate the MPC Agent Wallet SDK with popular AI fr
1515

1616
## ElizaOS Integration
1717

18-
[ElizaOS](https://elizaos.ai) is a popular framework for building AI agents. The MPC Wallet integrates as a plugin.
18+
[ElizaOS](https://elizaos.ai) is a popular framework for building AI agents. The MPC Wallet works as a plugin.
1919

2020
### Installation
2121

@@ -334,7 +334,7 @@ def wallet_send(to: str, amount: str, chain: str = "ethereum") -> str:
334334

335335
## Custom AI Frameworks
336336

337-
For custom AI frameworks, use the SDK directly.
337+
For custom AI frameworks, you can use the SDK directly.
338338

339339
### TypeScript Example
340340

@@ -589,7 +589,7 @@ try {
589589
### 3. Logging and Monitoring
590590

591591
```typescript
592-
// Set up comprehensive logging
592+
// Set up logging
593593
wallet.on('policyEvaluated', (tx, decision) => {
594594
logger.info('Policy evaluated', {
595595
txId: tx.requestId,
@@ -654,7 +654,7 @@ if (context.isKnownProtocol) {
654654

655655
## Next Steps
656656

657-
- [Basic Wallet Example](../examples/basic-wallet/) - Start with the basics
658-
- [ElizaOS Plugin Example](../examples/elizaos-plugin/) - Full ElizaOS integration
659-
- [LangChain Tool Example](../examples/langchain-tool/) - LangChain integration
660-
- [Telegram Bot Example](../examples/telegram-bot/) - Approval via Telegram
657+
- [Basic Wallet Example](../examples/basic-wallet/) - Start here
658+
- [ElizaOS Plugin Example](../examples/elizaos-plugin/) - Full ElizaOS setup
659+
- [LangChain Tool Example](../examples/langchain-tool/) - LangChain setup
660+
- [Telegram Bot Example](../examples/telegram-bot/) - Telegram approvals

docs/security-model.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Security Model
22

3-
This document describes the security model, threat analysis, and mitigation strategies for the MPC Agent Wallet SDK.
3+
This guide covers the security model, threat analysis and how the MPC Agent Wallet SDK protects against attacks.
44

55
## Overview
66

7-
The MPC Agent Wallet is designed to provide secure cryptocurrency wallet functionality for AI agents while maintaining human oversight and control.
7+
The MPC Agent Wallet gives AI agents secure cryptocurrency wallet access while keeping humans in control.
88

99
### Security Goals
1010

@@ -20,7 +20,7 @@ The MPC Agent Wallet is designed to provide secure cryptocurrency wallet functio
2020

2121
| Party | Trust Level | Responsibilities |
2222
|-------|-------------|------------------|
23-
| **Agent** | Semi-trusted | Initiates transactions, enforces client-side policy |
23+
| **Agent** | Semi-trusted | Starts transactions, enforces client-side policy |
2424
| **User** | Trusted | Primary approval authority, manages policy |
2525
| **Recovery** | Trusted (offline) | Backup approval, key recovery |
2626
| **Relay** | Untrusted | Message routing only (cannot access secrets) |
@@ -241,7 +241,7 @@ EncryptedKeyShare = ChaCha20-Poly1305(key, nonce, plaintext)
241241

242242
## Responsible Disclosure
243243

244-
If you discover a security vulnerability, please report it responsibly:
244+
Found a security issue? Please report it responsibly:
245245

246246
1. **Email**: security@example.com
247247
2. **PGP Key**: Available at [keys.example.com](https://keys.example.com)

examples/basic-wallet/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Basic Wallet Example
22

3-
This example demonstrates the fundamental operations of the MPC Agent Wallet SDK.
3+
A simple example showing basic MPC Agent Wallet SDK operations.
44

55
## Features
66

examples/defi-agent/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DeFi Agent Example
22

3-
This example demonstrates an automated DeFi agent that uses the MPC wallet to execute sophisticated DeFi strategies while maintaining user oversight.
3+
An automated DeFi agent that uses the MPC wallet to run DeFi strategies while keeping the user in control.
44

55
## Features
66

0 commit comments

Comments
 (0)