Skip to content

Commit 9d90ced

Browse files
committed
generated new headers and docs
1 parent f24ed90 commit 9d90ced

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

dash-spv-ffi/FFI_API.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Destroy the client and free associated resources. # Safety - `client` must be e
175175
#### `dash_spv_ffi_client_new`
176176
177177
```c
178-
dash_spv_ffi_client_new(config: *const FFIConfig,) -> *mut FFIDashSpvClient
178+
dash_spv_ffi_client_new(config: *const FFIClientConfig,) -> *mut FFIDashSpvClient
179179
```
180180

181181
**Description:**
@@ -225,7 +225,7 @@ Stop the SPV client. # Safety - `client` must be a valid, non-null pointer to a
225225
#### `dash_spv_ffi_client_update_config`
226226

227227
```c
228-
dash_spv_ffi_client_update_config(client: *mut FFIDashSpvClient, config: *const FFIConfig,) -> i32
228+
dash_spv_ffi_client_update_config(client: *mut FFIDashSpvClient, config: *const FFIClientConfig,) -> i32
229229
```
230230
231231
**Description:**
@@ -241,7 +241,7 @@ Update the running client's configuration. # Safety - `client` must be a valid
241241
#### `dash_spv_ffi_config_add_peer`
242242
243243
```c
244-
dash_spv_ffi_config_add_peer(config: *mut FFIConfig, addr: *const c_char,) -> i32
244+
dash_spv_ffi_config_add_peer(config: *mut FFIClientConfig, addr: *const c_char,) -> i32
245245
```
246246

247247
**Description:**
@@ -257,7 +257,7 @@ Adds a peer address to the configuration Accepts socket addresses with or witho
257257
#### `dash_spv_ffi_config_builder_build`
258258

259259
```c
260-
dash_spv_ffi_config_builder_build(builder: *mut FFIConfigBuilder,) -> *mut FFIConfig
260+
dash_spv_ffi_config_builder_build(builder: *mut FFIClientConfigBuilder,) -> *mut FFIClientConfig
261261
```
262262
263263
**Description:**
@@ -273,7 +273,7 @@ Gets ownership of the builder and returns the built configuration destroying the
273273
#### `dash_spv_ffi_config_builder_destroy`
274274
275275
```c
276-
dash_spv_ffi_config_builder_destroy(builder: *mut FFIConfigBuilder) -> ()
276+
dash_spv_ffi_config_builder_destroy(builder: *mut FFIClientConfigBuilder) -> ()
277277
```
278278

279279
**Description:**
@@ -289,7 +289,7 @@ Destroys an FFIConfigBuilder and frees its memory # Safety - `builder` must be
289289
#### `dash_spv_ffi_config_builder_devnet`
290290

291291
```c
292-
dash_spv_ffi_config_builder_devnet() -> *mut FFIConfigBuilder
292+
dash_spv_ffi_config_builder_devnet() -> *mut FFIClientConfigBuilder
293293
```
294294

295295
**Module:** `config`
@@ -299,7 +299,7 @@ dash_spv_ffi_config_builder_devnet() -> *mut FFIConfigBuilder
299299
#### `dash_spv_ffi_config_builder_mainnet`
300300

301301
```c
302-
dash_spv_ffi_config_builder_mainnet() -> *mut FFIConfigBuilder
302+
dash_spv_ffi_config_builder_mainnet() -> *mut FFIClientConfigBuilder
303303
```
304304

305305
**Module:** `config`
@@ -309,7 +309,7 @@ dash_spv_ffi_config_builder_mainnet() -> *mut FFIConfigBuilder
309309
#### `dash_spv_ffi_config_builder_regtest`
310310

311311
```c
312-
dash_spv_ffi_config_builder_regtest() -> *mut FFIConfigBuilder
312+
dash_spv_ffi_config_builder_regtest() -> *mut FFIClientConfigBuilder
313313
```
314314

315315
**Module:** `config`
@@ -319,7 +319,7 @@ dash_spv_ffi_config_builder_regtest() -> *mut FFIConfigBuilder
319319
#### `dash_spv_ffi_config_builder_set_fetch_mempool_transactions`
320320

321321
```c
322-
dash_spv_ffi_config_builder_set_fetch_mempool_transactions(builder: *mut FFIConfigBuilder, fetch: bool,) -> i32
322+
dash_spv_ffi_config_builder_set_fetch_mempool_transactions(builder: *mut FFIClientConfigBuilder, fetch: bool,) -> i32
323323
```
324324
325325
**Description:**
@@ -335,7 +335,7 @@ Sets whether to fetch full mempool transaction data # Safety - `builder` must b
335335
#### `dash_spv_ffi_config_builder_set_filter_load`
336336
337337
```c
338-
dash_spv_ffi_config_builder_set_filter_load(builder: *mut FFIConfigBuilder, load_filters: bool,) -> i32
338+
dash_spv_ffi_config_builder_set_filter_load(builder: *mut FFIClientConfigBuilder, load_filters: bool,) -> i32
339339
```
340340

