cw-multi-test 3.0.1

Testing tools for multi-contract interactions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! # Custom message and query handler

use crate::app::CosmosRouter;
use crate::error::std_error_bail;
use crate::{AppResponse, Module};
use cosmwasm_std::{Addr, Api, Binary, BlockInfo, Empty, Querier, StdError, StdResult, Storage};
use std::cell::{Ref, RefCell};
use std::ops::Deref;
use std::rc::Rc;

/// A cache for messages and queries processes by the custom module.
#[derive(Default, Clone)]
pub struct CachingCustomHandlerState<ExecC, QueryC>
where
    ExecC: Default + Clone,
    QueryC: Default + Clone,
{
    /// Cache for processes custom messages.
    execs: Rc<RefCell<Vec<ExecC>>>,
    /// Cache for processed custom queries.
    queries: Rc<RefCell<Vec<QueryC>>>,
}

impl<ExecC, QueryC> CachingCustomHandlerState<ExecC, QueryC>
where
    ExecC: Default + Clone,
    QueryC: Default + Clone,
{
    /// Creates a new [CachingCustomHandlerState].
    pub fn new() -> Self {
        Default::default()
    }

    /// Returns a slice of processed custom messages.
    pub fn execs(&self) -> impl Deref<Target = [ExecC]> + '_ {
        Ref::map(self.execs.borrow(), Vec::as_slice)
    }

    /// Returns a slice of processed custom queries.
    pub fn queries(&self) -> impl Deref<Target = [QueryC]> + '_ {
        Ref::map(self.queries.borrow(), Vec::as_slice)
    }

    /// Clears the cache.
    pub fn reset(&self) {
        self.execs.borrow_mut().clear();
        self.queries.borrow_mut().clear();
    }
}

/// Custom handler that stores all received messages and queries.
///
/// State is thin shared state, so it can be held after mock is passed to [App](crate::App) to read state.
#[derive(Default, Clone)]
pub struct CachingCustomHandler<ExecC, QueryC>
where
    ExecC: Default + Clone,
    QueryC: Default + Clone,
{
    /// Cached state.
    state: CachingCustomHandlerState<ExecC, QueryC>,
}

impl<ExecC, QueryC> CachingCustomHandler<ExecC, QueryC>
where
    ExecC: Default + Clone,
    QueryC: Default + Clone,
{
    /// Creates a new [CachingCustomHandler].
    pub fn new() -> Self {
        Default::default()
    }

    /// Returns the cached state.
    pub fn state(&self) -> CachingCustomHandlerState<ExecC, QueryC> {
        self.state.clone()
    }
}

impl<Exec, Query> Module for CachingCustomHandler<Exec, Query>
where
    Exec: Default + Clone,
    Query: Default + Clone,
{
    type ExecT = Exec;
    type QueryT = Query;
    type SudoT = Empty;

    fn execute<ExecC, QueryC>(
        &self,
        _api: &dyn Api,
        _storage: &mut dyn Storage,
        _router: &dyn CosmosRouter<ExecC = ExecC, QueryC = QueryC>,
        _block: &BlockInfo,
        _sender: Addr,
        msg: Self::ExecT,
    ) -> StdResult<AppResponse> {
        self.state.execs.borrow_mut().push(msg);
        Ok(AppResponse::default())
    }

    fn query(
        &self,
        _api: &dyn Api,
        _storage: &dyn Storage,
        _querier: &dyn Querier,
        _block: &BlockInfo,
        request: Self::QueryT,
    ) -> StdResult<Binary> {
        self.state.queries.borrow_mut().push(request);
        Ok(Binary::default())
    }

    fn sudo<ExecC, QueryC>(
        &self,
        _api: &dyn Api,
        _storage: &mut dyn Storage,
        _router: &dyn CosmosRouter<ExecC = ExecC, QueryC = QueryC>,
        _block: &BlockInfo,
        msg: Self::SudoT,
    ) -> StdResult<AppResponse> {
        std_error_bail!("Unexpected custom sudo message {:?}", msg)
    }
}