thru-abi-loader 0.2.21

ABI loading utilities for the Thru blockchain
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
use abi_loader::{flatten, flatten_to_yaml, AbiFile};
use std::path::PathBuf;

fn type_library_path() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../type-library")
}

#[test]
fn flatten_token_program() {
    let file = type_library_path().join("tn_token_program.abi.yaml");
    let include_dirs = vec![type_library_path()];

    let result = flatten(&file, &include_dirs).expect("flatten should succeed");

    // Verify imports are cleared
    assert!(
        result.abi.imports.is_empty(),
        "Flattened ABI should have no imports"
    );

    // Verify types from imports are included
    let type_names: Vec<&str> = result.types.iter().map(|t| t.name.as_str()).collect();

    // Types from thru_primitives.abi.yaml
    assert!(
        type_names.contains(&"Hash"),
        "Should contain Hash from primitives"
    );
    assert!(
        type_names.contains(&"Pubkey"),
        "Should contain Pubkey from primitives"
    );
    assert!(
        type_names.contains(&"Signature"),
        "Should contain Signature from primitives"
    );

    // Types from state_proof.abi.yaml
    assert!(
        type_names.contains(&"StateProof"),
        "Should contain StateProof"
    );

    // Types from root file (tn_token_program.abi.yaml)
    assert!(
        type_names.contains(&"TokenInstruction"),
        "Should contain TokenInstruction"
    );
    assert!(
        type_names.contains(&"TokenProgramAccount"),
        "Should contain TokenProgramAccount"
    );

    // Verify options are preserved from root file
    assert_eq!(
        result
            .abi
            .options
            .program_metadata
            .root_types
            .instruction_root,
        Some("TokenInstruction".to_string())
    );
    assert_eq!(
        result.abi.options.program_metadata.root_types.account_root,
        Some("TokenProgramAccount".to_string())
    );

    // Verify package info from root file
    assert_eq!(result.abi.package, "thru.program.token");
}

#[test]
fn flatten_primitives_no_imports() {
    let file = type_library_path().join("thru_primitives.abi.yaml");
    let include_dirs = vec![type_library_path()];

    let result = flatten(&file, &include_dirs).expect("flatten should succeed");

    // File with no imports should still work
    assert!(result.abi.imports.is_empty());

    let type_names: Vec<&str> = result.types.iter().map(|t| t.name.as_str()).collect();
    assert!(type_names.contains(&"Hash"));
    assert!(type_names.contains(&"Pubkey"));
    assert!(type_names.contains(&"Signature"));
    assert!(type_names.contains(&"Timestamp"));
    assert!(type_names.contains(&"Duration"));
    assert!(type_names.contains(&"Date"));
    assert!(type_names.contains(&"FixedPoint"));
    assert!(type_names.contains(&"InstructionData"));
    assert_eq!(type_names.len(), 8);
}

#[test]
fn flatten_state_proof_with_single_import() {
    let file = type_library_path().join("state_proof.abi.yaml");
    let include_dirs = vec![type_library_path()];

    let result = flatten(&file, &include_dirs).expect("flatten should succeed");

    assert!(result.abi.imports.is_empty());

    let type_names: Vec<&str> = result.types.iter().map(|t| t.name.as_str()).collect();

    // Should include types from thru_primitives
    assert!(type_names.contains(&"Hash"));
    assert!(type_names.contains(&"Pubkey"));

    // Should include types from state_proof itself
    assert!(type_names.contains(&"StateProof"));
}

#[test]
fn flatten_to_yaml_produces_valid_yaml() {
    let file = type_library_path().join("thru_primitives.abi.yaml");
    let include_dirs = vec![type_library_path()];

    let yaml =
        abi_loader::flatten_to_yaml(&file, &include_dirs).expect("flatten_to_yaml should succeed");

    // Should be parseable back as AbiFile
    let parsed: AbiFile = serde_yml::from_str(&yaml).expect("Should parse as valid ABI YAML");

    assert_eq!(parsed.abi.package, "thru.common.primitives");
    assert!(parsed.abi.imports.is_empty());
}