341341
**Description:**
@@ -351,7 +351,7 @@ Sets whether to load bloom filters # Safety - `builder` must be a valid pointer
351351
#### `dash_spv_ffi_config_builder_set_masternode_sync_enabled`
352352

353353
```c
354-
dash_spv_ffi_config_builder_set_masternode_sync_enabled(builder: *mut FFIConfigBuilder, enable: bool,) -> i32
354+
dash_spv_ffi_config_builder_set_masternode_sync_enabled(builder: *mut FFIClientConfigBuilder, enable: bool,) -> i32
355355
```
356356
357357
**Description:**
@@ -367,7 +367,7 @@ Enables or disables masternode synchronization # Safety - `builder` must be a v
367367
#### `dash_spv_ffi_config_builder_set_max_mempool_transactions`
368368
369369
```c
370-
dash_spv_ffi_config_builder_set_max_mempool_transactions(builder: *mut FFIConfigBuilder, max_transactions: u32,) -> i32
370+
dash_spv_ffi_config_builder_set_max_mempool_transactions(builder: *mut FFIClientConfigBuilder, max_transactions: u32,) -> i32
371371
```
372372

373373
**Description:**
@@ -383,7 +383,7 @@ Sets the maximum number of mempool transactions to track # Safety - `builder` m
383383
#### `dash_spv_ffi_config_builder_set_max_peers`
384384

385385
```c
386-
dash_spv_ffi_config_builder_set_max_peers(builder: *mut FFIConfigBuilder, max_peers: u32,) -> i32
386+
dash_spv_ffi_config_builder_set_max_peers(builder: *mut FFIClientConfigBuilder, max_peers: u32,) -> i32
387387
```
388388
389389
**Description:**
@@ -399,7 +399,7 @@ Sets the maximum number of peers to connect to # Safety - `builder` must be a v
399399
#### `dash_spv_ffi_config_builder_set_mempool_strategy`
400400
401401
```c
402-
dash_spv_ffi_config_builder_set_mempool_strategy(builder: *mut FFIConfigBuilder, strategy: FFIMempoolStrategy,) -> i32
402+
dash_spv_ffi_config_builder_set_mempool_strategy(builder: *mut FFIClientConfigBuilder, strategy: FFIMempoolStrategy,) -> i32
403403
```
404404

405405
**Description:**
@@ -415,7 +415,7 @@ Sets the mempool synchronization strategy # Safety - `builder` must be a valid
415415
#### `dash_spv_ffi_config_builder_set_mempool_tracking`
416416

417417
```c
418-
dash_spv_ffi_config_builder_set_mempool_tracking(builder: *mut FFIConfigBuilder, enable: bool,) -> i32
418+
dash_spv_ffi_config_builder_set_mempool_tracking(builder: *mut FFIClientConfigBuilder, enable: bool,) -> i32
419419
```
420420
421421
**Description:**
@@ -431,7 +431,7 @@ Enables or disables mempool tracking # Safety - `builder` must be a valid point
431431
#### `dash_spv_ffi_config_builder_set_persist_mempool`
432432
433433
```c
434-
dash_spv_ffi_config_builder_set_persist_mempool(builder: *mut FFIConfigBuilder, persist: bool,) -> i32
434+
dash_spv_ffi_config_builder_set_persist_mempool(builder: *mut FFIClientConfigBuilder, persist: bool,) -> i32
435435
```
436436

437437
**Description:**
@@ -447,7 +447,7 @@ Sets whether to persist mempool state to disk # Safety - `builder` must be a va
447447
#### `dash_spv_ffi_config_builder_set_relay_transactions`
448448

449449
```c
450-
dash_spv_ffi_config_builder_set_relay_transactions(builder: *mut FFIConfigBuilder, _relay: bool,) -> i32
450+
dash_spv_ffi_config_builder_set_relay_transactions(builder: *mut FFIClientConfigBuilder, _relay: bool,) -> i32
451451
```
452452
453453
**Description:**
@@ -463,7 +463,7 @@ Sets whether to relay transactions (currently a no-op) # Safety - `builder` mus
463463
#### `dash_spv_ffi_config_builder_set_restrict_to_configured_peers`
464464
465465
```c
466-
dash_spv_ffi_config_builder_set_restrict_to_configured_peers(builder: *mut FFIConfigBuilder, restrict_peers: bool,) -> i32
466+
dash_spv_ffi_config_builder_set_restrict_to_configured_peers(builder: *mut FFIClientConfigBuilder, restrict_peers: bool,) -> i32
467467
```
468468

