Struct dash_sdk::mock::sdk::MockDashPlatformSdk

pub struct MockDashPlatformSdk { /* private fields */ }

Mechanisms to mock Dash Platform SDK.

This object is returned by Sdk::mock() and is used to define mock expectations.

Use MockDashPlatformSdk::expect_fetch_many() to define expectations for FetchMany requests and MockDashPlatformSdk::expect_fetch() for Fetch requests.

Panics

Can panic on errors.

Implementations

impl MockDashPlatformSdk

pub fn prove(&self) -> bool

Returns true when requests should use proofs.

Panics

Panics when sdk is not set during initialization.

pub async fn load_expectations<P: AsRef<Path>>( &mut self, dir: P, ) -> Result<&mut Self, Error>

Load all expectations from files in a directory.

By default, mock expectations are loaded when Sdk is built with SdkBuilder::build(). This function can be used to load expectations after the Sdk is created, or use alternative location. Expectation files must be prefixed with [DapiClient::DUMP_FILE_PREFIX] and have .json extension.

pub async fn expect_fetch<O: Fetch + MockResponse, Q: Query<<O as Fetch>::Request>>( &mut self, query: Q, object: Option<O>, ) -> Result<&mut Self, Error>

where <<O as Fetch>::Request as TransportRequest>::Response: Default,

Expect a Fetch request and return provided object.

This method is used to define mock expectations for Fetch requests.

Generic Parameters

• O: Type of the object that will be returned in response to the query. Must implement Fetch and MockResponse.
• Q: Type of the query that will be sent to Platform. Must implement Query and Mockable.

Arguments

• query: Query that will be sent to Platform.
• object: Object that will be returned in response to query, or None if the object is expected to not exist.

Returns

• Reference to self on success, to allow chaining
• Error when expectation cannot be set or is already defined for this request

Panics

Can panic on errors.

Example

    use dash_sdk::{Sdk, platform::{Identity, Fetch, dpp::identity::accessors::IdentityGettersV0}};

    let mut api = Sdk::new_mock();
    // Define expected response
    let expected: Identity = Identity::random_identity(1, None, api.version())
        .expect("create expected identity");
    // Define query that will be sent
    let query = expected.id();
    // Expect that in response to `query`, `expected` will be returned
    api.mock().expect_fetch(query, Some(expected.clone())).await.unwrap();

    // Fetch the identity
    let retrieved = dpp::prelude::Identity::fetch(&api, query)
        .await
        .unwrap()
        .expect("object should exist");

    // Check that the identity is the same as expected
    assert_eq!(retrieved, expected);

pub async fn expect_fetch_many<K: Ord, O: FetchMany<K, R>, Q: Query<<O as FetchMany<K, R>>::Request>, R>( &mut self, query: Q, objects: Option<R>, ) -> Result<&mut Self, Error>

where R: MockResponse + FromProof<<O as FetchMany<K, R>>::Request, Request = <O as FetchMany<K, R>>::Request, Response = <<O as FetchMany<K, R>>::Request as TransportRequest>::Response> + Sync + FromIterator<(K, Option<O>)> + Send + Default, <<O as FetchMany<K, R>>::Request as TransportRequest>::Response: Default,

Expect a FetchMany request and return provided object.

This method is used to define mock expectations for FetchMany requests.

Generic Parameters

• O: Type of the object that will be returned in response to the query. Must implement FetchMany. Vec<O> must implement MockResponse.
• Q: Type of the query that will be sent to Platform. Must implement Query and Mockable.

Arguments

• query: Query that will be sent to Platform.
• objects: Vector of objects that will be returned in response to query, or None if no objects are expected.

Returns

• Reference to self on success, to allow chaining
• Error when expectation cannot be set or is already defined for this request

Panics

Can panic on errors.

Example

Usage example is similar to MockDashPlatformSdk::expect_fetch(), but the expected object must be a vector of objects.

Trait Implementations

impl Debug for MockDashPlatformSdk

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

Formats the value using the given formatter.