feat: basic ferment integration

dash/Cargo.toml

@@ -33,6 +33,7 @@ eddsa = ["ed25519-dalek"]
 quorum_validation = ["bls", "bls-signatures"]
 message_verification = ["bls"]
 bincode = [ "dep:bincode", "dashcore_hashes/bincode" ]
+apple = [ "ferment", "ferment-macro", "bls-signatures/legacy", "bls-signatures/bip32", "bls-signatures/apple", "bls-signatures/use_serde" ]
 
 # At least one of std, no-std must be enabled.
 #
@@ -62,14 +63,15 @@ hex_lit = "0.1.1"
 anyhow = { version= "1.0" }
 hex = { version= "0.4" }
 bincode = { version= "=2.0.0-rc.3", optional = true }
+bincode_derive = { version= "=2.0.0-rc.3", optional = true }
 bitflags = "2.9.0"
 blsful = { version = "3.0.0-pre8", optional = true }
 ed25519-dalek = { version = "2.1", features = ["rand_core"], optional = true }
 blake3 = "1.8.1"
 thiserror = "2"
-# version 1.3.5 is 0bb5c5b03249c463debb5cef5f7e52ee66f3aaab
-bls-signatures = { git = "https://github.com/dashpay/bls-signatures", rev = "0bb5c5b03249c463debb5cef5f7e52ee66f3aaab", optional = true }
-
+bls-signatures = { git = "https://github.com/dashpay/bls-signatures", rev = "b840e447227dbe6e9a302c97acdf45b95c4d3b21", optional = true  }
+ferment = { version = "0.2", package = "ferment", optional = true }
+ferment-macro = { version = "0.2", package = "ferment-macro", optional = true }
 [dev-dependencies]
 serde_json = "1.0.140"
 serde_test = "1.0.177"

dash/src/bip158.rs

