Merge pull request #11 from LFDT-Lockness/badges

Update repo

.github/changelog.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+m_branch=m;
+changelog_file=CHANGELOG.md;
+
+# fetch master since we might be in a shallow clone
+git fetch origin "$m_branch:$m_branch" --depth=1
+
+changed=0;
+for log in "$changelog_file" */"$changelog_file"; do
+    dir=$(dirname "$log");
+    # check if version changed
+    if git diff "$m_branch" -- "$dir/Cargo.toml" | grep -q "^-version = "; then
+        # check if changelog updated
+        if git diff --exit-code --no-patch "$m_branch" -- "$log"; then
+            echo "$dir version changed, but $log is not updated"
+            changed=1;
+        fi
+    fi
+done
+
+exit "$changed";

.github/workflows/rust.yml

@@ -62,13 +62,10 @@ jobs:
         cache-on-failure: "true"
     - name: Run clippy
       run: cargo clippy -- -D clippy::all
-  dry-publish:
+  check-changelog:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: Swatinem/rust-cache@v2
-      with:
-        cache-on-failure: "true"
-    - name: Run dry publish
-      run: cargo publish --dry-run
+    - name: Check changelogs
+      run: ./.github/changelog.sh
 

CHANGELOG.md

@@ -1,3 +1,20 @@
+# hd-wallet crate changelog
+
+## v0.5.1
+* Update docs and repo link [#11]
+
+[#11]: https://github.com/LFDT-Lockness/hd-wallet/pull/11
+
+## v0.5.0
+* The first release of `hd-wallet`, successor of `slip-10` crate. It has all functionality of
+  `slip-10` plus special Edwards derivation that works with Ed25519 curve [#8]
+
+[#8]: https://github.com/LFDT-Lockness/hd-wallet/pull/8
+
+# slip-10 crate changelog
+
+`slip-10` crate has been restructured and renamed into `hd-wallet`
+
 ## v0.4.0
 * Update `generic-ec` dep to `v0.4` [#7]
 

CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing Guide
+
+Thanks for taking interest to contributing to our project!
+
+## Join us in Discord!
+We welcome all contributors to communicate with us [in Discord]! Please, reach out to us
+in `#lockness-contribute` room.
+
+## Pull Requests
+Prior to making a PR, we ask you to communicate it with us, either [in Discord] or, if you
+prefer, by opening an issue in the repo. This would help to keep your work aligned with the
+maintainers view and avoid situations in which we can't accept your contribution.
+
+All commits are required to be signed via verified GPG key. You can read about commit signing
+in [this series of articles](https://docs.github.com/en/authentication/managing-commit-signature-verification)
+(we recommend using a hardware GPG token).
+
+All commits are required to be signed off by including `Signed-off-by: YOUR NAME <[email protected]>` line.
+By doing this, you certify that the commit is compliant with [Developer Certificate of Origin (DCO)](https://developercertificate.org/),
+meaning that you wrote the code or otherwise have the right to submit the code you are
+contributing to the project.
+
+```text
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```
+
+Commits can be automatically signed off automatically by using `-s` flag (i.e. `git commit -s`).
+
+## Issues
+Feel free to open an issue if you found a bug, have a suggestion, or wish to
+communicate with us for other reasons.
+
+However, if you want to report something that you believe might be a security
+vulnerability or a security flaw in this or any upstream project, please report
+it following the procedure described in [SECURITY.md](./SECURITY.md).
+
+Feel free to reach out to us [in Discord] as well.
+
+[in Discord]: https://discordapp.com/channels/905194001349627914/1285268686147424388

Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "hd-wallet"
-version = "0.5.0"
+version = "0.5.1"
 edition = "2021"
 license = "MIT OR Apache-2.0"
 description = "HD wallets derivation"
-repository = "https://github.com/dfns/slip-10"
+repository = "https://github.com/LFDT-Lockness/hd-wallet"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

README.md

@@ -1,3 +1,8 @@
+![License](https://img.shields.io/crates/l/hd-wallet.svg)
+[![Docs](https://docs.rs/hd-wallet/badge.svg)](https://docs.rs/hd-wallet)
+[![Crates io](https://img.shields.io/crates/v/hd-wallet.svg)](https://crates.io/crates/hd-wallet)
+[![Discord](https://img.shields.io/discord/905194001349627914?logo=discord&logoColor=ffffff&label=Discord)](https://discordapp.com/channels/905194001349627914/1285268686147424388)
+
 # HD wallets derivation
 
 This crate supports the following HD derivations:
@@ -52,5 +57,8 @@ let child_key = derive_using_generic_algo::<Secp256r1, Slip10Like>(master_key_pa
 * `curve-secp256k1`, `curve-secp256r1`, `curve-ed25519` add curve implementation into the crate
   curves module
 
+## Join us in Discord!
+Feel free to reach out to us [in Discord](https://discordapp.com/channels/905194001349627914/1285268686147424388)!
+
 [slip10-spec]: https://github.com/satoshilabs/slips/blob/master/slip-0010.md
 [bip32-spec]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki

SECURITY.md

@@ -0,0 +1,20 @@
+# Security Policy
+
+## Supported Versions
+
+Only the latest version of the library is supported.
+
+## Reporting a Vulnerability
+
+We ask to report any security vulnerabilities or flaws through:
+
+1. Github, in the "Security" tab, using the "Report a vulnerability" button.
+2. Email, [email protected]
+
+After receiving the report, it will take us up to 2 working days to respond. 
+We will evaluate the reported vulnerability, determine whether it needs to 
+be addressed, and (if so) and provide an estimated timeline for addressing it.
+
+After vulnerability was fixed and the new version of the library was
+properly tested, we publish the fix, and publicly disclose the vulnerability
+(credits for finding the issue go to the reporter).

src/lib.rs

@@ -1,3 +1,8 @@
+//! ![License](https://img.shields.io/crates/l/hd-wallet.svg)
+//! [![Docs](https://docs.rs/hd-wallet/badge.svg)](https://docs.rs/hd-wallet)
+//! [![Crates io](https://img.shields.io/crates/v/hd-wallet.svg)](https://crates.io/crates/hd-wallet)
+//! [![Discord](https://img.shields.io/discord/905194001349627914?logo=discord&logoColor=ffffff&label=Discord)](https://discordapp.com/channels/905194001349627914/1285268686147424388)
+//!
 //! # HD wallets derivation
 //!
 //! This crate supports the following HD derivations:
@@ -54,6 +59,9 @@
 //! * `curve-secp256k1`, `curve-secp256r1`, `curve-ed25519` add curve implementation into the crate
 //!   [curves] module
 //!
+//! ## Join us in Discord!
+//! Feel free to reach out to us [in Discord](https://discordapp.com/channels/905194001349627914/1285268686147424388)!
+//!
 //! [slip10-spec]: https://github.com/satoshilabs/slips/blob/master/slip-0010.md
 //! [bip32-spec]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki