Skip to content

Commit ff979c6

Browse files
Kazoplclaudiudinu98
andcommitted
docs: finalize README and CHANGELOG
- Update main README with badges - Add installation instructions - Create CHANGELOG for v0.1.0 - Add contributing guidelines Co-authored-by: Claudiu Dinu <claudiudinu1711@gmail.com>
1 parent cf2c5c3 commit ff979c6

3 files changed

Lines changed: 659 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## [0.1.0] - 2026-01-11
11+
12+
### Highlights
13+
14+
- **Rust 2024 Edition** - Using the latest stable Rust features including let chains
15+
- **Trusted Publishing** - PyPI uses OIDC for secure publishing without API tokens
16+
- **Multi-registry** - Packages available on crates.io, npm and PyPI
17+
- **Multi-chain** - Support for EVM chains and Solana
18+
19+
### Added
20+
21+
#### Core Library (`mpc-wallet-core`)
22+
- 2-of-3 threshold MPC key generation using DKLs23 protocol
23+
- Distributed signing with policy enforcement
24+
- Key share refresh for proactive security
25+
- BIP32 hierarchical deterministic key derivation
26+
- Multi-chain support:
27+
- EVM chains (Ethereum, Base, Arbitrum, etc.)
28+
- Solana
29+
- ERC-4337 smart account integration
30+
- Policy engine with configurable rules:
31+
- Per-transaction spending limits
32+
- Daily/weekly spending limits
33+
- Address whitelist/blacklist
34+
- Time-of-day restrictions
35+
- Contract interaction restrictions
36+
37+
#### Message Relay (`mpc-wallet-relay`)
38+
- WebSocket-based message relay for MPC protocol coordination
39+
- Signing session management
40+
- Approval request handling
41+
- Webhook notifications for user devices
42+
- RESTful API for session status
43+
44+
#### WASM Bindings (`@mpc-wallet/wasm`)
45+
- Browser-compatible WebAssembly bindings
46+
- Full key generation and signing support
47+
- Optimized bundle size
48+
49+
#### TypeScript SDK (`@mpc-wallet/sdk`)
50+
- High-level `MpcAgentWallet` class
51+
- Chain-specific utilities for EVM and Solana
52+
- Browser and Node.js storage adapters
53+
- Full TypeScript type definitions
54+
55+
#### Python SDK (`mpc-wallet`)
56+
- Async/await API design
57+
- Chain adapters for EVM and Solana
58+
- Policy configuration
59+
- Type hints with Pydantic models
60+
61+
#### Smart Contracts
62+
- `MpcSmartAccount` - ERC-4337 compatible smart account
63+
- `MpcRecoveryModule` - Time-locked recovery mechanism
64+
- `SpendingLimitHook` - On-chain spending limit enforcement
65+
66+
#### Documentation
67+
- Architecture overview
68+
- Security model documentation
69+
- Integration guides for AI agent frameworks
70+
- API reference for TypeScript and Python
71+
72+
#### Examples
73+
- Basic wallet usage
74+
- ElizaOS plugin integration
75+
- LangChain tool integration
76+
- Telegram approval bot
77+
- DeFi agent automation
78+
79+
### Security
80+
- Cryptographic operations use constant-time comparisons
81+
- Key shares encrypted at rest
82+
- No single point of failure in key management
83+
84+
---
85+
86+
## Package Versions
87+
88+
| Package | Version | Registry |
89+
|---------|---------|----------|
90+
| mpc-wallet-core | 0.1.0 | [crates.io](https://crates.io/crates/mpc-wallet-core) |
91+
| mpc-wallet-relay | 0.1.0 | [crates.io](https://crates.io/crates/mpc-wallet-relay) |
92+
| @mpc-wallet/wasm | 0.1.0 | [npm](https://www.npmjs.com/package/@mpc-wallet/wasm) |
93+
| @mpc-wallet/sdk | 0.1.0 | [npm](https://www.npmjs.com/package/@mpc-wallet/sdk) |
94+
| mpc-wallet | 0.1.0 | [PyPI](https://pypi.org/project/mpc-wallet/) |
95+
96+
[Unreleased]: https://github.com/Kazopl/mpc-agent-wallet/compare/v0.1.0...HEAD
97+
[0.1.0]: https://github.com/Kazopl/mpc-agent-wallet/releases/tag/v0.1.0

0 commit comments

Comments
 (0)