Skip to main content

ModuleManifest

Struct ModuleManifest 

Source
pub struct ModuleManifest {
Show 14 fields pub name: String, pub version: String, pub entry_point: String, pub description: Option<String>, pub author: Option<String>, pub capabilities: Vec<String>, pub dependencies: HashMap<String, String>, pub optional_dependencies: HashMap<String, String>, pub config_schema: HashMap<String, String>, pub rpc_overrides: Vec<String>, pub signatures: Option<SignatureSection>, pub binary: Option<BinarySection>, pub downloads: HashMap<String, PlatformDownload>, pub payment: Option<PaymentSection>,
}
Expand description

Module manifest (module.toml structure)

The manifest defines a module’s identity, dependencies, and capabilities. It follows a clean, hierarchical structure:

# Core metadata (required)
name = "my-module"
version = "1.0.0"
entry_point = "my-module"

# Optional metadata
description = "What this module does"
author = "Author Name <email@example.com>"

# Capabilities (permissions this module requires)
capabilities = ["read_blockchain", "subscribe_events"]

# Dependencies
[dependencies]
"blvm-lightning" = ">=1.0.0"

[optional_dependencies]
"blvm-mesh" = ">=0.5.0"

# Configuration schema (optional)
[config_schema]
poll_interval = "Polling interval in seconds"

Fields§

§name: String

Module name (unique identifier, alphanumeric with dashes/underscores)

§version: String

Module version (semantic versioning: major.minor.patch)

§entry_point: String

Module entry point (binary name or path relative to module directory)

§description: Option<String>

Human-readable description of what this module does

§author: Option<String>

Module author (name and/or email)

§capabilities: Vec<String>

Capabilities this module requires (permissions) These determine what APIs the module can access

§dependencies: HashMap<String, String>

Required dependencies (hard dependencies) Module will fail to load if these are missing or unavailable

§optional_dependencies: HashMap<String, String>

Optional dependencies (soft dependencies) Module can load and function without these

§config_schema: HashMap<String, String>

Configuration schema (descriptions of config keys) Maps config key names to their descriptions

§rpc_overrides: Vec<String>

JSON-RPC core methods this module intends to override. Each entry must be in OVERRIDABLE_CORE_RPC_METHODS; validated at load time. The module registers the actual handler at runtime via register_core_rpc_override.

§signatures: Option<SignatureSection>

Signature section (for signed/verified modules) Contains maintainer signatures and threshold

§binary: Option<BinarySection>

Binary information (local integrity — populated at install time) Contains hash and size for the already-installed binary

§downloads: HashMap<String, PlatformDownload>

Remote download coordinates per platform (written by release CI).

The node reads this section during bootstrap install to obtain the correct URL and SHA-256 for the running platform, eliminating the need for a central registry to track per-version binary locations.

Keys: "x86_64-linux" | "aarch64-linux" | "x86_64-apple" | "aarch64-apple"

§payment: Option<PaymentSection>

Payment configuration (for paid modules) Contains cryptographically signed payment addresses

Implementations§

Source§

impl ModuleManifest

Source

pub fn from_file<P>(path: P) -> Result<ModuleManifest, ModuleError>
where P: AsRef<Path>,

Load manifest from file

Source

pub fn to_metadata(&self) -> ModuleMetadata

Convert to ModuleMetadata

Source

pub fn get_threshold(&self) -> Option<(usize, usize)>

Get signature threshold as (required, total) tuple

Parses threshold string like “2-of-3” into (2, 3). Returns None if threshold is not set or cannot be parsed.

Source

pub fn parse_threshold(threshold_str: &str) -> Option<(usize, usize)>

Parse threshold string like “2-of-3” into (2, 3)

Source

pub fn get_signatures(&self) -> Vec<(String, String)>

Get signatures as (maintainer, signature_hex) pairs

Source

pub fn get_public_keys(&self) -> HashMap<String, String>

Get public keys as (maintainer, pubkey_hex) map

Source

pub fn has_signatures(&self) -> bool

Check if manifest has signatures

Trait Implementations§

Source§

impl Clone for ModuleManifest

Source§

fn clone(&self) -> ModuleManifest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ModuleManifest

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ModuleManifest

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ModuleManifest, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ModuleManifest

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<ModuleManifest> for ModuleMetadata

Source§

type Error = ModuleError

The type returned in the event of a conversion error.
Source§

fn try_from( manifest: ModuleManifest, ) -> Result<ModuleMetadata, <ModuleMetadata as TryFrom<ModuleManifest>>::Error>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,