Have a public monero-rpc type be properly formatted
Some checks failed
Message Queue Tests / build (push) Has been cancelled
Reproducible Runtime / build (push) Has been cancelled
coins/ Tests / test-coins (push) Waiting to run
Coordinator Tests / build (push) Waiting to run
Full Stack Tests / build (push) Waiting to run
Lint / fmt (push) Waiting to run
Lint / machete (push) Waiting to run
Lint / clippy (macos-13) (push) Waiting to run
Lint / clippy (macos-14) (push) Waiting to run
Lint / clippy (ubuntu-latest) (push) Waiting to run
Lint / clippy (windows-latest) (push) Waiting to run
Lint / deny (push) Waiting to run
Monero Tests / unit-tests (push) Waiting to run
Monero Tests / integration-tests (v0.17.3.2) (push) Waiting to run
Monero Tests / integration-tests (v0.18.2.0) (push) Waiting to run
no-std build / build (push) Waiting to run
Processor Tests / build (push) Waiting to run
Tests / test-infra (push) Waiting to run
Tests / test-substrate (push) Waiting to run
Tests / test-serai-client (push) Waiting to run

It was public as the raw RPC response. It's more polite to handle the
formatting in the RPC, and allows us to return a better structure.
This commit is contained in:
Luke Parker 2024-07-12 04:14:05 -04:00
parent 32c24917c4
commit ba657e23d1
No known key found for this signature in database
5 changed files with 83 additions and 36 deletions

View file

@ -102,3 +102,26 @@ async fn test_decoy_rpc() {
rpc.get_output_distribution(1 .. 0).await.unwrap_err(); rpc.get_output_distribution(1 .. 0).await.unwrap_err();
} }
} }
// This test passes yet requires a mainnet node, which we don't have reliable access to in CI.
/*
#[tokio::test]
async fn test_zero_out_tx_o_indexes() {
use monero_rpc::Rpc;
let rpc = SimpleRequestRpc::new("https://node.sethforprivacy.com".to_string()).await.unwrap();
assert_eq!(
rpc
.get_o_indexes(
hex::decode("17ce4c8feeb82a6d6adaa8a89724b32bf4456f6909c7f84c8ce3ee9ebba19163")
.unwrap()
.try_into()
.unwrap()
)
.await
.unwrap(),
Vec::<u64>::new()
);
}
*/

View file

