Skip to main content

aleph_types/message/
instance.rs

1use crate::message::execution::base::ExecutableContent;
2use crate::message::execution::environment::InstanceEnvironment;
3use crate::message::execution::volume::RootfsVolume;
4use serde::{Deserialize, Serialize};
5
6#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
7pub struct InstanceContent {
8    #[serde(flatten)]
9    pub base: ExecutableContent,
10    /// Properties of the instance execution environment.
11    pub environment: InstanceEnvironment,
12    /// Root filesystem for the instance.
13    pub rootfs: RootfsVolume,
14}
15
16#[cfg(test)]
17mod test {
18    use super::*;
19    use crate::chain::Chain;
20    use crate::memory_size::{MemorySize, MiB};
21    use crate::message::base_message::{MessageConfirmation, MessageContentEnum};
22    use crate::message::execution::base::{Payment, PaymentType};
23    use crate::message::execution::environment::{
24        GpuDeviceClass, GpuProperties, HostRequirements, Hypervisor, MachineResources,
25        NodeRequirements,
26    };
27    use crate::message::execution::volume::{ParentVolume, VolumePersistence};
28    use crate::message::{ContentSource, Message, MessageType};
29    use crate::timestamp::Timestamp;
30    use crate::{address, channel, item_hash, signature};
31    use assert_matches::assert_matches;
32    use std::collections::HashMap;
33
34    const INSTANCE_PAYG_FIXTURE: &str = include_str!(concat!(
35        env!("CARGO_MANIFEST_DIR"),
36        "/../../fixtures/messages/instance/instance-gpu-payg.json"
37    ));
38
39    #[test]
40    fn test_deserialize_instance_message() {
41        let message: Message = serde_json::from_str(INSTANCE_PAYG_FIXTURE).unwrap();
42
43        assert_eq!(
44            message.sender,
45            address!("0x238224C744F4b90b4494516e074D2676ECfC6803")
46        );
47        assert_eq!(message.chain, Chain::Ethereum);
48        assert_eq!(
49            message.signature,
50            signature!(
51                "0x4f7250efd67d989ac3067358ee657e301cd437fd0b4acb38342402e60125a0a209818f555386cd17b82080aba0a7a5cd83e4e1d8875c58b38f2e64cbe5dd308f1c"
52            )
53        );
54        assert_matches!(message.message_type, MessageType::Instance);
55        assert_matches!(
56            message.content_source,
57            ContentSource::Inline { item_content: _ }
58        );
59        assert_eq!(
60            message.item_hash,
61            item_hash!("a41fb91c3e68370759b72338dd1947f18e2ed883837aec5dc731d5f427f90564")
62        );
63        assert_eq!(message.time, Timestamp::from(1762349117.833245));
64        assert_eq!(message.channel, Some(channel!("ALEPH-CLOUDSOLUTIONS")));
65
66        // Check content fields
67        assert_eq!(
68            &message.content.address,
69            &address!("0x238224C744F4b90b4494516e074D2676ECfC6803")
70        );
71        assert_eq!(&message.content.time, &Timestamp::from(1762349117.833176));
72        assert_eq!(message.sent_at(), &message.content.time);
73
74        // Check instance content fields
75        let instance_content = match message.content() {
76            MessageContentEnum::Instance(content) => content,
77            other => {
78                panic!("Expected MessageContentEnum::Instance, got {:?}", other);
79            }
80        };
81
82        assert!(!instance_content.base.allow_amend);
83        assert_eq!(
84            instance_content.base.metadata,
85            Some(HashMap::from([(
86                "name".to_string(),
87                serde_json::Value::String("gpu-l40s-2".to_string())
88            )]))
89        );
90        assert_eq!(instance_content.base.variables, None);
91        assert_eq!(
92            instance_content.base.resources,
93            MachineResources {
94                vcpus: 12,
95                memory: MiB::from_units(73728),
96                seconds: 30,
97                published_ports: None,
98            }
99        );
100        assert_eq!(
101            instance_content.base.authorized_keys,
102            Some(vec![
103                "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIC068SD08xlTtMxTdmCe3rPVM/uA7SvgDUiQwP0FrIGS Libertai".to_string()
104            ])
105        );
106        assert_eq!(
107            instance_content.environment,
108            InstanceEnvironment {
109                internet: true,
110                aleph_api: true,
111                hypervisor: Some(Hypervisor::Qemu),
112                trusted_execution: None,
113                reproducible: false,
114                shared_cache: false,
115            }
116        );
117
118        let expected_requirements = HostRequirements {
119            cpu: None,
120            node: Some(NodeRequirements {
121                owner: None,
122                address_regex: None,
123                node_hash: Some(
124                    "dc3d1d194a990b5c54380c3c0439562fefa42f5a46807cba1c500ec3affecf04".to_string(),
125                ),
126                terms_and_conditions: None,
127            }),
128            gpu: Some(vec![GpuProperties {
129                vendor: "NVIDIA".to_string(),
130                device_name: "AD102GL [L40S]".to_string(),
131                device_class: GpuDeviceClass::_3DController,
132                device_id: "10de:26b9".to_string(),
133            }]),
134        };
135
136        assert_eq!(
137            instance_content.base.payment,
138            Some(Payment {
139                chain: Some(Chain::Base),
140                receiver: Some(address!("0xf0c0ddf11a0dCE6618B5DF8d9fAE3D95e72E04a9")),
141                payment_type: PaymentType::Superfluid,
142            })
143        );
144        assert_eq!(
145            instance_content.base.requirements,
146            Some(expected_requirements)
147        );
148        assert!(instance_content.base.volumes.is_empty());
149        assert_eq!(instance_content.base.replaces, None);
150        assert_eq!(
151            instance_content.rootfs,
152            RootfsVolume {
153                parent: ParentVolume {
154                    reference: item_hash!(
155                        "b6ff5c3a8205d1ca4c7c3369300eeafff498b558f71b851aa2114afd0a532717"
156                    ),
157                    use_latest: true
158                },
159                persistence: VolumePersistence::Host,
160                size_mib: MiB::from_units(737280).into(),
161                forgotten_by: None,
162            }
163        );
164
165        assert!(message.confirmed());
166        assert_eq!(
167            message.confirmed_at(),
168            message.confirmations[0].time.as_ref()
169        );
170        assert_eq!(
171            message.confirmations,
172            vec![MessageConfirmation {
173                chain: Chain::Ethereum,
174                height: 23733404,
175                hash: "0xda1dd1676b5f08cef019172a7b31de303c86aafe8cb209916cf5ffa2bc5871dc"
176                    .to_string(),
177                time: Some(Timestamp::from(1762349117.833245)),
178                publisher: Some(address!("0x23eC28598DCeB2f7082Cc3a9D670592DfEd6e0dC")),
179            }]
180        );
181    }
182}