recall_frc42_dispatch 0.1.1

Filecoin FRC-0042 calling convention/dispatch support library
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

// Copyright 2022-2024 Protocol Labs
// SPDX-License-Identifier: MIT
//
// Forked from https://github.com/filecoin-project/actors-utils with assumed MIT license
// as per Cargo.toml: https://github.com/filecoin-project/actors-utils/blob/7628cd8d39dafcc6035f28e350cdb0cccbea5ab4/frc42_dispatch/Cargo.toml#L5
//
// License headers added post-fork.
use fvm_ipld_encoding::ipld_block::IpldBlock;
#[cfg(feature = "use_sdk")]
use fvm_sdk::send;
use fvm_shared::{address::Address, econ::TokenAmount, error::ErrorNumber, Response};
use thiserror::Error;

use crate::hash::{Hasher, MethodNameErr, MethodResolver};

/// Utility to invoke standard methods on deployed actors.
#[derive(Default)]
pub struct MethodMessenger<T: Hasher> {
    method_resolver: MethodResolver<T>,
}

#[derive(Error, PartialEq, Eq, Debug)]
pub enum MethodMessengerError {
    #[error("error when calculating method name: `{0}`")]
    MethodName(#[from] MethodNameErr),
    #[error("error sending message: `{0}`")]
    Syscall(#[from] ErrorNumber),
}

impl<T: Hasher> MethodMessenger<T> {
    /// Creates a new method messenger using a specified hashing function (blake2b by default).
    pub fn new(hasher: T) -> Self {
        Self {
            method_resolver: MethodResolver::new(hasher),
        }
    }

    /// Calls a method (by name) on a specified actor by constructing and publishing the underlying
    /// on-chain message.
    #[cfg(feature = "use_sdk")]
    pub fn call_method(
        &self,
        to: &Address,
        method: &str,
        params: Option<IpldBlock>,
        value: TokenAmount,
    ) -> Result<Response, MethodMessengerError> {
        let method = self.method_resolver.method_number(method)?;
        send::send(
            to,
            method,
            params,
            value,
            None,
            fvm_shared::sys::SendFlags::empty(),
        )
        .map_err(MethodMessengerError::from)
    }

    #[cfg(not(feature = "use_sdk"))]
    #[allow(unused_variables)]
    pub fn call_method(
        &self,
        to: &Address,
        method: &str,
        params: Option<IpldBlock>,
        value: TokenAmount,
    ) -> Result<Response, MethodMessengerError> {
        let _method = self.method_resolver.method_number(method)?;
        unimplemented!()
    }
}