Struct dash_sdk::sdk::Sdk

pub struct Sdk {
    pub network: Network,
    /* private fields */
}

Dash Platform SDK

This is the main entry point for interacting with Dash Platform. It can be initialized in two modes:

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

Recommended method of initialization is to use SdkBuilder. There are also some helper methods:

• SdkBuilder::new_testnet() Create a SdkBuilder that connects to testnet.
• SdkBuilder::new_mainnet() Create a SdkBuilder that connects to mainnet.
• SdkBuilder::new_mock() Create a mock SdkBuilder.
• Sdk::new_mock() Create a mock Sdk.

Thread safety

Sdk is thread safe and can be shared between threads. It uses internal locking when needed.

It is also safe to clone the Sdk.

Examples

See tests/ for examples of using the SDK.

Fields

network: Network

The network that the sdk is configured for (Dash (mainnet), Testnet, Devnet, Regtest)

Implementations

impl Sdk

pub async fn start_instant_send_lock_stream( &self, from_block_hash: Vec<u8>, address: &Address, ) -> Result<Streaming<TransactionsWithProofsResponse>, Error>

Starts the stream to listen for instant send lock messages

pub async fn wait_for_asset_lock_proof_for_transaction( &self, stream: Streaming<TransactionsWithProofsResponse>, transaction: &Transaction, time_out: Option<Duration>, ) -> Result<AssetLockProof, Error>

Waits for a response for the asset lock proof

impl Sdk

pub fn new_mock() -> Self

Initialize Dash Platform SDK in mock mode.

This is a helper method that uses SdkBuilder to initialize the SDK in mock mode.

See also SdkBuilder.

pub fn context_provider(&self) -> Option<impl ContextProvider>

pub fn mock(&mut self) -> MutexGuard<'_, MockDashPlatformSdk>

Returns a mutable reference to the MockDashPlatformSdk instance.

Use returned object to configure mock responses with methods like expect_fetch.

Panics

Panics when:

• the self instance is not a Mock variant,
• the self instance is in use by another thread.

pub async fn get_identity_nonce( &self, identity_id: Identifier, bump_first: bool, settings: Option<PutSettings>, ) -> Result<IdentityNonce, Error>

Updates or fetches the nonce for a given identity from the cache, querying Platform if the cached value is stale or absent. Optionally increments the nonce before storing it, based on the provided settings.

pub async fn get_identity_contract_nonce( &self, identity_id: Identifier, contract_id: Identifier, bump_first: bool, settings: Option<PutSettings>, ) -> Result<IdentityNonce, Error>

Updates or fetches the nonce for a given identity and contract pair from a cache, querying Platform if the cached value is stale or absent. Optionally increments the nonce before storing it, based on the provided settings.

pub fn version<'v>(&self) -> &'v PlatformVersion

Return Dash Platform version information used by this SDK.

This is the version configured in SdkBuilder. Useful whenever you need to provide [PlatformVersion] to other SDK and DPP methods.

pub fn prove(&self) -> bool

Indicate if the sdk should request and verify proofs.

pub fn set_context_provider<C: ContextProvider + 'static>( &mut self, context_provider: C, )

Set the ContextProvider to use.

ContextProvider is used to access state information, like data contracts and quorum public keys.

Note that this will overwrite any previous context provider.

pub fn cancelled(&self) -> WaitForCancellationFuture<'_>

Returns a future that resolves when the Sdk is cancelled (eg. shutdown was requested).

pub fn shutdown(&self)

Request shutdown of the Sdk and all related operation.

Trait Implementations

impl Clone for Sdk

fn clone(&self) -> Sdk

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DapiRequestExecutor for Sdk

fn execute<'life0, 'async_trait, R>( &'life0 self, request: R, settings: RequestSettings, ) -> Pin<Box<dyn Future<Output = Result<R::Response, DapiClientError<<R::Client as TransportClient>::Error>>> + Send + 'async_trait>>

where R: 'async_trait + TransportRequest, Self: 'async_trait, 'life0: 'async_trait,

Execute request using this DAPI client.

impl Debug for Sdk

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.