postchain-client 0.0.5

Just another Chromia Postchain client implemented in Rust.
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
use postchain_client::{
    transport::client::{self, RestClient, RestResponse},
    utils::{
        operation::{Operation, Params, QueryParams},
        transaction::Transaction
    }
};

use std::{collections::BTreeMap, str::FromStr};
use rand::Rng;
use ctor::ctor;

#[ctor]
fn initialize_test_envs() {
    tracing_subscriber::fmt::init();
}

const POSTCHAIN_SINGLE_NODE_API_URL: &str = "http://localhost:7740";
const POSTCHAIN_MULTI_NODE_API_URL: &str = "https://node0.devnet1.chromia.dev:7740";

async fn assert_roundtrips(
    rc: &RestClient<'_>,
    brid: &str,
    query_type: &str,
    query_args: Option<&mut Vec<(&str, Params)>>,
    expected_value: &str,
) {
    let do_query = rc.query(brid, None, query_type, None, query_args).await;

    print!("test query = {query_type} ... ");

    match do_query {
        Ok(val) => {
            if let RestResponse::Bytes(val1) = val {
                assert_eq!(hex::encode(val1), expected_value);
                println!("ok")
            }
        }
        Err(error) => {
            rc.print_error(&error, false);
            std::process::exit(0);
        }
    }
}

async fn assert_roundtrips_transaction<'a>(
    rc: &RestClient<'_>,
    tx: &Transaction,
    operation_name: &'a str,
    brid: &'a str,
) {
    let send_transaction = rc.send_transaction(tx).await;

    print!("test transaction with operation_name = {operation_name} ... ");

    match send_transaction {
        Ok(_) => {
            println!("ok");
            let rid_hex = tx.tx_rid_hex();
            
            if let Err(error) = rid_hex {
                panic!("{error:?}");
            }

            let rid_hex_unwrap = rid_hex.unwrap();

            let tx_status = rc.get_transaction_status(brid, &rid_hex_unwrap).await;
            println!("{tx_status:?}");

            let tx_confirmation_proof = rc.get_confirmation_proof(brid, &rid_hex_unwrap).await;

            if let Err(error) = tx_confirmation_proof {
                eprintln!("Error getting confirmation proof: {error:?}");
                return;
            }
            println!("tx_confirmation_proof {tx_confirmation_proof:?}");
        }
        Err(error) => {
            if rc.print_error(&error, true) {
                std::process::exit(0);
            }
        }
    }
}

use std::sync::Once;

static mut URL: Option<&'static str> = None;
static INIT: Once = Once::new();

async fn initialize_rest_client() -> (String, RestClient<'static>) {
    // **Initialize RestClient**
    let mut rc = client::RestClient {
        node_url: vec![POSTCHAIN_SINGLE_NODE_API_URL],
        ..Default::default()
    };

    // **Get Blockchain RID**
    let get_blockchain_rid = rc.get_blockchain_rid(0).await;

    // **Determine Blockchain RID and RestClient**
    let brid_info: (String, RestClient<'static>) = if let Ok(val) = get_blockchain_rid {
        (val, rc)
    } else {
        let brid = "7A37DD331AC8FED64EEFCCA231B0F975DE7F4371CE5CA44105A5B117DF6DE251".to_string();

        rc = client::RestClient {
            node_url: vec![POSTCHAIN_MULTI_NODE_API_URL],
            ..Default::default()
        };

        let result = rc.get_nodes_from_directory(&brid).await;

        if let Err(ref error) = result {
            if rc.print_error(error, false) {
                std::process::exit(0);
            }
        }

        // Store the URL in a static variable
        let url = result.unwrap()[0].clone();
        INIT.call_once(|| {
            unsafe {
                URL = Some(Box::leak(url.into_boxed_str())); // Convert to a static reference
            }
        });

        rc = client::RestClient {
            node_url: vec![unsafe { URL.unwrap() }], // Use the static reference
            ..Default::default()
        };

        (brid, rc)
    };

    brid_info
}

fn read_private_key_from_env_var() -> [u8; 32] {
    match std::env::var("PRIV_KEY") {
        Ok(value) => {
            let bytes = hex::decode(value).unwrap();
            let mut array = [0u8; 32];
            array.copy_from_slice(&bytes);
            array
        }
        Err(e) => {
            panic!("Couldn't read PRIV_KEY: {e}")
        }
    }
}

