reputation-types 0.1.0

Core types and data structures for the KnowThat Reputation Engine
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# Reputation Types

[![Crates.io](https://img.shields.io/crates/v/reputation-types.svg)](https://crates.io/crates/reputation-types)
[![Documentation](https://docs.rs/reputation-types/badge.svg)](https://docs.rs/reputation-types)
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](https://github.com/knowthat-ai/reputation-engine)

Core data types and structures for the KnowThat Reputation Engine.

## Overview

This crate provides the fundamental data structures used throughout the KnowThat reputation system, including agent data, reputation scores, and builders for constructing agent instances. It serves as the foundation for all reputation calculations and interactions.

## Key Features

- **Type Safety**: Strong type system with builder pattern for safe construction
- **Serialization**: Full serde support for JSON serialization/deserialization
- **Validation**: Built-in validation for all data structures
- **Documentation**: Comprehensive documentation with examples
- **No Unsafe Code**: `#![forbid(unsafe_code)]` for memory safety guarantees

## Key Types

### `AgentData`

Represents an MCP agent with all reputation-relevant data including:

- Identity information (DID, verification status)
- Interaction history (total interactions, reviews)
- MCP level and capabilities
- Timestamps for tracking

### `ReputationScore`

The calculated reputation score containing:

- Numerical score value
- Confidence level and percentage
- Calculation metadata

### `AgentDataBuilder`

Fluent builder for constructing `AgentData` instances with validation.

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
reputation-types = "0.1.0"
```

### Basic Example

```rust
use reputation_types::{AgentData, AgentDataBuilder, ReputationScore};

// Create agent data using the builder
let agent = AgentDataBuilder::new("did:example:123")
    .total_interactions(150)
    .with_reviews(100, 4.5)
    .mcp_level(2)
    .identity_verified(true)
    .build()
    .unwrap();

println!("Agent: {}", agent.agent_id);
println!("Reviews: {} (avg: {})", agent.review_count, agent.average_rating);
```

### Builder Pattern

```rust
use reputation_types::AgentData;

let agent = AgentData::builder("did:example:456")
    .total_interactions(60)
    .with_reviews(50, 3.8)
    .mcp_level(1)
    .identity_verified(false)
    .build()
    .unwrap();
```

### Working with Reputation Scores

```rust
use reputation_types::ReputationScore;

let score = ReputationScore {
    score: 0.85,
    confidence: 0.92,
    // ... other fields
};

println!("Score: {:.2} ({}% confident)", score.score, (score.confidence * 100.0) as u8);
```

## Features

### Default Features

- `serde` - Serialization support

### Optional Features

- `wasm` - WebAssembly compatibility (enables `chrono/wasmbind`)

## License

Licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](../../LICENSE-APACHE))
- MIT License ([LICENSE-MIT](../../LICENSE-MIT))

at your option.

## Contributing

This is part of the [KnowThat Reputation Engine](https://github.com/knowthat-ai/reputation-engine) project. Please see the main repository for contribution guidelines.