sui_types/
accumulator_root.rs

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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

use crate::{
    balance::Balance,
    base_types::{ObjectID, SequenceNumber, SuiAddress},
    digests::TransactionDigest,
    dynamic_field::{
        serialize_dynamic_field, BoundedDynamicFieldID, DynamicFieldKey, DynamicFieldObject,
        DYNAMIC_FIELD_FIELD_STRUCT_NAME, DYNAMIC_FIELD_MODULE_NAME,
    },
    error::{SuiError, SuiResult},
    object::{Object, Owner},
    storage::{ChildObjectResolver, ObjectStore},
    MoveTypeTagTrait, MoveTypeTagTraitGeneric, SUI_ACCUMULATOR_ROOT_ADDRESS,
    SUI_ACCUMULATOR_ROOT_OBJECT_ID, SUI_FRAMEWORK_ADDRESS, SUI_FRAMEWORK_PACKAGE_ID,
};
use move_core_types::{
    ident_str,
    identifier::IdentStr,
    language_storage::{StructTag, TypeTag},
};
use serde::{de::DeserializeOwned, Deserialize, Serialize};

pub const ACCUMULATOR_ROOT_MODULE: &IdentStr = ident_str!("accumulator");
pub const ACCUMULATOR_SETTLEMENT_MODULE: &IdentStr = ident_str!("accumulator_settlement");
pub const ACCUMULATOR_ROOT_CREATE_FUNC: &IdentStr = ident_str!("create");
pub const ACCUMULATOR_ROOT_SETTLE_U128_FUNC: &IdentStr = ident_str!("settle_u128");
pub const ACCUMULATOR_ROOT_SETTLEMENT_PROLOGUE_FUNC: &IdentStr = ident_str!("settlement_prologue");

const ACCUMULATOR_KEY_TYPE: &IdentStr = ident_str!("Key");
const ACCUMULATOR_U128_TYPE: &IdentStr = ident_str!("U128");

pub fn get_accumulator_root_obj_initial_shared_version(
    object_store: &dyn ObjectStore,
) -> SuiResult<Option<SequenceNumber>> {
    Ok(object_store
        .get_object(&SUI_ACCUMULATOR_ROOT_OBJECT_ID)
        .map(|obj| match obj.owner {
            Owner::Shared {
                initial_shared_version,
            } => initial_shared_version,
            _ => unreachable!("Accumulator root object must be shared"),
        }))
}

/// Rust type for the Move type AccumulatorKey used to derive the dynamic field id for the
/// balance account object.
#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct AccumulatorKey {
    pub owner: SuiAddress,
}

impl MoveTypeTagTraitGeneric for AccumulatorKey {
    fn get_type_tag(type_params: &[TypeTag]) -> TypeTag {
        TypeTag::Struct(Box::new(StructTag {
            address: SUI_FRAMEWORK_PACKAGE_ID.into(),
            module: ACCUMULATOR_ROOT_MODULE.to_owned(),
            name: ACCUMULATOR_KEY_TYPE.to_owned(),
            type_params: type_params.to_vec(),
        }))
    }
}

#[derive(Serialize, Deserialize, Debug, Eq, PartialEq)]
pub enum AccumulatorValue {
    U128(U128),
}

#[derive(Default, Serialize, Deserialize, Debug, Eq, PartialEq)]
pub struct U128 {
    pub value: u128,
}

impl MoveTypeTagTrait for U128 {
    fn get_type_tag() -> TypeTag {
        TypeTag::Struct(Box::new(StructTag {
            address: SUI_FRAMEWORK_ADDRESS,
            module: ACCUMULATOR_ROOT_MODULE.to_owned(),
            name: ACCUMULATOR_U128_TYPE.to_owned(),
            type_params: vec![],
        }))
    }
}

impl AccumulatorValue {
    pub fn get_field_id(owner: SuiAddress, type_: &TypeTag) -> SuiResult<ObjectID> {
        if !Balance::is_balance_type(type_) {
            return Err(SuiError::TypeError {
                error: "only Balance<T> is supported".to_string(),
            });
        }

        let key = AccumulatorKey { owner };
        Ok(DynamicFieldKey(
            SUI_ACCUMULATOR_ROOT_OBJECT_ID,
            key,
            AccumulatorKey::get_type_tag(&[type_.clone()]),
        )
        .into_unbounded_id()?
        .as_object_id())
    }

    pub fn exists(
        child_object_resolver: &dyn ChildObjectResolver,
        version_bound: Option<SequenceNumber>,
        owner: SuiAddress,
        type_: &TypeTag,
    ) -> SuiResult<bool> {
        if !Balance::is_balance_type(type_) {
            return Err(SuiError::TypeError {
                error: "only Balance<T> is supported".to_string(),
            });
        }

        let key = AccumulatorKey { owner };
        DynamicFieldKey(
            SUI_ACCUMULATOR_ROOT_OBJECT_ID,
            key,
            AccumulatorKey::get_type_tag(&[type_.clone()]),
        )
        .into_id_with_bound(version_bound.unwrap_or(SequenceNumber::MAX))?
        .exists(child_object_resolver)
    }

    pub fn load_by_id<T>(
        child_object_resolver: &dyn ChildObjectResolver,
        version_bound: Option<SequenceNumber>,
        id: ObjectID,
    ) -> SuiResult<Option<T>>
    where
        T: Serialize + DeserializeOwned,
    {
        BoundedDynamicFieldID::<AccumulatorKey>::new(
            SUI_ACCUMULATOR_ROOT_OBJECT_ID,
            id,
            version_bound.unwrap_or(SequenceNumber::MAX),
        )
        .load_object(child_object_resolver)?
        .map(|o| o.load_value::<T>())
        .transpose()
    }

