fuel_streams_core/outputs/subjects.rs
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 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
use fuel_streams_macros::subject::{IntoSubject, Subject};
use crate::types::*;
/// Represents a subject for querying outputs by their identifier in the Fuel ecosystem.
///
/// This struct is used to create and parse subjects related to outputs identified by
/// various types of IDs, which can be used for subscribing to or publishing events
/// about specific outputs.
///
/// # Examples
///
/// Creating and parsing a subject:
///
/// ```
/// # use fuel_streams_core::outputs::subjects::OutputsByIdSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = OutputsByIdSubject {
/// tx_id: Some([1u8; 32].into()),
/// index: Some(0),
/// id_kind: Some(IdentifierKind::AssetID),
/// id_value: Some([3u8; 32].into()),
/// };
/// assert_eq!(
/// subject.parse(),
/// "by_id.outputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.asset_id.0x0303030303030303030303030303030303030303030303030303030303030303"
/// );
/// ```
///
/// All outputs by ID wildcard:
///
/// ```
/// # use fuel_streams_core::outputs::subjects::OutputsByIdSubject;
/// # use fuel_streams_macros::subject::*;
/// assert_eq!(OutputsByIdSubject::WILDCARD, "by_id.outputs.>");
/// ```
///
/// Creating a subject query using the `wildcard` method:
///
/// ```
/// # use fuel_streams_core::outputs::subjects::OutputsByIdSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let wildcard = OutputsByIdSubject::wildcard(Some([1u8; 32].into()), Some(0), Some(IdentifierKind::AssetID), None);
/// assert_eq!(wildcard, "by_id.outputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.asset_id.*");
/// ```
///
/// Using the builder pattern:
///
/// ```
/// # use fuel_streams_core::outputs::subjects::OutputsByIdSubject;
/// # use fuel_streams_core::types::*;
/// # use fuel_streams_macros::subject::*;
/// let subject = OutputsByIdSubject::new()
/// .with_tx_id(Some([1u8; 32].into()))
/// .with_index(Some(0))
/// .with_id_kind(Some(IdentifierKind::AssetID))
/// .with_id_value(Some([3u8; 32].into()));
/// assert_eq!(subject.parse(), "by_id.outputs.0x0101010101010101010101010101010101010101010101010101010101010101.0.asset_id.0x0303030303030303030303030303030303030303030303030303030303030303");
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "by_id.outputs.>"]
#[subject_format = "by_id.outputs.{tx_id}.{index}.{id_kind}.{id_value}"]
pub struct OutputsByIdSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<u8>,
pub id_kind: Option<IdentifierKind>,
pub id_value: Option<Bytes32>,
}
/// Represents the NATS subject for coin outputs.
///
/// This subject format allows for querying coin outputs based on transaction ID,
/// index, recipient address (`to`), and asset ID.
///
/// # Examples
///
/// **Creating a subject for a specific coin output:**
///
/// ```
/// use fuel_streams_core::outputs::subjects::OutputsCoinSubject;
/// use fuel_streams_core::types::*;
/// use fuel_streams_macros::subject::SubjectBuildable;
///
/// let subject = OutputsCoinSubject::new()
/// .with_tx_id(Some(Bytes32::zeroed()))
/// .with_index(Some(0))
/// .with_to(Some(Address::zeroed()))
/// .with_asset_id(Some(AssetId::zeroed()));
/// assert_eq!(
/// subject.to_string(),
/// "outputs.coin.0x0000000000000000000000000000000000000000000000000000000000000000.0.0x0000000000000000000000000000000000000000000000000000000000000000.0x0000000000000000000000000000000000000000000000000000000000000000"
/// );
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "outputs.>"]
#[subject_format = "outputs.coin.{tx_id}.{index}.{to}.{asset_id}"]
pub struct OutputsCoinSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<u16>,
pub to: Option<Address>,
pub asset_id: Option<AssetId>,
}
/// Represents the NATS subject for contract outputs.
///
/// This subject format allows for querying contract outputs based on
/// transaction ID, index, and contract ID.
///
/// # Examples
///
/// **Creating a subject for a specific contract output:**
///
/// ```
/// use fuel_streams_core::outputs::subjects::OutputsContractSubject;
/// use fuel_streams_core::types::*;
/// use fuel_streams_macros::subject::SubjectBuildable;
///
/// let subject = OutputsContractSubject::new()
/// .with_tx_id(Some(Bytes32::zeroed()))
/// .with_index(Some(0))
/// .with_contract_id(Some(ContractId::zeroed()));
/// assert_eq!(
/// subject.to_string(),
/// "outputs.contract.0x0000000000000000000000000000000000000000000000000000000000000000.0.0x0000000000000000000000000000000000000000000000000000000000000000"
/// );
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "outputs.>"]
#[subject_format = "outputs.contract.{tx_id}.{index}.{contract_id}"]
pub struct OutputsContractSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<u16>,
pub contract_id: Option<ContractId>,
}
/// Represents the NATS subject for change outputs.
///
/// This subject format allows for querying change outputs based on transaction ID,
/// index, recipient address (`to`), and asset ID.
///
/// # Examples
///
/// **Creating a subject for a specific change output:**
///
/// ```
/// use fuel_streams_core::outputs::subjects::OutputsChangeSubject;
/// use fuel_streams_core::types::*;
/// use fuel_streams_macros::subject::SubjectBuildable;
///
/// let subject = OutputsChangeSubject::new()
/// .with_tx_id(Some(Bytes32::zeroed()))
/// .with_index(Some(0))
/// .with_to(Some(Address::zeroed()))
/// .with_asset_id(Some(AssetId::zeroed()));
/// assert_eq!(
/// subject.to_string(),
/// "outputs.change.0x0000000000000000000000000000000000000000000000000000000000000000.0.0x0000000000000000000000000000000000000000000000000000000000000000.0x0000000000000000000000000000000000000000000000000000000000000000"
/// );
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "outputs.>"]
#[subject_format = "outputs.change.{tx_id}.{index}.{to}.{asset_id}"]
pub struct OutputsChangeSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<u16>,
pub to: Option<Address>,
pub asset_id: Option<AssetId>,
}
/// Represents the NATS subject for variable outputs.
///
/// This subject format allows for querying variable outputs based on transaction
/// ID, index, recipient address (`to`), and asset ID.
///
/// # Examples
///
/// **Creating a subject for a specific variable output:**
///
/// ```
/// use fuel_streams_core::outputs::subjects::OutputsVariableSubject;
/// use fuel_streams_core::types::*;
/// use fuel_streams_macros::subject::SubjectBuildable;
///
/// let subject = OutputsVariableSubject::new()
/// .with_tx_id(Some(Bytes32::zeroed()))
/// .with_index(Some(0))
/// .with_to(Some(Address::zeroed()))
/// .with_asset_id(Some(AssetId::from([1u8; 32])));
/// assert_eq!(
/// subject.to_string(),
/// "outputs.variable.0x0000000000000000000000000000000000000000000000000000000000000000.0.0x0000000000000000000000000000000000000000000000000000000000000000.0x0101010101010101010101010101010101010101010101010101010101010101"
/// );
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "outputs.>"]
#[subject_format = "outputs.variable.{tx_id}.{index}.{to}.{asset_id}"]
pub struct OutputsVariableSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<u16>,
pub to: Option<Address>,
pub asset_id: Option<AssetId>,
}
/// Represents the NATS subject for contract created outputs.
///
/// This subject format allows for querying contract creation outputs based on
/// transaction ID, index, and contract ID.
///
/// # Examples
///
/// **Creating a subject for a specific contract creation output:**
///
/// ```
/// use fuel_streams_core::outputs::subjects::OutputsContractCreatedSubject;
/// use fuel_streams_core::types::*;
/// use fuel_streams_macros::subject::SubjectBuildable;
///
/// let subject = OutputsContractCreatedSubject::new()
/// .with_tx_id(Some(Bytes32::zeroed()))
/// .with_index(Some(0))
/// .with_contract_id(Some(ContractId::zeroed()));
/// assert_eq!(
/// subject.to_string(),
/// "outputs.contract_created.0x0000000000000000000000000000000000000000000000000000000000000000.0.0x0000000000000000000000000000000000000000000000000000000000000000"
/// );
/// ```
#[derive(Subject, Debug, Clone, Default)]
#[subject_wildcard = "outputs.>"]
#[subject_format = "outputs.contract_created.{tx_id}.{index}.{contract_id}"]
pub struct OutputsContractCreatedSubject {
pub tx_id: Option<Bytes32>,
pub index: Option<u16>,
pub contract_id: Option<ContractId>,
}
#[cfg(test)]
mod tests {
use fuel_core_types::fuel_types::{Address, Bytes32};
use fuel_streams_macros::subject::SubjectBuildable;
use super::*;
#[test]
fn test_output_subject_wildcard() {
assert_eq!(OutputsByIdSubject::WILDCARD, "by_id.outputs.>");
assert_eq!(OutputsCoinSubject::WILDCARD, "outputs.>");
assert_eq!(OutputsContractSubject::WILDCARD, "outputs.>");
assert_eq!(OutputsChangeSubject::WILDCARD, "outputs.>");
assert_eq!(OutputsVariableSubject::WILDCARD, "outputs.>");
assert_eq!(OutputsContractCreatedSubject::WILDCARD, "outputs.>");
}
#[test]
fn test_outputs_coin_subject_creation() {
let coin_subject = OutputsCoinSubject::new()
.with_tx_id(Some(Bytes32::zeroed().into()))
.with_index(Some(0))
.with_to(Some(Address::zeroed().into()))
.with_asset_id(Some(AssetId::zeroed()));
assert_eq!(
coin_subject.to_string(),
"outputs.coin.0x0000000000000000000000000000000000000000000000000000000000000000.0.0x0000000000000000000000000000000000000000000000000000000000000000.0x0000000000000000000000000000000000000000000000000000000000000000"
);
}
#[test]
fn test_outputs_contract_created_subject_creation() {
let contract_created_subject = OutputsContractCreatedSubject::new()
.with_tx_id(Some(Bytes32::zeroed().into()))
.with_index(Some(0))
.with_contract_id(Some(ContractId::zeroed()));
assert_eq!(
contract_created_subject.to_string(),
"outputs.contract_created.0x0000000000000000000000000000000000000000000000000000000000000000.0.0x0000000000000000000000000000000000000000000000000000000000000000"
);
}
#[test]
fn test_output_subject_coin() {
let output_subject = OutputsCoinSubject::new()
.with_tx_id(Some(Bytes32::zeroed().into()))
.with_index(Some(0))
.with_to(Some(Address::zeroed().into()))
.with_asset_id(Some(AssetId::zeroed()));
assert_eq!(
output_subject.to_string(),
"outputs.coin.0x0000000000000000000000000000000000000000000000000000000000000000.0.0x0000000000000000000000000000000000000000000000000000000000000000.0x0000000000000000000000000000000000000000000000000000000000000000"
);
}
#[test]
fn test_output_subject_variable() {
let output_subject = OutputsVariableSubject::new()
.with_tx_id(Some(Bytes32::zeroed().into()))
.with_index(Some(0))
.with_to(Some(Address::zeroed().into()))
.with_asset_id(Some(AssetId::zeroed()));
assert_eq!(
output_subject.to_string(),
"outputs.variable.0x0000000000000000000000000000000000000000000000000000000000000000.0.0x0000000000000000000000000000000000000000000000000000000000000000.0x0000000000000000000000000000000000000000000000000000000000000000"
);
}
}