xrpl-rust 1.2.0

use alloc::borrow::Cow;
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::{
    Amount, FlagCollection, Model, NoFlags, ValidateCurrencies, XRPLModelException, XRPLModelResult,
};

use super::vault_common::{validate_positive_amount, validate_vault_id};
use super::{CommonFields, CommonTransactionBuilder, Memo, Signer, Transaction, TransactionType};

/// Withdraw assets from a vault on the XRP Ledger (XLS-65).
///
/// The withdrawer burns share tokens (MPTokens) in exchange for the
/// proportional share of the vault's assets.
///
/// See VaultWithdraw transaction:
/// `<https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0065d-single-asset-vault>`
#[skip_serializing_none]
#[derive(
    Debug,
    Default,
    Serialize,
    Deserialize,
    PartialEq,
    Eq,
    Clone,
    xrpl_rust_macros::ValidateCurrencies,
)]
#[serde(rename_all = "PascalCase")]
pub struct VaultWithdraw<'a> {
    /// The base fields for all transaction models.
    ///
    /// See Transaction Common Fields:
    /// `<https://xrpl.org/transaction-common-fields.html>`
    #[serde(flatten)]
    pub common_fields: CommonFields<'a, NoFlags>,
    /// The ID of the vault to withdraw from (256-bit hex string).
    #[serde(rename = "VaultID")]
    pub vault_id: Cow<'a, str>,
    /// The amount of the asset to withdraw from the vault.
    pub amount: Amount<'a>,
    /// An account to receive the withdrawn assets. Must be able to receive the asset.
    pub destination: Option<Cow<'a, str>>,
    /// Arbitrary tag identifying the reason for the withdrawal to the destination.
    pub destination_tag: Option<u32>,
}

impl Model for VaultWithdraw<'_> {
    fn get_errors(&self) -> XRPLModelResult<()> {
        self.validate_currencies()?;
        validate_vault_id(&self.vault_id)?;
        validate_positive_amount("amount", &self.amount)?;
        if let Some(dest) = &self.destination {
            if !is_valid_classic_address(dest) {
                return Err(XRPLModelException::InvalidValue {
                    field: "destination".into(),
                    expected: "a valid classic account address".into(),
                    found: dest.as_ref().into(),
                });
            }
        }
        Ok(())
    }
}

impl<'a> Transaction<'a, NoFlags> for VaultWithdraw<'a> {
    fn get_common_fields(&self) -> &CommonFields<'_, NoFlags> {
        &self.common_fields
    }

    fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, NoFlags> {
        &mut self.common_fields
    }

    fn get_transaction_type(&self) -> &TransactionType {
        self.common_fields.get_transaction_type()
    }
}

impl<'a> CommonTransactionBuilder<'a, NoFlags> for VaultWithdraw<'a> {
    fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, NoFlags> {
        &mut self.common_fields
    }

    fn into_self(self) -> Self {
        self
    }
}

