Replace type resolution assertions with failures
[ldk-c-bindings] / c-bindings-gen / src / types.rs
index 64f2a688adf2441b51b196da4ffe5fb7b60933a8..b92ca77c397c6d5af0b9e26098be36bafc527d72 100644 (file)
@@ -134,7 +134,7 @@ pub fn export_status(attrs: &[syn::Attribute]) -> ExportStatus {
                match token_iter.next().unwrap() {
                        TokenTree::Literal(lit) => {
                                let line = format!("{}", lit);
-                               if line.contains("(C-not exported)") {
+                               if line.contains("(C-not exported)") || line.contains("This is not exported to bindings users") {
                                        return ExportStatus::NoExport;
                                } else if line.contains("(C-not implementable)") {
                                        return ExportStatus::NotImplementable;
@@ -810,6 +810,7 @@ fn initial_clonable_types() -> HashSet<String> {
        res.insert("crate::c_types::PublicKey".to_owned());
        res.insert("crate::c_types::Transaction".to_owned());
        res.insert("crate::c_types::Witness".to_owned());
+       res.insert("crate::c_types::WitnessVersion".to_owned());
        res.insert("crate::c_types::TxOut".to_owned());
        res.insert("crate::c_types::Signature".to_owned());
        res.insert("crate::c_types::RecoverableSignature".to_owned());
@@ -977,6 +978,8 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "str" if is_ref => Some("crate::c_types::Str"),
                        "alloc::string::String"|"String" => Some("crate::c_types::Str"),
 
+                       "bitcoin::Address" => Some("crate::c_types::Str"),
+
                        "std::time::Duration"|"core::time::Duration" => Some("u64"),
                        "std::time::SystemTime" => Some("u64"),
                        "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some("crate::c_types::IOError"),
@@ -1007,24 +1010,30 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 
                        "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice"),
                        "bitcoin::blockdata::script::Script" if !is_ref => Some("crate::c_types::derived::CVec_u8Z"),
-                       "bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
+                       "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some("crate::lightning::chain::transaction::OutPoint"),
                        "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction"),
                        "bitcoin::Witness" => Some("crate::c_types::Witness"),
-                       "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
+                       "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut"),
                        "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network"),
                        "bitcoin::util::address::WitnessVersion" => Some("crate::c_types::WitnessVersion"),
                        "bitcoin::blockdata::block::BlockHeader" if is_ref  => Some("*const [u8; 80]"),
                        "bitcoin::blockdata::block::Block" if is_ref  => Some("crate::c_types::u8slice"),
 
-                       "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::ScriptHash"
+                       "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
+                       "bitcoin::hash_types::WPubkeyHash"|
+                       "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
+                               if !is_ref => Some("crate::c_types::TwentyBytes"),
+                       "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
+                       "bitcoin::hash_types::WPubkeyHash"|
+                       "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
                                if is_ref => Some("*const [u8; 20]"),
                        "bitcoin::hash_types::WScriptHash"
                                if is_ref => Some("*const [u8; 32]"),
 
                        // Newtypes that we just expose in their original form.
-                       "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
+                       "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
                                if is_ref  => Some("*const [u8; 32]"),
-                       "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
+                       "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
                                if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
                        "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes"),
                        "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
@@ -1095,6 +1104,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(""),
                        "bitcoin::secp256k1::SecretKey" if is_ref => Some("&::bitcoin::secp256k1::SecretKey::from_slice(&unsafe { *"),
                        "bitcoin::secp256k1::SecretKey" if !is_ref => Some(""),
+                       "bitcoin::secp256k1::Scalar" if is_ref => Some("&"),
                        "bitcoin::secp256k1::Scalar" if !is_ref => Some(""),
                        "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("::bitcoin::secp256k1::ecdh::SharedSecret::from_bytes("),
 
@@ -1104,18 +1114,22 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(""),
                        "bitcoin::Witness" if is_ref => Some("&"),
                        "bitcoin::Witness" => Some(""),
-                       "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
-                       "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
+                       "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::C_to_bitcoin_outpoint("),
+                       "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(""),
                        "bitcoin::network::constants::Network" => Some(""),
                        "bitcoin::util::address::WitnessVersion" => Some(""),
                        "bitcoin::blockdata::block::BlockHeader" => Some("&::bitcoin::consensus::encode::deserialize(unsafe { &*"),
                        "bitcoin::blockdata::block::Block" if is_ref => Some("&::bitcoin::consensus::encode::deserialize("),
 
-                       "bitcoin::hash_types::PubkeyHash" if is_ref =>
+                       "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash" if !is_ref =>
+                               Some("bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner("),
+                       "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash" if is_ref =>
                                Some("&bitcoin::hash_types::PubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
                        "bitcoin::hash_types::WPubkeyHash" if is_ref =>
                                Some("&bitcoin::hash_types::WPubkeyHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
-                       "bitcoin::hash_types::ScriptHash" if is_ref =>
+                       "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash" if !is_ref =>
+                               Some("bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner("),
+                       "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash" if is_ref =>
                                Some("&bitcoin::hash_types::ScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
                        "bitcoin::hash_types::WScriptHash" if is_ref =>
                                Some("&bitcoin::hash_types::WScriptHash::from_hash(bitcoin::hashes::Hash::from_inner(unsafe { *"),
@@ -1123,7 +1137,8 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        // Newtypes that we just expose in their original form.
                        "bitcoin::hash_types::Txid" if is_ref => Some("&::bitcoin::hash_types::Txid::from_slice(&unsafe { &*"),
                        "bitcoin::hash_types::Txid" if !is_ref => Some("::bitcoin::hash_types::Txid::from_slice(&"),
-                       "bitcoin::hash_types::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
+                       "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" => Some("::bitcoin::hash_types::BlockHash::from_slice(&"),
+                       "bitcoin::blockdata::constants::ChainHash" => Some("::bitcoin::blockdata::constants::ChainHash::from(&"),
                        "lightning::ln::PaymentHash" if !is_ref => Some("::lightning::ln::PaymentHash("),
                        "lightning::ln::PaymentHash" if is_ref => Some("&::lightning::ln::PaymentHash(unsafe { *"),
                        "lightning::ln::PaymentPreimage" if !is_ref => Some("::lightning::ln::PaymentPreimage("),
@@ -1188,28 +1203,34 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some(".into_rust()"),
                        "bitcoin::secp256k1::SecretKey" if !is_ref => Some(".into_rust()"),
                        "bitcoin::secp256k1::SecretKey" if is_ref => Some("}[..]).unwrap()"),
-                       "bitcoin::secp256k1::Scalar" if !is_ref => Some(".into_rust()"),
+                       "bitcoin::secp256k1::Scalar" => Some(".into_rust()"),
                        "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some(".data)"),
 
                        "bitcoin::blockdata::script::Script" if is_ref => Some(".to_slice()))"),
                        "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_rust())"),
                        "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(".into_bitcoin()"),
                        "bitcoin::Witness" => Some(".into_bitcoin()"),
-                       "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
-                       "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
+                       "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some(")"),
+                       "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(".into_rust()"),
                        "bitcoin::network::constants::Network" => Some(".into_bitcoin()"),
                        "bitcoin::util::address::WitnessVersion" => Some(".into()"),
                        "bitcoin::blockdata::block::BlockHeader" => Some(" }).unwrap()"),
                        "bitcoin::blockdata::block::Block" => Some(".to_slice()).unwrap()"),
 
-                       "bitcoin::hash_types::PubkeyHash"|"bitcoin::hash_types::WPubkeyHash"|
-                       "bitcoin::hash_types::ScriptHash"|"bitcoin::hash_types::WScriptHash"
+                       "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
+                       "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
+                       "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
+                               if !is_ref => Some(".data))"),
+                       "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
+                       "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
+                       "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
                                if is_ref => Some(" }.clone()))"),
 
                        // Newtypes that we just expose in their original form.
                        "bitcoin::hash_types::Txid" if is_ref => Some(" }[..]).unwrap()"),
                        "bitcoin::hash_types::Txid" => Some(".data[..]).unwrap()"),
-                       "bitcoin::hash_types::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
+                       "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" if !is_ref => Some(".data[..]).unwrap()"),
+                       "bitcoin::blockdata::constants::ChainHash" if !is_ref => Some(".data[..])"),
                        "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
                        |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
                        |"lightning::chain::keysinterface::KeyMaterial"
@@ -1265,6 +1286,8 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "str" if is_ref => Some(""),
                        "alloc::string::String"|"String" => Some(""),
 
+                       "bitcoin::Address" => Some("alloc::string::ToString::to_string(&"),
+
                        "std::time::Duration"|"core::time::Duration" => Some(""),
                        "std::time::SystemTime" => Some(""),
                        "std::io::Error"|"lightning::io::Error" => Some("crate::c_types::IOError::from_rust("),
@@ -1289,7 +1312,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "bitcoin::secp256k1::ecdsa::RecoverableSignature" => Some("crate::c_types::RecoverableSignature::from_rust(&"),
                        "bitcoin::secp256k1::SecretKey" if is_ref => Some(""),
                        "bitcoin::secp256k1::SecretKey" if !is_ref => Some("crate::c_types::SecretKey::from_rust("),
-                       "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar::from_rust("),
+                       "bitcoin::secp256k1::Scalar" if !is_ref => Some("crate::c_types::BigEndianScalar::from_rust(&"),
                        "bitcoin::secp256k1::ecdh::SharedSecret" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
 
                        "bitcoin::blockdata::script::Script" if is_ref => Some("crate::c_types::u8slice::from_slice(&"),
