diff --git a/coins/monero/README.md b/coins/monero/README.md index ad1eb953..50146e2e 100644 --- a/coins/monero/README.md +++ b/coins/monero/README.md @@ -17,3 +17,12 @@ monero-serai was written for Serai, a decentralized exchange aiming to support Monero. Despite this, monero-serai is intended to be a widely usable library, accurate to Monero. monero-serai guarantees the functionality needed for Serai, yet does not include any functionality specific to Serai. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). +- `compile-time-generators` (on by default): Derives the generators at + compile-time so they don't need to be derived at runtime. This is recommended + if program size doesn't need to be kept minimal. +- `multisig`: Enables the `multisig` feature for all dependencies. diff --git a/coins/monero/generators/README.md b/coins/monero/generators/README.md index 4a6aaf62..e9ac925b 100644 --- a/coins/monero/generators/README.md +++ b/coins/monero/generators/README.md @@ -6,3 +6,8 @@ the generators. This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). diff --git a/coins/monero/io/README.md b/coins/monero/io/README.md index 4ded71fb..536b72dd 100644 --- a/coins/monero/io/README.md +++ b/coins/monero/io/README.md @@ -4,3 +4,8 @@ Serialization functions, as within the Monero protocol. This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). diff --git a/coins/monero/primitives/README.md b/coins/monero/primitives/README.md index bf30be57..c866193b 100644 --- a/coins/monero/primitives/README.md +++ b/coins/monero/primitives/README.md @@ -4,3 +4,8 @@ Primitive structures and functions for the Monero protocol. This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). diff --git a/coins/monero/ringct/borromean/README.md b/coins/monero/ringct/borromean/README.md index 6d3071c8..3b836804 100644 --- a/coins/monero/ringct/borromean/README.md +++ b/coins/monero/ringct/borromean/README.md @@ -5,3 +5,8 @@ protocol. This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). diff --git a/coins/monero/ringct/bulletproofs/README.md b/coins/monero/ringct/bulletproofs/README.md index 9e712848..8f407fef 100644 --- a/coins/monero/ringct/bulletproofs/README.md +++ b/coins/monero/ringct/bulletproofs/README.md @@ -4,3 +4,11 @@ Bulletproofs(+) range proofs, as defined by the Monero protocol. This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). +- `compile-time-generators` (on by default): Derives the generators at + compile-time so they don't need to be derived at runtime. This is recommended + if program size doesn't need to be kept minimal. diff --git a/coins/monero/ringct/clsag/README.md b/coins/monero/ringct/clsag/README.md index 2af88f09..4b90c86c 100644 --- a/coins/monero/ringct/clsag/README.md +++ b/coins/monero/ringct/clsag/README.md @@ -2,7 +2,14 @@ The CLSAG linkable ring signature, as defined by the Monero protocol. -Additionally included is a FROST-based threshold multisignature algorithm. +Additionally included is a FROST-inspired threshold multisignature algorithm. This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). +- `multisig`: Provides a FROST-inspired threshold multisignature algorithm for + use. diff --git a/coins/monero/ringct/mlsag/README.md b/coins/monero/ringct/mlsag/README.md index 895d7116..40e979b6 100644 --- a/coins/monero/ringct/mlsag/README.md +++ b/coins/monero/ringct/mlsag/README.md @@ -4,3 +4,8 @@ The MLSAG linkable ring signature, as defined by the Monero protocol. This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). diff --git a/coins/monero/rpc/README.md b/coins/monero/rpc/README.md index 6453e7c6..4badf1d8 100644 --- a/coins/monero/rpc/README.md +++ b/coins/monero/rpc/README.md @@ -4,3 +4,8 @@ Trait for an RPC connection to a Monero daemon, built around monero-serai. This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). diff --git a/coins/monero/wallet/README.md b/coins/monero/wallet/README.md index 83483dda..22358c6b 100644 --- a/coins/monero/wallet/README.md +++ b/coins/monero/wallet/README.md @@ -46,3 +46,13 @@ monero-serai. Finally, this library only supports producing transactions with CLSAG signatures. That means this library cannot spend non-RingCT outputs. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). +- `compile-time-generators` (on by default): Derives the generators at + compile-time so they don't need to be derived at runtime. This is recommended + if program size doesn't need to be kept minimal. +- `multisig`: Adds support for creation of transactions using a threshold + multisignature wallet. diff --git a/coins/monero/wallet/address/README.md b/coins/monero/wallet/address/README.md index c94f5cc5..4869bba0 100644 --- a/coins/monero/wallet/address/README.md +++ b/coins/monero/wallet/address/README.md @@ -4,3 +4,8 @@ Rust implementation of [Polyseed](https://github.com/tevador/polyseed). This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). diff --git a/coins/monero/wallet/polyseed/README.md b/coins/monero/wallet/polyseed/README.md index c94f5cc5..4869bba0 100644 --- a/coins/monero/wallet/polyseed/README.md +++ b/coins/monero/wallet/polyseed/README.md @@ -4,3 +4,8 @@ Rust implementation of [Polyseed](https://github.com/tevador/polyseed). This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). diff --git a/coins/monero/wallet/seed/README.md b/coins/monero/wallet/seed/README.md index 23e254ce..dded4133 100644 --- a/coins/monero/wallet/seed/README.md +++ b/coins/monero/wallet/seed/README.md @@ -4,3 +4,8 @@ Rust implementation of Monero's seed algorithm. This library is usable under no-std when the `std` feature (on by default) is disabled. + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). diff --git a/coins/monero/wallet/util/README.md b/coins/monero/wallet/util/README.md index 84761cfb..15d7c80c 100644 --- a/coins/monero/wallet/util/README.md +++ b/coins/monero/wallet/util/README.md @@ -13,3 +13,13 @@ disabled. - Support for Monero's seed algorithm - Support for Polyseed + +### Cargo Features + +- `std` (on by default): Enables `std` (and with it, more efficient internal + implementations). +- `compile-time-generators` (on by default): Derives the generators at + compile-time so they don't need to be derived at runtime. This is recommended + if program size doesn't need to be kept minimal. +- `multisig`: Adds support for creation of transactions using a threshold + multisignature wallet.