Struct MockServiceRuntime

pub struct MockServiceRuntime<Application>
where
    Application: Service,
{ /* private fields */ }

The runtime available during execution of a query.

Implementations

impl<Application> MockServiceRuntime<Application>

where Application: Service,

pub fn new() -> Self

Creates a new MockServiceRuntime instance for a service.

pub fn key_value_store(&self) -> KeyValueStore

Returns the key-value store to interface with storage.

pub fn root_view_storage_context(&self) -> ViewStorageContext

Returns a storage context suitable for a root view.

pub fn with_application_parameters( self, application_parameters: Application::Parameters, ) -> Self

Configures the application parameters to return during the test.

pub fn set_application_parameters( &self, application_parameters: Application::Parameters, ) -> &Self

Configures the application parameters to return during the test.

pub fn application_parameters(&self) -> Application::Parameters

Returns the application parameters provided when the application was created.

pub fn with_application_id( self, application_id: ApplicationId<Application::Abi>, ) -> Self

Configures the application ID to return during the test.

pub fn set_application_id( &self, application_id: ApplicationId<Application::Abi>, ) -> &Self

Configures the application ID to return during the test.

pub fn application_id(&self) -> ApplicationId<Application::Abi>

Returns the ID of the current application.

pub fn with_application_creator_chain_id( self, application_creator_chain_id: ChainId, ) -> Self

Configures the application creator chain ID to return during the test.

pub fn set_application_creator_chain_id( &self, application_creator_chain_id: ChainId, ) -> &Self

Configures the application creator chain ID to return during the test.

pub fn application_creator_chain_id(&self) -> ChainId

Returns the chain ID of the current application creator.

pub fn with_chain_id(self, chain_id: ChainId) -> Self

Configures the chain ID to return during the test.

pub fn set_chain_id(&self, chain_id: ChainId) -> &Self

Configures the chain ID to return during the test.

pub fn chain_id(&self) -> ChainId

Returns the ID of the current chain.

pub fn with_next_block_height(self, next_block_height: BlockHeight) -> Self

Configures the next block height to return during the test.

pub fn set_next_block_height(&self, next_block_height: BlockHeight) -> &Self

Configures the block height to return during the test.

pub fn next_block_height(&self) -> BlockHeight

Returns the height of the next block that can be added to the current chain.

pub fn with_system_time(self, timestamp: Timestamp) -> Self

Configures the system time to return during the test.

pub fn set_system_time(&self, timestamp: Timestamp) -> &Self

Configures the system time to return during the test.

pub fn system_time(&self) -> Timestamp

Retrieves the current system time, i.e. the timestamp of the block in which this is called.

pub fn with_chain_balance(self, chain_balance: Amount) -> Self

Configures the chain balance to return during the test.

pub fn set_chain_balance(&self, chain_balance: Amount) -> &Self

Configures the chain balance to return during the test.

pub fn chain_balance(&self) -> Amount

Returns the current chain balance.

pub fn with_owner_balances( self, owner_balances: impl IntoIterator<Item = (AccountOwner, Amount)>, ) -> Self

Configures the balances on the chain to use during the test.

pub fn set_owner_balances( &self, owner_balances: impl IntoIterator<Item = (AccountOwner, Amount)>, ) -> &Self

Configures the balances on the chain to use during the test.

pub fn with_owner_balance(self, owner: AccountOwner, balance: Amount) -> Self

Configures the balance of one account on the chain to use during the test.

pub fn set_owner_balance(&self, owner: AccountOwner, balance: Amount) -> &Self

Configures the balance of one account on the chain to use during the test.

pub fn owner_balance(&self, owner: AccountOwner) -> Amount

Returns the balance of one of the accounts on this chain.

pub fn owner_balances(&self) -> Vec<(AccountOwner, Amount)>

Returns the balances of all accounts on the chain.

pub fn balance_owners(&self) -> Vec<AccountOwner>

Returns the owners of accounts on this chain.

pub fn schedule_raw_operation(&self, operation: Vec<u8>)

Schedules an operation to be included in the block being built.

The operation is specified as an opaque blob of bytes.

pub fn schedule_operation(&self, operation: &impl Serialize)

Schedules an operation to be included in the block being built.

The operation is serialized using BCS.

pub fn raw_scheduled_operations(&self) -> Vec<Vec<u8>>

Returns the list of operations scheduled since the most recent of:

• the last call to this method;
• the last call to Self::scheduled_operations;
• or since the mock runtime was created.

pub fn scheduled_operations<Operation>(&self) -> Vec<Operation>

where Operation: DeserializeOwned,

Returns the list of operations scheduled since the most recent of:

• the last call to this method;
• the last call to Self::raw_scheduled_operations;
• or since the mock runtime was created.

All operations are deserialized using BCS into the Operation generic type.

pub fn with_query_application_handler( self, handler: impl FnMut(ApplicationId, Vec<u8>) -> Vec<u8> + Send + 'static, ) -> Self

Configures the handler for application queries made during the test.

pub fn set_query_application_handler( &self, handler: impl FnMut(ApplicationId, Vec<u8>) -> Vec<u8> + Send + 'static, ) -> &Self

Configures the handler for application queries made during the test.

pub fn query_application<A: ServiceAbi>( &self, application: ApplicationId<A>, query: &A::Query, ) -> A::QueryResponse

Queries another application.

pub fn add_expected_http_request( &mut self, request: Request, response: Response, )

Adds an expected http_request call, and the response it should return in the test.

pub fn http_request(&self, request: Request) -> Response

Makes an HTTP request as an oracle and returns the HTTP response.

Should only be used with queries where it is very likely that all validators will receive the same response, otherwise most block proposals will fail.

Cannot be used in fast blocks: A block using this call should be proposed by a regular owner, not a super owner.

pub fn with_blobs( self, blobs: impl IntoIterator<Item = (DataBlobHash, Vec<u8>)>, ) -> Self

Configures the blobs returned when fetching from hashes during the test.

pub fn set_blobs( &self, blobs: impl IntoIterator<Item = (DataBlobHash, Vec<u8>)>, ) -> &Self

Configures the blobs returned when fetching from hashes during the test.

pub fn with_blob(self, hash: impl Into<DataBlobHash>, blob: Vec<u8>) -> Self

Configures the blob returned when fetching from the given hash during the test.

pub fn set_blob(&self, hash: impl Into<DataBlobHash>, blob: Vec<u8>) -> &Self

Configures the blob returned when fetching from the hash during the test.

pub fn read_data_blob(&self, hash: DataBlobHash) -> Vec<u8>

Fetches a blob from a given hash.

pub fn assert_blob_exists(&self, hash: DataBlobHash)

Asserts that a blob with the given hash exists in storage.

Trait Implementations

impl<Application> Default for MockServiceRuntime<Application>

where Application: Service,

fn default() -> Self

Returns the “default value” for a type.