@@ -1298,8 +1321,8 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some("crate::c_types::Transaction::from_bitcoin(&"),
                        "bitcoin::Witness" if is_ref => Some("crate::c_types::Witness::from_bitcoin("),
                        "bitcoin::Witness" if !is_ref => Some("crate::c_types::Witness::from_bitcoin(&"),
-                       "bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
-                       "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
+                       "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some("crate::c_types::bitcoin_to_C_outpoint("),
+                       "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some("crate::c_types::TxOut::from_rust("),
                        "bitcoin::network::constants::Network" => Some("crate::bitcoin::network::Network::from_bitcoin("),
                        "bitcoin::util::address::WitnessVersion" => Some(""),
                        "bitcoin::blockdata::block::BlockHeader" if is_ref => Some("&local_"),
@@ -1307,10 +1330,15 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 
                        "bitcoin::hash_types::Txid" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
 
+                       "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
+                       "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
+                       "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
+                               if !is_ref => Some("crate::c_types::TwentyBytes { data: "),
+
                        // Newtypes that we just expose in their original form.
-                       "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
+                       "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
                                if is_ref => Some(""),
-                       "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
+                       "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"|"bitcoin::blockdata::constants::ChainHash"
                                if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
                        "bitcoin::secp256k1::Message" if !is_ref => Some("crate::c_types::ThirtyTwoBytes { data: "),
                        "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
@@ -1352,6 +1380,8 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "alloc::string::String"|"String" if is_ref => Some(".as_str().into()"),
                        "alloc::string::String"|"String" => Some(".into()"),
 
+                       "bitcoin::Address" => Some(").into()"),
+
                        "std::time::Duration"|"core::time::Duration" => Some(".as_secs()"),
                        "std::time::SystemTime" => Some(".duration_since(::std::time::SystemTime::UNIX_EPOCH).expect(\"Times must be post-1970\").as_secs()"),
                        "std::io::Error"|"lightning::io::Error"|"lightning::io::ErrorKind" => Some(")"),
@@ -1382,8 +1412,8 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        "bitcoin::blockdata::script::Script" if !is_ref => Some(".into_bytes().into()"),
                        "bitcoin::blockdata::transaction::Transaction"|"bitcoin::Transaction" => Some(")"),
                        "bitcoin::Witness" => Some(")"),
-                       "bitcoin::blockdata::transaction::OutPoint" => Some(")"),
-                       "bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
+                       "bitcoin::OutPoint"|"bitcoin::blockdata::transaction::OutPoint" => Some(")"),
+                       "bitcoin::TxOut"|"bitcoin::blockdata::transaction::TxOut" if !is_ref => Some(")"),
                        "bitcoin::network::constants::Network" => Some(")"),
                        "bitcoin::util::address::WitnessVersion" => Some(".into()"),
                        "bitcoin::blockdata::block::BlockHeader" if is_ref => Some(""),
@@ -1391,11 +1421,18 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
 
                        "bitcoin::hash_types::Txid" if !is_ref => Some(".into_inner() }"),
 
+                       "bitcoin::PubkeyHash"|"bitcoin::hash_types::PubkeyHash"|
+                       "bitcoin::hash_types::WPubkeyHash"|"bitcoin::hash_types::WScriptHash"|
+                       "bitcoin::ScriptHash"|"bitcoin::hash_types::ScriptHash"
+                               if !is_ref => Some(".as_hash().into_inner() }"),
+
                        // Newtypes that we just expose in their original form.
-                       "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
+                       "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
                                if is_ref => Some(".as_inner()"),
-                       "bitcoin::hash_types::Txid"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
+                       "bitcoin::hash_types::Txid"|"bitcoin::BlockHash"|"bitcoin::hash_types::BlockHash"|"bitcoin_hashes::sha256::Hash"
                                if !is_ref => Some(".into_inner() }"),
+                       "bitcoin::blockdata::constants::ChainHash" if is_ref => Some(".as_bytes() }"),
+                       "bitcoin::blockdata::constants::ChainHash" if !is_ref => Some(".to_bytes() }"),
                        "bitcoin::secp256k1::Message" if !is_ref => Some(".as_ref().clone() }"),
                        "lightning::ln::PaymentHash"|"lightning::ln::PaymentPreimage"|"lightning::ln::PaymentSecret"
                        |"lightning::ln::channelmanager::PaymentId"|"lightning::ln::channelmanager::InterceptId"
@@ -1498,7 +1535,7 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                        "lightning::ln::PaymentHash" => true,
                                                        "lightning::ln::PaymentPreimage" => true,
                                                        "lightning::ln::channelmanager::PaymentId" => true,
-                                                       "bitcoin::hash_types::BlockHash" => true,
+                                                       "bitcoin::hash_types::BlockHash"|"bitcoin::BlockHash" => true,
                                                        "secp256k1::PublicKey"|"bitcoin::secp256k1::PublicKey" => true,
                                                        _ => false,
                                                }
@@ -2648,10 +2685,16 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                        } else if let syn::Type::Path(p_arg) = t {
                                if let Some(resolved) = self.maybe_resolve_path(&p_arg.path, generics) {
                                        if !self.is_primitive(&resolved) {
-                                               assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
+                                               if is_ref {
+                                                       // We don't currently support outer reference types for non-primitive inners
+                                                       return false;
+                                               }
                                        }
                                } else {
-                                       assert!(!is_ref); // We don't currently support outer reference types for non-primitive inners
+                                       if is_ref {
+                                               // We don't currently support outer reference types for non-primitive inners
+                                               return false;
+                                       }
                                }
                                if !self.write_c_type_intern(w, t, generics, false, false, false, true, true) { return false; }
                        } else {
@@ -2817,6 +2860,13 @@ impl<'a, 'c: 'a> TypeResolver<'a, 'c> {
                                                                if let syn::Type::Path(p) = &*refelem.elem {
                                                                        write_path!(p, Some(&mut mangled_tuple_type));
                                                                } else { return false; }
+                                                       } else if let syn::Type::Array(_) = elem {
+                                                               let mut resolved = Vec::new();
+                                                               if !self.write_c_type_intern(&mut resolved, &elem, generics, false, false, true, false, true) { return false; }
+                                                               let array_inner = String::from_utf8(resolved).unwrap();
+                                                               let arr_name = array_inner.split("::").last().unwrap();
+                                                               write!(w, "{}", arr_name).unwrap();
+                                                               write!(mangled_type, "{}", arr_name).unwrap();
                                                        } else { return false; }
                                                }
                                                write!(w, "Z").unwrap();