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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
// Copied from cw-plus repository: https://github.com/CosmWasm/cw-plus/tree/main/packages/controllers
// Original file distributed on Apache license
use itertools::Itertools;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use cosmwasm_std::{
Addr, BlockInfo, CustomQuery, Decimal, Deps, Order, StdResult, Storage, Uint128,
};
use cw_storage_plus::{Bound, Index, IndexList, IndexedMap, MultiIndex, PrefixBound};
use tg_utils::Expiration;
// settings for pagination
const MAX_LIMIT: u32 = 100;
const DEFAULT_LIMIT: u32 = 30;
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, JsonSchema)]
pub struct Claim {
/// Address owning the claim
pub addr: Addr,
/// Amount of tokens in claim
pub amount: Uint128,
/// Release time of the claim. Originally in `cw_controllers` it is an `Expiration` type, but
/// here we need to query for claims via release time, and expiration is impossible to be
/// properly sorted, as it is impossible to properly compare expiration by height and
/// expiration by time.
pub release_at: Expiration,
/// Height of a blockchain in a moment of creation of this claim
pub creation_height: u64,
}
struct ClaimIndexes<'a> {
// Last type param defines the pk deserialization type
pub release_at: MultiIndex<'a, u64, Claim, (Addr, u64)>,
}
impl<'a> IndexList<Claim> for ClaimIndexes<'a> {
fn get_indexes(&'_ self) -> Box<dyn Iterator<Item = &'_ dyn Index<Claim>> + '_> {
let v: Vec<&dyn Index<Claim>> = vec![&self.release_at];
Box::new(v.into_iter())
}
}
impl Claim {
pub fn new(addr: Addr, amount: u128, released: Expiration, creation_height: u64) -> Self {
Claim {
addr,
amount: amount.into(),
release_at: released,
creation_height,
}
}
}
pub struct Claims<'a> {
/// Claims are indexed by `(addr, release_at)` pair. Claims falling into the same key are
/// merged (summarized) as there is no point to distinguish them.
claims: IndexedMap<'a, (&'a Addr, u64), Claim, ClaimIndexes<'a>>,
}
impl<'a> Claims<'a> {
pub fn new(storage_key: &'a str, release_subkey: &'a str) -> Self {
let indexes = ClaimIndexes {
release_at: MultiIndex::new(
|claim| claim.release_at.as_key(),
storage_key,
release_subkey,
),
};
let claims = IndexedMap::new(storage_key, indexes);
Self { claims }
}
/// This creates a claim, such that the given address can claim an amount of tokens after
/// the release date.
pub fn create_claim(
&self,
storage: &mut dyn Storage,
addr: Addr,
amount: Uint128,
release_at: Expiration,
creation_height: u64,
) -> StdResult<()> {
let addr = &addr;
// Add a claim to this user to get their tokens after the unbonding period
self.claims.update(
storage,
(addr, release_at.as_key()),
move |claim| -> StdResult<_> {
match claim {
Some(mut claim) => {
claim.amount += amount;
Ok(claim)
}
None => Ok(Claim {
addr: addr.clone(),
amount,
release_at,
creation_height,
}),
}
},
)?;
Ok(())
}
/// This iterates over all mature claims for the address, and removes them, up to an optional limit.
/// It removes the finished claims and returns the total amount of tokens to be released.
pub fn claim_addr(
&self,
storage: &mut dyn Storage,
addr: &Addr,
block: &BlockInfo,
limit: impl Into<Option<u64>>,
) -> StdResult<Uint128> {
let claims = self
.claims
.prefix(addr)
// take all claims for the addr
.range_raw(
storage,
None,
Some(Bound::inclusive(Expiration::now(block).as_key())),
Order::Ascending,
);
let claims = self.collect_claims(claims, limit.into())?;
let amount = claims.iter().map(|claim| claim.amount).sum();
self.release_claims(storage, claims)?;
Ok(amount)
}
/// This iterates over all mature claims of any addresses, and removes them. Up to `limit`
/// claims would be processed, starting from the oldest. It removes the finished claims and
/// returns vector of pairs: `(addr, amount)`, representing amount of tokens to be released to particular addresses
pub fn claim_expired(
&self,
storage: &mut dyn Storage,
block: &BlockInfo,
limit: impl Into<Option<u64>>,
) -> StdResult<Vec<(Addr, Uint128)>> {
let claims = self
.claims
.idx
.release_at
// take all claims which are expired (at most same timestamp as current block)
.prefix_range_raw(
storage,
None,
Some(PrefixBound::inclusive(block.time.nanos())),
Order::Ascending,
);
let mut claims = self.collect_claims(claims, limit.into())?;
claims.sort_by_key(|claim| claim.addr.clone());
let releases = claims
.iter()
// TODO: use `slice::group_by` in place of `Itertools::group_by` when `slice_group_by`
// is stabilized [https://github.com/rust-lang/rust/issues/80552]
.group_by(|claim| &claim.addr)
.into_iter()
.map(|(addr, group)| (addr.clone(), group.map(|claim| claim.amount).sum()))
.collect();
self.release_claims(storage, claims)?;
Ok(releases)
}
/// Processes claims filtering those which are to be released. Returns vector of claims to be
/// released
fn collect_claims(
&self,
claims: impl IntoIterator<Item = StdResult<(Vec<u8>, Claim)>>,
limit: Option<u64>,
) -> StdResult<Vec<Claim>> {
// apply limit and collect - it is needed to collect intermediately, as it is impossible to
// remove from map while iterating as it borrows map internally; collecting to result, so
// it returns early on failure; collecting would also trigger a final map, so amount would
// be properly fulfilled
let claims = claims.into_iter().map(|r| r.map(|(_, c)| c));
if let Some(limit) = limit {
claims.take(limit as usize).collect()
} else {
claims.collect()
}
}
/// Releases given claims by removing them from storage
fn release_claims(
&self,
storage: &mut dyn Storage,
claims: impl IntoIterator<Item = Claim>,
) -> StdResult<()> {
for claim in claims {
self.claims
.remove(storage, (&claim.addr, claim.release_at.as_key()))?;
}
Ok(())
}
pub fn slash_claims_for_addr(
&self,
storage: &mut dyn Storage,
address: Addr,
portion: Decimal,
) -> StdResult<Uint128> {
let claims: StdResult<Vec<_>> = self
.claims
.prefix(&address)
.range(storage, None, None, Order::Ascending)
.collect();
let claims = claims?;
let mut total_slashed = Uint128::zero();
for (release_at, claim) in claims {
let key = (&address, release_at);
let slashed = claim.amount * portion;
let mut new_claim = claim.clone();
new_claim.amount -= slashed;
self.claims
.replace(storage, key, Some(&new_claim), Some(&claim))?;
total_slashed += slashed;
}
Ok(total_slashed)
}
pub fn query_claims<Q: CustomQuery>(
&self,
deps: Deps<Q>,
address: Addr,
limit: Option<u32>,
start_after: Option<Expiration>,
) -> StdResult<Vec<Claim>> {
let limit = limit.unwrap_or(DEFAULT_LIMIT).min(MAX_LIMIT) as usize;
let start = start_after.map(|s| Bound::exclusive(s.as_key()));
self.claims
.prefix(&address)
.range(deps.storage, start, None, Order::Ascending)
.map(|claim| match claim {
Ok((_, claim)) => Ok(claim),
Err(err) => Err(err),
})
.take(limit)
.collect()
}
}