#[test]
fn flatten_fails_for_missing_import() {
    // Create a temp file with a non-existent import
    let temp_dir = std::env::temp_dir();
    let temp_file = temp_dir.join("test_missing_import.abi.yaml");

    let content = r#"
abi:
  package: test.missing
  abi-version: 1
  package-version: "1.0.0"
  description: "Test file with missing import"
  imports:
    - type: path
      path: "nonexistent_file.abi.yaml"
types: []
"#;

    std::fs::write(&temp_file, content).expect("Failed to write temp file");

    let result = flatten(&temp_file, &[]);

    assert!(result.is_err(), "Should fail when import is not found");

    // Cleanup
    let _ = std::fs::remove_file(&temp_file);
}

#[test]
fn import_resolver_handles_circular_imports() {
    use abi_loader::ImportResolver;

    // Both files import each other - should not cause infinite loop
    // because ImportResolver tracks loaded files
    let temp_dir = std::env::temp_dir();
    let file_a = temp_dir.join("circular_a.abi.yaml");
    let file_b = temp_dir.join("circular_b.abi.yaml");

    let content_a = format!(
        r#"
abi:
  package: test.circular.a
  abi-version: 1
  package-version: "1.0.0"
  description: "Circular import test A"
  imports:
    - type: path
      path: "{}"
types:
  - name: TypeA
    kind:
      primitive: u32
"#,
        file_b.file_name().unwrap().to_str().unwrap()
    );

    let content_b = format!(
        r#"
abi:
  package: test.circular.b
  abi-version: 1
  package-version: "1.0.0"
  description: "Circular import test B"
  imports:
    - type: path
      path: "{}"
types:
  - name: TypeB
    kind:
      primitive: u64
"#,
        file_a.file_name().unwrap().to_str().unwrap()
    );

    std::fs::write(&file_a, content_a).expect("Failed to write file_a");
    std::fs::write(&file_b, content_b).expect("Failed to write file_b");

    let mut resolver = ImportResolver::new(vec![temp_dir.clone()]);
    let result = resolver.load_file_with_imports(&file_a, false);

    // Should succeed without infinite loop
    assert!(result.is_ok(), "Should handle circular imports gracefully");

    // Should have loaded both files exactly once
    assert_eq!(resolver.loaded_file_count(), 2);

    // Cleanup
    let _ = std::fs::remove_file(&file_a);
    let _ = std::fs::remove_file(&file_b);
}

#[test]
fn name_field_parsed_from_yaml() {
    let yaml = r#"
abi:
  package: thru.program.token
  name: "Token Program"
  abi-version: 1
  package-version: "0.1.0"
  description: "Test"
types: []
"#;
    let parsed: AbiFile = serde_yml::from_str(yaml).expect("Should parse YAML with name");
    assert_eq!(parsed.abi.name, Some("Token Program".to_string()));
    assert_eq!(parsed.name(), Some("Token Program"));
}

#[test]
fn name_field_defaults_to_none() {
    let yaml = r#"
abi:
  package: thru.common.primitives
  abi-version: 1
  package-version: "0.1.0"
  description: "Test without name"
types: []
"#;
    let parsed: AbiFile = serde_yml::from_str(yaml).expect("Should parse YAML without name");
    assert_eq!(parsed.abi.name, None);
    assert_eq!(parsed.name(), None);
}

#[test]
fn name_field_preserved_through_flatten() {
    let file = type_library_path().join("tn_token_program.abi.yaml");
    let include_dirs = vec![type_library_path()];

    let result = flatten(&file, &include_dirs).expect("flatten should succeed");
    assert_eq!(result.abi.name, Some("Token Program".to_string()));
    assert_eq!(result.name(), Some("Token Program"));
}

#[test]
fn name_field_survives_yaml_roundtrip() {
    let file = type_library_path().join("tn_token_program.abi.yaml");
    let include_dirs = vec![type_library_path()];

    let yaml = flatten_to_yaml(&file, &include_dirs).expect("flatten_to_yaml should succeed");
    let parsed: AbiFile = serde_yml::from_str(&yaml).expect("Should parse roundtripped YAML");
    assert_eq!(parsed.abi.name, Some("Token Program".to_string()));
}

#[test]
fn name_field_absent_after_flatten_when_not_set() {
    let file = type_library_path().join("thru_primitives.abi.yaml");
    let include_dirs = vec![type_library_path()];

    let result = flatten(&file, &include_dirs).expect("flatten should succeed");
    assert_eq!(result.abi.name, None);
}

