more cleanup

Author: mvadari

xrpl-std/src/core/tx/current_transaction.rs

@@ -1,6 +1,6 @@
-use crate::core::amount::xrp_amount::XrpAmount;
 use crate::core::amount::Amount;
 use crate::core::amount::Amount::Xrp;
+use crate::core::amount::xrp_amount::XrpAmount;
 use crate::core::field_codes::{
     SF_ACCOUNT, SF_ACCOUNT_TXN_ID, SF_CONDITION, SF_FEE, SF_FLAGS, SF_FULFILLMENT, SF_HASH,
     SF_LAST_LEDGER_SEQUENCE, SF_NETWORK_ID, SF_OFFER_SEQUENCE, SF_OWNER, SF_SEQUENCE,

xrpl-std/src/host/host_bindings.rs

@@ -159,7 +159,7 @@ unsafe extern "C" {
     ///
     /// # Parameters
     ///
-    /// - `slot`: An integer representing the slot index of the ledger object.
+    /// - `cache_num`: An integer representing the cache index of the ledger object.
     /// - `field`: An integer representing the specific field to retrieve from the ledger object.
     /// - `out_buff_ptr`: A mutable pointer to a buffer where the retrieved field data will be written.
     /// - `out_buff_len`: The size of the output buffer in bytes.
@@ -170,7 +170,7 @@ unsafe extern "C" {
     /// - Returns a negative error code on failure. The list of error codes is defined in
     ///   ../core/error_codes.rs
     pub fn get_ledger_obj_field(
-        slot: i32,
+        cache_num: i32,
         field: i32,
         out_buff_ptr: *mut u8,
         out_buff_len: usize,
@@ -221,10 +221,10 @@ unsafe extern "C" {
         out_buff_len: usize,
     ) -> i32;
 
-    /// Retrieves a nested field from a ledger object in a specific slot and writes the result into an output buffer.
+    /// Retrieves a nested field from a ledger object in a specific cache_num and writes the result into an output buffer.
     ///
     /// # Parameters
-    /// - `slot`: The slot index of the ledger object to access.
+    /// - `cache_num`: The cache index of the ledger object to access.
     /// - `locator_ptr`: A pointer to the memory location containing the locator string data
     ///                  (used to identify the nested field in the ledger object).
     /// - `locator_len`: The length of the locator string.
@@ -237,7 +237,7 @@ unsafe extern "C" {
     /// - Returns a negative error code on failure. The list of error codes is defined in
     ///   ../core/error_codes.rs
     pub fn get_ledger_obj_nested_field(
-        slot: i32,
+        cache_num: i32,
         locator_ptr: *const u8,
         locator_len: usize,
         out_buff_ptr: *mut u8,
@@ -268,18 +268,18 @@ unsafe extern "C" {
     ///   ../core/error_codes.rs
     pub fn get_current_ledger_obj_array_len(field: i32) -> i32;
 
-    /// Retrieves the length of an array based on the provided slot number and field value.
+    /// Retrieves the length of an array based on the provided cache number and field value.
     ///
     /// # Parameters
-    /// - `slot`: The slot index of the ledger object to access.
+    /// - `cache_num`: The cache index of the ledger object to access.
     /// - `field` (i32): The integer identifier for the desired field.
     ///
     /// # Returns
     ///
     /// - Returns a positive number of array length on success
     /// - Returns a negative error code on failure. The list of error codes is defined in
     ///   ../core/error_codes.rs
-    pub fn get_ledger_obj_array_len(slot: i32, field: i32) -> i32;
+    pub fn get_ledger_obj_array_len(cache_num: i32, field: i32) -> i32;
 
     /// Retrieves the length of an array based on the provided locator.
     ///
@@ -313,7 +313,7 @@ unsafe extern "C" {
     /// Retrieves the length of an array based on the provided locator.
     ///
     /// # Parameters
-    /// - `slot`: The slot index of the ledger object to access.
+    /// - `cache_num`: The cache index of the ledger object to access.
     /// - `locator_ptr`: A pointer to a byte array containing the locator for the nested field.
     /// - `locator_len`: The length of the locator data in bytes.
     ///
@@ -323,7 +323,7 @@ unsafe extern "C" {
     /// - Returns a negative error code on failure. The list of error codes is defined in
     ///   ../core/error_codes.rs
     pub fn get_ledger_obj_nested_array_len(
-        slot: i32,
+        cache_num: i32,
         locator_ptr: *const u8,
         locator_len: usize,
     ) -> i32;

xrpl-std/src/keylet.rs

@@ -2,19 +2,32 @@ use crate::host;
 use crate::types::{AccountID, Keylet, XRPL_KEYLET_SIZE};
 
 pub fn account_keylet(aid: &AccountID) -> Option<Keylet> {
-    let mut key_let: Keylet = [0; XRPL_KEYLET_SIZE];
+    let mut keylet: Keylet = [0; XRPL_KEYLET_SIZE];
+    let retcode =
+        unsafe { host::account_keylet(aid.as_ptr(), aid.len(), keylet.as_mut_ptr(), keylet.len()) };
+    if retcode > 0 { Some(keylet) } else { None }
+}
+
+pub fn escrow_keylet(owner: &AccountID, sequence: i32) -> Option<Keylet> {
+    let mut keylet: Keylet = [0; XRPL_KEYLET_SIZE];
     let retcode = unsafe {
-        host::account_keylet(aid.as_ptr(), aid.len(), key_let.as_mut_ptr(), key_let.len())
+        host::escrow_keylet(
+            owner.as_ptr(),
+            owner.len(),
+            sequence,
+            keylet.as_mut_ptr(),
+            keylet.len(),
+        )
     };
-    if retcode > 0 { Some(key_let) } else { None }
+    if retcode > 0 { Some(keylet) } else { None }
 }
 
 pub fn credential_keylet(
     subject: &AccountID,
     issuer: &AccountID,
     credential_type: &[u8],
 ) -> Option<Keylet> {
-    let mut key_let: Keylet = [0; XRPL_KEYLET_SIZE];
+    let mut keylet: Keylet = [0; XRPL_KEYLET_SIZE];
     let retcode = unsafe {
         host::credential_keylet(
             subject.as_ptr(),
@@ -23,23 +36,23 @@ pub fn credential_keylet(
             issuer.len(),
             credential_type.as_ptr(),
             credential_type.len(),
-            key_let.as_mut_ptr(),
-            key_let.len(),
+            keylet.as_mut_ptr(),
+            keylet.len(),
         )
     };
-    if retcode > 0 { Some(key_let) } else { None }
+    if retcode > 0 { Some(keylet) } else { None }
 }
 
 pub fn oracle_keylet(owner: &AccountID, document_id: i32) -> Option<Keylet> {
-    let mut key_let: Keylet = [0; XRPL_KEYLET_SIZE];
+    let mut keylet: Keylet = [0; XRPL_KEYLET_SIZE];
     let retcode = unsafe {
         host::oracle_keylet(
             owner.as_ptr(),
             owner.len(),
             document_id,
-            key_let.as_mut_ptr(),
-            key_let.len(),
+            keylet.as_mut_ptr(),
+            keylet.len(),
         )
     };
-    if retcode > 0 { Some(key_let) } else { None }
+    if retcode > 0 { Some(keylet) } else { None }
 }

xrpl-std/src/lib.rs

@@ -18,69 +18,75 @@ use crate::types::{AccountID, ContractData, NFT, XRPL_ACCOUNT_ID_SIZE, XRPL_CONT
 
 pub fn get_tx_account_id() -> Option<AccountID> {
     let mut account_id: AccountID = [0; XRPL_ACCOUNT_ID_SIZE];
-    if unsafe { host::get_tx_field(sfield::Account, account_id.as_mut_ptr(), account_id.len()) } > 0
-    {
+    let retcode =
+        unsafe { host::get_tx_field(sfield::Account, account_id.as_mut_ptr(), account_id.len()) };
+    if retcode > 0 {
         Some(account_id)
     } else {
+        let _ = trace_num("get_tx_account_id error", i64::from(retcode));
         None
     }
 }
 
 pub fn get_current_escrow_account_id() -> Option<AccountID> {
     let mut account_id: AccountID = [0; XRPL_ACCOUNT_ID_SIZE];
-    if unsafe {
+    let retcode = unsafe {
         host::get_current_ledger_obj_field(
             sfield::Account,
             account_id.as_mut_ptr(),
             account_id.len(),
         )
-    } > 0
-    {
+    };
+    if retcode > 0 {
         Some(account_id)
     } else {
+        let _ = trace_num("get_current_escrow_account_id error", i64::from(retcode));
         None
     }
 }
 
 pub fn get_current_escrow_destination() -> Option<AccountID> {
     let mut account_id: AccountID = [0; XRPL_ACCOUNT_ID_SIZE];
-    if unsafe {
+    let retcode = unsafe {
         host::get_current_ledger_obj_field(
             sfield::Destination,
             account_id.as_mut_ptr(),
             account_id.len(),
         )
-    } > 0
-    {
+    };
+    if retcode > 0 {
         Some(account_id)
     } else {
+        let _ = trace_num("get_current_escrow_destination error", i64::from(retcode));
         None
     }
 }
 
 pub fn get_current_escrow_data() -> Option<ContractData> {
     let mut data: ContractData = [0; XRPL_CONTRACT_DATA_SIZE];
-    if unsafe { host::get_current_ledger_obj_field(sfield::Data, data.as_mut_ptr(), data.len()) }
-        > 0
-    {
+    let retcode =
+        unsafe { host::get_current_ledger_obj_field(sfield::Data, data.as_mut_ptr(), data.len()) };
+    if retcode > 0 {
         Some(data)
     } else {
+        let _ = trace_num("get_current_escrow_data error", i64::from(retcode));
         None
     }
 }
 
 pub fn get_current_escrow_finish_after() -> Option<i32> {
     let mut after = 0i32;
-    if unsafe {
+    let retcode = unsafe {
         host::get_current_ledger_obj_field(
             sfield::FinishAfter,
             (&mut after) as *mut i32 as *mut u8,
             4,
         )
-    } > 0
-    {
+    };
+    if retcode > 0 {
         Some(after)
     } else {
+        let _ = trace_num("get_current_escrow_finish_after error", i64::from(retcode));
         None
     }
 }
@@ -93,6 +99,10 @@ pub fn get_account_balance(aid: &AccountID) -> Option<u64> {
     // let _ = trace_data("std-lib keylet ", &keylet, DataRepr::AsHex);
     let slot = unsafe { host::cache_ledger_obj(keylet.as_ptr(), keylet.len(), 0) };
     if slot <= 0 {
+        let _ = trace_num(
+            "get_account_balance cache_ledger_obj failed",
+            i64::from(slot),
+        );
         return None;
     }
     // let _ = trace("std-lib slot ");
@@ -121,40 +131,42 @@ pub fn get_account_balance(aid: &AccountID) -> Option<u64> {
 
 pub fn get_nft(owner: &AccountID, nft: &NFT) -> Option<ContractData> {
     let mut data: ContractData = [0; XRPL_CONTRACT_DATA_SIZE];
-    unsafe {
-        let retcode = host::get_NFT(
+
+    let retcode = unsafe {
+        host::get_NFT(
             owner.as_ptr(),
             owner.len(),
             nft.as_ptr(),
             nft.len(),
             data.as_mut_ptr(),
             data.len(),
-        );
-        if retcode > 0 {
-            Some(data)
-        } else {
-            let _ = trace_num("get_nft error", i64::from(retcode));
-            None
-        }
+        )
+    };
+    if retcode > 0 {
+        Some(data)
+    } else {
+        let _ = trace_num("get_nft error", i64::from(retcode));
+        None
     }
 }
 
 pub fn get_ledger_obj_nested_field(slot: i32, locator: &LocatorPacker) -> Option<ContractData> {
     let mut data: ContractData = [0; XRPL_CONTRACT_DATA_SIZE];
-    unsafe {
-        let retcode = host::get_ledger_obj_nested_field(
+
+    let retcode = unsafe {
+        host::get_ledger_obj_nested_field(
             slot,
             locator.get_addr(),
             locator.num_packed_bytes(),
             data.as_mut_ptr(),
             data.len(),
-        );
-        if retcode > 0 {
-            Some(data)
-        } else {
-            let _ = trace_num("get_ledger_obj_nested_field error", i64::from(retcode));
-            None
-        }
+        )
+    };
+    if retcode > 0 {
+        Some(data)
+    } else {
+        let _ = trace_num("get_ledger_obj_nested_field error", i64::from(retcode));
+        None
     }
 }
 

xrpl-std/src/types.rs

@@ -1,13 +1,19 @@
 pub const XRPL_ACCOUNT_ID_SIZE: usize = 20;
-pub const XRPL_NFTID_SIZE: usize = 32;
-pub const XRPL_HASH256_SIZE: usize = 32;
-pub const XRPL_CONTRACT_DATA_SIZE: usize = 4096; //TODO size??
 pub type AccountID = [u8; XRPL_ACCOUNT_ID_SIZE];
+
+pub const XRPL_NFTID_SIZE: usize = 32;
 pub type NFT = [u8; XRPL_NFTID_SIZE];
+
+pub const XRPL_HASH256_SIZE: usize = 32;
 pub type Hash256 = [u8; XRPL_HASH256_SIZE];
+
+pub const XRPL_CONTRACT_DATA_SIZE: usize = 4096; //TODO size??
 pub type ContractData = [u8; XRPL_CONTRACT_DATA_SIZE];
+
 // use keylet hash only (i.e. without 2-byte LedgerEntryType) for now.
 // TODO Check rippled
 pub const XRPL_KEYLET_SIZE: usize = 32;
-
 pub type Keylet = [u8; XRPL_KEYLET_SIZE];
+
+pub const XRPL_NFT_URI_SIZE: usize = 256;
+pub type NFT_URI = [u8; XRPL_NFT_URI_SIZE];