tap-msg 0.7.0

Core message processing library for the Transaction Authorization Protocol
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# tap-msg Crate

Core message processing library for the Transaction Authorization Protocol (TAP). This crate defines all TAP message types, serialization, validation, and DIDComm integration.

## Purpose

The `tap-msg` crate provides:
- TAP message type definitions and enums
- Message validation and serialization
- DIDComm message wrapping and unwrapping
- Message context and threading support
- Policy and constraint definitions

## Key Components

- `message/` - All TAP message type definitions
  - `transfer.rs` - Transfer message implementation
  - `payment.rs` - Payment request messages
  - `authorize.rs` - Authorization messages
  - `settle.rs` - Settlement messages
  - `cancel.rs` - Cancellation messages
  - `agent_management.rs` - Agent management messages
  - And more...
- `didcomm.rs` - DIDComm message wrapper
- `utils/` - Utility functions for message processing

## Build Commands

```bash
# Build the crate
cargo build -p tap-msg

# Run tests
cargo test -p tap-msg

# Run specific test
cargo test -p tap-msg test_name

# Run benchmarks
cargo bench -p tap-msg

# Run message benchmark
cargo bench --bench message_benchmark

# Build with WASM support
cargo build -p tap-msg --features wasm

# Test with examples
cargo test -p tap-msg --features examples
```

## Development Guidelines

### Message Implementation
- Always use `#[derive(TapMessage)]` from tap-msg-derive for new messages
- Implement the `Validation` trait for validatable message components
- Use typed structs over raw JSON for message bodies
- Include proper error handling with thiserror
- Add comprehensive doc comments with examples

### Testing
- Create test vectors for each message type in `tests/`
- Test both valid and invalid message scenarios
- Include round-trip serialization tests
- Test WASM compatibility when using `wasm` feature

### Message Types
All TAP messages should follow these patterns:
- Use snake_case for field names
- Include proper validation
- Support both JSON and binary serialization
- Be WASM-compatible when the feature is enabled
- Include appropriate threading support for multi-message flows

## Features

- `wasm` - Enables WebAssembly support with console error hooks and getrandom JS
- `examples` - Enables example code compilation

## Dependencies

Key dependencies include:
- `serde` for serialization
- `tap-caip` for CAIP identifier validation
- `tap-msg-derive` for message derive macros
- `chrono` for timestamp handling
- `uuid` for message IDs
- Optional WASM support with `wasm-bindgen`

## Examples

Message examples are available in `examples/` and can be run with:
```bash
cargo run --example message_example --features examples
```

## Testing

The crate includes comprehensive test suites:
- Unit tests for individual messages
- Integration tests for message flows
- Fuzz testing for robustness
- Test vector validation against TAIPs specifications

Run all tests with: `cargo test -p tap-msg`