@ -19,7 +19,7 @@ use zeroize::Zeroize;
use async_trait::async_trait; use async_trait::async_trait;
use curve25519_dalek::edwards::EdwardsPoint; use curve25519_dalek::edwards::{CompressedEdwardsY, EdwardsPoint};
use serde::{Serialize, Deserialize, de::DeserializeOwned}; use serde::{Serialize, Deserialize, de::DeserializeOwned};
use serde_json::{Value, json}; use serde_json::{Value, json};
@ -28,6 +28,7 @@ use monero_serai::{
io::*, io::*,
transaction::{Input, Timelock, Transaction}, transaction::{Input, Timelock, Transaction},
block::Block, block::Block,
DEFAULT_LOCK_WINDOW,
}; };
use monero_address::Address; use monero_address::Address;
@ -188,19 +189,24 @@ struct TransactionsResponse {
txs: Vec<TransactionResponse>, txs: Vec<TransactionResponse>,
} }
/// The response to an output query. /// The response to an query for the information of a RingCT output.
#[derive(Debug, Deserialize)] #[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub struct OutputResponse { pub struct OutputInformation {
/// The height of the block this output was added to the chain in. /// The block number of the block this output was added to the chain in.
///
/// This is equivalent to he height of the blockchain at the time the block was added.
pub height: usize, pub height: usize,
/// If the output is unlocked, per the node's local view. /// If the output is unlocked, per the node's local view.
pub unlocked: bool, pub unlocked: bool,
/// The output's key. /// The output's key.
pub key: String, ///
/// This is a CompressedEdwardsY, not an EdwardsPoint, as it may be invalid. CompressedEdwardsY
/// only asserts validity on decompression and allows representing compressed types.
pub key: CompressedEdwardsY,
/// The output's commitment. /// The output's commitment.
pub mask: String, pub commitment: EdwardsPoint,
/// The transaction which created this output. /// The transaction which created this output.
pub txid: String, pub transaction: [u8; 32],
} }
fn rpc_hex(value: &str) -> Result<Vec<u8>, RpcError> { fn rpc_hex(value: &str) -> Result<Vec<u8>, RpcError> {
@ -497,7 +503,6 @@ pub trait Rpc: Sync + Clone + Debug {
/// This may be manipulated to unsafe levels and MUST be sanity checked. /// This may be manipulated to unsafe levels and MUST be sanity checked.
/// ///
/// This MUST NOT be expected to be deterministic in any way. /// This MUST NOT be expected to be deterministic in any way.
// TODO: Take a sanity check argument
async fn get_fee_rate(&self, priority: FeePriority) -> Result<FeeRate, RpcError> { async fn get_fee_rate(&self, priority: FeePriority) -> Result<FeeRate, RpcError> {
#[derive(Debug, Deserialize)] #[derive(Debug, Deserialize)]
struct FeeResponse { struct FeeResponse {
@ -788,7 +793,6 @@ pub trait Rpc: Sync + Clone + Debug {
} }
// If the Vec was empty, it would've been omitted, hence the unwrap_or // If the Vec was empty, it would've been omitted, hence the unwrap_or
// TODO: Test against a 0-output TX, such as the ones found in block 202612
Ok(res.unwrap_or(vec![])) Ok(res.unwrap_or(vec![]))
}; };
@ -821,7 +825,7 @@ pub trait DecoyRpc: Sync + Clone + Debug {
) -> Result<Vec<u64>, RpcError>; ) -> Result<Vec<u64>, RpcError>;
/// Get the specified outputs from the RingCT (zero-amount) pool. /// Get the specified outputs from the RingCT (zero-amount) pool.
async fn get_outs(&self, indexes: &[u64]) -> Result<Vec<OutputResponse>, RpcError>; async fn get_outs(&self, indexes: &[u64]) -> Result<Vec<OutputInformation>, RpcError>;
/// Get the specified outputs from the RingCT (zero-amount) pool, but only return them if their /// Get the specified outputs from the RingCT (zero-amount) pool, but only return them if their
/// timelock has been satisfied. /// timelock has been satisfied.
@ -941,7 +945,16 @@ impl<R: Rpc> DecoyRpc for R {
Ok(distribution) Ok(distribution)
} }
async fn get_outs(&self, indexes: &[u64]) -> Result<Vec<OutputResponse>, RpcError> { async fn get_outs(&self, indexes: &[u64]) -> Result<Vec<OutputInformation>, RpcError> {
#[derive(Debug, Deserialize)]
struct OutputResponse {
height: usize,
unlocked: bool,
key: String,
mask: String,
txid: String,
}
#[derive(Debug, Deserialize)] #[derive(Debug, Deserialize)]
struct OutsResponse { struct OutsResponse {
status: String, status: String,
@ -965,7 +978,25 @@ impl<R: Rpc> DecoyRpc for R {
Err(RpcError::InvalidNode("bad response to get_outs".to_string()))?; Err(RpcError::InvalidNode("bad response to get_outs".to_string()))?;
} }
Ok(res.outs) Ok(
res
.outs
.into_iter()
.map(|output| {
Ok(OutputInformation {
height: output.height,
unlocked: output.unlocked,
key: CompressedEdwardsY(
rpc_hex(&output.key)?
.try_into()
.map_err(|_| RpcError::InvalidNode("output key wasn't 32 bytes".to_string()))?,
),
commitment: rpc_point(&output.mask)?,
transaction: hash_hex(&output.txid)?,
})
})
.collect::<Result<Vec<_>, RpcError>>()?,
)
} }
async fn get_unlocked_outputs( async fn get_unlocked_outputs(
@ -974,15 +1005,11 @@ impl<R: Rpc> DecoyRpc for R {
height: usize, height: usize,
fingerprintable_deterministic: bool, fingerprintable_deterministic: bool,
) -> Result<Vec<Option<[EdwardsPoint; 2]>>, RpcError> { ) -> Result<Vec<Option<[EdwardsPoint; 2]>>, RpcError> {
let outs: Vec<OutputResponse> = self.get_outs(indexes).await?; let outs = self.get_outs(indexes).await?;
// Only need to fetch txs to do deterministic check on timelock // Only need to fetch txs to do deterministic check on timelock
let txs = if fingerprintable_deterministic { let txs = if fingerprintable_deterministic {
self self.get_transactions(&outs.iter().map(|out| out.transaction).collect::<Vec<_>>()).await?
.get_transactions(
&outs.iter().map(|out| hash_hex(&out.txid)).collect::<Result<Vec<_>, _>>()?,
)
.await?
} else { } else {
vec![] vec![]
}; };
@ -996,19 +1023,20 @@ impl<R: Rpc> DecoyRpc for R {
// decoy // decoy
// Only valid keys can be used in CLSAG proofs, hence the need for re-selection, yet // Only valid keys can be used in CLSAG proofs, hence the need for re-selection, yet
// invalid keys may honestly exist on the blockchain // invalid keys may honestly exist on the blockchain
// Only a recent hard fork checked output keys were valid points let Some(key) = out.key.decompress() else {
let Some(key) = decompress_point(
rpc_hex(&out.key)?
.try_into()
.map_err(|_| RpcError::InvalidNode("non-32-byte point".to_string()))?,
) else {
return Ok(None); return Ok(None);
}; };
Ok(Some([key, rpc_point(&out.mask)?]).filter(|_| { Ok(Some([key, out.commitment]).filter(|_| {
if fingerprintable_deterministic { if fingerprintable_deterministic {
// TODO: Are timelock blocks by height or number? // https://github.com/monero-project/monero/blob
// TODO: This doesn't check the default timelock has been passed // /cc73fe71162d564ffda8e549b79a350bca53c454/src/cryptonote_core/blockchain.cpp#L90
Timelock::Block(height) >= txs[i].prefix().additional_timelock const ACCEPTED_TIMELOCK_DELTA: usize = 1;
// https://github.com/monero-project/monero/blob
// /cc73fe71162d564ffda8e549b79a350bca53c454/src/cryptonote_core/blockchain.cpp#L3836
((out.height + DEFAULT_LOCK_WINDOW) <= height) &&
(Timelock::Block(height - 1 + ACCEPTED_TIMELOCK_DELTA) >=
txs[i].prefix().additional_timelock)
} else { } else {
out.unlocked out.unlocked
} }

View file

@ -65,7 +65,6 @@ impl AddressType {
} }
/// The payment ID within this address. /// The payment ID within this address.
// TODO: wallet-core PaymentId? TX extra crate imported here?
pub fn payment_id(&self) -> Option<[u8; 8]> { pub fn payment_id(&self) -> Option<[u8; 8]> {
if let AddressType::LegacyIntegrated(id) = self { if let AddressType::LegacyIntegrated(id) = self {
Some(*id) Some(*id)

View file

@ -102,7 +102,6 @@ impl SharedKeyDerivations {
} }
// H(8Ra || 0x8d) // H(8Ra || 0x8d)
// TODO: Make this itself a PaymentId
#[allow(clippy::needless_pass_by_value)] #[allow(clippy::needless_pass_by_value)]
fn payment_id_xor(ecdh: Zeroizing<EdwardsPoint>) -> [u8; 8] { fn payment_id_xor(ecdh: Zeroizing<EdwardsPoint>) -> [u8; 8] {
// 8Ra // 8Ra

View file

@ -2,7 +2,7 @@ use monero_simple_request_rpc::SimpleRequestRpc;
use monero_wallet::{ use monero_wallet::{
DEFAULT_LOCK_WINDOW, DEFAULT_LOCK_WINDOW,
transaction::Transaction, transaction::Transaction,
rpc::{OutputResponse, Rpc, DecoyRpc}, rpc::{Rpc, DecoyRpc},
WalletOutput, WalletOutput,
}; };
@ -54,8 +54,7 @@ test!(
let most_recent_o_index = rpc.get_o_indexes(tx.hash()).await.unwrap().pop().unwrap(); let most_recent_o_index = rpc.get_o_indexes(tx.hash()).await.unwrap().pop().unwrap();
// Make sure output from tx1 is in the block in which it unlocks // Make sure output from tx1 is in the block in which it unlocks
let out_tx1: OutputResponse = let out_tx1 = rpc.get_outs(&[most_recent_o_index]).await.unwrap().swap_remove(0);
rpc.get_outs(&[most_recent_o_index]).await.unwrap().swap_remove(0);
assert_eq!(out_tx1.height, height - DEFAULT_LOCK_WINDOW); assert_eq!(out_tx1.height, height - DEFAULT_LOCK_WINDOW);
assert!(out_tx1.unlocked); assert!(out_tx1.unlocked);
@ -133,8 +132,7 @@ test!(
let most_recent_o_index = rpc.get_o_indexes(tx.hash()).await.unwrap().pop().unwrap(); let most_recent_o_index = rpc.get_o_indexes(tx.hash()).await.unwrap().pop().unwrap();
// Make sure output from tx1 is in the block in which it unlocks // Make sure output from tx1 is in the block in which it unlocks
let out_tx1: OutputResponse = let out_tx1 = rpc.get_outs(&[most_recent_o_index]).await.unwrap().swap_remove(0);
rpc.get_outs(&[most_recent_o_index]).await.unwrap().swap_remove(0);
assert_eq!(out_tx1.height, height - DEFAULT_LOCK_WINDOW); assert_eq!(out_tx1.height, height - DEFAULT_LOCK_WINDOW);
assert!(out_tx1.unlocked); assert!(out_tx1.unlocked);