// lib.rs
//
// 此部分代码主要负责Rust-C两侧的数据内存结构转换，提供了C侧的函数接口。注意命名规范：
// 在C侧使用时，凡是函数名带有 '_cwallet'的，调用过之后都必须用'free_cwallet'释放内存，
// 否则导致内存泄漏
// 

use std::ffi::{CStr, CString};
use std::os::raw::c_char;

mod wallet;

use wallet_impl::Wallet;

use crate::wallet::*;

#[cfg(target_os = "android")]
mod android;

#[repr(C)]
pub struct CWallet {
    pub public_key: *mut c_char,
    pub private_key: *mut c_char,
    pub public_addr: *mut c_char,
}

#[no_mangle]
pub unsafe extern "C" fn generate_cwallet() -> CWallet {
    println!("generating wallet");
    let (secret_key, pub_key) = wallet_impl::generate_keypair();

    // println!("secret key: {}", &secret_key.to_string());
    // println!("public key: {}", &pub_key.to_string());

    //let pub_address = eth_wallet::public_key_address(&pub_key);
    //println!("public address: {:?}", pub_address);

    let rust_wallet = wallet_impl::Wallet::new(&secret_key, &pub_key);
    println!("rust_wallet: {:?}", &rust_wallet);

    convert_to_cwallet(rust_wallet)
}

#[no_mangle]
pub unsafe extern "C" fn free_cwallet(cw: CWallet) {
    drop(CString::from_raw(cw.public_key));
    drop(CString::from_raw(cw.private_key));
    drop(CString::from_raw(cw.public_addr));
}

#[no_mangle]
pub unsafe extern "C" fn save_wallet(cw: &CWallet) {
    let rwallet = convert_to_rwallet(cw);
    wallet_impl::Wallet::save_keys(&rwallet, "wallet.json").unwrap();
}

#[no_mangle]
pub unsafe extern "C" fn fetch_cwallet() -> CWallet {
    match wallet_impl::Wallet::retrieve_keys("wallet.json") {
        Err(_) => {
            let wallet = wallet_impl::Wallet {
                secret_key: "".to_string(),
                public_key: "".to_string(),
                public_address: "".to_string(),
            };
            return convert_to_cwallet(wallet)
        }
        Ok(w) => return convert_to_cwallet(w)
    };
}

unsafe fn convert_to_cwallet(rwallet: Wallet) -> CWallet {
   // 转换Rust字符串数据为C的字符串并移交ownership
   let pubkey = CString::new(rwallet.public_key).unwrap();
   let c_pubkey: *mut c_char = pubkey.into_raw();
   let seckey = CString::new(rwallet.secret_key).unwrap();
   let c_seckey: *mut c_char = seckey.into_raw();
   let pubaddr = CString::new(rwallet.public_address).unwrap();
   let c_pubaddr: *mut c_char = pubaddr.into_raw();

   //println!("crypto wallet address: {}", CStr::from_ptr(c_pubaddr).to_str().unwrap());

   let cw = CWallet {
       public_key: c_pubkey,
       private_key: c_seckey,
       public_addr: c_pubaddr,
   };
   
      //println!("crypto_wallet addr: {}", CStr::from_ptr(cw.public_addr).to_str().unwrap());

   cw
}

unsafe fn convert_to_rwallet(cwallet: &CWallet) -> Wallet {

    let a = CStr::from_ptr(cwallet.public_addr);
    let pa = a.to_str().unwrap();

    let pk = CStr::from_ptr(cwallet.public_key);
    let ppk = pk.to_str().unwrap();

    let sk = CStr::from_ptr(cwallet.private_key);
    let psk = sk.to_str().unwrap();

    Wallet {
        secret_key: psk.to_string(),
        public_key: ppk.to_string(),
        public_address: pa.to_string(),
    }
}

这部分代码的 tricks 是什么呢？挑重点讲：

