Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-12-23 12:09:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Better document the forwarded output flow

Browse source
This commit is contained in:
Luke Parker 2024-09-02 22:31:15 -04:00
parent fadc88d2ad
commit f11a6b4ff1
3 changed files with 25 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
processor/primitives/src/eventuality.rs
View file

@ -19,8 +19,11 @@ pub trait Eventuality: Sized + Send + Sync {
/// identified, the full check is performed.
fn lookup(&self) -> Vec<u8>;
/// The output this plan forwarded.
fn forwarded_output(&self) -> Option<Self::OutputId>;
/// The output the resolution of this Eventuality was supposed to spend.
///
/// If the resolution of this Eventuality has multiple inputs, there is no singular spent output
/// so this MUST return None.
fn singular_spent_output(&self) -> Option<Self::OutputId>;
/// Read an Eventuality.
fn read(reader: &mut impl io::Read) -> io::Result<Self>;

15
processor/scanner/src/eventuality/mod.rs
View file

@ -352,19 +352,24 @@ impl<D: Db, S: ScannerFeed, Sch: Scheduler<S>> ContinuallyRan for EventualityTas
non_external_outputs.iter().filter(|output| output.kind() == OutputType::Forwarded)
{
let Some(eventuality) = completed_eventualities.get(&output.transaction_id()) else {
// Output sent to the forwarding address yet not actually forwarded
// Output sent to the forwarding address yet not one we made
continue;
};
let Some(forwarded) = eventuality.forwarded_output() else {
// This was a TX made by us, yet someone burned to the forwarding address
let Some(forwarded) = eventuality.singular_spent_output() else {
// This was a TX made by us, yet someone burned to the forwarding address as it doesn't
// follow the structure of forwarding transactions
continue;
};
let (return_address, in_instruction) =
let Some((return_address, in_instruction)) =
ScannerGlobalDb::<S>::return_address_and_in_instruction_for_forwarded_output(
&txn, &forwarded,
)
.expect("forwarded an output yet didn't save its InInstruction to the DB");
else {
// This was a TX made by us, coincidentally with the necessary structure, yet wasn't
// forwarding an output
continue;
};
queue_output_until_block::<S>(
&mut txn,
b + S::WINDOW_LENGTH,

10
processor/scanner/src/lib.rs
View file

@ -216,14 +216,24 @@ pub struct SchedulerUpdate<S: ScannerFeed> {
impl<S: ScannerFeed> SchedulerUpdate<S> {
/// The outputs to accumulate.
///
/// These MUST be accumulated.
pub fn outputs(&self) -> &[OutputFor<S>] {
&self.outputs
}
/// The outputs to forward to the latest multisig.
///
/// These MUST be forwarded in a 1-input 1-output transaction or dropped (if the fees are too
/// high to make the forwarding transaction).
pub fn forwards(&self) -> &[OutputFor<S>] {
&self.forwards
}
/// The outputs to return.
///
/// These SHOULD be returned as specified (potentially in batch). They MAY be dropped if the fees
/// are too high to make the return transaction.
pub fn returns(&self) -> &[Return<S>] {
&self.returns
}