|
| 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 | +### Added |
| 11 | +- Deploy workflow for automatic crates.io publishing on tag push |
| 12 | + |
| 13 | +### Changed |
| 14 | +- Refactored code according to clippy warnings |
| 15 | +- Added clippy to CI pipeline |
| 16 | +- Moved tests into a separate file |
| 17 | + |
| 18 | +### Documentation |
| 19 | +- Added test vectors in spec |
| 20 | + |
| 21 | +## [2.2.0] - 2024-12-12 |
| 22 | + |
| 23 | +### Added |
| 24 | +- `extract_public_key_from_slice` function to extract public key from bytes |
| 25 | + |
| 26 | +## [2.1.0] - 2024-11-29 |
| 27 | + |
| 28 | +### Added |
| 29 | +- New interface to concat and split error packets |
| 30 | + |
| 31 | +## [2.0.0] - 2024-11-28 |
| 32 | + |
| 33 | +### Changed |
| 34 | +- **Breaking:** Error parsing now returns hops index |
| 35 | + |
| 36 | +## [1.0.1] - 2024-09-29 |
| 37 | + |
| 38 | +### Fixed |
| 39 | +- Outdated docs for error packet example |
| 40 | + |
| 41 | +### Changed |
| 42 | +- Enabled CI for merge group |
| 43 | + |
| 44 | +### Documentation |
| 45 | +- Fixed spec grammar errors |
| 46 | + |
| 47 | +## [1.0.0] - 2024-09-26 |
| 48 | + |
| 49 | +### Added |
| 50 | +- `OnionPacket::from_bytes` to construct onion packet from bytes |
| 51 | + |
| 52 | +## [0.2.0] - 2024-09-25 |
| 53 | + |
| 54 | +### Added |
| 55 | +- Support for returning error packets |
| 56 | +- Fiber Sphinx protocol specification |
| 57 | + |
| 58 | +### Documentation |
| 59 | +- Documented returned value of `peel` |
| 60 | +- Added spec on error packet |
| 61 | +- Linked code to the spec |
| 62 | + |
| 63 | +## [0.1.1] - 2024-09-23 |
| 64 | + |
| 65 | +### Fixed |
| 66 | +- Crate publishing configuration |
| 67 | + |
| 68 | +## [0.1.0] - 2024-09-23 |
| 69 | + |
| 70 | +### Added |
| 71 | +- Initial implementation of Sphinx mix network protocol |
| 72 | +- Onion packet creation with arbitrary packet data length |
| 73 | +- Onion packet peeling (decryption for next hop) |
| 74 | +- HMAC verification for packet integrity |
| 75 | +- Ephemeral key derivation for each hop |
| 76 | +- Hop shared secret derivation |
| 77 | +- Filler generation for packet construction |
| 78 | + |
| 79 | +[Unreleased]: https://github.com/cryptape/fiber-sphinx/compare/v2.2.0...HEAD |
| 80 | +[2.2.0]: https://github.com/cryptape/fiber-sphinx/compare/v2.1.0...v2.2.0 |
| 81 | +[2.1.0]: https://github.com/cryptape/fiber-sphinx/compare/v2.0.0...v2.1.0 |
| 82 | +[2.0.0]: https://github.com/cryptape/fiber-sphinx/compare/v1.0.1...v2.0.0 |
| 83 | +[1.0.1]: https://github.com/cryptape/fiber-sphinx/compare/v1.0.0...v1.0.1 |
| 84 | +[1.0.0]: https://github.com/cryptape/fiber-sphinx/compare/v0.2.0...v1.0.0 |
| 85 | +[0.2.0]: https://github.com/cryptape/fiber-sphinx/compare/v0.1.1...v0.2.0 |
| 86 | +[0.1.1]: https://github.com/cryptape/fiber-sphinx/compare/v0.1.0...v0.1.1 |
| 87 | +[0.1.0]: https://github.com/cryptape/fiber-sphinx/releases/tag/v0.1.0 |
0 commit comments