• 用"#[repr(C)]"来标识我们要输出到 C 侧的数据结构，如 CWallet。它在 wallet_impl 里面有一个对应的 Wallet，用的都是 Rust 的数据类型，例如String。但是到了 C 侧，需要变成以"\0"结束的字符串表示方式。其他任何 Rust 的数据类型或者 struct 结构，如果要输出被外部以“C style”去调用，首先得把函数的输入参数、返回值都“翻译”成 C 侧能“理解”的结构；
• 用"#[no_managle]"来标识要输出到 C 侧的函数，防止 Rust 编译器在编译过程中把函数名进行改变；
• Rust 侧的一个字符串如果要作为返回值输送至 C 侧供其使用，需要把所谓的ownership 也转交过去（否则 Rust 函数在结束执行退出前会把内存清除释放，交到 C 侧变成空指针），这里一个重要手段是用 Rust FFI 提供的CString::into_raw()函数，把一个 Rust 字符串转化成 C 的指针；
• 对应于上述每一个 CString::into_raw()的调用，必须有一个CString::from_raw()的调用，以便于把 C 侧的字符串内存的 ownership 返还给 Rust 侧，由 Rust 侧释放掉；
• C 侧的使用者，在调用完 generate_wallet 的接口获得一个 CWallet 后，不得改变 CWallet 中几个字符串的长度，且事后必须使用 free_wallet 去告知 Rust 侧对内存释放，否则会导致内存泄漏；

上述几点确实有点“别扭”，这和 C 侧以及 Rust 侧的内存管理模型的差异有关，其中Rust 内存模型的“所有权”（ownership）设计让一些事情变得复杂。确实，用 Rust语言开发的过程往往是和编译器博弈的过程，这背后的逻辑是，我们宁愿把痛苦控制在开发编译阶段，换取生产运行阶段的安全稳定、精神安宁。

最后，我们来写一个测试程序，命令行验证一下能正常运行，在 examples 目录下，编辑一个 test.rs 文件：

//test.rs
// 
// 测试在Rust侧生成钱包密钥对，转换成C侧的数据结构。
// 测试钱包在C侧调用接口存储和重新读出钱包密钥
//

use std::ffi::{CStr};
//use rustylib::gen::{CWallet};
use rustywallet::{CWallet, generate_cwallet, free_cwallet, save_wallet, fetch_cwallet};

fn main() {

    unsafe {
        let wallet: CWallet = generate_cwallet();
        println!("---- generated a wallet to be used on C-side ----");
        print_wallet(&wallet);

        println!("---- saving the wallet to wallet.json ----");
        save_wallet(&wallet);
        println!("---- saved! ----");

        println!("---- fetching the saved wallet to be exposed to C-side ----");
        let fetched = fetch_cwallet();
        print_wallet(&fetched);

        free_cwallet(wallet);  // 对应 generate_cwallet()
        free_cwallet(fetched); // 对应 fetch_wallet()
    }
}

unsafe fn print_wallet(wallet: &CWallet) {
    let a = CStr::from_ptr(wallet.public_addr);
    let pa = a.to_str().unwrap();
    println!("public address=> {}", pa);

    let pk = CStr::from_ptr(wallet.public_key);
    let ppk = pk.to_str().unwrap();
    println!("public key=> {}", ppk);

    let sk = CStr::from_ptr(wallet.private_key);
    let psk = sk.to_str().unwrap();
    println!("private key=> {}", psk);
}

cargo run --example test

Compiling rust-crypto-wallet v0.1.0 (/Users/cliang/rusty/finclip-rust/rust-wallet)
Finished dev [unoptimized + debuginfo] target(s) in 14.82s
Running `target/debug/examples/test`
generating wallet
rust_wallet: Wallet { secret_key: "0cb5fe0b77a75a43c5d5aac449df17c1849ef39da6134419c7416ef79304e5bb", public_key: "03b03e2bde039d222cb8b9bc36d9919323485ae495916d8c234c6910c75ad4e1c5", public_address: "0x1a2c83981ab4679d10b7889f9f97028265991c8f" }
---- generated a wallet to be used on C-side ----
public address=> 0x1a2c83981ab4679d10b7889f9f97028265991c8f
public key=> 03b03e2bde039d222cb8b9bc36d9919323485ae495916d8c234c6910c75ad4e1c5
private key=> 0cb5fe0b77a75a43c5d5aac449df17c1849ef39da6134419c7416ef79304e5bb
---- saving the wallet to wallet.json ----
---- saved! ----
---- fetching the saved wallet to be exposed to C-side ----
public address=> 0x1a2c83981ab4679d10b7889f9f97028265991c8f
public key=> 03b03e2bde039d222cb8b9bc36d9919323485ae495916d8c234c6910c75ad4e1c5
private key=> 0cb5fe0b77a75a43c5d5aac449df17c1849ef39da6134419c7416ef79304e5bb

cargo lipo --release

cbindgen src/lib.rs -l c > rustywallet.h