Skip to content

feat(rs-sdk-ffi): expose SDK protocol version pinning #3734

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

Closed
thepastaclaw wants to merge 9 commits into from
Closed

feat(rs-sdk-ffi): expose SDK protocol version pinning #3734

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
22365d9
feat(ffi): expose SDK protocol version pinning
thepastaclaw May 25, 2026
ef353c1
fix(rs-sdk-ffi): address SDK protocol pinning review
thepastaclaw May 25, 2026
db8a8db
fix(rs-sdk-ffi): align sdk builder config paths
thepastaclaw May 25, 2026
687508c
fix(rs-sdk-ffi): address remaining PR3734 review feedback
thepastaclaw May 27, 2026
35b6d40
fix(rs-sdk-ffi): pin protocol version via extended config
thepastaclaw May 27, 2026
05bdc9e
Merge branch 'v3.1-dev' into feature/ffi-sdk-protocol-version
lklimek May 27, 2026
24eb5df
fix(rs-sdk-ffi): pin protocol version via separate constructors
thepastaclaw May 27, 2026
6c448d8
refactor(rs-sdk-ffi): delegate callbacks helper directly to extended …
thepastaclaw May 27, 2026
5657829
docs(rs-sdk-ffi): fix protocol pinning examples
thepastaclaw May 27, 2026
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
39 changes: 14 additions & 25 deletions packages/rs-sdk-ffi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,14 @@ dash_sdk_init();
DashSDKConfig config = {
.network = DASH_SDK_NETWORK_TESTNET,
.dapi_addresses = "seed-1.testnet.networks.dash.org",
.skip_asset_lock_proof_verification = false,
.request_retry_count = 3,
.request_timeout_ms = 30000
};
Comment on lines 86 to 92
Comment on lines 86 to 92
Copy link
Copy Markdown
Collaborator Author

@thepastaclaw thepastaclaw May 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in 5657829897: the C example now uses a full DAPI URI with scheme and port: https://seed-1.testnet.networks.dash.org:1443.


// Create SDK instance
DashSDKResult result = dash_sdk_create(&config);
// Create SDK instance pinned to Platform protocol version 11.
// Pass 0 to keep the default auto-detect behavior.
DashSDKResult result = dash_sdk_create_with_protocol_version(&config, 11);
if (result.error) {
// Handle error
dash_sdk_error_free(result.error);
Expand All @@ -106,28 +108,11 @@ dash_sdk_destroy(sdk);
// Initialize the SDK
dash_sdk_init()

// Create SDK configuration
var config = DashSDKConfig(
network: DashSDKNetwork.testnet,
dapi_addresses: "seed-1.testnet.networks.dash.org".cString(using: .utf8),
request_retry_count: 3,
request_timeout_ms: 30000
)

// Create SDK instance
let result = dash_sdk_create(&config)
if let error = result.error {
// Handle error
dash_sdk_error_free(error)
return
}
// Default behavior auto-detects the protocol version.
let sdk = try SDK(network: .testnet)

let sdk = result.data

// Use the SDK...

// Clean up
dash_sdk_destroy(sdk)
// Pass 11 to pin Platform protocol version 11 instead.
let pinnedSDK = try SDK(network: .testnet, protocolVersion: 11)
```

### Python Usage Example
Expand All @@ -147,19 +132,22 @@ class DashSDKConfig(Structure):
_fields_ = [
("network", c_int),
("dapi_addresses", c_char_p),
("skip_asset_lock_proof_verification", c_bool),
("request_retry_count", c_uint32),
("request_timeout_ms", c_uint64)
]

config = DashSDKConfig(
network=1, # Testnet
dapi_addresses=b"seed-1.testnet.networks.dash.org",
skip_asset_lock_proof_verification=False,
request_retry_count=3,
request_timeout_ms=30000
)
Comment on lines 146 to 152
Copy link
Copy Markdown
Collaborator Author

@thepastaclaw thepastaclaw May 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in 5657829897: the Python example now uses the same full DAPI URI form (https://seed-1.testnet.networks.dash.org:1443) so it satisfies AddressList::from_str parsing.


# Create SDK instance
result = lib.dash_sdk_create(byref(config))
# Create SDK instance pinned to protocol version 11.
# Pass 0 to keep the default auto-detect behavior.
result = lib.dash_sdk_create_with_protocol_version(byref(config), 11)
Comment on lines +154 to +156
# ... handle result and use SDK
```

Expand All @@ -170,6 +158,7 @@ result = lib.dash_sdk_create(byref(config))
#### Core Functions
- `dash_sdk_init()` - Initialize the FFI library
- `dash_sdk_create()` - Create an SDK instance
- `dash_sdk_create_with_protocol_version()` - Create an SDK instance with optional protocol-version pinning
- `dash_sdk_destroy()` - Destroy an SDK instance
- `dash_sdk_version()` - Get the SDK version

Expand Down
Loading
Loading