bsv-rs 0.3.21

BSV blockchain SDK for Rust - primitives, script, transactions, and more
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
//! HTTP integration tests for LivePolicy fee model.
//!
//! These tests use `wiremock` to spin up a local mock HTTP server and verify that
//! the LivePolicy fee model correctly queries policy endpoints, caches results,
//! and falls back to defaults when the endpoint is unreachable.
//!
//! Run with: `cargo test --features "full,http" --test live_policy_http_tests`

#![cfg(all(feature = "transaction", feature = "http"))]

use bsv_rs::transaction::{
    FeeModel, LivePolicy, LivePolicyConfig, Transaction, DEFAULT_CACHE_TTL_SECS,
    DEFAULT_FALLBACK_RATE, DEFAULT_POLICY_URL,
};
use std::time::Duration;
use wiremock::matchers::{header, method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

// =============================================================================
// LivePolicy HTTP Tests
// =============================================================================

#[tokio::test]
async fn test_live_policy_refresh_success() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "miningFee": {
                "satoshis": 1,
                "bytes": 1000
            }
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let rate = fee_model.refresh().await.unwrap();

    // 1 satoshi per 1000 bytes = 1 sat/KB
    assert_eq!(rate, 1);
    assert_eq!(fee_model.cached_rate(), Some(1));
    assert_eq!(fee_model.effective_rate(), 1);
}

#[tokio::test]
async fn test_live_policy_refresh_higher_fee_rate() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "miningFee": {
                "satoshis": 50,
                "bytes": 1000
            }
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let rate = fee_model.refresh().await.unwrap();

    // 50 satoshis per 1000 bytes = 50 sat/KB
    assert_eq!(rate, 50);
}

#[tokio::test]
async fn test_live_policy_refresh_nested_policy() {
    let mock_server = MockServer::start().await;

    // Some ARC endpoints return fee info nested under "policy"
    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "policy": {
                "miningFee": {
                    "satoshis": 5,
                    "bytes": 1000
                }
            }
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let rate = fee_model.refresh().await.unwrap();

    assert_eq!(rate, 5);
}

#[tokio::test]
async fn test_live_policy_refresh_with_api_key() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .and(header("Authorization", "Bearer test-api-key"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "miningFee": {
                "satoshis": 1,
                "bytes": 1000
            }
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let config = LivePolicyConfig {
        policy_url: format!("{}/v1/policy", mock_server.uri()),
        api_key: Some("test-api-key".to_string()),
        cache_ttl: Duration::from_secs(DEFAULT_CACHE_TTL_SECS),
        fallback_rate: DEFAULT_FALLBACK_RATE,
        timeout_ms: 10_000,
    };

    let fee_model = LivePolicy::with_config(config);
    let rate = fee_model.refresh().await.unwrap();
    assert_eq!(rate, 1);
}

#[tokio::test]
async fn test_live_policy_refresh_server_error() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(500).set_body_string("Internal Server Error"))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let result = fee_model.refresh().await;

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("HTTP 500"));
}

#[tokio::test]
async fn test_live_policy_refresh_not_found() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(404))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let result = fee_model.refresh().await;

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("HTTP 404"));
}

#[tokio::test]
async fn test_live_policy_refresh_malformed_json() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_string("not json at all"))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let result = fee_model.refresh().await;

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("parse policy"));
}

#[tokio::test]
async fn test_live_policy_refresh_missing_mining_fee() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "someOtherField": true
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let result = fee_model.refresh().await;

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("No mining fee"));
}

#[tokio::test]
async fn test_live_policy_fallback_when_not_refreshed() {
    // Without refreshing, the fee model should use the fallback rate
    let fee_model = LivePolicy::new();
    assert_eq!(fee_model.effective_rate(), DEFAULT_FALLBACK_RATE);
    assert!(fee_model.cached_rate().is_none());
}

#[tokio::test]
async fn test_live_policy_compute_fee_after_refresh() {
    let mock_server = MockServer::start().await;

    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "miningFee": {
                "satoshis": 1,
                "bytes": 1
            }
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    fee_model.refresh().await.unwrap();

    // 1 sat/byte = 1000 sat/KB
    assert_eq!(fee_model.effective_rate(), 1000);

    let tx = Transaction::new();
    let fee = fee_model.compute_fee(&tx).unwrap();
    // Empty transaction: 10 bytes * 1000 sat/KB / 1000 = 10 sats
    assert_eq!(fee, 10);
}

