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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240

extern crate tap_msg;

use std::collections::HashMap;
use tap_caip::AssetId;
// Removed unused import: PlainMessage
use tap_msg::message::tap_message_trait::{create_tap_message, TapMessage, TapMessageBody};
use tap_msg::message::{Agent, Party, Transfer};

/// Tests that the to_didcomm method automatically extracts all agent DIDs when no sender is specified
#[test]
fn test_to_didcomm_extracts_all_agents_when_no_sender() {
    // Create a Transfer message with multiple participants
    let asset = "eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7"
        .parse::<AssetId>()
        .unwrap();

    let originator = Party::new("did:web:agent1.example");
    let beneficiary = Party::new("did:web:agent2.example");
    let agent3 = Agent::new(
        "did:pkh:eip155:1:0x1234a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
        "settlementAddress",
        "did:pkh:eip155:1:0x1234a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
    );

    let body = Transfer {
        transaction_id: Some(uuid::Uuid::new_v4().to_string()),
        asset,
        originator: Some(originator.clone()),
        beneficiary: Some(beneficiary.clone()),
        amount: "100.00".to_string(),
        agents: vec![agent3.clone()],
        settlement_id: None,
        expiry: None,
        transaction_value: None,
        connection_id: None,
        metadata: HashMap::new(),
        memo: None,
    };

    // Convert to DIDComm message with sender specified (required in the new API)
    // Use a sender that's not in the participants list
    let sender_did = "did:web:sender.example";
    let message = body.to_didcomm(sender_did).unwrap();

    // The from field should be the sender DID
    assert_eq!(message.from, sender_did);

    // The to field should include all participant DIDs except the sender
    assert!(!message.to.is_empty());
    assert_eq!(message.to.len(), 3); // originator + beneficiary + agent

    // Verify each participant DID is in the recipients
    assert!(message.to.contains(&originator.id));
    assert!(message.to.contains(&beneficiary.id));
    assert!(message.to.contains(&agent3.id));
}

/// Tests that the to_didcomm method filters out the sender DID from recipients when specified
#[test]
fn test_to_didcomm_filters_sender_when_specified() {
    // Create a Transfer message with multiple participants
    let asset = "eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7"
        .parse::<AssetId>()
        .unwrap();

    // Use the originator as the sender
    let sender_did = "did:web:agent1.example";

    let originator = Party::new(sender_did);
    let beneficiary = Party::new("did:web:agent2.example");
    let agent3 = Agent::new(
        "did:pkh:eip155:1:0x1234a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
        "settlementAddress",
        "did:pkh:eip155:1:0x1234a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
    );

    let body = Transfer {
        transaction_id: Some(uuid::Uuid::new_v4().to_string()),
        asset,
        originator: Some(originator.clone()),
        beneficiary: Some(beneficiary.clone()),
        amount: "100.00".to_string(),
        agents: vec![agent3.clone()],
        settlement_id: None,
        expiry: None,
        transaction_value: None,
        connection_id: None,
        metadata: HashMap::new(),
        memo: None,
    };

    // Convert to DIDComm message with sender specified
    let message = body.to_didcomm(sender_did).unwrap();

    // The from field should be the sender DID
    assert_eq!(message.from, sender_did);

    // The to field should not include the sender
    assert!(!message.to.contains(&sender_did.to_string()));

    // The to field should include the other participant DIDs
    assert!(message.to.contains(&beneficiary.id));
    assert!(message.to.contains(&agent3.id));
}

/// Tests the to_didcomm_with_route method with custom routing
#[test]
fn test_to_didcomm_with_route() {
    // Create a Transfer message with multiple participants
    let asset = "eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7"
        .parse::<AssetId>()
        .unwrap();

    // Use the originator as the sender
    let sender_did = "did:web:agent1.example";

    let originator = Party::new(sender_did);
    let beneficiary = Party::new("did:web:agent2.example");
    let agent3 = Agent::new(
        "did:pkh:eip155:1:0x1234a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
        "settlementAddress",
        "did:pkh:eip155:1:0x1234a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
    );

    let body = Transfer {
        transaction_id: Some(uuid::Uuid::new_v4().to_string()),
        asset,
        originator: Some(originator.clone()),
        beneficiary: Some(beneficiary.clone()),
        amount: "100.00".to_string(),
        agents: vec![agent3.clone()],
        settlement_id: None,
        expiry: None,
        transaction_value: None,
        connection_id: None,
        metadata: HashMap::new(),
        memo: None,
    };

    // Custom recipients that include only beneficiary
    let recipients = [beneficiary.id.as_str()];

    // Convert to DIDComm message with custom routing
    let mut message = body.to_didcomm(sender_did).unwrap();
    message.to = recipients.iter().map(|s| s.to_string()).collect();

    // The from field should be the sender DID
    assert_eq!(message.from, sender_did);

    // The to field should include only the specified recipients
    assert_eq!(message.to.len(), 1);
    assert!(message.to.contains(&beneficiary.id));
    assert!(!message.to.contains(&agent3.id));
}

/// Tests creating a new TAP message with the create_tap_message utility function
#[test]
fn test_create_tap_message() {
    // Create a Transfer message with multiple participants
    let asset = "eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7"
        .parse::<AssetId>()
        .unwrap();

    let sender_did = "did:web:agent1.example";

    let originator = Party::new(sender_did);
    let beneficiary = Party::new("did:web:agent2.example");

    let body = Transfer {
        transaction_id: Some(uuid::Uuid::new_v4().to_string()),
        asset,
        originator: Some(originator.clone()),
        beneficiary: Some(beneficiary.clone()),
        amount: "100.00".to_string(),
        agents: vec![],
        settlement_id: None,
        expiry: None,
        transaction_value: None,
        connection_id: None,
        metadata: HashMap::new(),
        memo: None,
    };

    // Create a TAP message with custom ID and recipients
    let message = create_tap_message(
        &body,
        Some("test-id-123".to_string()),
        sender_did,
        &[beneficiary.id.as_str()],
    )
    .unwrap();

    // Verify the message properties
    assert_eq!(message.id, "test-id-123");
    assert_eq!(message.from, sender_did);

    // Verify recipients
    assert_eq!(message.to.len(), 1);
    assert!(message.to.contains(&beneficiary.id));
}

/// Tests that the TapMessage trait implementation extracts participants correctly
#[test]
fn test_get_all_participants() {
    // Create a Transfer message with multiple participants
    let asset = "eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7"
        .parse::<AssetId>()
        .unwrap();

    let sender_did = "did:web:agent1.example";

    let originator = Party::new(sender_did);
    let beneficiary = Party::new("did:web:agent2.example");

    let body = Transfer {
        transaction_id: Some(uuid::Uuid::new_v4().to_string()),
        asset,
        originator: Some(originator.clone()),
        beneficiary: Some(beneficiary.clone()),
        amount: "100.00".to_string(),
        agents: vec![],
        settlement_id: None,
        expiry: None,
        transaction_value: None,
        connection_id: None,
        metadata: HashMap::new(),
        memo: None,
    };

    // Create a message using to_didcomm
    let message = body.to_didcomm(sender_did).unwrap();

    // Use the TapMessage trait to get all participants
    let participants = message.get_all_participants();

    // Verify the participants match the expected participants
    assert_eq!(participants.len(), 2); // sender + recipient
    assert!(participants.contains(&sender_did.to_string()));
    assert!(participants.contains(&beneficiary.id));
}