cougr-core 1.0.0

Cougr - A Soroban-compatible ECS framework for on-chain gaming on Stellar
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
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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
use soroban_sdk::{contracttype, Address, BytesN, Env, Symbol, Vec};

use super::device_storage::DeviceStorage;
use super::error::AccountError;

/// A registered device key with metadata.
#[contracttype]
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct DeviceKey {
    /// Unique identifier for this device key.
    pub key_id: BytesN<32>,
    /// Human-readable device name (e.g., "phone", "laptop").
    pub device_name: Symbol,
    /// Ledger timestamp when the device was registered.
    pub registered_at: u64,
    /// Ledger timestamp of the last use.
    pub last_used: u64,
    /// Whether this device key is currently active.
    pub is_active: bool,
}

/// Policy for multi-device management.
#[contracttype]
#[derive(Clone, Debug)]
pub struct DevicePolicy {
    /// Maximum number of devices that can be registered.
    pub max_devices: u32,
    /// Number of ledger slots of inactivity before auto-revoke.
    /// Set to 0 to disable auto-revoke.
    pub auto_revoke_after: u64,
}

/// Trait for account types that support multi-device key management.
pub trait MultiDeviceProvider {
    /// Register a new device key.
    fn register_device(
        &mut self,
        env: &Env,
        key_id: BytesN<32>,
        device_name: Symbol,
    ) -> Result<DeviceKey, AccountError>;

    /// Revoke a device key by its ID.
    fn revoke_device(&mut self, env: &Env, key_id: &BytesN<32>) -> Result<(), AccountError>;

    /// List all registered device keys (active and inactive).
    fn list_devices(&self, env: &Env) -> Vec<DeviceKey>;

    /// Returns the number of active devices.
    fn active_device_count(&self, env: &Env) -> usize;

    /// Update the last_used timestamp for a device.
    fn update_last_used(&mut self, env: &Env, key_id: &BytesN<32>) -> Result<(), AccountError>;

    /// Set the device management policy.
    fn set_policy(&mut self, env: &Env, policy: DevicePolicy);

    /// Get the current device policy.
    fn policy(&self, env: &Env) -> DevicePolicy;

    /// Revoke devices that have been inactive beyond the policy's auto_revoke_after.
    /// Returns the number of devices revoked.
    fn cleanup_inactive(&mut self, env: &Env) -> u32;
}

/// Persistent implementation of multi-device management.
///
/// Device keys and policy are stored in Soroban persistent storage
/// via [`DeviceStorage`], surviving across contract invocations.
pub struct DeviceManager {
    address: Address,
}

impl DeviceManager {
    /// Create a new device manager with the given policy, persisting it.
    pub fn new(address: Address, policy: DevicePolicy, env: &Env) -> Self {
        DeviceStorage::store_policy(env, &address, &policy);
        DeviceStorage::store_devices(env, &address, &Vec::new(env));
        Self { address }
    }

    /// Load an existing device manager (policy must already be stored).
    pub fn load(address: Address) -> Self {
        Self { address }
    }

    /// Create a device manager with a default policy.
    pub fn with_defaults(address: Address, env: &Env) -> Self {
        let policy = DevicePolicy {
            max_devices: 5,
            auto_revoke_after: 0,
        };
        Self::new(address, policy, env)
    }
}

impl MultiDeviceProvider for DeviceManager {
    fn register_device(
        &mut self,
        env: &Env,
        key_id: BytesN<32>,
        device_name: Symbol,
    ) -> Result<DeviceKey, AccountError> {
        let policy =
            DeviceStorage::load_policy(env, &self.address).ok_or(AccountError::StorageError)?;
        let devices = DeviceStorage::load_devices(env, &self.address);

        // Check device limit (active only)
        let mut active_count: u32 = 0;
        for i in 0..devices.len() {
            if let Some(d) = devices.get(i) {
                if d.is_active {
                    active_count += 1;
                }
                // Check for duplicate active key_id
                if d.key_id == key_id && d.is_active {
                    return Err(AccountError::DeviceLimitReached);
                }
            }
        }

        if active_count >= policy.max_devices {
            return Err(AccountError::DeviceLimitReached);
        }

        let now = env.ledger().timestamp();
        let device = DeviceKey {
            key_id,
            device_name,
            registered_at: now,
            last_used: now,
            is_active: true,
        };

        let mut new_devices = devices;
        new_devices.push_back(device.clone());
        DeviceStorage::store_devices(env, &self.address, &new_devices);
        Ok(device)
    }

