affinidi-messaging-sdk

SDK for integrating Affinidi Messaging into your application. Provides a high-level API for sending and receiving end-to-end encrypted DIDComm v2 messages via a mediator service.

Note: This SDK focuses on the DIDComm protocol. For Trust Spanning Protocol (TSP) messaging, see the affinidi-tsp crate directly, or use affinidi-messaging-core for a protocol-agnostic API that works with both DIDComm and TSP.

Installation

[dependencies]
affinidi-messaging-sdk = "0.17"

Quick Start

use affinidi_messaging_sdk::{ATM, config::Config};

let config = Config::builder()
    .with_ssl_certificates(&mut vec!["path/to/client.chain".into()])
    .with_my_did("did:peer:2...")
    .with_atm_did("did:peer:2...")
    .build()?;

let mut atm = ATM::new(config, vec![]).await?;

// Send a trust ping
atm.send_ping("did:peer:2...", true, true).await?;

Transport

The SDK supports both WebSocket and HTTPS REST transports:

• WebSocket (default) — used for sending messages and receiving inbound message streams
• REST — used for authentication (JWT tokens) and as a fallback

WebSocket is created automatically when ATM::new() is called. You can disable it or manage it manually:

let config = Config::builder()
    .with_websocket_disabled()
    .build()?;
let mut atm = ATM::new(config, vec![]).await?;

// Send via REST
atm.send_ping("did:peer:2...", true, true).await?;

// Start WebSocket later if needed
atm.start_websocket().await?;
atm.send_ping("did:peer:2...", true, true).await?;
atm.close_websocket().await?;

Core API

Sending Messages

Message Management

Packing & Unpacking

Debug Logging

export RUST_LOG=none,affinidi_messaging_sdk=debug

Examples

Set up a mediator first (see mediator README), then:

export MEDIATOR_DID=<your-mediator-did>
export MEDIATOR_ENDPOINT=https://localhost:7037/mediator/v1

cargo run --example ping
cargo run --example send_message_to_me
cargo run --example message_pickup

See affinidi-messaging-helpers for more examples.

Related Crates

• affinidi-messaging-didcomm — DIDComm protocol implementation (dependency)
• affinidi-tsp — Trust Spanning Protocol (alternative protocol)
• affinidi-messaging-core — Protocol-agnostic messaging traits
• affinidi-messaging-mediator — Mediator service
• affinidi-did-resolver-cache-sdk — DID resolution

License

Apache-2.0