Update the changelog for v0.6.0
This commit is contained in:
parent
470a72d4de
commit
6a5068a552
28
CHANGELOG.md
28
CHANGELOG.md
@ -4,11 +4,33 @@ All notable changes to this project will be documented in this file.
|
||||
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.1/)
|
||||
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
## [0.6.0] 2024-03-15
|
||||
|
||||
### Added
|
||||
|
||||
- Added Architecture Decision Records (ADRs) to document architectural decisions
|
||||
- Added the `Signature` class to fix the primitive obsession with signatures and to make it easier to work with them
|
||||
- Added `valid_sig?` and `check_sig!` to the `Crypto` class to verify whether an event's signature is valid
|
||||
- Added `sign_message` to the `Crypto` class to sign a message
|
||||
- Added `verify_signature?` to the `Event` class to verify whether an event's signature is valid
|
||||
- Added `#to_ary` to the `KeyPair` class to enable keypair destructuring
|
||||
- Added RBS types for `schnorr`
|
||||
|
||||
### Changed
|
||||
|
||||
- Updated the required Ruby version to `3.3.0` (was `3.2.0`)
|
||||
- Updated the gem `dotenv` to version `3.1` (was `2.8`)
|
||||
- Updated the gem `bip-schnorr` to version `0.7` (was `0.6`)
|
||||
- Updated the gem `overcommit` to version `0.63` (was `0.59`)
|
||||
- Updated the gem `rbs` to version `3.4` (was `3.3`)
|
||||
- Updated the gem `rspec` to version `3.13` (was `3.12`)
|
||||
- Updated the gem `rspec-rubocop` to version `2.27` (was `2.25`)
|
||||
- Updated the gem `rubocop` to version `1.62` (was `1.57`)
|
||||
|
||||
## Fixed
|
||||
|
||||
- Fixed a typo in the README (`generate_keypair` -> `generate_key_pair`)
|
||||
- Fixed a typo in the YARD documentation of `Nostr::Key#initialize` (`ValidationError` -> `KeyValidationError`)
|
||||
|
||||
### Fixed
|
||||
|
||||
@ -21,7 +43,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
|
||||
|
||||
- Added relay message type enums `Nostr::RelayMessageType`
|
||||
- Compliance with [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md) - bech32-formatted strings
|
||||
- `Nostr::PrivateKey` and `Nostr::PublicKey` to represent private and public keys, respectively
|
||||
- Added `Nostr::PrivateKey` and `Nostr::PublicKey` to represent private and public keys, respectively
|
||||
- Added a validation of private and public keys
|
||||
- Added an ability to convert keys to and from Bech32 format
|
||||
- Added RBS types for `faye-websocket` and `bech32`
|
||||
@ -93,7 +115,7 @@ principles of immutability and was a major source of internal complexity as I ne
|
||||
|
||||
- Initial release
|
||||
|
||||
[unreleased]: https://github.com/wilsonsilva/nostr/compare/v0.5.0...HEAD
|
||||
[0.6.0]: https://github.com/wilsonsilva/nostr/compare/v0.5.0...v0.6.0
|
||||
[0.5.0]: https://github.com/wilsonsilva/nostr/compare/v0.4.0...v0.5.0
|
||||
[0.4.0]: https://github.com/wilsonsilva/nostr/compare/v0.3.0...v0.4.0
|
||||
[0.3.0]: https://github.com/wilsonsilva/nostr/compare/v0.2.0...v0.3.0
|
||||
|
Loading…
x
Reference in New Issue
Block a user