    fn revoke_device(&mut self, env: &Env, key_id: &BytesN<32>) -> Result<(), AccountError> {
        DeviceStorage::update_device(env, &self.address, key_id, |d| {
            if !d.is_active {
                // Will still succeed but we need custom handling
            }
            d.is_active = false;
        })
    }

    fn list_devices(&self, env: &Env) -> Vec<DeviceKey> {
        DeviceStorage::load_devices(env, &self.address)
    }

    fn active_device_count(&self, env: &Env) -> usize {
        let devices = DeviceStorage::load_devices(env, &self.address);
        let mut count: usize = 0;
        for i in 0..devices.len() {
            if let Some(d) = devices.get(i) {
                if d.is_active {
                    count += 1;
                }
            }
        }
        count
    }

    fn update_last_used(&mut self, env: &Env, key_id: &BytesN<32>) -> Result<(), AccountError> {
        let now = env.ledger().timestamp();
        DeviceStorage::update_device(env, &self.address, key_id, |d| {
            d.last_used = now;
        })
    }

    fn set_policy(&mut self, env: &Env, policy: DevicePolicy) {
        DeviceStorage::store_policy(env, &self.address, &policy);
    }

    fn policy(&self, env: &Env) -> DevicePolicy {
        DeviceStorage::load_policy(env, &self.address).unwrap_or(DevicePolicy {
            max_devices: 5,
            auto_revoke_after: 0,
        })
    }

