Merge pull request 'chore: rename pow_sha256 crate (this) to mcaptcha_pow_sha256' (#3) from rename-crate into master
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Reviewed-on: #3
This commit is contained in:
commit
05048711a3
5 changed files with 21 additions and 22 deletions
22
Cargo.lock
generated
22
Cargo.lock
generated
|
@ -155,6 +155,17 @@ version = "0.2.149"
|
|||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a08173bc88b7955d1b3145aa561539096c421ac8debde8cbc3612ec635fee29b"
|
||||
|
||||
[[package]]
|
||||
name = "mcaptcha_pow_sha256"
|
||||
version = "0.3.1"
|
||||
dependencies = [
|
||||
"bincode",
|
||||
"derive_builder",
|
||||
"num",
|
||||
"serde",
|
||||
"sha2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "num"
|
||||
version = "0.4.1"
|
||||
|
@ -233,17 +244,6 @@ dependencies = [
|
|||
"autocfg",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pow_sha256"
|
||||
version = "0.3.1"
|
||||
dependencies = [
|
||||
"bincode",
|
||||
"derive_builder",
|
||||
"num",
|
||||
"serde",
|
||||
"sha2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "proc-macro2"
|
||||
version = "1.0.69"
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
[package]
|
||||
name = "pow_sha256"
|
||||
name = "mcaptcha_pow_sha256"
|
||||
version = "0.3.1"
|
||||
authors = [ "Aravinth Manivannan <realaravinth@bastsense.net>", "Robert Kornacki <robk@syre.io>"]
|
||||
description = """
|
||||
|
@ -9,7 +9,7 @@ edition = "2021"
|
|||
keywords = ["mCaptcha", "PoW", "sha256", "proof-of-work"]
|
||||
readme = "README.md"
|
||||
license = "MIT OR Apache-2.0"
|
||||
repository = "https://git.batsense.net/mCaptcha/pow_sha256"
|
||||
repository = "https://git.batsense.net/mCaptcha/mcaptcha_pow_sha256"
|
||||
categories = ["captcha", "algorithms", "cryptography::cryptocurrencies"]
|
||||
|
||||
|
||||
|
|
13
README.md
13
README.md
|
@ -11,8 +11,8 @@
|
|||
**NOTE: All versions prior to 0.3.1 produce broken PoWs, upgrade to
|
||||
latest version**
|
||||
|
||||
> pow_sha256's copy of `pow_sha256` by
|
||||
> [robkorn](https://github.com/robkorn/pow_sha256)
|
||||
> mcaptcha_pow_sha256 is a copy of `pow_sha256` by
|
||||
> [robkorn](https://github.com/robkorn/mcaptcha_pow_sha256)
|
||||
> which is a modified version of [`pow` library](https://github.com/bddap/pow).
|
||||
> All copyrights belong to the original authors.
|
||||
|
||||
|
@ -23,7 +23,7 @@ crate can be used to prove work was done on a given serializable input.
|
|||
The input merely needs to implement `serde::Deserialize` to be used.
|
||||
|
||||
This is a fork of the [`pow` library](https://github.com/bddap/pow) by
|
||||
[@robkorn](https://github.com/robkorn/pow_sha256)) with some new
|
||||
[@robkorn](https://github.com/robkorn/mcaptcha_pow_sha256)) with some new
|
||||
additions. Primary of these being:
|
||||
|
||||
- PoW datatype now offers a constructor
|
||||
|
@ -35,8 +35,7 @@ mostly just stylistic/ease of use improvements.
|
|||
|
||||
## Documentation
|
||||
|
||||
- [master-branch](https://mcaptcha.github.io/pow_sha256/pow_sha256/index.html)
|
||||
- [All published versions](https://mcaptcha.org/docs/api/pow-sha256)
|
||||
https://docs.rs/mcaptcha_pow_sha256
|
||||
|
||||
## Examples
|
||||
|
||||
|
@ -44,7 +43,7 @@ Prove work specifically targeting a phrase.
|
|||
|
||||
```rust
|
||||
|
||||
use pow_sha256::{ConfigBuilder, PoW};
|
||||
use mcaptcha_pow_sha256::{ConfigBuilder, PoW};
|
||||
|
||||
fn main() {
|
||||
let config = ConfigBuilder::default()
|
||||
|
@ -70,7 +69,7 @@ Prove more difficult work. This time targeting a time.
|
|||
// to find a nonce of the correct difficulty.
|
||||
|
||||
|
||||
use pow_sha256::{ConfigBuilder, PoW};
|
||||
use mcaptcha_pow_sha256::{ConfigBuilder, PoW};
|
||||
|
||||
fn main() {
|
||||
let config = ConfigBuilder::default()
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
* See `Default` implementation for the default configuration.
|
||||
*/
|
||||
|
||||
use pow_sha256::{ConfigBuilder, PoW};
|
||||
use mcaptcha_pow_sha256::{ConfigBuilder, PoW};
|
||||
|
||||
fn main() {
|
||||
let config = ConfigBuilder::default()
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
//!
|
||||
//! # Example:
|
||||
//! ```rust
|
||||
//! use pow_sha256::{ConfigBuilder, PoW};
|
||||
//! use mcaptcha_pow_sha256::{ConfigBuilder, PoW};
|
||||
//!
|
||||
//! fn main() {
|
||||
//! let config = ConfigBuilder::default()
|
||||
|
|
Loading…
Reference in a new issue