refactor: drop FFINetworks and use FFINetwork only (#294)

This drops the `FFINetworks` enum which was supposed to be used by the FFI layer to provide multiple networks via bitflag combinations. Since im working away from having multi network support in the wallet this PR removes it and uses `FFINetwork` instead.

Author: xdustinface

dash-spv-ffi/examples/wallet_manager_usage.rs

@@ -51,7 +51,7 @@ fn main() {
         let affected = wallet_manager_process_transaction(
             wallet_manager,
             tx_hex.as_ptr() as *const i8,
-            FFINetworks::TestnetFlag,
+            FFINetwork::Testnet,
             100000, // block height
             &mut error
         );

key-wallet-ffi/FFI_API.md

@@ -418,7 +418,7 @@ Free a managed account result's error message (if any) Note: This does NOT free
 #### `wallet_manager_add_wallet_from_mnemonic`
 
 ```c
-wallet_manager_add_wallet_from_mnemonic(manager: *mut FFIWalletManager, mnemonic: *const c_char, passphrase: *const c_char, network: FFINetworks, error: *mut FFIError,) -> bool
+wallet_manager_add_wallet_from_mnemonic(manager: *mut FFIWalletManager, mnemonic: *const c_char, passphrase: *const c_char, network: FFINetwork, error: *mut FFIError,) -> bool
 ```
 
 **Description:**
@@ -434,7 +434,7 @@ Add a wallet from mnemonic to the manager (backward compatibility)  # Safety  -
 #### `wallet_manager_add_wallet_from_mnemonic_return_serialized_bytes`
 
 ```c
-wallet_manager_add_wallet_from_mnemonic_return_serialized_bytes(manager: *mut FFIWalletManager, mnemonic: *const c_char, passphrase: *const c_char, network: FFINetworks, birth_height: c_uint, account_options: *const crate::types::FFIWalletAccountCreationOptions, downgrade_to_pubkey_wallet: bool, allow_external_signing: bool, wallet_bytes_out: *mut *mut u8, wallet_bytes_len_out: *mut usize, wallet_id_out: *mut u8, error: *mut FFIError,) -> bool
+wallet_manager_add_wallet_from_mnemonic_return_serialized_bytes(manager: *mut FFIWalletManager, mnemonic: *const c_char, passphrase: *const c_char, network: FFINetwork, birth_height: c_uint, account_options: *const crate::types::FFIWalletAccountCreationOptions, downgrade_to_pubkey_wallet: bool, allow_external_signing: bool, wallet_bytes_out: *mut *mut u8, wallet_bytes_len_out: *mut usize, wallet_id_out: *mut u8, error: *mut FFIError,) -> bool
 ```
 
 **Module:** `wallet_manager`
@@ -444,7 +444,7 @@ wallet_manager_add_wallet_from_mnemonic_return_serialized_bytes(manager: *mut FF
 #### `wallet_manager_add_wallet_from_mnemonic_with_options`
 
 ```c
-wallet_manager_add_wallet_from_mnemonic_with_options(manager: *mut FFIWalletManager, mnemonic: *const c_char, passphrase: *const c_char, network: FFINetworks, account_options: *const crate::types::FFIWalletAccountCreationOptions, error: *mut FFIError,) -> bool
+wallet_manager_add_wallet_from_mnemonic_with_options(manager: *mut FFIWalletManager, mnemonic: *const c_char, passphrase: *const c_char, network: FFINetwork, account_options: *const crate::types::FFIWalletAccountCreationOptions, error: *mut FFIError,) -> bool
 ```
 
 **Description:**
@@ -1219,7 +1219,7 @@ Build and sign a transaction using the wallet's managed info  This is the recomm
 #### `wallet_build_transaction`
 
 ```c
-wallet_build_transaction(wallet: *mut FFIWallet, _network: FFINetworks, account_index: c_uint, outputs: *const FFITxOutput, outputs_count: usize, fee_per_kb: u64, tx_bytes_out: *mut *mut u8, tx_len_out: *mut usize, error: *mut FFIError,) -> bool
+wallet_build_transaction(wallet: *mut FFIWallet, account_index: c_uint, outputs: *const FFITxOutput, outputs_count: usize, fee_per_kb: u64, tx_bytes_out: *mut *mut u8, tx_len_out: *mut usize, error: *mut FFIError,) -> bool
 ```
 
 **Description:**
@@ -1251,7 +1251,7 @@ Check if a transaction belongs to the wallet using ManagedWalletInfo  # Safety
 #### `wallet_create_from_mnemonic`
 
 ```c
-wallet_create_from_mnemonic(mnemonic: *const c_char, passphrase: *const c_char, network: FFINetworks, error: *mut FFIError,) -> *mut FFIWallet
+wallet_create_from_mnemonic(mnemonic: *const c_char, passphrase: *const c_char, network: FFINetwork, error: *mut FFIError,) -> *mut FFIWallet
 ```
 
 **Description:**
@@ -1267,7 +1267,7 @@ Create a new wallet from mnemonic (backward compatibility - single network)  # S
 #### `wallet_create_from_mnemonic_with_options`
 
 ```c
-wallet_create_from_mnemonic_with_options(mnemonic: *const c_char, passphrase: *const c_char, networks: FFINetworks, account_options: *const FFIWalletAccountCreationOptions, error: *mut FFIError,) -> *mut FFIWallet
+wallet_create_from_mnemonic_with_options(mnemonic: *const c_char, passphrase: *const c_char, network: FFINetwork, account_options: *const FFIWalletAccountCreationOptions, error: *mut FFIError,) -> *mut FFIWallet
 ```
 
 **Description:**
@@ -1283,7 +1283,7 @@ Create a new wallet from mnemonic with options  # Safety  - `mnemonic` must be a
 #### `wallet_create_from_seed`
 
 ```c
-wallet_create_from_seed(seed: *const u8, seed_len: usize, network: FFINetworks, error: *mut FFIError,) -> *mut FFIWallet
+wallet_create_from_seed(seed: *const u8, seed_len: usize, network: FFINetwork, error: *mut FFIError,) -> *mut FFIWallet
 ```
 
 **Description:**
@@ -1299,7 +1299,7 @@ Create a new wallet from seed (backward compatibility)  # Safety  - `seed` must
 #### `wallet_create_from_seed_with_options`
 
 ```c
-wallet_create_from_seed_with_options(seed: *const u8, seed_len: usize, networks: FFINetworks, account_options: *const FFIWalletAccountCreationOptions, error: *mut FFIError,) -> *mut FFIWallet
+wallet_create_from_seed_with_options(seed: *const u8, seed_len: usize, network: FFINetwork, account_options: *const FFIWalletAccountCreationOptions, error: *mut FFIError,) -> *mut FFIWallet
 ```
 
 **Description:**
@@ -1331,7 +1331,7 @@ Create a managed wallet from a regular wallet  This creates a ManagedWalletInfo
 #### `wallet_create_random`
 
 ```c
-wallet_create_random(network: FFINetworks, error: *mut FFIError,) -> *mut FFIWallet
+wallet_create_random(network: FFINetwork, error: *mut FFIError,) -> *mut FFIWallet
 ```
 
 **Description:**
@@ -1347,7 +1347,7 @@ Create a new random wallet (backward compatibility)  # Safety  - `error` must be
 #### `wallet_create_random_with_options`
 
 ```c
-wallet_create_random_with_options(networks: FFINetworks, account_options: *const FFIWalletAccountCreationOptions, error: *mut FFIError,) -> *mut FFIWallet
+wallet_create_random_with_options(network: FFINetwork, account_options: *const FFIWalletAccountCreationOptions, error: *mut FFIError,) -> *mut FFIWallet
 ```
 
 **Description:**
@@ -1603,7 +1603,7 @@ Get an IdentityTopUp account handle with a specific registration index This is u
 #### `wallet_get_utxos`
 
 ```c
-wallet_get_utxos(_wallet: *const crate::types::FFIWallet, _network: FFINetworks, utxos_out: *mut *mut FFIUTXO, count_out: *mut usize, error: *mut FFIError,) -> bool
+wallet_get_utxos(_wallet: *const crate::types::FFIWallet, utxos_out: *mut *mut FFIUTXO, count_out: *mut usize, error: *mut FFIError,) -> bool
 ```
 
 **Description:**
@@ -1667,7 +1667,7 @@ Check if wallet is watch-only  # Safety  - `wallet` must be a valid pointer to a
 #### `wallet_sign_transaction`
 
 ```c
-wallet_sign_transaction(wallet: *const FFIWallet, _network: FFINetworks, tx_bytes: *const u8, tx_len: usize, signed_tx_out: *mut *mut u8, signed_len_out: *mut usize, error: *mut FFIError,) -> bool
+wallet_sign_transaction(wallet: *const FFIWallet, tx_bytes: *const u8, tx_len: usize, signed_tx_out: *mut *mut u8, signed_len_out: *mut usize, error: *mut FFIError,) -> bool
 ```
 
 **Description:**
@@ -2293,14 +2293,14 @@ Check if an account is watch-only  # Safety  - `account` must be a valid pointer
 #### `account_get_network`
 
 ```c
-account_get_network(account: *const FFIAccount) -> FFINetworks
+account_get_network(account: *const FFIAccount) -> FFINetwork
 ```
 
 **Description:**
-Get the network of an account  # Safety  - `account` must be a valid pointer to an FFIAccount instance - Returns FFINetwork::NoNetworks if the account is null
+Get the network of an account  # Safety  - `account` must be a valid pointer to an FFIAccount instance - Returns `FFINetwork::Dash` if the account is null
 
 **Safety:**
-- `account` must be a valid pointer to an FFIAccount instance - Returns FFINetwork::NoNetworks if the account is null
+- `account` must be a valid pointer to an FFIAccount instance - Returns `FFINetwork::Dash` if the account is null
 
 **Module:** `account`
 
@@ -2369,7 +2369,7 @@ bls_account_get_is_watch_only(account: *const FFIBLSAccount) -> bool
 #### `bls_account_get_network`
 
 ```c
-bls_account_get_network(account: *const FFIBLSAccount) -> FFINetworks
+bls_account_get_network(account: *const FFIBLSAccount) -> FFINetwork
 ```
 
 **Module:** `account`
@@ -2452,7 +2452,7 @@ eddsa_account_get_is_watch_only(account: *const FFIEdDSAAccount) -> bool
 #### `eddsa_account_get_network`
 
 ```c
-eddsa_account_get_network(account: *const FFIEdDSAAccount) -> FFINetworks
+eddsa_account_get_network(account: *const FFIEdDSAAccount) -> FFINetwork
 ```
 
 **Module:** `account`
@@ -3042,10 +3042,10 @@ managed_account_get_network(account: *const FFIManagedAccount,) -> FFINetwork
 ```
 
 **Description:**
-Get the network of a managed account  # Safety  - `account` must be a valid pointer to an FFIManagedAccount instance
+Get the network of a managed account  # Safety  - `account` must be a valid pointer to an FFIManagedAccount instance - Returns `FFINetwork::Dash` if the account is null
 
 **Safety:**
-- `account` must be a valid pointer to an FFIManagedAccount instance
+- `account` must be a valid pointer to an FFIManagedAccount instance - Returns `FFINetwork::Dash` if the account is null
 
 **Module:** `managed_account`
 
@@ -3505,7 +3505,7 @@ This function is unsafe because it dereferences raw pointers: - `encrypted_key`
 #### `bip38_encrypt_private_key`
 
 ```c
-bip38_encrypt_private_key(private_key: *const c_char, passphrase: *const c_char, _network: FFINetworks, error: *mut FFIError,) -> *mut c_char
+bip38_encrypt_private_key(private_key: *const c_char, passphrase: *const c_char, error: *mut FFIError,) -> *mut c_char
 ```
 
 **Description:**
@@ -4080,7 +4080,7 @@ Free a string  # Safety  - `s` must be a valid pointer created by C string creat
 - `FFIWalletManager` - Wallet manager handle
 - `FFIBalance` - Balance information
 - `FFIUTXO` - Unspent transaction output
-- `FFINetworks` - Network enumeration
+- `FFINetwork` - Network enumeration
 
 ## Memory Management
 

key-wallet-ffi/include/key_wallet_ffi.h

@@ -89,16 +89,14 @@ typedef enum {
 } FFIAccountType;
 
 /*
- FFI Network type (bit flags for multiple networks)
+ FFI Network type (single network)
  */
 typedef enum {
-    NO_NETWORKS = 0,
-    DASH_FLAG = 1,
-    TESTNET_FLAG = 2,
-    REGTEST_FLAG = 4,
-    DEVNET_FLAG = 8,
-    ALL_NETWORKS = 15,
-} FFINetworks;
+    DASH = 0,
+    TESTNET = 1,
+    REGTEST = 2,
+    DEVNET = 3,
+} FFINetwork;
 
 /*
  FFI Error code
@@ -119,16 +117,6 @@ typedef enum {
     INTERNAL_ERROR = 12,
 } FFIErrorCode;
 
-/*
- FFI Network type (single network)
- */
-typedef enum {
-    DASH = 0,
-    TESTNET = 1,
-    REGTEST = 2,
-    DEVNET = 3,
-} FFINetwork;
-
 /*
  Address pool type
  */
@@ -897,9 +885,9 @@ FFIAccountResult wallet_get_top_up_account_with_registration_index(const FFIWall
  # Safety
 
  - `account` must be a valid pointer to an FFIAccount instance
- - Returns FFINetwork::NoNetworks if the account is null
+ - Returns `FFINetwork::Dash` if the account is null
  */
- FFINetworks account_get_network(const FFIAccount *account) ;
+ FFINetwork account_get_network(const FFIAccount *account) ;
 
 /*
  Get the parent wallet ID of an account
@@ -951,9 +939,9 @@ FFIAccountResult wallet_get_top_up_account_with_registration_index(const FFIWall
  # Safety
 
  - `account` must be a valid pointer to an FFIBLSAccount instance
- - Returns FFINetwork::NoNetworks if the account is null
+ - Returns `FFINetwork::Dash` if the account is null
  */
- FFINetworks bls_account_get_network(const FFIBLSAccount *account) ;
+ FFINetwork bls_account_get_network(const FFIBLSAccount *account) ;
 
 /*
  Get the parent wallet ID of a BLS account
@@ -1008,9 +996,9 @@ FFIAccountType bls_account_get_account_type(const FFIBLSAccount *account,
  # Safety
 
  - `account` must be a valid pointer to an FFIEdDSAAccount instance
- - Returns FFINetwork::NoNetworks if the account is null
+ - Returns `FFINetwork::Dash` if the account is null
  */
- FFINetworks eddsa_account_get_network(const FFIEdDSAAccount *account) ;
+ FFINetwork eddsa_account_get_network(const FFIEdDSAAccount *account) ;
 
 /*
  Get the parent wallet ID of an EdDSA account
@@ -2433,6 +2421,7 @@ FFIManagedAccountResult managed_wallet_get_dashpay_external_account(const FFIWal
  # Safety
 
  - `account` must be a valid pointer to an FFIManagedAccount instance
+ - Returns `FFINetwork::Dash` if the account is null
  */
  FFINetwork managed_account_get_network(const FFIManagedAccount *account) ;
 
@@ -3200,7 +3189,6 @@ bool mnemonic_to_seed(const char *mnemonic,
  */
 
 bool wallet_build_transaction(FFIWallet *wallet,
-                              FFINetworks _network,
                               unsigned int account_index,
                               const FFITxOutput *outputs,
                               size_t outputs_count,
@@ -3224,7 +3212,6 @@ bool wallet_build_transaction(FFIWallet *wallet,
  */
 
 bool wallet_sign_transaction(const FFIWallet *wallet,
-                             FFINetworks _network,
                              const uint8_t *tx_bytes,
                              size_t tx_len,
                              uint8_t **signed_tx_out,
@@ -3589,7 +3576,6 @@ bool managed_wallet_get_utxos(const FFIManagedWalletInfo *managed_info,
  */
 
 bool wallet_get_utxos(const FFIWallet *_wallet,
-                      FFINetworks _network,
                       FFIUTXO **utxos_out,
                       size_t *count_out,
                       FFIError *error)
@@ -3622,7 +3608,7 @@ bool wallet_get_utxos(const FFIWallet *_wallet,
 
 FFIWallet *wallet_create_from_mnemonic_with_options(const char *mnemonic,
                                                     const char *passphrase,
-                                                    FFINetworks networks,
+                                                    FFINetwork network,
                                                     const FFIWalletAccountCreationOptions *account_options,
                                                     FFIError *error)
 ;
@@ -3641,7 +3627,7 @@ FFIWallet *wallet_create_from_mnemonic_with_options(const char *mnemonic,
 
 FFIWallet *wallet_create_from_mnemonic(const char *mnemonic,
                                        const char *passphrase,
-                                       FFINetworks network,
+                                       FFINetwork network,
                                        FFIError *error)
 ;
 
@@ -3658,7 +3644,7 @@ FFIWallet *wallet_create_from_mnemonic(const char *mnemonic,
 
 FFIWallet *wallet_create_from_seed_with_options(const uint8_t *seed,
                                                 size_t seed_len,
-                                                FFINetworks networks,
+                                                FFINetwork network,
                                                 const FFIWalletAccountCreationOptions *account_options,
                                                 FFIError *error)
 ;
@@ -3675,7 +3661,7 @@ FFIWallet *wallet_create_from_seed_with_options(const uint8_t *seed,
 
 FFIWallet *wallet_create_from_seed(const uint8_t *seed,
                                    size_t seed_len,
-                                   FFINetworks network,
+                                   FFINetwork network,
                                    FFIError *error)
 ;
 
@@ -3689,7 +3675,7 @@ FFIWallet *wallet_create_from_seed(const uint8_t *seed,
  - The caller must ensure all pointers remain valid for the duration of this call
  */
 
-FFIWallet *wallet_create_random_with_options(FFINetworks networks,
+FFIWallet *wallet_create_random_with_options(FFINetwork network,
                                              const FFIWalletAccountCreationOptions *account_options,
                                              FFIError *error)
 ;
@@ -3702,7 +3688,7 @@ FFIWallet *wallet_create_random_with_options(FFINetworks networks,
  - `error` must be a valid pointer to an FFIError structure or null
  - The caller must ensure the pointer remains valid for the duration of this call
  */
- FFIWallet *wallet_create_random(FFINetworks network, FFIError *error) ;
+ FFIWallet *wallet_create_random(FFINetwork network, FFIError *error) ;
 
 /*
  Get wallet ID (32-byte hash)
@@ -3906,7 +3892,7 @@ char *wallet_manager_describe(const FFIWalletManager *manager,
 bool wallet_manager_add_wallet_from_mnemonic_with_options(FFIWalletManager *manager,
                                                           const char *mnemonic,
                                                           const char *passphrase,
-                                                          FFINetworks network,
+                                                          FFINetwork network,
                                                           const FFIWalletAccountCreationOptions *account_options,
                                                           FFIError *error)
 ;
@@ -3926,7 +3912,7 @@ bool wallet_manager_add_wallet_from_mnemonic_with_options(FFIWalletManager *mana
 bool wallet_manager_add_wallet_from_mnemonic(FFIWalletManager *manager,
                                              const char *mnemonic,
                                              const char *passphrase,
-                                             FFINetworks network,
+                                             FFINetwork network,
                                              FFIError *error)
 ;
 
@@ -3956,7 +3942,7 @@ bool wallet_manager_add_wallet_from_mnemonic(FFIWalletManager *manager,
 bool wallet_manager_add_wallet_from_mnemonic_return_serialized_bytes(FFIWalletManager *manager,
                                                                      const char *mnemonic,
                                                                      const char *passphrase,
-                                                                     FFINetworks network,
+                                                                     FFINetwork network,
                                                                      unsigned int birth_height,
                                                                      const FFIWalletAccountCreationOptions *account_options,
                                                                      bool downgrade_to_pubkey_wallet,
@@ -4201,12 +4187,7 @@ void wallet_manager_free_addresses(char **addresses,
  - `passphrase` must be a valid, null-terminated C string
  - `error` must be a valid pointer to an FFIError or null
  */
-
-char *bip38_encrypt_private_key(const char *private_key,
-                                const char *passphrase,
-                                FFINetworks _network,
-                                FFIError *error)
-;
+ char *bip38_encrypt_private_key(const char *private_key, const char *passphrase, FFIError *error) ;
 
 /*
  Decrypt a BIP38 encrypted private key

key-wallet-ffi/scripts/generate_ffi_docs.py

@@ -257,7 +257,7 @@ def generate_markdown(functions: List[FFIFunction]) -> str:
     md.append("- `FFIWalletManager` - Wallet manager handle")
     md.append("- `FFIBalance` - Balance information")
     md.append("- `FFIUTXO` - Unspent transaction output")
-    md.append("- `FFINetworks` - Network enumeration")
+    md.append("- `FFINetwork` - Network enumeration")
     md.append("")
 
     # Memory Management