ma_core/
lib.rs

1//! # ma-core
2//!
3//! A lean DIDComm service library for the ma ecosystem.
4//!
5//! `ma-core` provides the building blocks for ma-capable endpoints:
6//!
7//! - **DID documents** — create, validate, resolve, and publish `did:ma:` documents
8//!   to IPFS/IPNS (via Kubo or custom backends).
9//! - **Service inboxes** — bounded, TTL-aware FIFO queues ([`Inbox`])
10//!   for receiving validated messages on named protocol services.
11//! - **Outbox sending** — fire-and-forget delivery of validated [`Message`] objects
12//!   to remote endpoints, serialized to CBOR on the wire ([`Outbox`]).
13//! - **Endpoint abstraction** — the [`MaEndpoint`] trait with an iroh-backed
14//!   implementation ([`IrohEndpoint`], behind the `iroh` feature).
15//! - **Transport parsing** — extract endpoint IDs and protocols from DID document
16//!   service strings (`/iroh/<id>/<protocol>`).
17//! - **Identity bootstrap** — secure secret key generation and persistence.
18//!
19//! ## Services
20//!
21//! Every endpoint must provide `ma/inbox/0.0.1` (the default inbox).
22//! Endpoints may optionally provide `ma/ipfs/0.0.1` to publish DID documents
23//! on behalf of others.
24//!
25//! ## Feature flags
26//!
27//! - **`kubo`** (default) — enables Kubo RPC client for IPFS publishing.
28//! - **`iroh`** — enables the iroh QUIC transport backend ([`IrohEndpoint`],
29//!   [`Channel`], [`Outbox`]).
30//! - **`gossip`** — enables iroh-gossip broadcast helpers.
31//!
32//! ## Platform support
33//!
34//! Core types (`Inbox`, `Service`, transport parsing, validation)
35//! compile on all targets including `wasm32-unknown-unknown`. Kubo, DID
36//! publishing via Kubo requires a native target.
37
38#![forbid(unsafe_code)]
39
40pub mod endpoint;
41pub mod error;
42#[cfg(feature = "gossip")]
43pub mod gossip;
44pub mod identity;
45pub mod inbox;
46pub mod interfaces;
47pub mod ipfs_publish;
48#[cfg(feature = "iroh")]
49pub mod iroh;
50#[cfg(feature = "iroh")]
51pub mod outbox;
52pub mod resolve;
53pub mod service;
54pub mod topic;
55pub mod transport;
56pub(crate) mod ttl_queue;
57
58#[cfg(all(not(target_arch = "wasm32"), feature = "kubo"))]
59pub mod kubo;
60pub mod pinning;
61
62// ─── Re-export did-ma types so users don't need a separate dependency ───────
63
64pub use did_ma::{
65    Did, Document, EncryptionKey, Headers, MaError, Message, Proof, ReplayGuard, SigningKey,
66    VerificationMethod, DEFAULT_MAX_CLOCK_SKEW_SECS, DEFAULT_MESSAGE_TTL_SECS,
67    DEFAULT_REPLAY_WINDOW_SECS,
68};
69
70// ─── Re-export core error type ──────────────────────────────────────────────
71
72pub use error::{Error, Result};
73
74// ─── Re-export service constants ────────────────────────────────────────────
75
76pub use service::{
77    Service, BROADCAST_PROTOCOL, BROADCAST_TOPIC, CONTENT_TYPE_BROADCAST, CONTENT_TYPE_DOC,
78    CONTENT_TYPE_IPFS_REQUEST, CONTENT_TYPE_MESSAGE, INBOX_PROTOCOL, IPFS_PROTOCOL,
79};
80
81// ─── Re-export Inbox ────────────────────────────────────────────────────────
82
83pub use inbox::Inbox;
84
85// ─── Re-export Topic ────────────────────────────────────────────────────────
86
87pub use topic::{topic_id, Topic, TopicId};
88
89// ─── Re-export endpoint trait and implementations ───────────────────────────
90
91pub use endpoint::{MaEndpoint, DEFAULT_DELIVERY_PROTOCOL_ID};
92#[cfg(feature = "iroh")]
93pub use iroh::channel::Channel;
94#[cfg(feature = "iroh")]
95pub use iroh::IrohEndpoint;
96#[cfg(feature = "iroh")]
97pub use outbox::Outbox;
98
99// ─── Re-export iroh primitives so dependents don't need a direct iroh dep ───
100
101#[cfg(feature = "iroh")]
102pub use ::iroh::endpoint::{presets, Connection, RecvStream, SendStream};
103#[cfg(feature = "iroh")]
104pub use ::iroh::protocol::{AcceptError, ProtocolHandler, Router};
105#[cfg(feature = "iroh")]
106pub use ::iroh::{Endpoint, EndpointAddr, EndpointId, RelayUrl, SecretKey};
107
108// ─── Re-export gossip helpers ────────────────────────────────────────────────
109
110#[cfg(feature = "gossip")]
111pub use gossip::{
112    broadcast_topic_id, gossip_send, gossip_send_text, join_broadcast_channel, join_gossip_topic,
113    topic_id_for,
114};
115
116// ─── Re-export transport parsing ────────────────────────────────────────────
117
118pub use transport::{
119    endpoint_id_from_transport, endpoint_id_from_transport_value, normalize_endpoint_id,
120    protocol_from_transport, resolve_endpoint_for_protocol, resolve_inbox_endpoint_id,
121    transport_string,
122};
123
124// ─── Re-export identity helpers ─────────────────────────────────────────────
125
126pub use identity::{generate_secret_key_file, load_secret_key_bytes, socket_addr_to_multiaddr};
127
128// ─── Re-export DID resolution ───────────────────────────────────────────────
129
130pub use resolve::DidResolver;
131#[cfg(not(target_arch = "wasm32"))]
132pub use resolve::GatewayResolver;
133
134// ─── Re-export existing modules ─────────────────────────────────────────────
135
136pub use interfaces::{DidPublisher, IpfsPublisher};
137#[cfg(all(not(target_arch = "wasm32"), feature = "kubo"))]
138pub use ipfs_publish::KuboDidPublisher;
139#[cfg(all(not(target_arch = "wasm32"), feature = "kubo"))]
140pub use ipfs_publish::{handle_ipfs_publish, publish_did_document_to_kubo};
141pub use ipfs_publish::{
142    validate_ipfs_publish_request, IpfsPublishDidRequest, IpfsPublishDidResponse,
143    ValidatedIpfsPublish,
144};
145#[cfg(all(not(target_arch = "wasm32"), feature = "kubo"))]
146pub use kubo::KuboKey;
147pub use pinning::{pin_update_add_rm, PinUpdateOutcome};
ma_core/lib.rs

ma_core/
lib.rs