#[tokio::test]
async fn test_live_policy_compute_fee_with_fallback() {
    // Without refreshing, should use fallback rate (100 sat/KB)
    let fee_model = LivePolicy::new();
    let tx = Transaction::new();
    let fee = fee_model.compute_fee(&tx).unwrap();
    // Empty transaction: 10 bytes * 100 sat/KB / 1000 = 1 sat
    assert_eq!(fee, 1);
}

#[tokio::test]
async fn test_live_policy_set_rate_overrides_fallback() {
    let fee_model = LivePolicy::new();
    fee_model.set_rate(500);

    assert_eq!(fee_model.cached_rate(), Some(500));
    assert_eq!(fee_model.effective_rate(), 500);

    let tx = Transaction::new();
    let fee = fee_model.compute_fee(&tx).unwrap();
    // Empty transaction: 10 bytes * 500 sat/KB / 1000 = 5 sats
    assert_eq!(fee, 5);
}

#[tokio::test]
async fn test_live_policy_cache_expiry() {
    let config = LivePolicyConfig {
        policy_url: "https://not-used.example.com/v1/policy".to_string(),
        api_key: None,
        cache_ttl: Duration::from_millis(50), // Very short TTL for testing
        fallback_rate: 100,
        timeout_ms: 10_000,
    };

    let fee_model = LivePolicy::with_config(config);
    fee_model.set_rate(500);

    assert_eq!(fee_model.cached_rate(), Some(500));

    // Wait for cache to expire
    tokio::time::sleep(Duration::from_millis(100)).await;

    // Cache should have expired, so cached_rate returns None
    assert!(fee_model.cached_rate().is_none());

    // effective_rate falls back to fallback
    assert_eq!(fee_model.effective_rate(), 100);
}

#[tokio::test]
async fn test_live_policy_refresh_updates_cache() {
    let mock_server = MockServer::start().await;

    // First response: low fee
    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "miningFee": {
                "satoshis": 1,
                "bytes": 1000
            }
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));

    let rate1 = fee_model.refresh().await.unwrap();
    assert_eq!(rate1, 1);
    assert_eq!(fee_model.effective_rate(), 1);
}

#[tokio::test]
async fn test_live_policy_custom_fallback_rate() {
    let config = LivePolicyConfig {
        policy_url: "https://not-used.example.com/v1/policy".to_string(),
        api_key: None,
        cache_ttl: Duration::from_secs(300),
        fallback_rate: 250,
        timeout_ms: 10_000,
    };

    let fee_model = LivePolicy::with_config(config);
    assert_eq!(fee_model.effective_rate(), 250);
}

#[tokio::test]
async fn test_live_policy_default_policy_url() {
    let fee_model = LivePolicy::new();
    assert_eq!(fee_model.policy_url(), DEFAULT_POLICY_URL);
}

#[tokio::test]
async fn test_live_policy_default_cache_ttl() {
    let fee_model = LivePolicy::new();
    assert_eq!(
        fee_model.cache_ttl(),
        Duration::from_secs(DEFAULT_CACHE_TTL_SECS)
    );
}

#[tokio::test]
async fn test_live_policy_refresh_converts_sat_per_byte_to_per_kb() {
    let mock_server = MockServer::start().await;

    // 1 sat per 2 bytes = 500 sat/KB
    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "miningFee": {
                "satoshis": 1,
                "bytes": 2
            }
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let rate = fee_model.refresh().await.unwrap();

    assert_eq!(rate, 500);
}

#[tokio::test]
async fn test_live_policy_refresh_defaults_missing_satoshis() {
    let mock_server = MockServer::start().await;

    // Missing satoshis defaults to 1
    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "miningFee": {
                "bytes": 1000
            }
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let rate = fee_model.refresh().await.unwrap();

    // Default satoshis=1, bytes=1000: 1*1000/1000 = 1
    assert_eq!(rate, 1);
}

#[tokio::test]
async fn test_live_policy_refresh_defaults_missing_bytes() {
    let mock_server = MockServer::start().await;

    // Missing bytes defaults to 1
    Mock::given(method("GET"))
        .and(path("/v1/policy"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "miningFee": {
                "satoshis": 5
            }
        })))
        .expect(1)
        .mount(&mock_server)
        .await;

    let fee_model = LivePolicy::with_url(&format!("{}/v1/policy", mock_server.uri()));
    let rate = fee_model.refresh().await.unwrap();

    // satoshis=5, default bytes=1: 5*1000/1 = 5000
    assert_eq!(rate, 5000);
}