    fn cleanup_inactive(&mut self, env: &Env) -> u32 {
        let policy = DeviceStorage::load_policy(env, &self.address).unwrap_or(DevicePolicy {
            max_devices: 5,
            auto_revoke_after: 0,
        });

        if policy.auto_revoke_after == 0 {
            return 0;
        }

        let now = env.ledger().timestamp();
        let threshold = policy.auto_revoke_after;
        let devices = DeviceStorage::load_devices(env, &self.address);
        let mut new_devices: Vec<DeviceKey> = Vec::new(env);
        let mut revoked: u32 = 0;

        for i in 0..devices.len() {
            if let Some(mut d) = devices.get(i) {
                if d.is_active && now.saturating_sub(d.last_used) > threshold {
                    d.is_active = false;
                    revoked += 1;
                }
                new_devices.push_back(d);
            }
        }

        if revoked > 0 {
            DeviceStorage::store_devices(env, &self.address, &new_devices);
        }

        revoked
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use soroban_sdk::{contract, contractimpl, symbol_short, testutils::Address as _, Env};

    #[contract]
    pub struct TestContract;

    #[contractimpl]
    impl TestContract {}

    fn default_policy() -> DevicePolicy {
        DevicePolicy {
            max_devices: 3,
            auto_revoke_after: 0,
        }
    }

    #[test]
    fn test_register_device() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let mut manager = DeviceManager::new(addr, default_policy(), &env);
            let key_id = BytesN::from_array(&env, &[1u8; 32]);
            let device = manager
                .register_device(&env, key_id, symbol_short!("phone"))
                .unwrap();

            assert!(device.is_active);
            assert_eq!(manager.active_device_count(&env), 1);
        });
    }

    #[test]
    fn test_device_limit() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let policy = DevicePolicy {
                max_devices: 2,
                auto_revoke_after: 0,
            };
            let mut manager = DeviceManager::new(addr, policy, &env);

            manager
                .register_device(
                    &env,
                    BytesN::from_array(&env, &[1u8; 32]),
                    symbol_short!("dev1"),
                )
                .unwrap();
            manager
                .register_device(
                    &env,
                    BytesN::from_array(&env, &[2u8; 32]),
                    symbol_short!("dev2"),
                )
                .unwrap();

            let result = manager.register_device(
                &env,
                BytesN::from_array(&env, &[3u8; 32]),
                symbol_short!("dev3"),
            );
            assert_eq!(result, Err(AccountError::DeviceLimitReached));
        });
    }

    #[test]
    fn test_revoke_device() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let mut manager = DeviceManager::new(addr, default_policy(), &env);
            let key_id = BytesN::from_array(&env, &[1u8; 32]);

            manager
                .register_device(&env, key_id.clone(), symbol_short!("phone"))
                .unwrap();
            manager.revoke_device(&env, &key_id).unwrap();

            assert_eq!(manager.active_device_count(&env), 0);
            assert_eq!(manager.list_devices(&env).len(), 1); // still in list, just inactive
        });
    }

    #[test]
    fn test_revoke_nonexistent() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let mut manager = DeviceManager::new(addr, default_policy(), &env);
            let key_id = BytesN::from_array(&env, &[99u8; 32]);

            let result = manager.revoke_device(&env, &key_id);
            assert_eq!(result, Err(AccountError::DeviceNotFound));
        });
    }

    #[test]
    fn test_update_last_used() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let mut manager = DeviceManager::new(addr, default_policy(), &env);
            let key_id = BytesN::from_array(&env, &[1u8; 32]);

            manager
                .register_device(&env, key_id.clone(), symbol_short!("phone"))
                .unwrap();
            manager.update_last_used(&env, &key_id).unwrap();

            let devices = manager.list_devices(&env);
            assert_eq!(devices.len(), 1);
        });
    }

    #[test]
    fn test_update_last_used_nonexistent() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let mut manager = DeviceManager::new(addr, default_policy(), &env);
            let key_id = BytesN::from_array(&env, &[99u8; 32]);

            let result = manager.update_last_used(&env, &key_id);
            assert_eq!(result, Err(AccountError::DeviceNotFound));
        });
    }

    #[test]
    fn test_cleanup_inactive_disabled() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let mut manager = DeviceManager::new(addr, default_policy(), &env);

            manager
                .register_device(
                    &env,
                    BytesN::from_array(&env, &[1u8; 32]),
                    symbol_short!("phone"),
                )
                .unwrap();

            let revoked = manager.cleanup_inactive(&env);
            assert_eq!(revoked, 0);
            assert_eq!(manager.active_device_count(&env), 1);
        });
    }

    #[test]
    fn test_set_policy() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let mut manager = DeviceManager::new(addr, default_policy(), &env);
            let new_policy = DevicePolicy {
                max_devices: 10,
                auto_revoke_after: 500,
            };
            manager.set_policy(&env, new_policy);
            assert_eq!(manager.policy(&env).max_devices, 10);
            assert_eq!(manager.policy(&env).auto_revoke_after, 500);
        });
    }

    #[test]
    fn test_with_defaults() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let manager = DeviceManager::with_defaults(addr, &env);
            assert_eq!(manager.policy(&env).max_devices, 5);
            assert_eq!(manager.active_device_count(&env), 0);
        });
    }

    #[test]
    fn test_revoked_device_allows_new_registration() {
        let env = Env::default();
        let contract_id = env.register(TestContract, ());
        let addr = Address::generate(&env);

        env.as_contract(&contract_id, || {
            let policy = DevicePolicy {
                max_devices: 1,
                auto_revoke_after: 0,
            };
            let mut manager = DeviceManager::new(addr, policy, &env);

            let key1 = BytesN::from_array(&env, &[1u8; 32]);
            manager
                .register_device(&env, key1.clone(), symbol_short!("old"))
                .unwrap();
            manager.revoke_device(&env, &key1).unwrap();

            // Should be able to register again since active count is 0
            let key2 = BytesN::from_array(&env, &[2u8; 32]);
            manager
                .register_device(&env, key2, symbol_short!("new"))
                .unwrap();
            assert_eq!(manager.active_device_count(&env), 1);
        });
    }
}