Skip to content

feat(swift-sdk): methods that consume the spv client marked as consuming #3478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ZocoLini wants to merge 1 commit into
base: v3.1-dev
Choose a base branch
from
Open

feat(swift-sdk): methods that consume the spv client marked as consuming #3478

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions packages/swift-sdk/Sources/SwiftDashSDK/Core/SPV/SPVClient.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,10 @@ import Foundation
/// The FFI is still a work in progress, that means that some functionalities are not yet
/// implemented or may change in the future, this wrap was made with that in mind.
///
/// Important limitations:
/// - Once stopped, the SPVClient cannot be restarted without creating a new instance, FFI limitation
/// - The pointers are freed automatically but, to be able to create a new instance (with the same dataDir)
/// Note: The pointers are freed automatically but, to be able to create a new instance (with the same dataDir)
/// without causing the initialization to fail, you must call SPVClient::destroy manually, this is because,
/// FFIDashSpvClient locks the dir to avoid concurrency corruption and its only possible to
/// ensure is unlocked by freeing the pointer, FFI limitation
/// - Clearing the storage stops the SPVClient, a new one has to be created, FFI limitation
/// ensure it is unlocked by freeing the pointer
public class SPVClient: @unchecked Sendable {
private var spvEventHandlers: SPVEventHandlers?

Expand Down Expand Up @@ -175,7 +172,7 @@ public class SPVClient: @unchecked Sendable {
}

/// Clear all persisted SPV storage (headers, filters, metadata, sync state).
public func clearStorage() throws {
public consuming func clearStorage() throws {
let rc = dash_spv_ffi_client_clear_storage(client)
if rc != 0 {
throw SPVError.storageOperationFailed(SPVClient.getLastDashFFIError())
Expand All @@ -187,7 +184,7 @@ public class SPVClient: @unchecked Sendable {
spvEventHandlers?.progress.onProgressUpdate(getSyncProgress())
}

public func destroy() {
public consuming func destroy() {
dash_spv_ffi_client_destroy(client)
dash_spv_ffi_config_destroy(config)

Expand Down Expand Up @@ -226,7 +223,7 @@ public class SPVClient: @unchecked Sendable {
}
}

public func stopSync() {
public consuming func stopSync() {
Comment thread
ZocoLini marked this conversation as resolved.
let cancelResult = dash_spv_ffi_client_stop(client)
if cancelResult != 0 {
let message = SPVClient.getLastDashFFIError()
Expand Down
Loading