    pub fn load(
        child_object_resolver: &dyn ChildObjectResolver,
        version_bound: Option<SequenceNumber>,
        owner: SuiAddress,
        type_: &TypeTag,
    ) -> SuiResult<Option<Self>> {
        if !Balance::is_balance_type(type_) {
            return Err(SuiError::TypeError {
                error: "only Balance<T> is supported".to_string(),
            });
        }

        let key = AccumulatorKey { owner };
        let key_type_tag = AccumulatorKey::get_type_tag(&[type_.clone()]);

        let Some(value) = DynamicFieldKey(SUI_ACCUMULATOR_ROOT_OBJECT_ID, key, key_type_tag)
            .into_id_with_bound(version_bound.unwrap_or(SequenceNumber::MAX))?
            .load_object(child_object_resolver)?
            .map(|o| o.load_value::<U128>())
            .transpose()?
        else {
            return Ok(None);
        };

        Ok(Some(Self::U128(value)))
    }

    pub fn load_object(
        child_object_resolver: &dyn ChildObjectResolver,
        version_bound: Option<SequenceNumber>,
        owner: SuiAddress,
        type_: &TypeTag,
    ) -> SuiResult<Option<Object>> {
        let key = AccumulatorKey { owner };
        let key_type_tag = AccumulatorKey::get_type_tag(&[type_.clone()]);

        Ok(
            DynamicFieldKey(SUI_ACCUMULATOR_ROOT_OBJECT_ID, key, key_type_tag)
                .into_id_with_bound(version_bound.unwrap_or(SequenceNumber::MAX))?
                .load_object(child_object_resolver)?
                .map(|o| o.as_object()),
        )
    }

    pub fn create_for_testing(owner: SuiAddress, type_tag: TypeTag, balance: u64) -> Object {
        let key = AccumulatorKey { owner };
        let value = U128 {
            value: balance as u128,
        };

        let field_key = DynamicFieldKey(
            SUI_ACCUMULATOR_ROOT_OBJECT_ID,
            key,
            AccumulatorKey::get_type_tag(&[type_tag.clone()]),
        );
        let field = field_key.into_field(value).unwrap();
        let move_object = field
            .into_move_object_unsafe_for_testing(SequenceNumber::new())
            .unwrap();

        Object::new_move(
            move_object,
            Owner::ObjectOwner(SUI_ACCUMULATOR_ROOT_ADDRESS.into()),
            TransactionDigest::genesis_marker(),
        )
    }
}

pub fn update_account_balance_for_testing(account_object: &mut Object, balance_change: i128) {
    let current_balance_field = DynamicFieldObject::<AccumulatorKey>::new(account_object.clone())
        .load_field::<U128>()
        .unwrap();

    let current_balance = current_balance_field.value.value;

    assert!(current_balance <= i128::MAX as u128);
    assert!(current_balance as i128 >= balance_change.abs());

    let new_balance = U128 {
        value: (current_balance as i128 + balance_change) as u128,
    };

    let new_field = serialize_dynamic_field(
        &current_balance_field.id,
        &current_balance_field.name,
        new_balance,
    )
    .unwrap();

    let move_object = account_object.data.try_as_move_mut().unwrap();
    move_object.set_contents_unsafe(new_field);
}

/// Check if a StructTag is Field<Key<Balance<T>>, U128>
pub(crate) fn is_balance_accumulator_field(s: &StructTag) -> bool {
    s.address == SUI_FRAMEWORK_ADDRESS
        && s.module.as_ident_str() == DYNAMIC_FIELD_MODULE_NAME
        && s.name.as_ident_str() == DYNAMIC_FIELD_FIELD_STRUCT_NAME
        && s.type_params.len() == 2
        && is_accumulator_key_balance(&s.type_params[0])
        && is_accumulator_u128(&s.type_params[1])
}

/// Check if a TypeTag is Key<Balance<T>>
pub(crate) fn is_accumulator_key_balance(t: &TypeTag) -> bool {
    if let TypeTag::Struct(s) = t {
        s.address == SUI_FRAMEWORK_ADDRESS
            && s.module.as_ident_str() == ACCUMULATOR_ROOT_MODULE
            && s.name.as_ident_str() == ACCUMULATOR_KEY_TYPE
            && s.type_params.len() == 1
            && Balance::is_balance_type(&s.type_params[0])
    } else {
        false
    }
}

/// Check if a TypeTag is U128 from accumulator module
pub(crate) fn is_accumulator_u128(t: &TypeTag) -> bool {
    if let TypeTag::Struct(s) = t {
        s.address == SUI_FRAMEWORK_ADDRESS
            && s.module.as_ident_str() == ACCUMULATOR_ROOT_MODULE
            && s.name.as_ident_str() == ACCUMULATOR_U128_TYPE
            && s.type_params.is_empty()
    } else {
        false
    }
}

/// Extract T from Field<Key<Balance<T>>, U128>
pub(crate) fn extract_balance_type_from_field(s: &StructTag) -> Option<TypeTag> {
    if s.type_params.len() != 2 {
        return None;
    }

    if let TypeTag::Struct(key_struct) = &s.type_params[0] {
        if key_struct.type_params.len() == 1 {
            if let TypeTag::Struct(balance_struct) = &key_struct.type_params[0] {
                if Balance::is_balance(balance_struct) && balance_struct.type_params.len() == 1 {
                    return Some(balance_struct.type_params[0].clone());
                }
            }
        }
    }
    None
}