Improve docs a bit

This commit is contained in:
Luke Parker
2024-06-19 08:36:26 -04:00
parent 08b95abdd8
commit 6f61861d4b
8 changed files with 11 additions and 16 deletions

3
Cargo.lock generated
View File

@@ -4867,7 +4867,6 @@ name = "monero-serai"
version = "0.1.4-alpha"
dependencies = [
"curve25519-dalek",
"digest_auth",
"hex",
"hex-literal",
"monero-borromean",
@@ -4881,8 +4880,6 @@ dependencies = [
"serde",
"serde_json",
"std-shims",
"thiserror",
"tokio",
"zeroize",
]

View File

@@ -18,8 +18,6 @@ workspace = true
[dependencies]
std-shims = { path = "../../common/std-shims", version = "^0.1.1", default-features = false }
thiserror = { version = "1", default-features = false, optional = true }
zeroize = { version = "^1.5", default-features = false, features = ["zeroize_derive"] }
rand_core = { version = "0.6", default-features = false }
@@ -38,16 +36,10 @@ hex = { version = "0.4", default-features = false, features = ["alloc"] }
serde = { version = "1", default-features = false, features = ["derive", "alloc"] }
serde_json = { version = "1", default-features = false, features = ["alloc"] }
# Used for the provided HTTP RPC
digest_auth = { version = "0.3", default-features = false, optional = true }
tokio = { version = "1", default-features = false, optional = true }
[features]
std = [
"std-shims/std",
"thiserror",
"zeroize/std",
"rand_core/std",
@@ -67,4 +59,4 @@ std = [
compile-time-generators = ["curve25519-dalek/precomputed-tables", "monero-bulletproofs/compile-time-generators"]
multisig = ["monero-clsag/multisig", "std"]
#binaries = ["tokio/rt-multi-thread", "tokio/macros", "http-rpc"]
default = ["std"]
default = ["std", "compile-time-generators"]

View File

@@ -118,7 +118,7 @@ impl UnreducedScalar {
/// reduced. This lead to the scalar stored being interpreted as a different scalar.
/// This function recovers that scalar.
///
/// See https://github.com/monero-project/monero/issues/8438 for more info.
/// See <https://github.com/monero-project/monero/issues/8438> for more info.
pub fn recover_monero_slide_scalar(&self) -> Scalar {
if self.0[31] & 128 == 0 {
// Computing the w-NAF of a number can only give an output with 1 more bit than

View File

@@ -54,4 +54,4 @@ std = [
"monero-primitives/std",
]
compile-time-generators = ["curve25519-dalek/precomputed-tables"]
default = ["std"]
default = ["std", "compile-time-generators"]

View File

@@ -250,6 +250,10 @@ async fn get_fee_rate_v14(rpc: &impl Rpc, priority: FeePriority) -> Result<FeeRa
///
/// This is abstract such that users can use an HTTP library (which being their choice), a
/// Tor/i2p-based transport, or even a memory buffer an external service somehow routes.
///
/// While no implementors are directly provided, [monero-simple-request-rpc](
/// https://github.com/serai-dex/serai/tree/develop/coins/monero/rpc/simple-request
/// ) is recommended.
#[async_trait]
pub trait Rpc: Sync + Clone + Debug {
/// Perform a POST request to the specified route with the specified body.

View File

@@ -84,5 +84,6 @@ std = [
"monero-serai/std",
"monero-rpc/std",
]
compile-time-generators = ["curve25519-dalek/precomputed-tables", "monero-serai/compile-time-generators"]
multisig = ["transcript", "dalek-ff-group", "frost", "monero-serai/multisig", "std"]
default = ["std"]
default = ["std", "compile-time-generators"]

View File

@@ -54,7 +54,7 @@ ethereum-serai = { path = "../coins/ethereum", default-features = false, optiona
# Monero
dalek-ff-group = { path = "../crypto/dalek-ff-group", default-features = false, features = ["std"], optional = true }
monero-simple-request-rpc = { path = "../coins/monero/rpc/simple-request", default-features = false, optional = true }
monero-wallet = { path = "../coins/monero/wallet", default-features = false, features = ["std", "multisig"], optional = true }
monero-wallet = { path = "../coins/monero/wallet", default-features = false, features = ["std", "multisig", "compile-time-generators"], optional = true }
# Application
log = { version = "0.4", default-features = false, features = ["std"] }

View File

@@ -28,3 +28,4 @@ pub use monero_clsag;
pub use monero_bulletproofs;
pub use monero_serai;
pub use monero_rpc;
pub use monero_wallet;