#[allow(unused_assignments)]
#[tokio::test]
async fn signed_transaction_integration_test() {
    let client = initialize_rest_client().await;

    let mut rng = rand::rng();
    let random_integer: i32 = rng.random_range(1..=100000);

    let brid = client.0;
    let rc = client.1;

    let operation_name = "setBoolean";
    let params = vec![Params::Boolean(false)];
    let ops = vec![
        Operation::from_list(operation_name.to_string(), params),
        Operation::from_list("nop".to_string(), vec![Params::Integer(random_integer.into())])
    ];

    let merkle_hash_version = rc.detect_merkle_hash_version(&brid).await;

    let mut tx = Transaction{
        blockchain_rid: hex::decode(brid.clone()).unwrap(),
        operations: Some(ops),
        merkle_hash_version,
        ..Default::default()
    };

    let private_key_from_env = read_private_key_from_env_var();

    let result = tx.sign(&private_key_from_env);

    if let Err(error) = result {
        eprint!("TX sign error {error:?}");
    } else {
        assert_roundtrips_transaction(&rc, &tx, operation_name, &brid).await;
    }
}

#[allow(unused_assignments)]
#[tokio::test]
async fn signed_transaction_with_nested_arguments_integration_test() {
    let client = initialize_rest_client().await;

    let brid = client.0;
    let rc = client.1;

    let private_key_from_env = read_private_key_from_env_var();

    let merkle_hash_version = rc.detect_merkle_hash_version(&brid).await;

    let operation_name = "nestedArguments";

    let ops = vec![
        Operation::from_list(operation_name.to_string(), vec![
            Params::Array(vec![
                Params::Array(vec![Params::Integer(1),Params::Text("foo".to_string()),Params::Text("bar".to_string())]),
                Params::Array(vec![Params::Text("foo".to_string())]),
            ])
        ])
    ];
    let mut tx = Transaction{
        blockchain_rid: hex::decode(brid.clone()).unwrap(),
        operations: Some(ops),
        merkle_hash_version,
        ..Default::default()
    };

    let result = tx.sign(&private_key_from_env);

    if let Err(error) = result {
        eprint!("TX sign error {error:?}");
    } else {
        assert_roundtrips_transaction(&rc, &tx, operation_name, &brid).await;
    }
}

#[allow(unused_assignments)]
#[tokio::test]
async fn unsigned_transactions_integration_test() {
    let client = initialize_rest_client().await;

    let mut rng = rand::rng();
    let random_integer: i32 = rng.random_range(1..=100000);

    let brid = client.0;
    let brid_vec = hex::decode(brid.clone()).unwrap();
    let rc = client.1;

    let operation_name = "setBoolean";
    let params = vec![Params::Boolean(true)];
    let ops = vec![
        Operation::from_list(operation_name.to_string(), params),
        Operation::from_list("nop".to_string(), vec![Params::Integer(random_integer.into())])
    ];
    let tx = Transaction{
        blockchain_rid: brid_vec.clone(),
        operations: Some(ops),
        ..Default::default()
    };

    assert_roundtrips_transaction(&rc, &tx, operation_name, &brid).await;

    let operation_name = "setMultivalue";
    let params = vec![
        Params::Integer(123),
        Params::Text("foo".to_string()),
        Params::Text("bar".to_string()),
        ];
    let ops = vec![
        Operation::from_list(operation_name.to_string(), params),
        Operation::from_list("nop".to_string(), vec![Params::Integer(random_integer.into())])
    ];
    let tx = Transaction{
        blockchain_rid: brid_vec.clone(),
        operations: Some(ops),
        ..Default::default()
    };

    assert_roundtrips_transaction(&rc, &tx, operation_name, &brid).await;

    let operation_name = "setEntityViaStruct";
    let params = vec![
        ("int".to_string(), Params::Integer(1)),
        ("string1".to_string(), Params::Text("foo".to_string())),
        ("string2".to_string(), Params::Text("bar".to_string())),
        ];
    let ops = vec![
        Operation::from_dict(operation_name.to_string(), params),
        Operation::from_list("nop".to_string(), vec![Params::Integer(random_integer.into())])
    ];
    let tx = Transaction{
        blockchain_rid: brid_vec.clone(),
        operations: Some(ops),
        ..Default::default()
    };

    assert_roundtrips_transaction(&rc, &tx, operation_name, &brid).await;

    let operation_name = "nestedArguments";
    let params = vec![
    ("multiStruct".to_string(), Params::Array(vec![Params::Integer(1),Params::Text("foo".to_string()),Params::Text("bar".to_string())])),
    ("arrayExample".to_string(), Params::Array(vec![Params::Text("foo".to_string())])),
    ];
    let ops = vec![
        Operation::from_dict(operation_name.to_string(), params),
        Operation::from_list("nop".to_string(), vec![Params::Integer(random_integer.into())])
    ];
    let tx = Transaction{
        blockchain_rid: brid_vec.clone(),
        operations: Some(ops),
        ..Default::default()
    };

    assert_roundtrips_transaction(&rc, &tx, operation_name, &brid).await;
}


