freenet_stdlib/
delegate_interface.rs

1use std::{
2    borrow::{Borrow, Cow},
3    fmt::Display,
4    fs::File,
5    io::Read,
6    ops::Deref,
7    path::Path,
8};
9
10use blake3::{traits::digest::Digest, Hasher as Blake3};
11use serde::{Deserialize, Deserializer, Serialize};
12use serde_with::serde_as;
13
14use crate::generated::client_request::{
15    DelegateKey as FbsDelegateKey, InboundDelegateMsg as FbsInboundDelegateMsg,
16    InboundDelegateMsgType,
17};
18
19use crate::common_generated::common::SecretsId as FbsSecretsId;
20
21use crate::client_api::{TryFromFbs, WsApiError};
22use crate::prelude::{ContractInstanceId, CONTRACT_KEY_SIZE};
23use crate::{code_hash::CodeHash, prelude::Parameters};
24
25const DELEGATE_HASH_LENGTH: usize = 32;
26
27type Secret = Vec<u8>;
28
29#[derive(Clone, Debug, Serialize, Deserialize)]
30pub struct Delegate<'a> {
31    #[serde(borrow)]
32    parameters: Parameters<'a>,
33    #[serde(borrow)]
34    pub data: DelegateCode<'a>,
35    key: DelegateKey,
36}
37
38impl Delegate<'_> {
39    pub fn key(&self) -> &DelegateKey {
40        &self.key
41    }
42
43    pub fn code(&self) -> &DelegateCode {
44        &self.data
45    }
46
47    pub fn code_hash(&self) -> &CodeHash {
48        &self.data.code_hash
49    }
50
51    pub fn params(&self) -> &Parameters {
52        &self.parameters
53    }
54
55    pub fn into_owned(self) -> Delegate<'static> {
56        Delegate {
57            parameters: self.parameters.into_owned(),
58            data: self.data.into_owned(),
59            key: self.key,
60        }
61    }
62
63    pub fn size(&self) -> usize {
64        self.parameters.size() + self.data.size()
65    }
66
67    pub(crate) fn deserialize_delegate<'de, D>(deser: D) -> Result<Delegate<'static>, D::Error>
68    where
69        D: Deserializer<'de>,
70    {
71        let data: Delegate<'de> = Deserialize::deserialize(deser)?;
72        Ok(data.into_owned())
73    }
74}
75
76impl PartialEq for Delegate<'_> {
77    fn eq(&self, other: &Self) -> bool {
78        self.key == other.key
79    }
80}
81
82impl Eq for Delegate<'_> {}
83
84impl<'a> From<(&DelegateCode<'a>, &Parameters<'a>)> for Delegate<'a> {
85    fn from((data, parameters): (&DelegateCode<'a>, &Parameters<'a>)) -> Self {
86        Self {
87            key: DelegateKey::from_params_and_code(parameters, data),
88            parameters: parameters.clone(),
89            data: data.clone(),
90        }
91    }
92}
93
94/// Executable delegate
95#[derive(Debug, Serialize, Deserialize, Clone)]
96#[serde_as]
97pub struct DelegateCode<'a> {
98    #[serde_as(as = "serde_with::Bytes")]
99    #[serde(borrow)]
100    pub(crate) data: Cow<'a, [u8]>,
101    // todo: skip serializing and instead compute it
102    pub(crate) code_hash: CodeHash,
103}
104
105impl DelegateCode<'static> {
106    /// Loads the contract raw wasm module, without any version.
107    pub fn load_raw(path: &Path) -> Result<Self, std::io::Error> {
108        let contract_data = Self::load_bytes(path)?;
109        Ok(DelegateCode::from(contract_data))
110    }
111
112    pub(crate) fn load_bytes(path: &Path) -> Result<Vec<u8>, std::io::Error> {
113        let mut contract_file = File::open(path)?;
114        let mut contract_data = if let Ok(md) = contract_file.metadata() {
115            Vec::with_capacity(md.len() as usize)
116        } else {
117            Vec::new()
118        };
119        contract_file.read_to_end(&mut contract_data)?;
120        Ok(contract_data)
121    }
122}
123
124impl DelegateCode<'_> {
125    /// Delegate code hash.
126    pub fn hash(&self) -> &CodeHash {
127        &self.code_hash
128    }
129
130    /// Returns the `Base58` string representation of the delegate key.
131    pub fn hash_str(&self) -> String {
132        Self::encode_hash(&self.code_hash.0)
133    }
134
135    /// Reference to delegate code.
136    pub fn data(&self) -> &[u8] {
137        &self.data
138    }
139
140    /// Returns the `Base58` string representation of a hash.
141    pub fn encode_hash(hash: &[u8; DELEGATE_HASH_LENGTH]) -> String {
142        bs58::encode(hash)
143            .with_alphabet(bs58::Alphabet::BITCOIN)
144            .into_string()
145    }
146
147    pub fn into_owned(self) -> DelegateCode<'static> {
148        DelegateCode {
149            code_hash: self.code_hash,
150            data: Cow::from(self.data.into_owned()),
151        }
152    }
153
154    pub fn size(&self) -> usize {
155        self.data.len()
156    }
157}
158
159impl PartialEq for DelegateCode<'_> {
160    fn eq(&self, other: &Self) -> bool {
161        self.code_hash == other.code_hash
162    }
163}
164
165impl Eq for DelegateCode<'_> {}
166
167impl AsRef<[u8]> for DelegateCode<'_> {
168    fn as_ref(&self) -> &[u8] {
169        self.data.borrow()
170    }
171}
172
173impl From<Vec<u8>> for DelegateCode<'static> {
174    fn from(data: Vec<u8>) -> Self {
175        let key = CodeHash::from_code(data.as_slice());
176        DelegateCode {
177            data: Cow::from(data),
178            code_hash: key,
179        }
180    }
181}
182
183impl<'a> From<&'a [u8]> for DelegateCode<'a> {
184    fn from(code: &'a [u8]) -> Self {
185        let key = CodeHash::from_code(code);
186        DelegateCode {
187            data: Cow::from(code),
188            code_hash: key,
189        }
190    }
191}
192
193#[serde_as]
194#[derive(Clone, PartialEq, Eq, Hash, Debug, Serialize, Deserialize)]
195pub struct DelegateKey {
196    #[serde_as(as = "[_; DELEGATE_HASH_LENGTH]")]
197    key: [u8; DELEGATE_HASH_LENGTH],
198    code_hash: CodeHash,
199}
200
201impl From<DelegateKey> for SecretsId {
202    fn from(key: DelegateKey) -> SecretsId {
203        SecretsId {
204            hash: key.key,
205            key: vec![],
206        }
207    }
208}
209
210impl DelegateKey {
211    pub const fn new(key: [u8; DELEGATE_HASH_LENGTH], code_hash: CodeHash) -> Self {
212        Self { key, code_hash }
213    }
214
215    fn from_params_and_code<'a>(
216        params: impl Borrow<Parameters<'a>>,
217        wasm_code: impl Borrow<DelegateCode<'a>>,
218    ) -> Self {
219        let code = wasm_code.borrow();
220        let key = generate_id(params.borrow(), code);
221        Self {
222            key,
223            code_hash: *code.hash(),
224        }
225    }
226
227    pub fn encode(&self) -> String {
228        bs58::encode(self.key)
229            .with_alphabet(bs58::Alphabet::BITCOIN)
230            .into_string()
231    }
232
233    pub fn code_hash(&self) -> &CodeHash {
234        &self.code_hash
235    }
236
237    pub fn bytes(&self) -> &[u8] {
238        self.key.as_ref()
239    }
240
241    pub fn from_params(
242        code_hash: impl Into<String>,
243        parameters: &Parameters,
244    ) -> Result<Self, bs58::decode::Error> {
245        let mut code_key = [0; DELEGATE_HASH_LENGTH];
246        bs58::decode(code_hash.into())
247            .with_alphabet(bs58::Alphabet::BITCOIN)
248            .onto(&mut code_key)?;
249        let mut hasher = Blake3::new();
250        hasher.update(code_key.as_slice());
251        hasher.update(parameters.as_ref());
252        let full_key_arr = hasher.finalize();
253
254        debug_assert_eq!(full_key_arr[..].len(), DELEGATE_HASH_LENGTH);
255        let mut key = [0; DELEGATE_HASH_LENGTH];
256        key.copy_from_slice(&full_key_arr);
257
258        Ok(Self {
259            key,
260            code_hash: CodeHash(code_key),
261        })
262    }
263}
264
265impl Deref for DelegateKey {
266    type Target = [u8; DELEGATE_HASH_LENGTH];
267
268    fn deref(&self) -> &Self::Target {
269        &self.key
270    }
271}
272
273impl Display for DelegateKey {
274    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
275        write!(f, "{}", self.encode())
276    }
277}
278
279impl<'a> TryFromFbs<&FbsDelegateKey<'a>> for DelegateKey {
280    fn try_decode_fbs(key: &FbsDelegateKey<'a>) -> Result<Self, WsApiError> {
281        let mut key_bytes = [0; DELEGATE_HASH_LENGTH];
282        key_bytes.copy_from_slice(key.key().bytes().iter().as_ref());
283        Ok(DelegateKey {
284            key: key_bytes,
285            code_hash: CodeHash::from_code(key.code_hash().bytes()),
286        })
287    }
288}
289
290/// Type of errors during interaction with a delegate.
291#[derive(Debug, thiserror::Error, Serialize, Deserialize)]
292pub enum DelegateError {
293    #[error("de/serialization error: {0}")]
294    Deser(String),
295    #[error("{0}")]
296    Other(String),
297}
298
299fn generate_id<'a>(
300    parameters: &Parameters<'a>,
301    code_data: &DelegateCode<'a>,
302) -> [u8; DELEGATE_HASH_LENGTH] {
303    let contract_hash = code_data.hash();
304
305    let mut hasher = Blake3::new();
306    hasher.update(contract_hash.0.as_slice());
307    hasher.update(parameters.as_ref());
308    let full_key_arr = hasher.finalize();
309
310    debug_assert_eq!(full_key_arr[..].len(), DELEGATE_HASH_LENGTH);
311    let mut key = [0; DELEGATE_HASH_LENGTH];
312    key.copy_from_slice(&full_key_arr);
313    key
314}
315
316#[serde_as]
317#[derive(Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
318pub struct SecretsId {
319    #[serde_as(as = "serde_with::Bytes")]
320    key: Vec<u8>,
321    #[serde_as(as = "[_; 32]")]
322    hash: [u8; 32],
323}
324
325impl SecretsId {
326    pub fn new(key: Vec<u8>) -> Self {
327        let mut hasher = Blake3::new();
328        hasher.update(&key);
329        let hashed = hasher.finalize();
330        let mut hash = [0; 32];
331        hash.copy_from_slice(&hashed);
332        Self { key, hash }
333    }
334
335    pub fn encode(&self) -> String {
336        bs58::encode(self.hash)
337            .with_alphabet(bs58::Alphabet::BITCOIN)
338            .into_string()
339    }
340
341    pub fn hash(&self) -> &[u8; 32] {
342        &self.hash
343    }
344    pub fn key(&self) -> &[u8] {
345        self.key.as_slice()
346    }
347}
348
349impl Display for SecretsId {
350    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
351        write!(f, "{}", self.encode())
352    }
353}
354
355impl<'a> TryFromFbs<&FbsSecretsId<'a>> for SecretsId {
356    fn try_decode_fbs(key: &FbsSecretsId<'a>) -> Result<Self, WsApiError> {
357        let mut key_hash = [0; 32];
358        key_hash.copy_from_slice(key.hash().bytes().iter().as_ref());
359        Ok(SecretsId {
360            key: key.key().bytes().to_vec(),
361            hash: key_hash,
362        })
363    }
364}
365
366/// A Delegate is a webassembly code designed to act as an agent for the user on
367/// Freenet. Delegates can:
368///
369///  * Store private data on behalf of the user
370///  * Create, read, and modify contracts
371///  * Create other delegates
372///  * Send and receive messages from other delegates and user interfaces
373///  * Ask the user questions and receive answers
374///
375/// Example use cases:
376///
377///  * A delegate stores a private key for the user, other components can ask
378///    the delegate to sign messages, it will ask the user for permission
379///  * A delegate monitors an inbox contract and downloads new messages when
380///    they arrive
381pub trait DelegateInterface {
382    /// Process inbound message, producing zero or more outbound messages in response.
383    /// All state for the delegate must be stored using the secret mechanism.
384    ///
385    /// # Arguments
386    /// - attested: an optional identifier for the client of this function. Usually will
387    ///   be a [`ContractInstanceId`].
388    fn process(
389        parameters: Parameters<'static>,
390        attested: Option<&'static [u8]>,
391        message: InboundDelegateMsg,
392    ) -> Result<Vec<OutboundDelegateMsg>, DelegateError>;
393}
394
395#[serde_as]
396#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq)]
397pub struct DelegateContext(#[serde_as(as = "serde_with::Bytes")] Vec<u8>);
398
399impl DelegateContext {
400    pub const MAX_SIZE: usize = 4096 * 10 * 10;
401
402    pub fn new(bytes: Vec<u8>) -> Self {
403        assert!(bytes.len() < Self::MAX_SIZE);
404        Self(bytes)
405    }
406
407    pub fn append(&mut self, bytes: &mut Vec<u8>) {
408        assert!(self.0.len() + bytes.len() < Self::MAX_SIZE);
409        self.0.append(bytes)
410    }
411
412    pub fn replace(&mut self, bytes: Vec<u8>) {
413        assert!(bytes.len() < Self::MAX_SIZE);
414        let _ = std::mem::replace(&mut self.0, bytes);
415    }
416}
417
418impl AsRef<[u8]> for DelegateContext {
419    fn as_ref(&self) -> &[u8] {
420        &self.0
421    }
422}
423
424#[derive(Serialize, Deserialize, Debug, Clone)]
425pub enum InboundDelegateMsg<'a> {
426    ApplicationMessage(ApplicationMessage),
427    GetSecretResponse(GetSecretResponse),
428    UserResponse(#[serde(borrow)] UserInputResponse<'a>),
429    GetSecretRequest(GetSecretRequest),
430}
431
432impl InboundDelegateMsg<'_> {
433    pub fn into_owned(self) -> InboundDelegateMsg<'static> {
434        match self {
435            InboundDelegateMsg::ApplicationMessage(r) => InboundDelegateMsg::ApplicationMessage(r),
436            InboundDelegateMsg::GetSecretResponse(r) => InboundDelegateMsg::GetSecretResponse(r),
437            InboundDelegateMsg::UserResponse(r) => InboundDelegateMsg::UserResponse(r.into_owned()),
438            InboundDelegateMsg::GetSecretRequest(r) => InboundDelegateMsg::GetSecretRequest(r),
439        }
440    }
441
442    pub fn get_context(&self) -> Option<&DelegateContext> {
443        match self {
444            InboundDelegateMsg::ApplicationMessage(ApplicationMessage { context, .. }) => {
445                Some(context)
446            }
447            InboundDelegateMsg::GetSecretResponse(GetSecretResponse { context, .. }) => {
448                Some(context)
449            }
450            _ => None,
451        }
452    }
453
454    pub fn get_mut_context(&mut self) -> Option<&mut DelegateContext> {
455        match self {
456            InboundDelegateMsg::ApplicationMessage(ApplicationMessage { context, .. }) => {
457                Some(context)
458            }
459            InboundDelegateMsg::GetSecretResponse(GetSecretResponse { context, .. }) => {
460                Some(context)
461            }
462            _ => None,
463        }
464    }
465}
466
467impl From<GetSecretRequest> for InboundDelegateMsg<'_> {
468    fn from(value: GetSecretRequest) -> Self {
469        Self::GetSecretRequest(value)
470    }
471}
472
473impl From<ApplicationMessage> for InboundDelegateMsg<'_> {
474    fn from(value: ApplicationMessage) -> Self {
475        Self::ApplicationMessage(value)
476    }
477}
478
479impl<'a> TryFromFbs<&FbsInboundDelegateMsg<'a>> for InboundDelegateMsg<'a> {
480    fn try_decode_fbs(msg: &FbsInboundDelegateMsg<'a>) -> Result<Self, WsApiError> {
481        match msg.inbound_type() {
482            InboundDelegateMsgType::common_ApplicationMessage => {
483                let app_msg = msg.inbound_as_common_application_message().unwrap();
484                let mut instance_key_bytes = [0; CONTRACT_KEY_SIZE];
485                instance_key_bytes
486                    .copy_from_slice(app_msg.app().data().bytes().to_vec().as_slice());
487                let app_msg = ApplicationMessage {
488                    app: ContractInstanceId::new(instance_key_bytes),
489                    payload: app_msg.payload().bytes().to_vec(),
490                    context: DelegateContext::new(app_msg.context().bytes().to_vec()),
491                    processed: app_msg.processed(),
492                };
493                Ok(InboundDelegateMsg::ApplicationMessage(app_msg))
494            }
495            InboundDelegateMsgType::common_GetSecretResponse => {
496                let get_secret = msg.inbound_as_common_get_secret_response().unwrap();
497                let get_secret = GetSecretResponse {
498                    key: SecretsId::try_decode_fbs(&get_secret.key())?,
499                    value: get_secret.value().map(|value| value.bytes().to_vec()),
500                    context: DelegateContext::new(get_secret.delegate_context().bytes().to_vec()),
501                };
502                Ok(InboundDelegateMsg::GetSecretResponse(get_secret))
503            }
504            InboundDelegateMsgType::UserInputResponse => {
505                let user_response = msg.inbound_as_user_input_response().unwrap();
506                let user_response = UserInputResponse {
507                    request_id: user_response.request_id(),
508                    response: ClientResponse::new(user_response.response().data().bytes().to_vec()),
509                    context: DelegateContext::new(
510                        user_response.delegate_context().bytes().to_vec(),
511                    ),
512                };
513                Ok(InboundDelegateMsg::UserResponse(user_response))
514            }
515            InboundDelegateMsgType::common_GetSecretRequest => {
516                let get_secret = msg.inbound_as_common_get_secret_request().unwrap();
517                let get_secret = GetSecretRequest {
518                    key: SecretsId::try_decode_fbs(&get_secret.key())?,
519                    context: DelegateContext::new(get_secret.delegate_context().bytes().to_vec()),
520                    processed: get_secret.processed(),
521                };
522                Ok(InboundDelegateMsg::GetSecretRequest(get_secret))
523            }
524            _ => unreachable!("invalid inbound delegate message type"),
525        }
526    }
527}
528
529#[derive(Serialize, Deserialize, Debug, Clone)]
530pub struct GetSecretResponse {
531    pub key: SecretsId,
532    pub value: Option<Secret>,
533    pub context: DelegateContext,
534}
535
536#[non_exhaustive]
537#[derive(Serialize, Deserialize, Debug, Clone)]
538pub struct ApplicationMessage {
539    pub app: ContractInstanceId,
540    pub payload: Vec<u8>,
541    pub context: DelegateContext,
542    pub processed: bool,
543}
544
545impl ApplicationMessage {
546    pub fn new(app: ContractInstanceId, payload: Vec<u8>) -> Self {
547        Self {
548            app,
549            payload,
550            context: DelegateContext::default(),
551            processed: false,
552        }
553    }
554
555    pub fn with_context(mut self, context: DelegateContext) -> Self {
556        self.context = context;
557        self
558    }
559
560    pub fn processed(mut self, p: bool) -> Self {
561        self.processed = p;
562        self
563    }
564}
565
566#[derive(Serialize, Deserialize, Debug, Clone)]
567pub struct UserInputResponse<'a> {
568    pub request_id: u32,
569    #[serde(borrow)]
570    pub response: ClientResponse<'a>,
571    pub context: DelegateContext,
572}
573
574impl UserInputResponse<'_> {
575    pub fn into_owned(self) -> UserInputResponse<'static> {
576        UserInputResponse {
577            request_id: self.request_id,
578            response: self.response.into_owned(),
579            context: self.context,
580        }
581    }
582}
583
584#[derive(Serialize, Deserialize, Debug, Clone)]
585pub enum OutboundDelegateMsg {
586    // for the apps
587    ApplicationMessage(ApplicationMessage),
588    RequestUserInput(
589        #[serde(deserialize_with = "OutboundDelegateMsg::deser_user_input_req")]
590        UserInputRequest<'static>,
591    ),
592    // todo: remove when context can be accessed from the delegate environment and we pass it as reference
593    ContextUpdated(DelegateContext),
594    // from the node
595    GetSecretRequest(GetSecretRequest),
596    SetSecretRequest(SetSecretRequest),
597    // GetContractRequest {
598    //     mode: RelatedMode,
599    //     contract_id: ContractInstanceId,
600    // },
601    GetSecretResponse(GetSecretResponse),
602}
603
604impl From<GetSecretRequest> for OutboundDelegateMsg {
605    fn from(req: GetSecretRequest) -> Self {
606        Self::GetSecretRequest(req)
607    }
608}
609
610impl From<ApplicationMessage> for OutboundDelegateMsg {
611    fn from(req: ApplicationMessage) -> Self {
612        Self::ApplicationMessage(req)
613    }
614}
615
616impl OutboundDelegateMsg {
617    fn deser_user_input_req<'de, D>(deser: D) -> Result<UserInputRequest<'static>, D::Error>
618    where
619        D: serde::Deserializer<'de>,
620    {
621        let value = <UserInputRequest<'de> as Deserialize>::deserialize(deser)?;
622        Ok(value.into_owned())
623    }
624
625    pub fn processed(&self) -> bool {
626        match self {
627            OutboundDelegateMsg::ApplicationMessage(msg) => msg.processed,
628            OutboundDelegateMsg::GetSecretRequest(msg) => msg.processed,
629            OutboundDelegateMsg::SetSecretRequest(_) => false,
630            OutboundDelegateMsg::RequestUserInput(_) => true,
631            OutboundDelegateMsg::ContextUpdated(_) => true,
632            OutboundDelegateMsg::GetSecretResponse(_) => true,
633        }
634    }
635
636    pub fn get_context(&self) -> Option<&DelegateContext> {
637        match self {
638            OutboundDelegateMsg::ApplicationMessage(ApplicationMessage { context, .. }) => {
639                Some(context)
640            }
641            OutboundDelegateMsg::GetSecretRequest(GetSecretRequest { context, .. }) => {
642                Some(context)
643            }
644            _ => None,
645        }
646    }
647
648    pub fn get_mut_context(&mut self) -> Option<&mut DelegateContext> {
649        match self {
650            OutboundDelegateMsg::ApplicationMessage(ApplicationMessage { context, .. }) => {
651                Some(context)
652            }
653            OutboundDelegateMsg::GetSecretRequest(GetSecretRequest { context, .. }) => {
654                Some(context)
655            }
656            _ => None,
657        }
658    }
659}
660
661#[derive(Serialize, Deserialize, Debug, Clone)]
662pub struct GetSecretRequest {
663    pub key: SecretsId,
664    pub context: DelegateContext,
665    pub processed: bool,
666}
667
668impl GetSecretRequest {
669    pub fn new(key: SecretsId) -> Self {
670        Self {
671            key,
672            context: Default::default(),
673            processed: false,
674        }
675    }
676}
677
678#[derive(Serialize, Deserialize, Debug, Clone)]
679pub struct SetSecretRequest {
680    pub key: SecretsId,
681    /// Sets or unsets (if none) a value associated with the key.
682    pub value: Option<Secret>,
683}
684
685#[serde_as]
686#[derive(Serialize, Deserialize, Debug, Clone)]
687pub struct NotificationMessage<'a>(
688    #[serde_as(as = "serde_with::Bytes")]
689    #[serde(borrow)]
690    Cow<'a, [u8]>,
691);
692
693impl TryFrom<&serde_json::Value> for NotificationMessage<'static> {
694    type Error = ();
695
696    fn try_from(json: &serde_json::Value) -> Result<NotificationMessage<'static>, ()> {
697        // todo: validate format when we have a better idea of what we want here
698        let bytes = serde_json::to_vec(json).unwrap();
699        Ok(Self(Cow::Owned(bytes)))
700    }
701}
702
703impl NotificationMessage<'_> {
704    pub fn into_owned(self) -> NotificationMessage<'static> {
705        NotificationMessage(self.0.into_owned().into())
706    }
707    pub fn bytes(&self) -> &[u8] {
708        self.0.as_ref()
709    }
710}
711
712#[serde_as]
713#[derive(Serialize, Deserialize, Debug, Clone)]
714pub struct ClientResponse<'a>(
715    #[serde_as(as = "serde_with::Bytes")]
716    #[serde(borrow)]
717    Cow<'a, [u8]>,
718);
719
720impl Deref for ClientResponse<'_> {
721    type Target = [u8];
722
723    fn deref(&self) -> &Self::Target {
724        &self.0
725    }
726}
727
728impl ClientResponse<'_> {
729    pub fn new(response: Vec<u8>) -> Self {
730        Self(response.into())
731    }
732    pub fn into_owned(self) -> ClientResponse<'static> {
733        ClientResponse(self.0.into_owned().into())
734    }
735    pub fn bytes(&self) -> &[u8] {
736        self.0.as_ref()
737    }
738}
739
740#[derive(Serialize, Deserialize, Debug, Clone)]
741pub struct UserInputRequest<'a> {
742    pub request_id: u32,
743    #[serde(borrow)]
744    /// An interpretable message by the notification system.
745    pub message: NotificationMessage<'a>,
746    /// If a response is required from the user they can be chosen from this list.
747    pub responses: Vec<ClientResponse<'a>>,
748}
749
750impl UserInputRequest<'_> {
751    pub fn into_owned(self) -> UserInputRequest<'static> {
752        UserInputRequest {
753            request_id: self.request_id,
754            message: self.message.into_owned(),
755            responses: self.responses.into_iter().map(|r| r.into_owned()).collect(),
756        }
757    }
758}
759
760#[doc(hidden)]
761pub(crate) mod wasm_interface {
762    //! Contains all the types to interface between the host environment and
763    //! the wasm module execution.
764    use super::*;
765    use crate::memory::WasmLinearMem;
766
767    #[repr(C)]
768    #[derive(Debug, Clone, Copy)]
769    pub struct DelegateInterfaceResult {
770        ptr: i64,
771        size: u32,
772    }
773
774    impl DelegateInterfaceResult {
775        pub unsafe fn from_raw(ptr: i64, mem: &WasmLinearMem) -> Self {
776            let result = Box::leak(Box::from_raw(crate::memory::buf::compute_ptr(
777                ptr as *mut Self,
778                mem,
779            )));
780            #[cfg(feature = "trace")]
781            {
782                tracing::trace!(
783                    "got FFI result @ {ptr} ({:p}) -> {result:?}",
784                    ptr as *mut Self
785                );
786            }
787            *result
788        }
789
790        #[cfg(feature = "contract")]
791        pub fn into_raw(self) -> i64 {
792            #[cfg(feature = "trace")]
793            {
794                tracing::trace!("returning FFI -> {self:?}");
795            }
796            let ptr = Box::into_raw(Box::new(self));
797            #[cfg(feature = "trace")]
798            {
799                tracing::trace!("FFI result ptr: {ptr:p} ({}i64)", ptr as i64);
800            }
801            ptr as _
802        }
803
804        pub unsafe fn unwrap(
805            self,
806            mem: WasmLinearMem,
807        ) -> Result<Vec<OutboundDelegateMsg>, DelegateError> {
808            let ptr = crate::memory::buf::compute_ptr(self.ptr as *mut u8, &mem);
809            let serialized = std::slice::from_raw_parts(ptr as *const u8, self.size as _);
810            let value: Result<Vec<OutboundDelegateMsg>, DelegateError> =
811                bincode::deserialize(serialized)
812                    .map_err(|e| DelegateError::Other(format!("{e}")))?;
813            #[cfg(feature = "trace")]
814            {
815                tracing::trace!(
816                    "got result through FFI; addr: {:p} ({}i64, mapped: {ptr:p})
817                     serialized: {serialized:?}
818                     value: {value:?}",
819                    self.ptr as *mut u8,
820                    self.ptr
821                );
822            }
823            value
824        }
825    }
826
827    impl From<Result<Vec<OutboundDelegateMsg>, DelegateError>> for DelegateInterfaceResult {
828        fn from(value: Result<Vec<OutboundDelegateMsg>, DelegateError>) -> Self {
829            let serialized = bincode::serialize(&value).unwrap();
830            let size = serialized.len() as _;
831            let ptr = serialized.as_ptr();
832            #[cfg(feature = "trace")]
833            {
834                tracing::trace!(
835                    "sending result through FFI; addr: {ptr:p} ({}),\n  serialized: {serialized:?}\n  value: {value:?}",
836                    ptr as i64
837                );
838            }
839            std::mem::forget(serialized);
840            Self {
841                ptr: ptr as i64,
842                size,
843            }
844        }
845    }
846}
freenet_stdlib/delegate_interface.rs

freenet_stdlib/
delegate_interface.rs
