lexe-api-core 0.1.7

Core Lexe API types and traits
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

use lexe_common::{
    api::{MegaId, user::UserPk},
    time::TimestampMs,
};
use serde::{Deserialize, Serialize};

use crate::types::{LeaseId, ports::RunPorts};

/// A request sent to a meganode API server to run a usernode within a meganode.
#[derive(Serialize, Deserialize)]
pub struct MegaNodeApiUserRunRequest {
    /// The user to run.
    pub user_pk: UserPk,

    /// The lease ID for this user node.
    pub lease_id: LeaseId,

    /// Included to sanity check that we've requested the right meganode.
    pub mega_id: MegaId,

    /// Whether the node should shut down after completing sync.
    pub shutdown_after_sync: bool,
}

#[derive(Serialize, Deserialize)]
pub struct MegaNodeApiUserRunResponse {
    pub run_ports: RunPorts,
}

/// A request from a usernode to renew its lease.
#[derive(Serialize, Deserialize)]
pub struct UserLeaseRenewalRequest {
    /// The ID of the lease to renew.
    pub lease_id: LeaseId,
    /// Sanity check: The requesting user.
    pub user_pk: UserPk,
    /// Sanity check: The current time within the enclave.
    pub timestamp: TimestampMs,
}

/// A notification from a meganode that a user has shut down,
/// and that we can terminate the user's lease.
#[derive(Serialize, Deserialize)]
pub struct UserFinishedRequest {
    /// The user that shut down.
    pub user_pk: UserPk,
    /// The ID of the lease to terminate.
    pub lease_id: LeaseId,
    /// Sanity check: The meganode issuing the request.
    pub mega_id: MegaId,
}

/// A request to evict a usernode within a meganode.
#[derive(Serialize, Deserialize)]
pub struct MegaNodeApiUserEvictRequest {
    /// The user to be evicted.
    pub user_pk: UserPk,
    /// Sanity check: The meganode to which the request is being sent.
    pub mega_id: MegaId,
}