use alloc::borrow::Cow;
use alloc::collections::BTreeSet;
use alloc::vec::Vec;
use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;
use crate::core::addresscodec::is_valid_classic_address;
use crate::models::amount::XRPAmount;
use crate::models::exceptions::XRPLModelException;
use crate::models::{
transactions::{Credential, Memo, Signer, Transaction, TransactionType},
Model, ValidateCurrencies,
};
use crate::models::{FlagCollection, NoFlags};
use super::{CommonFields, CommonTransactionBuilder};
#[skip_serializing_none]
#[derive(
Debug,
Default,
Serialize,
Deserialize,
PartialEq,
Eq,
Clone,
xrpl_rust_macros::ValidateCurrencies,
)]
#[serde(rename_all = "PascalCase")]
pub struct PermissionedDomainSet<'a> {
#[serde(flatten)]
pub common_fields: CommonFields<'a, NoFlags>,
#[serde(rename = "DomainID")]
pub domain_id: Option<Cow<'a, str>>,
pub accepted_credentials: Vec<Credential>,
}
impl<'a> Model for PermissionedDomainSet<'a> {
fn get_errors(&self) -> crate::models::XRPLModelResult<()> {
validate_accepted_credentials(&self.accepted_credentials)?;
if let Some(domain_id) = &self.domain_id {
validate_domain_id(domain_id.as_ref())?;
}
self.validate_currencies()
}
}
pub(crate) fn validate_accepted_credentials(
credentials: &[Credential],
) -> crate::models::XRPLModelResult<()> {
if credentials.is_empty() {
return Err(XRPLModelException::MissingField(
"AcceptedCredentials".into(),
));
}
if credentials.len() > 10 {
return Err(XRPLModelException::ValueTooLong {
field: "AcceptedCredentials".into(),
max: 10,
found: credentials.len(),
});
}
let mut seen: BTreeSet<(alloc::string::String, alloc::string::String)> = BTreeSet::new();
for credential in credentials {
validate_credential(credential)?;
let key = (
credential.issuer.clone(),
credential.credential_type.to_uppercase(),
);
if !seen.insert(key) {
return Err(XRPLModelException::InvalidValue {
field: "AcceptedCredentials".into(),
expected: "unique Issuer/CredentialType pairs".into(),
found: alloc::format!("{}/{}", credential.issuer, credential.credential_type),
});
}
}
Ok(())
}
pub(crate) fn validate_domain_id(domain_id: &str) -> crate::models::XRPLModelResult<()> {
if domain_id.len() != 64
|| !domain_id.chars().all(|c| c.is_ascii_hexdigit())
|| domain_id.chars().all(|c| c == '0')
{
return Err(XRPLModelException::InvalidValue {
field: "DomainID".into(),
expected: "non-zero 64-character hex string".into(),
found: domain_id.into(),
});
}
Ok(())
}
pub(crate) fn validate_credential(credential: &Credential) -> crate::models::XRPLModelResult<()> {
if credential.issuer.is_empty() {
return Err(XRPLModelException::MissingField("Credential.Issuer".into()));
}
if !is_valid_classic_address(&credential.issuer) {
return Err(XRPLModelException::InvalidValue {
field: "Credential.Issuer".into(),
expected: "valid classic XRPL address".into(),
found: credential.issuer.clone(),
});
}
let ct = &credential.credential_type;
if ct.is_empty() {
return Err(XRPLModelException::MissingField(
"Credential.CredentialType".into(),
));
}
if ct.len() > 128 {
return Err(XRPLModelException::ValueTooLong {
field: "Credential.CredentialType".into(),
max: 128,
found: ct.len(),
});
}
if !ct.len().is_multiple_of(2) || !ct.chars().all(|c| c.is_ascii_hexdigit()) {
return Err(XRPLModelException::InvalidValue {
field: "Credential.CredentialType".into(),
expected: "even-length hex string (<=128 chars)".into(),
found: ct.clone(),
});
}
Ok(())
}
impl<'a> Transaction<'a, NoFlags> for PermissionedDomainSet<'a> {
fn get_transaction_type(&self) -> &TransactionType {
self.common_fields.get_transaction_type()
}
fn get_common_fields(&self) -> &CommonFields<'_, NoFlags> {
self.common_fields.get_common_fields()
}
fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, NoFlags> {
self.common_fields.get_mut_common_fields()
}
}
impl<'a> CommonTransactionBuilder<'a, NoFlags> for PermissionedDomainSet<'a> {
fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, NoFlags> {
&mut self.common_fields
}
fn into_self(self) -> Self {
self
}
}
impl<'a> PermissionedDomainSet<'a> {
pub fn new(
account: Cow<'a, str>,
account_txn_id: Option<Cow<'a, str>>,
fee: Option<XRPAmount<'a>>,
last_ledger_sequence: Option<u32>,
memos: Option<Vec<Memo>>,
sequence: Option<u32>,
signers: Option<Vec<Signer>>,
source_tag: Option<u32>,
ticket_sequence: Option<u32>,
domain_id: Option<Cow<'a, str>>,
accepted_credentials: Vec<Credential>,
) -> Self {
Self {
common_fields: CommonFields {
account,
transaction_type: TransactionType::PermissionedDomainSet,
account_txn_id,
fee,
flags: FlagCollection::default(),
last_ledger_sequence,
memos,
sequence,
signers,
source_tag,
ticket_sequence,
..Default::default()
},
domain_id,
accepted_credentials,
}
}
pub fn with_domain_id(mut self, domain_id: Cow<'a, str>) -> Self {
self.domain_id = Some(domain_id);
self
}
pub fn with_accepted_credentials(mut self, credentials: Vec<Credential>) -> Self {
self.accepted_credentials = credentials;
self
}
pub fn with_credential(mut self, credential: Credential) -> Self {
self.accepted_credentials.push(credential);
self
}
}
#[cfg(test)]
mod tests {
use super::*;
use alloc::string::ToString;
use alloc::vec;
const TEST_ACCOUNT: &str = "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh";
#[test]
fn test_serde() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
fee: Some("10".into()),
sequence: Some(1),
signing_pub_key: Some("".into()),
..Default::default()
},
domain_id: None,
accepted_credentials: vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(), }],
};
let serialized = serde_json::to_string(&txn).unwrap();
let deserialized: PermissionedDomainSet = serde_json::from_str(&serialized).unwrap();
assert_eq!(txn, deserialized);
}
#[test]
fn test_serde_with_domain_id() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
fee: Some("10".into()),
sequence: Some(2),
signing_pub_key: Some("".into()),
..Default::default()
},
domain_id: Some(
"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2".into(),
),
accepted_credentials: vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "414D4C".to_string(), }],
};
let serialized = serde_json::to_string(&txn).unwrap();
assert!(serialized.contains("DomainID"));
assert!(
serialized.contains("A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2")
);
let deserialized: PermissionedDomainSet = serde_json::from_str(&serialized).unwrap();
assert_eq!(txn, deserialized);
}
#[test]
fn test_builder_pattern() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
..Default::default()
}
.with_fee("12".into())
.with_sequence(100)
.with_last_ledger_sequence(596447)
.with_source_tag(42)
.with_credential(Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(), });
assert_eq!(txn.common_fields.account, TEST_ACCOUNT);
assert_eq!(txn.common_fields.fee.as_ref().unwrap().0, "12");
assert_eq!(txn.common_fields.sequence, Some(100));
assert_eq!(txn.common_fields.last_ledger_sequence, Some(596447));
assert_eq!(txn.common_fields.source_tag, Some(42));
assert_eq!(txn.accepted_credentials.len(), 1);
assert!(txn.domain_id.is_none());
}
#[test]
fn test_default() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
..Default::default()
};
assert_eq!(txn.common_fields.account, TEST_ACCOUNT);
assert_eq!(
txn.common_fields.transaction_type,
TransactionType::PermissionedDomainSet
);
assert!(txn.domain_id.is_none());
assert!(txn.accepted_credentials.is_empty());
assert!(txn.common_fields.fee.is_none());
assert!(txn.common_fields.sequence.is_none());
assert!(txn.get_errors().is_err());
}
#[test]
fn test_with_credentials() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
fee: Some("10".into()),
sequence: Some(5),
..Default::default()
},
domain_id: None,
accepted_credentials: vec![
Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(), },
Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "414D4C".to_string(), },
Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "41434352454449544544".to_string(), },
],
};
assert_eq!(txn.accepted_credentials.len(), 3);
assert_eq!(txn.accepted_credentials[0].issuer, TEST_ACCOUNT.to_string());
assert_eq!(
txn.accepted_credentials[1].credential_type,
"414D4C".to_string()
);
assert_eq!(
txn.accepted_credentials[2].credential_type,
"41434352454449544544".to_string()
);
}
#[test]
fn test_update_domain() {
let domain_id =
"A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4E5F6A1B2".to_string();
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
fee: Some("10".into()),
sequence: Some(10),
..Default::default()
},
domain_id: Some(domain_id.clone().into()),
accepted_credentials: vec![Credential {
issuer: "rNewIssuer".to_string(),
credential_type: "5645524946494544".to_string(), }],
};
assert_eq!(txn.domain_id, Some(domain_id.into()));
assert_eq!(txn.accepted_credentials.len(), 1);
}
#[test]
fn test_create_domain() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
fee: Some("10".into()),
sequence: Some(1),
..Default::default()
},
domain_id: None,
accepted_credentials: vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(), }],
};
assert!(txn.domain_id.is_none());
assert_eq!(txn.accepted_credentials.len(), 1);
}
#[test]
fn test_new_constructor() {
let txn = PermissionedDomainSet::new(
TEST_ACCOUNT.into(),
None,
Some("12".into()),
Some(596447),
None,
Some(1),
None,
None,
None,
None,
vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(), }],
);
assert_eq!(txn.common_fields.account, TEST_ACCOUNT);
assert_eq!(
txn.common_fields.transaction_type,
TransactionType::PermissionedDomainSet
);
assert_eq!(txn.common_fields.fee.as_ref().unwrap().0, "12");
assert_eq!(txn.common_fields.sequence, Some(1));
assert_eq!(txn.common_fields.last_ledger_sequence, Some(596447));
assert!(txn.domain_id.is_none());
assert_eq!(txn.accepted_credentials.len(), 1);
}
#[test]
fn test_with_domain_id_builder() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
..Default::default()
}
.with_domain_id("AABB0011".into())
.with_accepted_credentials(vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(), }]);
assert_eq!(txn.domain_id, Some("AABB0011".into()));
assert_eq!(txn.accepted_credentials.len(), 1);
}
#[test]
fn test_with_memo() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
..Default::default()
}
.with_fee("10".into())
.with_sequence(1)
.with_memo(Memo {
memo_data: Some("creating domain".into()),
memo_format: None,
memo_type: Some("text".into()),
})
.with_credential(Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(), });
assert_eq!(txn.common_fields.memos.as_ref().unwrap().len(), 1);
assert_eq!(txn.accepted_credentials.len(), 1);
}
#[test]
fn test_empty_credentials_rejected() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
fee: Some("10".into()),
sequence: Some(1),
..Default::default()
},
domain_id: Some("AABB0011".into()),
accepted_credentials: vec![],
};
let result = txn.get_errors();
assert!(result.is_err());
assert_eq!(
result.unwrap_err(),
XRPLModelException::MissingField("AcceptedCredentials".into())
);
}
#[test]
fn test_too_many_credentials_rejected() {
let credentials: Vec<Credential> = (0..11)
.map(|_| Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(),
})
.collect();
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: None,
accepted_credentials: credentials,
};
let result = txn.get_errors();
assert!(result.is_err());
assert!(matches!(
result.unwrap_err(),
XRPLModelException::ValueTooLong {
max: 10,
found: 11,
..
}
));
}
#[test]
fn test_non_hex_credential_type_rejected() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: None,
accepted_credentials: vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "KYC".to_string(), }],
};
let result = txn.get_errors();
assert!(result.is_err());
assert!(matches!(
result.unwrap_err(),
XRPLModelException::InvalidValue { .. }
));
}
#[test]
fn test_credential_type_64_bytes_accepted() {
let credential = Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "A".repeat(128),
};
assert!(validate_credential(&credential).is_ok());
}
#[test]
fn test_credential_type_over_64_bytes_rejected() {
let too_long = "A".repeat(130);
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: None,
accepted_credentials: vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: too_long,
}],
};
let result = txn.get_errors();
assert!(result.is_err());
assert!(matches!(
result.unwrap_err(),
XRPLModelException::ValueTooLong { max: 128, .. }
));
}
#[test]
fn test_duplicate_credentials_rejected() {
let duplicate = Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(),
};
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: None,
accepted_credentials: vec![duplicate.clone(), duplicate],
};
assert!(matches!(
txn.get_errors(),
Err(XRPLModelException::InvalidValue { .. })
));
}
#[test]
fn test_set_all_zero_domain_id_rejected() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: Some("0".repeat(64).into()),
accepted_credentials: vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(),
}],
};
assert!(matches!(
txn.get_errors(),
Err(XRPLModelException::InvalidValue { .. })
));
}
#[test]
fn test_duplicate_credentials_case_insensitive_rejected() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: None,
accepted_credentials: vec![
Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4b5943".to_string(),
},
Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(),
},
],
};
assert!(matches!(
txn.get_errors(),
Err(XRPLModelException::InvalidValue { .. })
));
}
#[test]
fn test_set_wrong_length_domain_id_rejected() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: Some("ABCD".into()), accepted_credentials: vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(),
}],
};
assert!(matches!(
txn.get_errors(),
Err(XRPLModelException::InvalidValue { .. })
));
}
#[test]
fn test_set_non_hex_domain_id_rejected() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: Some("G".repeat(64).into()), accepted_credentials: vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(),
}],
};
assert!(matches!(
txn.get_errors(),
Err(XRPLModelException::InvalidValue { .. })
));
}
#[test]
fn test_ticket_sequence() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
..Default::default()
}
.with_ticket_sequence(42)
.with_fee("10".into())
.with_credential(Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "4B5943".to_string(), });
assert_eq!(txn.common_fields.ticket_sequence, Some(42));
assert!(txn.common_fields.sequence.is_none());
}
#[test]
fn test_credential_empty_issuer_rejected() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: None,
accepted_credentials: vec![Credential {
issuer: "".to_string(),
credential_type: "4B5943".to_string(), }],
};
let result = txn.get_errors();
assert!(result.is_err());
assert_eq!(
result.unwrap_err(),
XRPLModelException::MissingField("Credential.Issuer".into())
);
}
#[test]
fn test_credential_empty_credential_type_rejected() {
let txn = PermissionedDomainSet {
common_fields: CommonFields {
account: TEST_ACCOUNT.into(),
transaction_type: TransactionType::PermissionedDomainSet,
..Default::default()
},
domain_id: None,
accepted_credentials: vec![Credential {
issuer: TEST_ACCOUNT.to_string(),
credential_type: "".to_string(),
}],
};
let result = txn.get_errors();
assert!(result.is_err());
assert_eq!(
result.unwrap_err(),
XRPLModelException::MissingField("Credential.CredentialType".into())
);
}
}