fvm_actor_utils 15.0.0

Utils for authoring native actors for the Filecoin Virtual Machine
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

use cid::Cid;
use fvm_ipld_encoding::ipld_block::IpldBlock;
use fvm_shared::{
    address::Address, econ::TokenAmount, error::ErrorNumber, ActorID, MethodNum, Response,
};
use thiserror::Error;

pub mod fake_syscalls;
pub mod fvm_syscalls;

/// Copied to avoid linking against `fvm_sdk` for non-WASM targets.
#[derive(Copy, Clone, Debug, Error)]
#[error("actor does not exist in state-tree")]
pub struct NoStateError;

/// The Syscalls trait defines methods available to the actor from its execution environment.
///
/// The methods available are a subset of the methods exported by `fvm_sdk`.
pub trait Syscalls {
    /// Get the IPLD root CID. Fails if the actor doesn't have state (before the first call to
    /// `set_root` and after actor deletion).
    fn root(&self) -> Result<Cid, NoStateError>;

    /// Set the actor's state-tree root.
    ///
    /// Fails if:
    ///
    /// - The new root is not in the actor's "reachable" set.
    /// - Fails if the actor has been deleted.
    fn set_root(&self, cid: &Cid) -> Result<(), NoStateError>;

    /// Returns the ID address of the actor.
    fn receiver(&self) -> ActorID;

    /// Returns the ID address of the calling actor.
    fn caller(&self) -> ActorID;

    /// Sends a message to an actor.
    fn send(
        &self,
        to: &Address,
        method: MethodNum,
        params: Option<IpldBlock>,
        value: TokenAmount,
    ) -> Result<Response, ErrorNumber>;

    /// Resolves the ID address of an actor.
    ///
    /// Returns None if the address cannot be resolved. Successfully resolving an address doesn't
    /// necessarily mean the actor exists (e.g., if the address was already an actor ID).
    fn resolve_address(&self, addr: &Address) -> Option<ActorID>;
}