#[allow(unused_assignments)]
#[tokio::test]
async fn queries_integration_test_success_cases() {
    let client = initialize_rest_client().await;

    let brid = client.0;
    let rc = client.1;   

    // query boolean
    assert_roundtrips(
        &rc,
        &brid,
        "test_boolean",
        Some(&mut vec![("arg1", QueryParams::Boolean(false))]),
        "a303020101",
    )
    .await;

    // query number
    assert_roundtrips(
        &rc,
        &brid,
        "test_number",
        Some(&mut vec![("arg1", QueryParams::Integer(1000))]),
        "a304020203e8",
    )
    .await;

    // query negative number
    assert_roundtrips(
        &rc,
        &brid,
        "test_number",
        Some(&mut vec![("arg1", QueryParams::Integer(-1000))]),
        "a3040202fc18",
    )
    .await;

    // query decimal
    assert_roundtrips(
        &rc,
        &brid,
        "test_decimal",
        Some(&mut vec![("arg1", QueryParams::Decimal(bigdecimal::BigDecimal::from_str("99.999").unwrap()))]),
        "a2080c0639392e393939",
    )
    .await;

    // query string
    assert_roundtrips(
        &rc,
        &brid,
        "test_string",
        Some(&mut vec![("arg1", QueryParams::Text("test".to_string()))]),
        "a2060c0474657374",
    )
    .await;

    // query byteArray
    assert_roundtrips(
        &rc,
        &brid,
        "test_byte_array",
        Some(&mut vec![(
            "arg1",
            QueryParams::ByteArray("test".as_bytes().to_vec()),
        )]),
        "a106040474657374",
    )
    .await;

    // query json
    let data = serde_json::json!({
        "name": "Cuong Le",
        "city": "HCM",
        "country": "Vietnam"
    })
    .to_string();

    assert_roundtrips(&rc, &brid, "test_json", Some(&mut vec![
        ("arg1", QueryParams::Text(data))
    ]), "a2360c347b2263697479223a2248434d222c22636f756e747279223a22566965746e616d222c226e616d65223a2243756f6e67204c65227d").await;

    // query null
    assert_roundtrips(&rc, &brid, "test_null", None, "a0020500").await;

    // query big integer
    let data = num_bigint::BigInt::from_str("1234567890123456789").unwrap();
    assert_roundtrips(
        &rc,
        &brid,
        "test_big_integer",
        Some(&mut vec![("arg1", QueryParams::BigInteger(data))]),
        "a60a0208112210f47de98115",
    )
    .await;

    // query negative big integer
    let data = num_bigint::BigInt::from_str("-1234567890123456789").unwrap();
    assert_roundtrips(
        &rc,
        &brid,
        "test_big_integer",
        Some(&mut vec![("arg1", QueryParams::BigInteger(data))]),
        "a60a0208eeddef0b82167eeb",
    )
    .await;

    // query array
    let data = &mut vec![(
        "arg1",
        QueryParams::Array(vec![
            QueryParams::Text("foo".to_string()),
            QueryParams::Text("bar".to_string()),
        ]),
    )];
    assert_roundtrips(
        &rc,
        &brid,
        "test_array",
        Some(data),
        "a510300ea2050c03666f6fa2050c03626172",
    )
    .await;

    // query empty array
    let data = &mut vec![("arg1", QueryParams::Array(vec![]))];
    assert_roundtrips(&rc, &brid, "test_array", Some(data), "a5023000").await;

    // query string key map
    let mut params: BTreeMap<String, QueryParams> = BTreeMap::new();
    params.insert("foo".to_string(), QueryParams::Text("bar".to_string()));
    params.insert("foo1".to_string(), QueryParams::Text("bar1".to_string()));

    let data = &mut vec![("arg1", QueryParams::Dict(params))];

    assert_roundtrips(
        &rc,
        &brid,
        "test_string_key_map",
        Some(data),
        "a420301e300c0c03666f6fa2050c03626172300e0c04666f6f31a2060c0462617231",
    )
    .await;

    // query empty string key map
    let params: BTreeMap<String, QueryParams> = BTreeMap::new();
    let data = &mut vec![("arg1", QueryParams::Dict(params))];
    assert_roundtrips(&rc, &brid, "test_string_key_map", Some(data), "a4023000").await;

    // query set
    let data = &mut vec![(
        "arg1",
        QueryParams::Array(vec![
            QueryParams::Text("foo".to_string()),
            QueryParams::Text("bar".to_string()),
            QueryParams::Text("foo1".to_string()),
            QueryParams::Text("bar1".to_string()),
        ]),
    )];
    assert_roundtrips(
        &rc,
        &brid,
        "test_set",
        Some(data),
        "a520301ea2050c03666f6fa2050c03626172a2060c04666f6f31a2060c0462617231",
    )
    .await;

    // query empty set
    // see: `query empty array`

    // query unnamed tuple
    // same `array`
    let data = &mut vec![(
        "arg1",
        QueryParams::Array(vec![QueryParams::Integer(1), QueryParams::Integer(2)]),
    )];
    assert_roundtrips(
        &rc,
        &brid,
        "test_unnamed_tuple",
        Some(data),
        "a50c300aa303020101a303020102",
    )
    .await;

    // query named tuple
    // same `map`
    let mut params: BTreeMap<String, QueryParams> = BTreeMap::new();
    params.insert("x".to_string(), QueryParams::Integer(1));
    params.insert("y".to_string(), QueryParams::Integer(2));

    let data = &mut vec![("arg1", QueryParams::Dict(params))];
    assert_roundtrips(
        &rc,
        &brid,
        "test_named_tuple",
        Some(data),
        "a416301430080c0178a30302010130080c0179a303020102",
    )
    .await;

    // query empty string key map
    // see `query empty string key map`

    // query set
    let data = &mut vec![(
        "arg1",
        QueryParams::Array(vec![
            QueryParams::Text("foo".to_string()),
            QueryParams::Text("bar".to_string()),
        ]),
    )];
    assert_roundtrips(
        &rc,
        &brid,
        "test_set",
        Some(data),
        "a510300ea2050c03666f6fa2050c03626172",
    )
    .await;

    // query empty set
    // same `array`

    // queries tuple test
    // same `array`

    // query enum
    let data = &mut vec![("x", QueryParams::Integer(1))];
    assert_roundtrips(&rc, &brid, "test_enum", Some(data), "a303020101").await;

    // query struct
    // key = string
    // value = dict() or array()
    let mut params: BTreeMap<String, QueryParams> = BTreeMap::new();
    params.insert("int".to_string(), QueryParams::Integer(13));
    let data = &mut vec![("x", QueryParams::Dict(params))];
    assert_roundtrips(
        &rc,
        &brid,
        "test_struct",
        Some(data),
        "a40e300c300a0c03696e74a30302010d",
    )
    .await;

    let data = &mut vec![(
        "x",
        QueryParams::Array(vec![QueryParams::Integer(13)]),
    )];
    assert_roundtrips(
        &rc,
        &brid,
        "test_struct",
        Some(data),
        "a40e300c300a0c03696e74a30302010d",
    )
    .await;

    // query test map
    let data: &mut Vec<(&str, QueryParams)> = &mut vec![];

    assert_roundtrips(
        &rc,
        &brid,
        "test_map",
        Some(data),
        "a420301e301c0c0a73616d706c655f6b6579a20e0c0c73616d706c655f76616c7565",
    )
    .await;

    // query test map with bytearray key
    let data: &mut Vec<(&str, QueryParams)> = &mut vec![];

    assert_roundtrips(
        &rc,
        &brid,
        "test_map_with_bytearray_key",
        Some(data),
        "a53b3039a5373035a12304210373599a61cc6b3bc02a78c34313e1737ae9cfd56b9bb24360b437d469efdf3b15a20e0c0c73616d706c655f76616c7565",
    )
    .await;

    // query test nullable struct
    let mut params: BTreeMap<String, QueryParams> = BTreeMap::new();
    params.insert("int".to_string(), QueryParams::Null);

    let data = &mut vec![("arg1", QueryParams::Dict(params))];

    assert_roundtrips(
        &rc,
        &brid,
        "test_nullable_struct",
        Some(data),
        "a40d300b30090c03696e74a0020500",
    )
    .await;    

    // query test type as arg name
    assert_roundtrips(
        &rc,
        &brid,
        "test_type_as_arg_name",
        Some(&mut vec![("type", QueryParams::Text("test".to_string()))]),
        "a2060c0474657374",
    )
    .await;

    // query test complex object
    let client_data = serde_json::json!({
        "type": "data",
        "from": "client",
        "data": {
            "foo": "bar",
            "is_client": true
        }
    }).to_string();

    let server_data = serde_json::json!({
        "type": "data",
        "from": "server",
        "data": {
            "foo": "bar",
            "is_client": false
        }
    }).to_string();

    let blessing_rating_factor: BTreeMap<String, QueryParams> = BTreeMap::new();
    let item_rating_factor: BTreeMap<String, QueryParams> = BTreeMap::new();

    let mut args: BTreeMap<String, QueryParams> = BTreeMap::new();
    args.insert("skill_unlock_level".to_string(), QueryParams::Array(vec![
        QueryParams::Integer(1), QueryParams::Integer(2)
        ]));
    args.insert("hero_level_lookup".to_string(), QueryParams::Array(vec![]));
    args.insert("player_level_lookup".to_string(), QueryParams::Array(vec![]));
    args.insert("hero_level_bonus_lookup".to_string(), QueryParams::Array(vec![]));
    args.insert("blessing_rating_factor".to_string(), QueryParams::Dict(blessing_rating_factor));
    args.insert("item_rating_factor".to_string(), QueryParams::Dict(item_rating_factor));
    args.insert("blessing_gender_male_chance".to_string(), QueryParams::Decimal(bigdecimal::BigDecimal::from_str("1.1").unwrap()));
    args.insert("onboarding_map_blessing_to_fragments".to_string(), QueryParams::Array(vec![]));
    args.insert("season_claim_offset".to_string(), QueryParams::Integer(1));

    assert_roundtrips(
        &rc,
        &brid,
        "test_complex_object",
        Some(&mut vec![
            ("client_data", QueryParams::Text(client_data)),
            ("server_data", QueryParams::Text(server_data)),
            ("args", QueryParams::Dict(args))
        ]),
        "a2020c00",
    )
    .await;
}

#[tokio::test]
async fn queries_integration_test_get_nodes_from_directory() {
    let mut rc = client::RestClient {
        node_url: vec![POSTCHAIN_MULTI_NODE_API_URL],
        ..Default::default()
    };

    let result = rc
        .get_nodes_from_directory(
            "4F2F41730E4CACBCA0A43F07AB756DCF57B8D72F4C1006825106D7B3C22758B0",
        )
        .await;

    let expected_result = vec![
        "https://node4.devnet1.chromia.dev",
        "https://node7.devnet1.chromia.dev",
        "https://node5.devnet1.chromia.dev",
        "https://node6.devnet1.chromia.dev",
    ];

    match result {
        Ok(val) => {
            rc.update_node_urls(&val);
            assert_eq!(rc.node_url, expected_result);
        }
        Err(error) => {
            rc.print_error(&error, false);
            std::process::exit(0);
        }
    }
}