@@ -601,7 +601,7 @@ mod test {
     use serde_json::Value;
 
     use super::*;
-    use crate::ScriptBuf;
+    use crate::blockdata::script::ScriptBuf;
     use crate::consensus::encode::deserialize;
     use crate::hash_types::BlockHash;
     use crate::internal_macros::hex;

dash/src/blockdata/script/mod.rs

@@ -69,15 +69,15 @@ use crate::{OutPoint, io};
 mod borrowed;
 mod builder;
 mod instruction;
-mod owned;
+pub mod owned;
 mod push_bytes;
 #[cfg(test)]
 mod tests;
 
 pub use self::borrowed::*;
 pub use self::builder::*;
 pub use self::instruction::*;
-pub use self::owned::*;
+pub use self::owned::ScriptBuf;
 pub use self::push_bytes::*;
 
 /// Encodes an integer in script(minimal CScriptNum) format.

dash/src/blockdata/script/owned.rs

@@ -29,6 +29,7 @@ use crate::taproot::TapNodeHash;
 /// [deref coercions]: https://doc.rust-lang.org/std/ops/trait.Deref.html#more-on-deref-coercion
 #[derive(Default, Clone, PartialOrd, Ord, PartialEq, Eq, Hash)]
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub struct ScriptBuf(pub Vec<u8>);
 
 impl ScriptBuf {

dash/src/blockdata/transaction/mod.rs

@@ -41,7 +41,7 @@ use hashes::{Hash, sha256d};
 use crate::blockdata::constants::WITNESS_SCALE_FACTOR;
 #[cfg(feature = "bitcoinconsensus")]
 use crate::blockdata::script;
-use crate::blockdata::script::Script;
+use crate::blockdata::script::{Script, ScriptBuf};
 use crate::blockdata::transaction::hash_type::EcdsaSighashType;
 use crate::blockdata::transaction::special_transaction::{TransactionPayload, TransactionType};
 use crate::blockdata::transaction::txin::TxIn;
@@ -52,8 +52,8 @@ use crate::consensus::{Decodable, Encodable, encode};
 use crate::hash_types::{InputsHash, Txid, Wtxid};
 use crate::prelude::*;
 use crate::sighash::LegacySighash;
-pub use crate::transaction::outpoint::*;
-use crate::{ScriptBuf, Weight, io};
+pub use self::outpoint::OutPoint;
+use crate::{Weight, io};
 
 /// Used for signature hash for invalid use of SIGHASH_SINGLE.
 const UINT256_ONE: [u8; 32] = [
@@ -165,6 +165,7 @@ impl<E> EncodeSigningDataResult<E> {
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub struct Transaction {
     /// The protocol version, is currently expected to be 1 or 2 (BIP 68).
     pub version: u16,
@@ -178,29 +179,8 @@ pub struct Transaction {
     pub special_transaction_payload: Option<TransactionPayload>,
 }
 
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 impl Transaction {
-    /// Computes a "normalized TXID" which does not include any signatures.
-    /// This gives a way to identify a transaction that is "the same" as
-    /// another in the sense of having same inputs and outputs.
-    pub fn ntxid(&self) -> sha256d::Hash {
-        let cloned_tx = Transaction {
-            version: self.version,
-            lock_time: self.lock_time,
-            input: self
-                .input
-                .iter()
-                .map(|txin| TxIn {
-                    script_sig: ScriptBuf::new(),
-                    witness: Witness::default(),
-                    ..*txin
-                })
-                .collect(),
-            output: self.output.clone(),
-            special_transaction_payload: self.special_transaction_payload.clone(),
-        };
-        cloned_tx.txid().into()
-    }
-
     /// Computes the txid. For non-segwit transactions this will be identical
     /// to the output of `wtxid()`, but for segwit transactions,
     /// this will give the correct txid (not including witnesses) while `wtxid`
@@ -228,6 +208,36 @@ impl Transaction {
         TransactionType::from_optional_payload(&self.special_transaction_payload)
     }
 
+    /// Is this a coin base transaction?
+    pub fn is_coin_base(&self) -> bool {
+        self.input.len() == 1 && self.input[0].previous_output.is_null()
+    }
+
+}
+
+impl Transaction {
+    /// Computes a "normalized TXID" which does not include any signatures.
+    /// This gives a way to identify a transaction that is "the same" as
+    /// another in the sense of having same inputs and outputs.
+    pub fn ntxid(&self) -> sha256d::Hash {
+        let cloned_tx = Transaction {
+            version: self.version,
+            lock_time: self.lock_time,
+            input: self
+                .input
+                .iter()
+                .map(|txin| TxIn {
+                    script_sig: ScriptBuf::new(),
+                    witness: Witness::default(),
+                    ..*txin
+                })
+                .collect(),
+            output: self.output.clone(),
+            special_transaction_payload: self.special_transaction_payload.clone(),
+        };
+        cloned_tx.txid().into()
+    }
+
     /// Computes SegWit-version of the transaction id (wtxid). For transaction with the witness
     /// data this hash includes witness, for pre-witness transaction it is equal to the normal
     /// value returned by txid() function.
@@ -556,11 +566,6 @@ impl Transaction {
         Ok(())
     }
 
-    /// Is this a coin base transaction?
-    pub fn is_coin_base(&self) -> bool {
-        self.input.len() == 1 && self.input[0].previous_output.is_null()
-    }
-
     /// Returns `true` if the transaction itself opted in to be BIP-125-replaceable (RBF). This
     /// **does not** cover the case where a transaction becomes replaceable due to ancestors being
     /// RBF.

dash/src/blockdata/transaction/outpoint.rs

@@ -35,6 +35,7 @@ use crate::io;
 /// A reference to a transaction output.
 #[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub struct OutPoint {
     /// The referenced transaction's txid.
     pub txid: Txid,
@@ -68,6 +69,7 @@ impl From<OutPoint> for [u8; 36] {
     }
 }
 
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 impl OutPoint {
     /// Creates a new [`OutPoint`].
     #[inline]

dash/src/blockdata/transaction/special_transaction/asset_lock.rs

@@ -27,7 +27,7 @@ use bincode::{Decode, Encode};
 
 use crate::consensus::{Decodable, Encodable, encode};
 use crate::prelude::*;
-use crate::transaction::txout::TxOut;
+use crate::blockdata::transaction::txout::TxOut;
 use crate::{VarInt, io};
 
 /// An Asset Lock payload. This is contained as the payload of an asset lock special transaction.
@@ -41,11 +41,13 @@ use crate::{VarInt, io};
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub struct AssetLockPayload {
     pub version: u8,
     pub credit_outputs: Vec<TxOut>,
 }
 
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 impl AssetLockPayload {
     /// The size of the payload in bytes.
     pub fn size(&self) -> usize {

dash/src/blockdata/transaction/special_transaction/asset_unlock/qualified_asset_unlock.rs

@@ -51,6 +51,7 @@ pub const ASSET_UNLOCK_TX_SIZE: usize = 190;
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub struct AssetUnlockPayload {
     /// The base information about the asset unlock. This base information is the information that
     /// should be put into a queue.

dash/src/blockdata/transaction/special_transaction/asset_unlock/request_info.rs

@@ -35,6 +35,7 @@ use crate::prelude::*;
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub struct AssetUnlockRequestInfo {
     /// The core request height of the transaction. This should match a period where the quorum_hash
     /// is still active

dash/src/blockdata/transaction/special_transaction/asset_unlock/unqualified_asset_unlock.rs

@@ -25,20 +25,23 @@
 #[cfg(feature = "bincode")]
 use bincode::{Decode, Encode};
 
+use crate::blockdata::script::ScriptBuf;
 use crate::blockdata::transaction::special_transaction::TransactionType;
 use crate::blockdata::transaction::special_transaction::TransactionType::AssetUnlock;
+use crate::blockdata::transaction::txin::TxIn;
+use crate::blockdata::transaction::txout::TxOut;
 use crate::consensus::{Decodable, Encodable, encode};
 use crate::hash_types::{PubkeyHash, ScriptHash};
 use crate::prelude::*;
-use crate::transaction::TxOut;
-use crate::{ScriptBuf, TxIn, VarInt, io};
+use crate::{VarInt, io};
 
 /// An Asset Unlock Base payload. This is the base payload of the Asset Unlock. In order to make
 /// it a full payload the request info should be added.
 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub struct AssetUnlockBasePayload {
     /// The payload protocol version, is currently expected to be 0.
     pub version: u8,

dash/src/blockdata/transaction/special_transaction/coinbase.rs

@@ -35,6 +35,7 @@ use crate::io::{Error, ErrorKind};
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub struct CoinbasePayload {
     pub version: u16,
     pub height: u32,
@@ -45,6 +46,7 @@ pub struct CoinbasePayload {
     pub asset_locked_amount: Option<u64>,
 }
 
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 impl CoinbasePayload {
     /// The size of the payload in bytes.
     /// version(2) + height(4) + merkle_root_masternode_list(32) + merkle_root_quorums(32)

dash/src/blockdata/transaction/special_transaction/mod.rs

@@ -64,6 +64,7 @@ pub mod quorum_commitment;
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub enum TransactionPayload {
     /// A wrapper for a Masternode Registration payload
     ProviderRegistrationPayloadType(ProviderRegistrationPayload),
@@ -98,6 +99,7 @@ impl Encodable for TransactionPayload {
     }
 }
 
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 impl TransactionPayload {
     /// Gets the Transaction Type for a Special Transaction Payload
     pub fn get_type(&self) -> TransactionType {
@@ -128,6 +130,9 @@ impl TransactionPayload {
         }
     }
 
+}
+impl TransactionPayload {
+
     /// Convenience method that assumes the payload to be a provider registration payload to get it
     /// easier.
     /// Errors if it is not a provider registration payload.
@@ -254,6 +259,7 @@ impl TransactionPayload {
 ///
 #[derive(Clone, Copy, PartialEq, Eq)]
 #[repr(u16)]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub enum TransactionType {
     /// A Classic transaction
     Classic = 0,

dash/src/blockdata/transaction/special_transaction/provider_registration.rs

@@ -42,17 +42,20 @@ use hashes::Hash;
 use internals::hex::Case::Lower;
 
 use crate::address::Payload;
+use crate::blockdata::script::ScriptBuf;
+use crate::blockdata::transaction::OutPoint;
 use crate::blockdata::transaction::special_transaction::SpecialTransactionBasePayloadEncodable;
 use crate::bls_sig_utils::BLSPublicKey;
 use crate::consensus::{Decodable, Encodable, encode};
 use crate::hash_types::{InputsHash, PubkeyHash, SpecialTransactionPayloadHash};
 use crate::prelude::*;
-use crate::{Address, Network, OutPoint, ScriptBuf, VarInt, io};
+use crate::{Address, Network, VarInt, io};
 
 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Debug, Hash, Copy)]
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub enum ProviderMasternodeType {
     Regular = 0,
     HighPerformance = 1,
@@ -97,6 +100,7 @@ impl Decodable for ProviderMasternodeType {
 #[cfg_attr(feature = "bincode", derive(Encode, Decode))]
 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 #[cfg_attr(feature = "serde", serde(crate = "actual_serde"))]
+#[cfg_attr(feature = "apple", ferment_macro::export)]
 pub struct ProviderRegistrationPayload {
     pub version: u16,
     pub masternode_type: ProviderMasternodeType,
@@ -114,7 +118,23 @@ pub struct ProviderRegistrationPayload {
     pub platform_p2p_port: Option<u16>,
     pub platform_http_port: Option<u16>,
 }
-
+#[cfg_attr(feature = "apple", ferment_macro::export)]
+impl ProviderRegistrationPayload {
+    /// The size of the payload in bytes.
+    /// version(2) + provider_type(2) + provider_mode(2) + collateral_outpoint(32 + 4) + ip_address(16) +
+    /// port(2) + owner_key_hash(20) + operator_public_key(48) + voting_key_hash(20) + operator_reward(2) +
+    /// script_payout(VarInt(script_payout_len).len() + script_payout_len) +
+    /// inputs_hash(32) +
+    /// payload_sig(VarInt(payload_sig_len).len() + payload_sig_len)
+    pub fn size(&self) -> usize {
+        let mut size = 2 + 2 + 2 + 32 + 4 + 16 + 2 + 20 + 48 + 20 + 2 + 32; // 182 bytes
+        let script_payout_len = self.script_payout.0.len();
+        let signature_len = self.signature.len();
+        size += VarInt(script_payout_len as u64).len() + script_payout_len;
+        size += VarInt(signature_len as u64).len() + signature_len;
+        size
+    }
+}
 impl ProviderRegistrationPayload {
     /// A convenience method to get the address from payout script
     pub fn payout_address(&self, network: Network) -> Result<Address, encode::Error> {
@@ -149,21 +169,6 @@ impl ProviderRegistrationPayload {
             base_payload_hash.as_byte_array().to_hex_string(Lower)
         ))
     }
-
-    /// The size of the payload in bytes.
-    /// version(2) + provider_type(2) + provider_mode(2) + collateral_outpoint(32 + 4) + ip_address(16) +
-    /// port(2) + owner_key_hash(20) + operator_public_key(48) + voting_key_hash(20) + operator_reward(2) +
-    /// script_payout(VarInt(script_payout_len).len() + script_payout_len) +
-    /// inputs_hash(32) +
-    /// payload_sig(VarInt(payload_sig_len).len() + payload_sig_len)
-    pub fn size(&self) -> usize {
-        let mut size = 2 + 2 + 2 + 32 + 4 + 16 + 2 + 20 + 48 + 20 + 2 + 32; // 182 bytes
-        let script_payout_len = self.script_payout.0.len();
-        let signature_len = self.signature.len();
-        size += VarInt(script_payout_len as u64).len() + script_payout_len;
-        size += VarInt(signature_len as u64).len() + signature_len;
-        size
-    }
 }
 
 impl SpecialTransactionBasePayloadEncodable for ProviderRegistrationPayload {