impl<'a> VaultWithdraw<'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>,
        vault_id: Cow<'a, str>,
        amount: Amount<'a>,
        destination: Option<Cow<'a, str>>,
        destination_tag: Option<u32>,
    ) -> VaultWithdraw<'a> {
        VaultWithdraw {
            common_fields: CommonFields::new(
                account,
                TransactionType::VaultWithdraw,
                account_txn_id,
                fee,
                Some(FlagCollection::default()),
                last_ledger_sequence,
                memos,
                None,
                sequence,
                signers,
                None,
                source_tag,
                ticket_sequence,
                None,
            ),
            vault_id,
            amount,
            destination,
            destination_tag,
        }
    }

    /// Set the destination account.
    pub fn with_destination(mut self, destination: Cow<'a, str>) -> Self {
        self.destination = Some(destination);
        self
    }

    /// Set the destination tag.
    pub fn with_destination_tag(mut self, destination_tag: u32) -> Self {
        self.destination_tag = Some(destination_tag);
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::models::{IssuedCurrencyAmount, XRPAmount};

    const VAULT_ID: &str = "A0000000000000000000000000000000000000000000000000000000DEADBEEF";

    #[test]
    fn test_serde() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer123".into(),
                transaction_type: TransactionType::VaultWithdraw,
                signing_pub_key: Some("".into()),
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("1000000")),
            destination: None,
            destination_tag: None,
        };

        let json_str = r#"{"Account":"rWithdrawer123","TransactionType":"VaultWithdraw","Flags":0,"SigningPubKey":"","VaultID":"A0000000000000000000000000000000000000000000000000000000DEADBEEF","Amount":"1000000"}"#;

        // Serialize
        let serialized = serde_json::to_string(&vault_withdraw).unwrap();
        assert_eq!(
            serde_json::to_value(&serialized).unwrap(),
            serde_json::to_value(json_str).unwrap()
        );

        // Deserialize
        let deserialized: VaultWithdraw = serde_json::from_str(json_str).unwrap();
        assert_eq!(vault_withdraw, deserialized);
    }

    #[test]
    fn test_serde_issued_currency() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawICA456".into(),
                transaction_type: TransactionType::VaultWithdraw,
                signing_pub_key: Some("".into()),
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::IssuedCurrencyAmount(IssuedCurrencyAmount::new(
                "USD".into(),
                "rIssuer789".into(),
                "500".into(),
            )),
            destination: None,
            destination_tag: None,
        };

        let serialized = serde_json::to_string(&vault_withdraw).unwrap();
        let deserialized: VaultWithdraw = serde_json::from_str(&serialized).unwrap();
        assert_eq!(vault_withdraw, deserialized);
    }

    #[test]
    fn test_builder_pattern() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer123".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("1000000")),
            destination: None,
            destination_tag: None,
        }
        .with_fee("12".into())
        .with_sequence(100)
        .with_last_ledger_sequence(7108682)
        .with_source_tag(12345)
        .with_memo(Memo {
            memo_data: Some("withdrawing from vault".into()),
            memo_format: None,
            memo_type: Some("text".into()),
        });

        assert_eq!(vault_withdraw.vault_id, VAULT_ID);
        assert_eq!(vault_withdraw.common_fields.fee.as_ref().unwrap().0, "12");
        assert_eq!(vault_withdraw.common_fields.sequence, Some(100));
        assert_eq!(
            vault_withdraw.common_fields.last_ledger_sequence,
            Some(7108682)
        );
        assert_eq!(vault_withdraw.common_fields.source_tag, Some(12345));
        assert_eq!(
            vault_withdraw.common_fields.memos.as_ref().unwrap().len(),
            1
        );
    }

    #[test]
    fn test_default() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer789".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("5000000")),
            destination: None,
            destination_tag: None,
        };

        assert_eq!(vault_withdraw.common_fields.account, "rWithdrawer789");
        assert_eq!(
            vault_withdraw.common_fields.transaction_type,
            TransactionType::VaultWithdraw
        );
        assert_eq!(vault_withdraw.vault_id, VAULT_ID);
        assert!(vault_withdraw.common_fields.fee.is_none());
        assert!(vault_withdraw.common_fields.sequence.is_none());
    }

    #[test]
    fn test_ticket_sequence() {
        let ticket_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rTicketWithdrawer111".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("2000000")),
            destination: None,
            destination_tag: None,
        }
        .with_ticket_sequence(54321)
        .with_fee("12".into());

        assert_eq!(ticket_withdraw.common_fields.ticket_sequence, Some(54321));
        assert!(ticket_withdraw.common_fields.sequence.is_none());
    }

    #[test]
    fn test_multiple_memos() {
        let multi_memo_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rMultiMemoWithdrawer222".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::IssuedCurrencyAmount(IssuedCurrencyAmount::new(
                "USD".into(),
                "rUSDIssuer333".into(),
                "250".into(),
            )),
            destination: None,
            destination_tag: None,
        }
        .with_memo(Memo {
            memo_data: Some("partial withdrawal".into()),
            memo_format: None,
            memo_type: Some("text".into()),
        })
        .with_memo(Memo {
            memo_data: Some("rebalancing portfolio".into()),
            memo_format: None,
            memo_type: Some("text".into()),
        })
        .with_fee("18".into())
        .with_sequence(400);

        assert_eq!(
            multi_memo_withdraw
                .common_fields
                .memos
                .as_ref()
                .unwrap()
                .len(),
            2
        );
        assert_eq!(multi_memo_withdraw.common_fields.sequence, Some(400));
    }

    #[test]
    fn test_new_constructor() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rNewWithdrawer444".into(),
                transaction_type: TransactionType::VaultWithdraw,
                fee: Some("12".into()),
                last_ledger_sequence: Some(7108682),
                sequence: Some(100),
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("10000000")),
            destination: None,
            destination_tag: None,
        };

        assert_eq!(vault_withdraw.common_fields.account, "rNewWithdrawer444");
        assert_eq!(
            vault_withdraw.common_fields.transaction_type,
            TransactionType::VaultWithdraw
        );
        assert_eq!(vault_withdraw.common_fields.fee.as_ref().unwrap().0, "12");
        assert_eq!(vault_withdraw.vault_id, VAULT_ID);
    }

    #[test]
    fn test_with_destination() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawerDest".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("1000000")),
            destination: None,
            destination_tag: None,
        }
        .with_destination("rDestAccount789".into())
        .with_destination_tag(42);

        assert_eq!(vault_withdraw.destination, Some("rDestAccount789".into()));
        assert_eq!(vault_withdraw.destination_tag, Some(42));
    }

    #[test]
    fn test_invalid_destination_rejected() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("1000000")),
            destination: Some("notanaddress".into()),
            destination_tag: None,
        };
        assert!(vault_withdraw.validate().is_err());
    }

    #[test]
    fn test_valid_destination_accepted() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("1000000")),
            destination: Some("rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn".into()),
            destination_tag: None,
        };
        assert!(vault_withdraw.validate().is_ok());
    }

    #[test]
    fn test_get_transaction_type() {
        use crate::models::transactions::Transaction;
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rTxTypeTest".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("1000000")),
            destination: None,
            destination_tag: None,
        };
        assert_eq!(
            *vault_withdraw.get_transaction_type(),
            TransactionType::VaultWithdraw
        );
    }

    #[test]
    fn test_validate() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rValidateWithdrawer555".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("1000000")),
            destination: None,
            destination_tag: None,
        }
        .with_fee("12".into())
        .with_sequence(300);

        assert!(vault_withdraw.validate().is_ok());
    }

    #[test]
    fn test_amount_zero_rejected() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("0")),
            destination: None,
            destination_tag: None,
        };
        assert!(vault_withdraw.validate().is_err());
    }

    #[test]
    fn test_amount_negative_rejected() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::IssuedCurrencyAmount(crate::models::amount::IssuedCurrencyAmount::new(
                "USD".into(),
                "rIssuer".into(),
                "-5".into(),
            )),
            destination: None,
            destination_tag: None,
        };
        assert!(vault_withdraw.validate().is_err());
    }

    #[test]
    fn test_amount_non_numeric_rejected() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::XRPAmount(XRPAmount::from("bad")),
            destination: None,
            destination_tag: None,
        };
        assert!(vault_withdraw.validate().is_err());
    }

    #[test]
    fn test_amount_ica_non_numeric_rejected() {
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::IssuedCurrencyAmount(IssuedCurrencyAmount::new(
                "USD".into(),
                "rIssuer".into(),
                "not-a-number".into(),
            )),
            destination: None,
            destination_tag: None,
        };
        assert!(vault_withdraw.validate().is_err());
    }

    #[test]
    fn test_amount_mpt_positive_accepted() {
        use crate::models::amount::MPTAmount;
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::MPTAmount(MPTAmount {
                mpt_issuance_id: "000000016B4E90A4B36D74F6E16A5BED41EBD7AA37B19B89".into(),
                value: "1000".into(),
            }),
            destination: None,
            destination_tag: None,
        };
        assert!(vault_withdraw.validate().is_ok());
    }

    #[test]
    fn test_amount_mpt_zero_rejected() {
        use crate::models::amount::MPTAmount;
        let vault_withdraw = VaultWithdraw {
            common_fields: CommonFields {
                account: "rWithdrawer".into(),
                transaction_type: TransactionType::VaultWithdraw,
                ..Default::default()
            },
            vault_id: VAULT_ID.into(),
            amount: Amount::MPTAmount(MPTAmount {
                mpt_issuance_id: "000000016B4E90A4B36D74F6E16A5BED41EBD7AA37B19B89".into(),
                value: "0".into(),
            }),
            destination: None,
            destination_tag: None,
        };
        assert!(vault_withdraw.validate().is_err());
    }
}