diff --git a/CHANGELOG.md b/CHANGELOG.md index c37674fe..90b81ae1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,10 +5,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) as described in [The Cargo Book](https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field). ## [Unreleased] +N/A + +## [0.1.0] - 2021-08-24 ### Added - Swap offers - Swap roles and trade roles +- Basic support for Bitcoin and Monero - Basic transaction template for `Bitcoin` - **experimental** ECDSA adaptor signatures (with `ecdsa_fun`) - Messages exchanged between farcaster-node's microservices - Tasks and blockchain events used by syncers + +[Unreleased]: https://github.com/farcaster-project/farcaster-core/compare/v0.1.0...HEAD +[0.1.0]: https://github.com/farcaster-project/farcaster-core/releases/tag/v0.1.0 diff --git a/Cargo.toml b/Cargo.toml index e778b766..c9c4d8e0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,7 @@ [package] name = "farcaster_core" -description = "Farcaster project core library." +description = "Farcaster project core library, blockchain atomic swaps." +keywords = ["farcaster", "atomic swap", "bitcoin", "monero"] version = "0.1.0" authors = ["Farcaster Devs"] license = "LGPL-3.0" @@ -11,6 +12,7 @@ readme = "README.md" include = [ "src/*", "README.md", + "CHANGELOG.md", "LICENSE", ] @@ -37,6 +39,7 @@ thiserror = "1.0.24" serde_crate = { package = "serde", version = "1", features = ["derive"], optional = true } inet2_addr = { version = "0.4.0", default-features = false, features = ["tor", "strict_encoding"] } +# crypto libs rand = { version = "0.8.4", optional = true } ecdsa_fun = { version = "0.6", default-features = false, features = ["all"], optional = true } sha2 = { version = "0.9", optional = true } diff --git a/README.md b/README.md index 36a0108e..a271e607 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,9 @@ The Farcaster atomic swaps project core library aim to implement in Rust the fol - [x] Messages exchanged between [farcaster-node](https://github.com/farcaster-project/farcaster-node)'s microservices - [x] Tasks and blockchain events used by syncers +## Documentation +Currently can be found on [docs.rs/farcaster_core](https://docs.rs/farcaster_core). All possible improvments, to add usage examples and to expand on existing docs would be extremely appreciated. + ## Core framework This library is twofold: providing a flexible framework to add specific blockchain support and implementing these specific blockchain. The framework is accessible in modules at the root of the crate: