Struct dash_sdk::sdk::SdkBuilder

pub struct SdkBuilder { /* private fields */ }

Dash Platform SDK Builder, used to configure and SdkBuilder::build() the Sdk.

SdkBuilder implements a “builder” design pattern to allow configuration of the Sdk before it is instantiated. It allows creation of Sdk in two modes:

• Normal: Connects to a remote Dash Platform node.
• Mock: Uses a mock implementation of Dash Platform.

Mandatory steps of initialization in normal mode are:

1. Create an instance of SdkBuilder with SdkBuilder::new()
2. Configure the builder with SdkBuilder::with_core()
3. Call SdkBuilder::build() to create the Sdk instance.

Implementations

impl SdkBuilder

pub fn new(addresses: AddressList) -> Self

Create a new SdkBuilder with provided address list.

pub fn new_mock() -> Self

Create a new SdkBuilder that will generate mock client.

pub fn new_testnet() -> Self

Create a new SdkBuilder instance preconfigured for testnet. NOT IMPLEMENTED YET.

This is a helper method that preconfigures SdkBuilder for testnet use. Use this method if you want to connect to Dash Platform testnet during development and testing of your solution.

pub fn new_mainnet() -> Self

Create a new SdkBuilder instance preconfigured mainnet (production network). NOT IMPLEMENTED YET.

This is a helper method that preconfigures SdkBuilder for production use. Use this method if you want to connect to Dash Platform mainnet with production-ready product.

pub fn with_network(self, network: Network) -> Self

Configure network type.

Defaults to Network::Dash which is mainnet.

pub fn with_settings(self, settings: RequestSettings) -> Self

Configure request settings.

Tune request settings used to connect to the Dash Platform.

Defaults to RequestSettings::default().

See RequestSettings for more information.

pub fn with_version(self, version: &'static PlatformVersion) -> Self

Configure platform version.

Select specific version of Dash Platform to use.

Defaults to [PlatformVersion::latest()].

pub fn with_context_provider<C: ContextProvider + 'static>( self, context_provider: C, ) -> Self

Configure context provider to use.

Context provider is used to retrieve data contracts and quorum public keys from application state. It should be implemented by the user of this SDK to provide stateful information about the application.

See ContextProvider for more information and GrpcContextProvider for an example implementation.

pub fn with_cancellation_token(self, cancel_token: CancellationToken) -> Self

Set cancellation token that will be used by the Sdk.

Once that cancellation token is cancelled, all pending requests shall teriminate.

pub fn with_core(self, ip: &str, port: u16, user: &str, password: &str) -> Self

Use Dash Core as a wallet and context provider.

This is a convenience method that configures the SDK to use Dash Core as a wallet and context provider.

For more control over the configuration, use [SdkBuilder::with_wallet()] and SdkBuilder::with_context_provider().

This is temporary implementation, intended for development purposes.

pub fn with_dump_dir(self, dump_dir: &Path) -> Self

Configure directory where dumps of all requests and responses will be saved. Useful for debugging.

This function will create the directory if it does not exist and save dumps of

• all requests and responses - in files named msg-*.json
• retrieved quorum public keys - in files named quorum_pubkey-*.json
• retrieved data contracts - in files named data_contract-*.json

These files can be used together with MockDashPlatformSdk to replay the requests and responses. See MockDashPlatformSdk::load_expectations() for more information.

Available only when mocks feature is enabled.

pub fn build(self) -> Result<Sdk, Error>

Build the Sdk instance.

This method will create the Sdk instance based on the configuration provided to the builder.

Errors

This method will return an error if the Sdk cannot be created.

Trait Implementations

impl Default for SdkBuilder

fn default() -> Self

Create default SdkBuilder that will create a mock client.