1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
use fuel_core_types::fuel_tx::UniqueIdentifier;
use fuel_streams_macros::subject::{IntoSubject, Subject};
use crate::{blocks::types::BlockHeight, types::*};
/// Represents a NATS subject for transactions in the Fuel network.
///
/// This subject format allows for efficient querying and filtering of transactions
/// based on their height, index, ID, status, and kind.
///
/// # Examples
///
/// Creating a subject for a specific transaction:
///
/// ```
/// # use fuel_streams_core::transactions::TransactionsSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::IntoSubject;
/// let subject = TransactionsSubject {
/// height: Some(23.into()),
/// tx_index: Some(1),
/// tx_id: Some(Bytes32::zeroed()),
/// status: Some(TransactionStatus::Success),
/// kind: Some(TransactionKind::Script),
/// };
/// assert_eq!(
/// subject.parse(),
/// "transactions.23.1.0x0000000000000000000000000000000000000000000000000000000000000000.success.script"
/// );
/// ```
///
/// All transactions wildcard:
///
/// ```
/// # use fuel_streams_core::transactions::TransactionsSubject;
/// # use fuel_streams_macros::subject::IntoSubject;
/// assert_eq!(TransactionsSubject::WILDCARD, "transactions.>");
/// ```
///
/// Creating a subject query using the `wildcard` method:
///
/// ```
/// # use fuel_streams_core::transactions::TransactionsSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::IntoSubject;
/// let wildcard = TransactionsSubject::wildcard(None, None, Some(Bytes32::zeroed()), None, None);
/// assert_eq!(wildcard, "transactions.*.*.0x0000000000000000000000000000000000000000000000000000000000000000.*.*");
/// ```
///
/// Using the builder pattern:
///
/// ```
/// # use fuel_streams_core::transactions::TransactionsSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::IntoSubject;
/// let subject = TransactionsSubject::new().with_height(Some(23.into()));
/// assert_eq!(subject.parse(), "transactions.23.*.*.*.*");
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "transactions.>"]
#[subject_format = "transactions.{height}.{tx_index}.{tx_id}.{status}.{kind}"]
pub struct TransactionsSubject {
pub height: Option<BlockHeight>,
pub tx_index: Option<usize>,
pub tx_id: Option<Bytes32>,
pub status: Option<TransactionStatus>,
pub kind: Option<TransactionKind>,
}
impl From<&Transaction> for TransactionsSubject {
fn from(value: &Transaction) -> Self {
let subject = TransactionsSubject::new();
let tx_id = value.cached_id().unwrap();
let kind = TransactionKind::from(value.to_owned());
subject.with_tx_id(Some(tx_id.into())).with_kind(Some(kind))
}
}
/// Represents a NATS subject for querying transactions by their identifier in the Fuel network.
///
/// This subject format allows for efficient querying of transactions based on their identifier kind and value.
///
/// # Examples
///
/// Creating a subject for a specific transaction by ID:
///
/// ```
/// # use fuel_streams_core::transactions::TransactionsByIdSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::IntoSubject;
/// let subject = TransactionsByIdSubject {
/// id_kind: Some(IdentifierKind::ContractID),
/// id_value: Some(Address::zeroed()),
/// };
/// assert_eq!(
/// subject.parse(),
/// "by_id.transactions.contract_id.0x0000000000000000000000000000000000000000000000000000000000000000"
/// );
/// ```
///
/// All transactions by ID wildcard:
///
/// ```
/// # use fuel_streams_core::transactions::TransactionsByIdSubject;
/// # use fuel_streams_macros::subject::IntoSubject;
/// assert_eq!(TransactionsByIdSubject::WILDCARD, "by_id.transactions.>");
/// ```
///
/// Creating a subject query using the `wildcard` method:
///
/// ```
/// # use fuel_streams_core::transactions::TransactionsByIdSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::IntoSubject;
/// let wildcard = TransactionsByIdSubject::wildcard(Some(IdentifierKind::ContractID), None);
/// assert_eq!(wildcard, "by_id.transactions.contract_id.*");
/// ```
///
/// Using the builder pattern:
///
/// ```
/// # use fuel_streams_core::transactions::TransactionsByIdSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::IntoSubject;
/// let subject = TransactionsByIdSubject::new().with_id_kind(Some(IdentifierKind::ContractID));
/// assert_eq!(subject.parse(), "by_id.transactions.contract_id.*");
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "by_id.transactions.>"]
#[subject_format = "by_id.transactions.{id_kind}.{id_value}"]
pub struct TransactionsByIdSubject {
pub id_kind: Option<IdentifierKind>,
pub id_value: Option<Address>,
}
#[cfg(test)]
mod test {
use pretty_assertions::assert_eq;
use super::*;
#[test]
fn transactions_subjects_from_transaction() {
let mock_tx = MockTransaction::build();
let subject = TransactionsSubject::from(&mock_tx);
assert!(subject.height.is_none());
assert!(subject.tx_index.is_none());
assert!(subject.status.is_none());
assert!(subject.kind.is_some());
assert_eq!(
subject.tx_id.unwrap(),
mock_tx.to_owned().cached_id().unwrap().into()
);
}
}