#[test]
fn flatten_nft_market_program() {
    let file = type_library_path().join("tn_nft_market_program.abi.yaml");
    let include_dirs = vec![type_library_path()];

    let result = flatten(&file, &include_dirs).expect("flatten should succeed");

    assert!(
        result.abi.imports.is_empty(),
        "Flattened ABI should have no imports"
    );

    let type_names: Vec<&str> = result.types.iter().map(|t| t.name.as_str()).collect();

    // Types from thru_primitives (imported via onchain)
    assert!(
        type_names.contains(&"Pubkey"),
        "Should contain Pubkey from primitives"
    );
    assert!(
        type_names.contains(&"Hash"),
        "Should contain Hash from primitives"
    );

    // Types from state_proof (imported via onchain)
    assert!(
        type_names.contains(&"StateProof"),
        "Should contain StateProof"
    );

    // Types from root file
    assert!(
        type_names.contains(&"NftMarketInstruction"),
        "Should contain NftMarketInstruction"
    );
    assert!(
        type_names.contains(&"NftMarketOrder"),
        "Should contain NftMarketOrder"
    );
    assert!(
        type_names.contains(&"NftMarketConfig"),
        "Should contain NftMarketConfig"
    );
    assert!(
        type_names.contains(&"NftMarketProgramAccount"),
        "Should contain NftMarketProgramAccount"
    );
    assert!(
        type_names.contains(&"NftMarketEvent"),
        "Should contain NftMarketEvent"
    );

    // Verify no type-refs have a package field in flattened output
    fn assert_no_packages(kind: &abi_types::TypeKind) {
        match kind {
            abi_types::TypeKind::TypeRef(tr) => {
                assert!(
                    tr.package.is_none(),
                    "TypeRef '{}' should have no package in flattened output",
                    tr.name
                );
            }
            abi_types::TypeKind::Struct(s) => {
                for f in &s.fields {
                    assert_no_packages(&f.field_type);
                }
            }
            abi_types::TypeKind::Enum(e) => {
                for v in &e.variants {
                    assert_no_packages(&v.variant_type);
                }
            }
            abi_types::TypeKind::Array(a) => {
                assert_no_packages(&a.element_type);
            }
            abi_types::TypeKind::Union(u) => {
                for v in &u.variants {
                    assert_no_packages(&v.variant_type);
                }
            }
            abi_types::TypeKind::SizeDiscriminatedUnion(sdu) => {
                for v in &sdu.variants {
                    assert_no_packages(&v.variant_type);
                }
            }
            abi_types::TypeKind::Primitive(_) => {}
        }
    }

    for typedef in &result.types {
        assert_no_packages(&typedef.kind);
    }

    // Verify roundtrip: flat YAML should parse back correctly and type-refs
    // should have no package fields (only the top-level abi.package remains)
    let yaml = serde_yml::to_string(&result).expect("Should serialize to YAML");
    let reparsed: AbiFile = serde_yml::from_str(&yaml).expect("Should re-parse flattened YAML");
    assert_eq!(reparsed.abi.package, "thru.program.nft_market");
    assert!(reparsed.types.iter().any(|t| t.name == "Pubkey"));
    assert!(reparsed.types.iter().any(|t| t.name == "StateProof"));
}

#[test]
fn flatten_preserves_package_in_non_flat_roundtrip() {
    // Verify that the package field is preserved when parsing non-flat ABI files
    let yaml = r#"
abi:
  package: test.with.packages
  abi-version: 1
  package-version: "1.0.0"
  description: "Test package field preservation"
types:
  - name: MyStruct
    kind:
      struct:
        packed: true
        fields:
          - name: key
            field-type:
              type-ref:
                name: Pubkey
                package: "thru.common.primitives"
"#;
    let parsed: AbiFile = serde_yml::from_str(yaml).expect("Should parse YAML with package field");
    let field = &parsed.types[0];
    if let abi_types::TypeKind::Struct(s) = &field.kind {
        if let abi_types::TypeKind::TypeRef(tr) = &s.fields[0].field_type {
            assert_eq!(tr.package.as_deref(), Some("thru.common.primitives"));
        } else {
            panic!("Expected TypeRef");
        }
    } else {
        panic!("Expected Struct");
    }
}