xrpl/models/transactions/
permissioned_domain_delete.rs

1use alloc::borrow::Cow;
2use alloc::vec::Vec;
3use serde::{Deserialize, Serialize};
4use serde_with::skip_serializing_none;
5
6use crate::models::amount::XRPAmount;
7use crate::models::{
8    transactions::{Memo, Signer, Transaction, TransactionType},
9    Model, ValidateCurrencies,
10};
11use crate::models::{FlagCollection, NoFlags};
12
13use super::{CommonFields, CommonTransactionBuilder};
14
15/// A PermissionedDomainDelete transaction removes an existing permissioned
16/// domain from the XRP Ledger. Only the owner of the domain can delete it.
17///
18/// See XLS-80 PermissionedDomains:
19/// `<https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0080-permissioned-domains>`
20#[skip_serializing_none]
21#[derive(
22    Debug,
23    Default,
24    Serialize,
25    Deserialize,
26    PartialEq,
27    Eq,
28    Clone,
29    xrpl_rust_macros::ValidateCurrencies,
30)]
31#[serde(rename_all = "PascalCase")]
32pub struct PermissionedDomainDelete<'a> {
33    /// The base fields for all transaction models.
34    ///
35    /// See Transaction Common Fields:
36    /// `<https://xrpl.org/transaction-common-fields.html>`
37    #[serde(flatten)]
38    pub common_fields: CommonFields<'a, NoFlags>,
39    /// The ID of the permissioned domain to delete.
40    #[serde(rename = "DomainID")]
41    pub domain_id: Cow<'a, str>,
42}
43
44impl<'a> Model for PermissionedDomainDelete<'a> {
45    fn get_errors(&self) -> crate::models::XRPLModelResult<()> {
46        // DomainID is the 32-byte hash of the PermissionedDomain ledger entry,
47        // serialized as 64 uppercase hex chars. Reuse the shared validator so the
48        // rule stays in lockstep with PermissionedDomainSet.
49        crate::models::transactions::permissioned_domain_set::validate_domain_id(
50            self.domain_id.as_ref(),
51        )?;
52        self.validate_currencies()
53    }
54}
55
56impl<'a> Transaction<'a, NoFlags> for PermissionedDomainDelete<'a> {
57    fn get_transaction_type(&self) -> &TransactionType {
58        self.common_fields.get_transaction_type()
59    }
60
61    fn get_common_fields(&self) -> &CommonFields<'_, NoFlags> {
62        self.common_fields.get_common_fields()
63    }
64
65    fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, NoFlags> {
66        self.common_fields.get_mut_common_fields()
67    }
68}
69
70impl<'a> CommonTransactionBuilder<'a, NoFlags> for PermissionedDomainDelete<'a> {
71    fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, NoFlags> {
72        &mut self.common_fields
73    }
74
75    fn into_self(self) -> Self {
76        self
77    }
78}
79
80impl<'a> PermissionedDomainDelete<'a> {
81    pub fn new(
82        account: Cow<'a, str>,
83        account_txn_id: Option<Cow<'a, str>>,
84        fee: Option<XRPAmount<'a>>,
85        last_ledger_sequence: Option<u32>,
86        memos: Option<Vec<Memo>>,
87        sequence: Option<u32>,
88        signers: Option<Vec<Signer>>,
89        source_tag: Option<u32>,
90        ticket_sequence: Option<u32>,
91        domain_id: Cow<'a, str>,
92    ) -> Self {
93        Self {
94            common_fields: CommonFields {
95                account,
96                transaction_type: TransactionType::PermissionedDomainDelete,
97                account_txn_id,
98                fee,
99                flags: FlagCollection::default(),
100                last_ledger_sequence,
101                memos,
102                sequence,
103                signers,
104                source_tag,
105                ticket_sequence,
106                ..Default::default()
107            },
108            domain_id,
109        }
110    }
111}
112
113#[cfg(test)]
114mod tests {
115    use super::*;
116    use crate::models::exceptions::XRPLModelException;
117
118    /// Shared test account (a valid classic address).
119    const TEST_ACCOUNT: &str = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh";
120
121    #[test]
122    fn test_serde() {
123        let txn = PermissionedDomainDelete {
124            common_fields: CommonFields {
125                account: TEST_ACCOUNT.into(),
126                transaction_type: TransactionType::PermissionedDomainDelete,
127                fee: Some("10".into()),
128                sequence: Some(1),
129                signing_pub_key: Some("".into()),
130                ..Default::default()
131            },
132            domain_id: "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2".into(),
133        };
134
135        let serialized = serde_json::to_string(&txn).unwrap();
136
137        // Verify key fields are present
138        assert!(serialized.contains("PermissionedDomainDelete"));
139        assert!(serialized.contains("DomainID"));
140
141        let deserialized: PermissionedDomainDelete = serde_json::from_str(&serialized).unwrap();
142        assert_eq!(txn, deserialized);
143    }
144
145    #[test]
146    fn test_serde_json_format() {
147        let txn = PermissionedDomainDelete {
148            common_fields: CommonFields {
149                account: TEST_ACCOUNT.into(),
150                transaction_type: TransactionType::PermissionedDomainDelete,
151                fee: Some("12".into()),
152                sequence: Some(5),
153                signing_pub_key: Some("".into()),
154                ..Default::default()
155            },
156            domain_id: "AABB00112233445566778899AABB00112233445566778899AABB001122334455".into(),
157        };
158
159        let default_json_str = r#"{"Account":"rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh","TransactionType":"PermissionedDomainDelete","Fee":"12","Flags":0,"Sequence":5,"SigningPubKey":"","DomainID":"AABB00112233445566778899AABB00112233445566778899AABB001122334455"}"#;
160
161        let default_json_value = serde_json::to_value(default_json_str).unwrap();
162        let serialized_string = serde_json::to_string(&txn).unwrap();
163        let serialized_value = serde_json::to_value(&serialized_string).unwrap();
164        assert_eq!(serialized_value, default_json_value);
165
166        let deserialized: PermissionedDomainDelete =
167            serde_json::from_str(default_json_str).unwrap();
168        assert_eq!(txn, deserialized);
169    }
170
171    #[test]
172    fn test_builder_pattern() {
173        let txn = PermissionedDomainDelete {
174            common_fields: CommonFields {
175                account: TEST_ACCOUNT.into(),
176                transaction_type: TransactionType::PermissionedDomainDelete,
177                ..Default::default()
178            },
179            domain_id: "AABB00112233445566778899AABB00112233445566778899AABB00112233445A".into(),
180        }
181        .with_fee("12".into())
182        .with_sequence(100)
183        .with_last_ledger_sequence(596447)
184        .with_source_tag(42)
185        .with_memo(Memo {
186            memo_data: Some("deleting domain".into()),
187            memo_format: None,
188            memo_type: Some("text".into()),
189        });
190
191        assert_eq!(txn.common_fields.account, TEST_ACCOUNT);
192        assert_eq!(txn.common_fields.fee.as_ref().unwrap().0, "12");
193        assert_eq!(txn.common_fields.sequence, Some(100));
194        assert_eq!(txn.common_fields.last_ledger_sequence, Some(596447));
195        assert_eq!(txn.common_fields.source_tag, Some(42));
196        assert_eq!(txn.common_fields.memos.as_ref().unwrap().len(), 1);
197        assert_eq!(
198            txn.domain_id,
199            "AABB00112233445566778899AABB00112233445566778899AABB00112233445A"
200        );
201    }
202
203    #[test]
204    fn test_default() {
205        let txn = PermissionedDomainDelete {
206            common_fields: CommonFields {
207                account: TEST_ACCOUNT.into(),
208                transaction_type: TransactionType::PermissionedDomainDelete,
209                ..Default::default()
210            },
211            domain_id: "AABB00112233445566778899AABB00112233445566778899AABB00112233445A".into(),
212        };
213
214        assert_eq!(txn.common_fields.account, TEST_ACCOUNT);
215        assert_eq!(
216            txn.common_fields.transaction_type,
217            TransactionType::PermissionedDomainDelete
218        );
219        assert_eq!(
220            txn.domain_id,
221            "AABB00112233445566778899AABB00112233445566778899AABB00112233445A"
222        );
223        assert!(txn.common_fields.fee.is_none());
224        assert!(txn.common_fields.sequence.is_none());
225    }
226
227    #[test]
228    fn test_new_constructor() {
229        let txn = PermissionedDomainDelete::new(
230            TEST_ACCOUNT.into(),
231            None,
232            Some("12".into()),
233            Some(596447),
234            None,
235            Some(1),
236            None,
237            None,
238            None,
239            "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2".into(),
240        );
241
242        assert_eq!(txn.common_fields.account, TEST_ACCOUNT);
243        assert_eq!(
244            txn.common_fields.transaction_type,
245            TransactionType::PermissionedDomainDelete
246        );
247        assert_eq!(txn.common_fields.fee.as_ref().unwrap().0, "12");
248        assert_eq!(txn.common_fields.sequence, Some(1));
249        assert_eq!(txn.common_fields.last_ledger_sequence, Some(596447));
250        assert_eq!(
251            txn.domain_id,
252            "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2"
253        );
254    }
255
256    #[test]
257    fn test_ticket_sequence() {
258        let txn = PermissionedDomainDelete {
259            common_fields: CommonFields {
260                account: TEST_ACCOUNT.into(),
261                transaction_type: TransactionType::PermissionedDomainDelete,
262                ..Default::default()
263            },
264            domain_id: "AABB00112233445566778899AABB00112233445566778899AABB00112233445A".into(),
265        }
266        .with_ticket_sequence(42)
267        .with_fee("10".into());
268
269        assert_eq!(txn.common_fields.ticket_sequence, Some(42));
270        assert!(txn.common_fields.sequence.is_none());
271    }
272
273    #[test]
274    fn test_account_txn_id() {
275        let txn = PermissionedDomainDelete {
276            common_fields: CommonFields {
277                account: TEST_ACCOUNT.into(),
278                transaction_type: TransactionType::PermissionedDomainDelete,
279                ..Default::default()
280            },
281            domain_id: "AABB00112233445566778899AABB00112233445566778899AABB00112233445A".into(),
282        }
283        .with_account_txn_id("F1E2D3C4B5A69788".into())
284        .with_fee("10".into())
285        .with_sequence(50);
286
287        assert_eq!(
288            txn.common_fields.account_txn_id,
289            Some("F1E2D3C4B5A69788".into())
290        );
291    }
292
293    #[test]
294    fn test_invalid_domain_id_rejected() {
295        // DomainID must be exactly 64 hex chars (32-byte hash).
296        let too_short = PermissionedDomainDelete {
297            common_fields: CommonFields {
298                account: TEST_ACCOUNT.into(),
299                transaction_type: TransactionType::PermissionedDomainDelete,
300                ..Default::default()
301            },
302            domain_id: "AABB0011".into(),
303        };
304        assert!(matches!(
305            too_short.get_errors().unwrap_err(),
306            XRPLModelException::InvalidValue { .. }
307        ));
308
309        // Correct length but non-hex chars.
310        let non_hex = PermissionedDomainDelete {
311            common_fields: CommonFields {
312                account: TEST_ACCOUNT.into(),
313                transaction_type: TransactionType::PermissionedDomainDelete,
314                ..Default::default()
315            },
316            domain_id: "Z".repeat(64).into(),
317        };
318        assert!(matches!(
319            non_hex.get_errors().unwrap_err(),
320            XRPLModelException::InvalidValue { .. }
321        ));
322    }
323
324    #[test]
325    fn test_delete_all_zero_domain_id_rejected() {
326        let txn = PermissionedDomainDelete {
327            common_fields: CommonFields {
328                account: TEST_ACCOUNT.into(),
329                transaction_type: TransactionType::PermissionedDomainDelete,
330                ..Default::default()
331            },
332            domain_id: "0".repeat(64).into(),
333        };
334
335        assert!(matches!(
336            txn.get_errors(),
337            Err(XRPLModelException::InvalidValue { .. })
338        ));
339    }
340
341    #[test]
342    fn test_valid_domain_id_accepted() {
343        let txn = PermissionedDomainDelete {
344            common_fields: CommonFields {
345                account: TEST_ACCOUNT.into(),
346                transaction_type: TransactionType::PermissionedDomainDelete,
347                ..Default::default()
348            },
349            domain_id: "A".repeat(64).into(),
350        };
351        assert!(txn.get_errors().is_ok());
352    }
353}
xrpl/models/transactions/permissioned_domain_delete.rs

xrpl/models/transactions/
permissioned_domain_delete.rs
