Skip to content

Commit

Permalink
chore: readme and release metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
Slesarew committed Nov 20, 2024
1 parent e1c07e1 commit 32b89e9
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
13 changes: 12 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
[package]
name = "substrate-crypto-light"
description = "Cryptographic code for Substrate chains in pure rust with better baremetal support"
license = "GPL-3.0-or-later"
version = "0.1.0"
authors = [
"Alexander Slesarev <[email protected]>",
"Vera Abramova <[email protected]>",
]
repository = "https://github.com/Alzymologist/substrate-crypto-light"
homepage = "https://github.com/Alzymologist/substrate-crypto-light"
documentation = "https://docs.rs/substrate-crypto-light"
keywords = ["no_std", "crypto", "substrate", "polkadot"]
edition = "2021"
exclude = ["/for_tests", "/.github"]

[dependencies]
base58 = {version = "0.2.0"}
Expand All @@ -20,7 +31,7 @@ zeroize = {version = "1.7.0", features = ["derive"]}

[dev-dependencies]
hex = "0.4.3"
mnemonic-external = {git = "https://github.com/Alzymologist/mnemonic-external"}
mnemonic-external = "0.1.0"
sp-core = "34.0.0"

[features]
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
Cryptographic code for Substrate chains in pure rust with better baremetal support.

This is largely based on
[`sp_core`](https://docs.rs/sp-core/latest/sp_core/) crate. Draft.
[`sp_core`](https://docs.rs/sp-core/latest/sp_core/) crate.

Key differences here:

- no-std compatible with arm,
- sr25519 supports external Rng, for usability on baremetal
- ecdsa support based on pure Rust crate `k256` (TODO need to transfer stuff
here from Kampela code, as of now), to avoid compiling difficulties
- ecdsa support based on pure Rust crate `k256`, to avoid compiling difficulties
(original `sp-core` has ecdsa from `secp256k1` C wrapper crate and it does
not compile on certain no-std targets and creates extremely large binary
blob on others)

0 comments on commit 32b89e9

Please sign in to comment.