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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
use cosmwasm_std::{from_binary, Addr, QuerierWrapper, StdError, StdResult};
use serde::de::DeserializeOwned;
use crate::common::{validate_address, validate_string};
use crate::query::{
AttributeQueryParams, MarkerQueryParams, NameQueryParams, ProvenanceQuery,
ProvenanceQueryParams,
};
use crate::types::{AttributeValueType, Attributes, Marker, Name, Names, ProvenanceRoute};
// The data format version to pass into provenance for queries.
static QUERY_DATAFMT_VERSION: &str = "2.0.0";
/// A type for simplifying provenance custom queries.
pub struct ProvenanceQuerier<'a> {
querier: &'a QuerierWrapper<'a>,
}
impl<'a> ProvenanceQuerier<'a> {
/// Creates a new provenance querier
pub fn new(querier: &'a QuerierWrapper) -> Self {
ProvenanceQuerier { querier }
}
// Execute a name module query.
fn query_name_module(&self, params: NameQueryParams) -> StdResult<Names> {
let request = ProvenanceQuery {
route: ProvenanceRoute::Name,
params: ProvenanceQueryParams::Name(params),
version: String::from(QUERY_DATAFMT_VERSION),
};
let res: Names = self.querier.custom_query(&request.into())?;
Ok(res)
}
/// Resolve the address for a name.
///
/// ### Example
///
/// ```rust
/// // Imports required
/// use cosmwasm_std::{Deps, QueryResponse, StdResult};
/// use provwasm_std::{Name, ProvenanceQuerier};
///
/// // Resolve the address for a name.
/// fn query_resolve_name(deps: Deps, name: String) -> StdResult<QueryResponse> {
/// let querier = ProvenanceQuerier::new(&deps.querier);
/// let name: Name = querier.resolve_name(&name)?;
/// // Do something with name.address ...
/// todo!()
/// }
/// ```
pub fn resolve_name<S: Into<String>>(&self, name: S) -> StdResult<Name> {
let res = self.query_name_module(NameQueryParams::Resolve {
name: validate_string(name, "name")?,
})?;
if res.records.len() != 1 {
return Err(StdError::generic_err(
"expected only one address bound to name",
));
}
Ok(res.records[0].clone())
}
/// Lookup all names bound to the given address.
///
/// ### Example
///
/// ```rust
/// // Imports required
/// use cosmwasm_std::{Addr, Deps, QueryResponse, StdResult};
/// use provwasm_std::{Names, ProvenanceQuerier};
///
/// // Lookup all names bound to an address.
/// fn query_lookup_names(deps: Deps, address: Addr) -> StdResult<QueryResponse> {
/// let querier = ProvenanceQuerier::new(&deps.querier);
/// let names: Names = querier.lookup_names(address)?;
/// // Do something with names.records ...
/// todo!()
/// }
/// ```
pub fn lookup_names<H: Into<Addr>>(&self, address: H) -> StdResult<Names> {
self.query_name_module(NameQueryParams::Lookup {
address: validate_address(address)?,
})
}
// Execute a attribute module query.
fn query_attributes(&self, params: AttributeQueryParams) -> StdResult<Attributes> {
let request = ProvenanceQuery {
route: ProvenanceRoute::Attribute,
params: ProvenanceQueryParams::Attribute(params),
version: String::from(QUERY_DATAFMT_VERSION),
};
let res: Attributes = self.querier.custom_query(&request.into())?;
Ok(res)
}
/// Get attributes for an account. If the name parameter is `None`, all attributes are returned.
///
/// ### Example
///
/// ```rust
/// // Imports required
/// use cosmwasm_std::{Addr, Deps, QueryResponse, StdResult};
/// use provwasm_std::{Attributes, ProvenanceQuerier};
///
/// // Query all attributes added to an account.
/// pub fn try_query_attributes(deps: Deps, address: Addr) -> StdResult<QueryResponse> {
/// let querier = ProvenanceQuerier::new(&deps.querier);
/// let none: Option<String> = None;
/// let res: Attributes = querier.get_attributes(address, none)?;
/// // Do something with res.attributes ...
/// todo!()
/// }
/// ```
pub fn get_attributes<H: Into<Addr>, S: Into<String>>(
&self,
address: H,
name: Option<S>,
) -> StdResult<Attributes> {
let address = validate_address(address)?;
match name {
None => self.query_attributes(AttributeQueryParams::GetAllAttributes { address }),
Some(name) => self.query_attributes(AttributeQueryParams::GetAttributes {
address,
name: validate_string(name, "name")?,
}),
}
}
/// Get named JSON attributes from an account and deserialize the values.
/// Attribute values with the same name must be able to be deserialized to the same type.
///
/// ### Example
///
/// ```rust
/// // Imports required
/// use cosmwasm_std::{Addr, Deps, QueryResponse, StdResult};
/// use provwasm_std::ProvenanceQuerier;
/// use schemars::JsonSchema;
/// use serde::{Deserialize, Serialize};
///
/// // Query all label attributes added to an account.
/// pub fn query_labels(deps: Deps, address: Addr) -> StdResult<QueryResponse> {
/// let attr_name = String::from("label.my-contract.sc.pb");
/// let querier = ProvenanceQuerier::new(&deps.querier);
/// let labels: Vec<Label> = querier.get_json_attributes(address, &attr_name)?;
/// // Do something with labels...
/// todo!()
/// }
///
/// // Text with timestamp.
/// #[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
/// #[serde(rename_all = "snake_case")]
/// pub struct Label {
/// pub text: String,
/// pub timestamp: u64,
/// }
/// ```
pub fn get_json_attributes<H: Into<Addr>, S: Into<String>, T: DeserializeOwned>(
&self,
address: H,
name: S,
) -> StdResult<Vec<T>> {
// Gather results
let resp = self.query_attributes(AttributeQueryParams::GetAttributes {
address: validate_address(address)?,
name: validate_string(name, "name")?,
})?;
// Map deserialize, returning values or failure.
resp.attributes
.iter()
.filter(|a| a.value_type == AttributeValueType::Json)
.map(|a| from_binary(&a.value))
.collect()
}
// Execute a marker module query.
fn query_marker(&self, params: MarkerQueryParams) -> StdResult<Marker> {
let request = ProvenanceQuery {
route: ProvenanceRoute::Marker,
params: ProvenanceQueryParams::Marker(params),
version: String::from(QUERY_DATAFMT_VERSION),
};
let res: Marker = self.querier.custom_query(&request.into())?;
Ok(res)
}
/// Get a marker by address.
///
/// ### Example
///
/// ```rust
/// // Imports required
/// use provwasm_std::{ProvenanceQuerier, Marker};
/// use cosmwasm_std::{Addr, Deps, QueryResponse, StdResult};
///
/// // Query a marker by address.
/// fn try_get_marker_by_address(deps: Deps, address: Addr) -> StdResult<QueryResponse> {
/// let querier = ProvenanceQuerier::new(&deps.querier);
/// let marker: Marker = querier.get_marker_by_address(address)?;
/// // Do something with marker ...
/// todo!()
/// }
/// ```
pub fn get_marker_by_address<H: Into<Addr>>(&self, address: H) -> StdResult<Marker> {
self.query_marker(MarkerQueryParams::GetMarkerByAddress {
address: validate_address(address)?,
})
}
/// Get a marker by denomination.
///
/// ### Example
///
/// ```rust
/// // Imports required
/// use cosmwasm_std::{Deps, QueryResponse, StdResult};
/// use provwasm_std::{ProvenanceQuerier, Marker};
///
/// // Query a marker by denom.
/// fn try_get_marker_by_denom(deps: Deps, denom: String) -> StdResult<QueryResponse> {
/// let querier = ProvenanceQuerier::new(&deps.querier);
/// let marker: Marker = querier.get_marker_by_denom(&denom)?;
/// // Do something with marker ...
/// todo!()
/// }
/// ```
pub fn get_marker_by_denom<S: Into<String>>(&self, denom: S) -> StdResult<Marker> {
self.query_marker(MarkerQueryParams::GetMarkerByDenom {
denom: validate_string(denom, "denom")?,
})
}
}