1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
pub mod settings;
pub mod time;
use std::{
ffi::{CStr, CString},
os::raw::c_char,
};
pub use wallet::Settings as SettingsRust;
use wallet_core::c::{
fragment::{fragment_delete, fragment_from_raw, fragment_id},
spending_counters_delete, symmetric_cipher_decrypt,
time::BlockDate,
vote, wallet_delete_error, wallet_delete_proposal, wallet_delete_settings,
wallet_delete_wallet, wallet_id, wallet_import_keys, wallet_set_state,
wallet_spending_counters, wallet_total_value, wallet_vote_cast, SpendingCounters,
TransactionOut,
};
use wallet_core::{
Error as ErrorRust, Fragment as FragmentRust, Proposal as ProposalRust, Wallet as WalletRust,
};
#[repr(C)]
pub struct Wallet {}
#[repr(C)]
pub struct Settings {}
#[repr(C)]
pub struct Proposal {}
#[repr(C)]
pub struct Fragment;
#[repr(C)]
pub struct Error {}
#[repr(C)]
pub struct EncryptingVoteKey {}
pub type WalletPtr = *mut Wallet;
pub type SettingsPtr = *mut Settings;
pub type ProposalPtr = *mut Proposal;
pub type FragmentPtr = *mut Fragment;
pub type ErrorPtr = *mut Error;
pub type EncryptingVoteKeyPtr = *mut EncryptingVoteKey;
/// recover a wallet from an account and a list of utxo keys
///
/// You can also use this function to recover a wallet even after you have
/// transferred all the funds to the new format (see the _convert_ function)
///
/// The recovered wallet will be returned in `wallet_out`.
///
/// # parameters
///
/// * account_key: the Ed25519 extended key used wallet's account address private key
/// in the form of a 64 bytes array.
/// * utxo_keys: an array of Ed25519 extended keys in the form of 64 bytes, used as utxo
/// keys for the wallet
/// * utxo_keys_len: the number of keys in the utxo_keys array (not the number of bytes)
/// * wallet_out: the recovered wallet
///
/// # Safety
///
/// This function dereference raw pointers (password and wallet_out). Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
/// # errors
///
/// The function may fail if:
///
/// * the `wallet_out` is null pointer
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_import_keys(
account_key: *const u8,
wallet_out: *mut WalletPtr,
) -> ErrorPtr {
let r = wallet_import_keys(account_key, wallet_out as *mut *mut WalletRust);
r.into_c_api() as ErrorPtr
}
/// get the wallet id
///
/// This ID is the identifier to use against the blockchain/explorer to retrieve
/// the state of the wallet (counter, total value etc...)
///
/// # Parameters
///
/// * wallet: the recovered wallet (see recover function);
/// * id_out: a ready allocated pointer to an array of 32bytes. If this array is not
/// 32bytes this may result in a buffer overflow.
///
/// # Safety
///
/// This function dereference raw pointers (wallet, block0 and settings_out). Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
/// the `id_out` needs to be ready allocated 32bytes memory. If not this will result
/// in an undefined behavior, in the best scenario it will be a buffer overflow.
///
/// # Errors
///
/// On error the function returns a `ErrorPtr`. On success `NULL` is returned.
/// The `ErrorPtr` can then be observed to gathered details of the error.
/// Don't forget to call `iohk_jormungandr_wallet_delete_error` to free
/// the `ErrorPtr` from memory and avoid memory leaks.
///
/// * this function may fail if the wallet pointer is null;
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_id(
wallet: WalletPtr,
id_out: *mut u8,
) -> ErrorPtr {
wallet_id(wallet as *mut WalletRust, id_out).into_c_api() as ErrorPtr
}
/// get the current spending counters for the (only) account in this wallet
///
/// iohk_jormungandr_spending_counters_delete should be called to deallocate the memory when it's
/// not longer needed
///
/// # Errors
///
/// * this function may fail if the wallet pointer is null;
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_spending_counters(
wallet: WalletPtr,
spending_counters_ptr: *mut SpendingCounters,
) -> ErrorPtr {
wallet_spending_counters(wallet as *mut WalletRust, spending_counters_ptr).into_c_api()
as ErrorPtr
}
/// get the total value in the wallet
///
/// make sure to call `retrieve_funds` prior to calling this function
/// otherwise you will always have `0`
///
/// After calling this function the results is returned in the `total_out`.
///
/// # Errors
///
/// * this function may fail if the wallet pointer is null;
///
/// On error the function returns a `ErrorPtr`. On success `NULL` is returned.
/// The `ErrorPtr` can then be observed to gathered details of the error.
/// Don't forget to call `iohk_jormungandr_wallet_delete_error` to free
/// the `ErrorPtr` from memory and avoid memory leaks.
///
/// If the `total_out` pointer is null, this function does nothing
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_total_value(
wallet: WalletPtr,
total_out: *mut u64,
) -> ErrorPtr {
let r = wallet_total_value(wallet as *mut WalletRust, total_out);
r.into_c_api() as ErrorPtr
}
/// update the wallet account state
///
/// this is the value retrieved from any jormungandr endpoint that allows to query
/// for the account state. It gives the value associated to the account as well as
/// the counter.
///
/// It is important to be sure to have an updated wallet state before doing any
/// transactions otherwise future transactions may fail to be accepted by any
/// nodes of the blockchain because of invalid signature state.
///
/// # Errors
///
/// * this function may fail if the wallet pointer is null;
///
/// On error the function returns a `ErrorPtr`. On success `NULL` is returned.
/// The `ErrorPtr` can then be observed to gathered details of the error.
/// Don't forget to call `iohk_jormungandr_wallet_delete_error` to free
/// the `ErrorPtr` from memory and avoid memory leaks.
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_set_state(
wallet: WalletPtr,
value: u64,
counters: SpendingCounters,
) -> ErrorPtr {
let r = wallet_set_state(wallet as *mut WalletRust, value, counters);
r.into_c_api() as ErrorPtr
}
/// build the proposal object
///
/// # Errors
///
/// This function may fail if:
///
/// * `proposal_out` is null.
/// * `num_choices` is out of the allowed range.
///
/// # Safety
///
/// This function dereference raw pointers. Even though the function checks if
/// the pointers are null. Mind not to put random values in or you may see
/// unexpected behaviors.
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_vote_proposal_new_public(
vote_plan_id: *const u8,
index: u8,
num_choices: u8,
proposal_out: *mut ProposalPtr,
) -> ErrorPtr {
let r = vote::proposal_new(
vote_plan_id,
index,
num_choices,
vote::ProposalPublic,
proposal_out as *mut *mut ProposalRust,
);
r.into_c_api() as ErrorPtr
}
/// build the proposal object
///
/// * `vote_encryption_key`: a null terminated string (c-string) with the bech32
/// representation of the encryption vote key
///
/// # Errors
///
/// This function may fail if:
///
/// * `proposal_out` is null.
/// * `num_choices` is out of the allowed range.
///
/// # Safety
///
/// This function dereference raw pointers. Even though the function checks if
/// the pointers are null. Mind not to put random values in or you may see
/// unexpected behaviors.
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_vote_proposal_new_private(
vote_plan_id: *const u8,
index: u8,
num_choices: u8,
vote_encryption_key: *const std::os::raw::c_char,
proposal_out: *mut ProposalPtr,
) -> ErrorPtr {
let bech32_str = CStr::from_ptr(vote_encryption_key);
let r = vote::proposal_new(
vote_plan_id,
index,
num_choices,
vote::ProposalPrivate(bech32_str),
proposal_out as *mut *mut ProposalRust,
);
r.into_c_api() as ErrorPtr
}
/// build the vote cast transaction
///
/// # Errors
///
/// This function may fail upon receiving a null pointer or a `choice` value
/// that does not fall within the range specified in `proposal`.
///
/// # Safety
///
/// This function dereference raw pointers. Even though the function checks if
/// the pointers are null. Mind not to put random values in or you may see
/// unexpected behaviors.
///
/// Don't forget to remove `transaction_out` with
/// `iohk_jormungandr_waller_delete_buffer`.
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_vote_cast(
wallet: WalletPtr,
settings: SettingsPtr,
proposal: ProposalPtr,
choice: u8,
valid_until: BlockDate,
lane: u8,
transaction_out: *mut TransactionOut,
) -> ErrorPtr {
let r = wallet_vote_cast(
wallet as *mut WalletRust,
settings as *mut SettingsRust,
proposal as *mut ProposalRust,
choice,
valid_until,
lane,
transaction_out,
);
r.into_c_api() as ErrorPtr
}
/// decrypt payload of the wallet transfer protocol
///
/// Parameters
///
/// password: byte buffer with the encryption password
/// password_length: length of the password buffer
/// ciphertext: byte buffer with the encryption password
/// ciphertext_length: length of the password buffer
/// plaintext_out: used to return a pointer to a byte buffer with the decrypted text
/// plaintext_out_length: used to return the length of decrypted text
///
/// The returned buffer is in the heap, so make sure to call the delete_buffer function
///
/// # Safety
///
/// This function dereference raw pointers. Even though the function checks if
/// the pointers are null. Mind not to put random values in or you may see
/// unexpected behaviors.
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_symmetric_cipher_decrypt(
password: *const u8,
password_length: usize,
ciphertext: *const u8,
ciphertext_length: usize,
plaintext_out: *mut *const u8,
plaintext_out_length: *mut usize,
) -> ErrorPtr {
let r = symmetric_cipher_decrypt(
password,
password_length,
ciphertext,
ciphertext_length,
plaintext_out,
plaintext_out_length,
);
r.into_c_api() as ErrorPtr
}
/// Get a string describing the error, this will return an allocated
/// null terminated string describing the error.
///
/// If the given error is a `NULL` pointer, the string is and always
/// is `"success"`. This string still need to be deleted with the
/// `iohk_jormungandr_wallet_delete_string` function.
///
/// This function returns an allocated null terminated pointer. Don't
/// forget to free the memory with: `iohk_jormungandr_wallet_delete_string`.
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_error_to_string(error: ErrorPtr) -> *mut c_char {
if let Some(error) = (error as *mut ErrorRust).as_ref() {
CString::new(error.to_string()).unwrap().into_raw()
} else {
CString::new(b"success".to_vec()).unwrap().into_raw()
}
}
/// Get a string describing the error, this will return an allocated
/// null terminated string providing extra details regarding the source
/// of the error.
///
/// If the given error is a `NULL` pointer, the string is and always
/// is `"success"`. If no details are available the function will return
/// `"no more details"`. This string still need to be deleted with the
/// `iohk_jormungandr_wallet_delete_string` function.
///
/// This function returns an allocated null terminated pointer. Don't
/// forget to free the memory with: `iohk_jormungandr_wallet_delete_string`.
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_error_details(error: ErrorPtr) -> *mut c_char {
if let Some(error) = (error as *mut ErrorRust).as_ref() {
if let Some(details) = error.details() {
CString::new(details.to_string()).unwrap().into_raw()
} else {
CString::new(b"no more details".to_vec())
.unwrap()
.into_raw()
}
} else {
CString::new(b"success".to_vec()).unwrap().into_raw()
}
}
/// deserialize a fragment from bytes
///
/// # Parameters
///
/// * `buffer` -- a pointer to the serialized fragment bytes.
/// * `buffer_length` -- the length of the serialized fragment bytes array.
/// * `fragment` -- the location of the pointer to the deserialized fragemnt.
///
/// # Errors
///
/// This functions may fail if:
///
/// * `buffer` is a null pointer.
/// * `fragment` is a null pointer.
/// * `buffer` contains invalid fragment bytes.
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
/// Don't forget to delete the fragment object with `iohk_jormungandr_delete_fragment`.
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_fragment_from_raw(
buffer: *const u8,
buffer_length: usize,
fragment_out: *mut FragmentPtr,
) -> ErrorPtr {
fragment_from_raw(
buffer,
buffer_length,
fragment_out as *mut *mut FragmentRust,
)
.into_c_api() as ErrorPtr
}
/// get the ID of the provided fragment
///
/// # Parameters
///
/// * `fragment` -- a pointer to fragment.
/// * `fragment_id_out` -- a pointer to a pre-allocated 32 bytes array.
///
/// # Errors
///
/// This function would return an error if either of the provided pointers is null.
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors.
///
/// `fragment_id_out` is expected to be an already allocated 32 byte array. Doing otherwise may
/// potentially result into an undefined behavior.
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_fragment_id(
fragment: FragmentPtr,
fragment_id_out: *mut u8,
) -> ErrorPtr {
fragment_id(fragment as *mut FragmentRust, fragment_id_out).into_c_api() as ErrorPtr
}
/// Delete a null terminated string that was allocated by this library
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_delete_string(ptr: *mut c_char) {
if !ptr.is_null() {
let cstring = CString::from_raw(ptr);
std::mem::drop(cstring)
}
}
/// Delete a binary buffer that was returned by this library alongside with its
/// length.
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_delete_buffer(ptr: *mut u8, length: usize) {
if !ptr.is_null() {
let data = std::slice::from_raw_parts_mut(ptr, length);
let data = Box::from_raw(data as *mut [u8]);
std::mem::drop(data);
}
}
/// delete the pointer and free the allocated memory
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_delete_error(error: ErrorPtr) {
wallet_delete_error(error as *mut ErrorRust)
}
/// delete the pointer and free the allocated memory
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_delete_settings(settings: SettingsPtr) {
wallet_delete_settings(settings as *mut SettingsRust)
}
/// delete the pointer, zero all the keys and free the allocated memory
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_delete_wallet(wallet: WalletPtr) {
wallet_delete_wallet(wallet as *mut WalletRust)
}
/// delete the pointer
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
///
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_wallet_delete_proposal(proposal: ProposalPtr) {
wallet_delete_proposal(proposal as *mut ProposalRust)
}
/// delete the pointer
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_delete_fragment(fragment: FragmentPtr) {
fragment_delete(fragment as *mut FragmentRust);
}
/// delete the inner buffer that was allocated by this library
///
/// # Safety
///
/// This function dereference raw pointers. Even though
/// the function checks if the pointers are null. Mind not to put random values
/// in or you may see unexpected behaviors
#[no_mangle]
pub unsafe extern "C" fn iohk_jormungandr_delete_spending_counters(
spending_counters: SpendingCounters,
) {
spending_counters_delete(spending_counters);
}