469469
**Description:**
@@ -479,7 +479,7 @@ Restrict connections strictly to configured peers (disable DNS discovery and pee
479479
#### `dash_spv_ffi_config_builder_set_start_from_height`
480480

481481
```c
482-
dash_spv_ffi_config_builder_set_start_from_height(builder: *mut FFIConfigBuilder, height: u32,) -> i32
482+
dash_spv_ffi_config_builder_set_start_from_height(builder: *mut FFIClientConfigBuilder, height: u32,) -> i32
483483
```
484484
485485
**Description:**
@@ -495,7 +495,7 @@ Sets the starting block height for synchronization # Safety - `builder` must be
495495
#### `dash_spv_ffi_config_builder_set_storage_path`
496496
497497
```c
498-
dash_spv_ffi_config_builder_set_storage_path(builder: *mut FFIConfigBuilder, path: *const c_char,) -> i32
498+
dash_spv_ffi_config_builder_set_storage_path(builder: *mut FFIClientConfigBuilder, path: *const c_char,) -> i32
499499
```
500500

501501
**Description:**
@@ -511,7 +511,7 @@ Sets the data directory for storing blockchain data # Safety - `builder` must b
511511
#### `dash_spv_ffi_config_builder_set_user_agent`
512512

513513
```c
514-
dash_spv_ffi_config_builder_set_user_agent(builder: *mut FFIConfigBuilder, user_agent: *const c_char,) -> i32
514+
dash_spv_ffi_config_builder_set_user_agent(builder: *mut FFIClientConfigBuilder, user_agent: *const c_char,) -> i32
515515
```
516516
517517
**Description:**
@@ -527,7 +527,7 @@ Sets the user agent string to advertise in the P2P handshake # Safety - `builde
527527
#### `dash_spv_ffi_config_builder_set_validation_mode`
528528
529529
```c
530-
dash_spv_ffi_config_builder_set_validation_mode(builder: *mut FFIConfigBuilder, mode: FFIValidationMode,) -> i32
530+
dash_spv_ffi_config_builder_set_validation_mode(builder: *mut FFIClientConfigBuilder, mode: FFIValidationMode,) -> i32
531531
```
532532

533533
**Description:**
@@ -543,7 +543,7 @@ Sets the validation mode for the SPV client # Safety - `builder` must be a vali
543543
#### `dash_spv_ffi_config_builder_set_worker_threads`
544544

545545
```c
546-
dash_spv_ffi_config_builder_set_worker_threads(builder: *mut FFIConfigBuilder, threads: u32,) -> i32
546+
dash_spv_ffi_config_builder_set_worker_threads(builder: *mut FFIClientConfigBuilder, threads: u32,) -> i32
547547
```
548548
549549
**Description:**
@@ -559,7 +559,7 @@ Sets the number of Tokio worker threads for the FFI runtime (0 = auto) # Safety
559559
#### `dash_spv_ffi_config_builder_testnet`
560560
561561
```c
562-
dash_spv_ffi_config_builder_testnet() -> *mut FFIConfigBuilder
562+
dash_spv_ffi_config_builder_testnet() -> *mut FFIClientConfigBuilder
563563
```
564564

565565
**Module:** `config`
@@ -569,7 +569,7 @@ dash_spv_ffi_config_builder_testnet() -> *mut FFIConfigBuilder
569569
#### `dash_spv_ffi_config_destroy`
570570

571571
```c
572-
dash_spv_ffi_config_destroy(config: *mut FFIConfig) -> ()
572+
dash_spv_ffi_config_destroy(config: *mut FFIClientConfig) -> ()
573573
```
574574
575575
**Description:**
@@ -585,7 +585,7 @@ Destroys an FFIConfig and frees its memory # Safety - `builder` must be a valid
585585
#### `dash_spv_ffi_config_get_mempool_strategy`
586586
587587
```c
588-
dash_spv_ffi_config_get_mempool_strategy(config: *const FFIConfig,) -> FFIMempoolStrategy
588+
dash_spv_ffi_config_get_mempool_strategy(config: *const FFIClientConfig,) -> FFIMempoolStrategy
589589
```
590590

591591
**Description:**
@@ -601,7 +601,7 @@ Gets the mempool synchronization strategy # Safety - `config` must be a valid p
601601
#### `dash_spv_ffi_config_get_mempool_tracking`
602602

603603
```c
604-
dash_spv_ffi_config_get_mempool_tracking(config: *const FFIConfig,) -> bool
604+
dash_spv_ffi_config_get_mempool_tracking(config: *const FFIClientConfig,) -> bool
605605
```
606606
607607
**Description:**
@@ -617,7 +617,7 @@ Gets whether mempool tracking is enabled # Safety - `config` must be a valid po
617617
#### `dash_spv_ffi_config_get_network`
618618
619619
```c
620-
dash_spv_ffi_config_get_network(config: *const FFIConfig) -> FFINetwork
620+
dash_spv_ffi_config_get_network(config: *const FFIClientConfig,) -> FFINetwork
621621
```
622622

623623
**Description:**
@@ -633,7 +633,7 @@ Gets the network type from the configuration # Safety - `config` must be a vali
633633
#### `dash_spv_ffi_config_get_storage_path`
634634

635635
```c
636-
dash_spv_ffi_config_get_storage_path(config: *const FFIConfig,) -> FFIString
636+
dash_spv_ffi_config_get_storage_path(config: *const FFIClientConfig,) -> FFIString
637637
```
638638
639639
**Description:**

0 commit comments

Comments
 (0)