-
Notifications
You must be signed in to change notification settings - Fork 35
Expand file tree
/
Copy pathbuild.zig
More file actions
865 lines (767 loc) · 36.4 KB
/
build.zig
File metadata and controls
865 lines (767 loc) · 36.4 KB
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
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
const std = @import("std");
const builtin = @import("builtin");
const Builder = std.Build;
const zkvmTarget = struct {
name: []const u8,
set_pie: bool = false,
triplet: []const u8,
cpu_features: []const u8,
};
const zkvm_targets: []const zkvmTarget = &.{
.{ .name = "risc0", .triplet = "riscv32-freestanding-none", .cpu_features = "generic_rv32" },
.{ .name = "sp1", .triplet = "riscv32-freestanding-none", .cpu_features = "generic_rv32" },
.{ .name = "zisk", .set_pie = true, .triplet = "riscv64-freestanding-none", .cpu_features = "generic_rv64" },
.{ .name = "openvm", .triplet = "riscv32-freestanding-none", .cpu_features = "generic_rv32" },
.{ .name = "ziren", .triplet = "mipsel-freestanding-none", .cpu_features = "mips32r2" },
};
const ProverChoice = enum { dummy, risc0, openvm, all };
fn setTestRunLabel(b: *Builder, run_step: *std.Build.Step.Run, name: []const u8) void {
run_step.step.name = b.fmt("test {s}", .{name});
}
fn setTestRunLabelFromCompile(b: *Builder, run_step: *std.Build.Step.Run, compile_step: *std.Build.Step.Compile) void {
const source_name = if (compile_step.root_module.root_source_file) |root_source|
root_source.getDisplayName()
else
compile_step.step.name;
setTestRunLabel(b, run_step, source_name);
}
// Add the glue libs to a compile target
fn addRustGlueLib(b: *Builder, comp: *Builder.Step.Compile, target: Builder.ResolvedTarget, prover: ProverChoice) void {
// Conditionally include prover libraries based on selection
// Use profile-specific directories for single-prover builds
switch (prover) {
.dummy => {
comp.addObjectFile(b.path("rust/target/release/libhashsig_glue.a"));
comp.addObjectFile(b.path("rust/target/release/libmultisig_glue.a"));
comp.addObjectFile(b.path("rust/target/release/liblibp2p_glue.a"));
},
.risc0 => {
comp.addObjectFile(b.path("rust/target/risc0-release/librisc0_glue.a"));
comp.addObjectFile(b.path("rust/target/risc0-release/libhashsig_glue.a"));
comp.addObjectFile(b.path("rust/target/risc0-release/libmultisig_glue.a"));
comp.addObjectFile(b.path("rust/target/risc0-release/liblibp2p_glue.a"));
},
.openvm => {
comp.addObjectFile(b.path("rust/target/openvm-release/libopenvm_glue.a"));
comp.addObjectFile(b.path("rust/target/openvm-release/libhashsig_glue.a"));
comp.addObjectFile(b.path("rust/target/openvm-release/libmultisig_glue.a"));
comp.addObjectFile(b.path("rust/target/openvm-release/liblibp2p_glue.a"));
},
.all => {
comp.addObjectFile(b.path("rust/target/release/librisc0_glue.a"));
comp.addObjectFile(b.path("rust/target/release/libopenvm_glue.a"));
comp.addObjectFile(b.path("rust/target/release/libhashsig_glue.a"));
comp.addObjectFile(b.path("rust/target/release/libmultisig_glue.a"));
comp.addObjectFile(b.path("rust/target/release/liblibp2p_glue.a"));
},
}
comp.linkLibC();
comp.linkSystemLibrary("unwind");
if (target.result.os.tag == .macos) {
comp.linkFramework("CoreFoundation");
comp.linkFramework("SystemConfiguration");
comp.linkFramework("Security");
}
}
pub fn build(b: *Builder) !void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});
// Get git commit hash as version
const git_version = b.option([]const u8, "git_version", "Git commit hash for version") orelse "unknown";
// Get prover choice (default to dummy)
const prover_option = b.option([]const u8, "prover", "Choose prover: dummy, risc0, openvm, or all (default: dummy)") orelse "dummy";
const prover = std.meta.stringToEnum(ProverChoice, prover_option) orelse .dummy;
const build_rust_lib_steps = build_rust_project(b, "rust", prover);
// LTO option (disabled by default for faster builds)
const enable_lto = b.option(bool, "lto", "Enable Link Time Optimization (slower builds, smaller binaries)") orelse false;
// add ssz
const ssz = b.dependency("ssz", .{
.target = target,
.optimize = optimize,
}).module("ssz.zig");
const simargs = b.dependency("zigcli", .{
.target = target,
.optimize = optimize,
}).module("simargs");
const xev = b.dependency("xev", .{
.target = target,
.optimize = optimize,
}).module("xev");
const metrics = b.dependency("metrics", .{
.target = target,
.optimize = optimize,
}).module("metrics");
const datetime = b.dependency("datetime", .{
.target = target,
.optimize = optimize,
}).module("datetime");
const enr_dep = b.dependency("zig_enr", .{
.target = target,
.optimize = optimize,
});
const enr = enr_dep.module("zig-enr");
const multiformats = enr_dep.builder.dependency("zmultiformats", .{
.target = target,
.optimize = optimize,
}).module("multiformats-zig");
const multiaddr_mod = enr_dep.builder.dependency("multiaddr", .{
.target = target,
.optimize = optimize,
}).module("multiaddr");
const yaml = b.dependency("zig_yaml", .{
.target = target,
.optimize = optimize,
}).module("yaml");
// add rocksdb
const rocksdb = b.dependency("rocksdb", .{
.target = target,
.optimize = optimize,
}).module("bindings");
// add snappyz
const snappyz = b.dependency("zig_snappy", .{
.target = target,
.optimize = optimize,
}).module("snappyz");
const snappyframesz_dep = b.dependency("snappyframesz", .{
.target = target,
.optimize = optimize,
});
const snappyframesz = snappyframesz_dep.module("snappyframesz.zig");
// Create build options early so modules can use them
const build_options = b.addOptions();
build_options.addOption([]const u8, "version", git_version);
build_options.addOption([]const u8, "prover", @tagName(prover));
build_options.addOption(bool, "has_risc0", prover == .risc0 or prover == .all);
build_options.addOption(bool, "has_openvm", prover == .openvm or prover == .all);
const use_poseidon = b.option(bool, "use_poseidon", "Use Poseidon SSZ hasher (default: false)") orelse false;
build_options.addOption(bool, "use_poseidon", use_poseidon);
// Absolute path to test-keys for pre-generated validator keys
build_options.addOption([]const u8, "test_keys_path", b.pathFromRoot("test-keys/hash-sig-keys"));
const build_options_module = build_options.createModule();
// add zeam-utils
const zeam_utils = b.addModule("@zeam/utils", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/utils/src/lib.zig"),
});
zeam_utils.addImport("datetime", datetime);
zeam_utils.addImport("yaml", yaml);
zeam_utils.addImport("ssz", ssz);
zeam_utils.addImport("build_options", build_options_module);
if (use_poseidon) {
// add hash-zig dependency only when Poseidon hasher is enabled
const hash_zig = b.dependency("hash_zig", .{
.target = target,
.optimize = optimize,
});
const hash_zig_module = hash_zig.module("hash-zig");
zeam_utils.addImport("hash_zig", hash_zig_module);
}
// add zeam-params
const zeam_params = b.addModule("@zeam/params", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/params/src/lib.zig"),
});
// add zeam-metrics (core metrics definitions)
const zeam_metrics = b.addModule("@zeam/metrics", .{
.root_source_file = b.path("pkgs/metrics/src/lib.zig"),
.target = target,
.optimize = optimize,
});
zeam_metrics.addImport("metrics", metrics);
// add zeam-xmss
const zeam_xmss = b.addModule("@zeam/xmss", .{
.root_source_file = b.path("pkgs/xmss/src/lib.zig"),
.target = target,
.optimize = optimize,
});
zeam_xmss.addImport("ssz", ssz);
// add zeam-types
const zeam_types = b.addModule("@zeam/types", .{
.root_source_file = b.path("pkgs/types/src/lib.zig"),
.target = target,
.optimize = optimize,
});
zeam_types.addImport("ssz", ssz);
zeam_types.addImport("@zeam/params", zeam_params);
zeam_types.addImport("@zeam/utils", zeam_utils);
zeam_types.addImport("@zeam/metrics", zeam_metrics);
zeam_types.addImport("@zeam/xmss", zeam_xmss);
// add zeam-types
const zeam_configs = b.addModule("@zeam/configs", .{
.root_source_file = b.path("pkgs/configs/src/lib.zig"),
.target = target,
.optimize = optimize,
});
zeam_configs.addImport("@zeam/utils", zeam_utils);
zeam_configs.addImport("@zeam/types", zeam_types);
zeam_configs.addImport("@zeam/params", zeam_params);
zeam_configs.addImport("yaml", yaml);
// add zeam-api (HTTP serving and events)
const zeam_api = b.addModule("@zeam/api", .{
.root_source_file = b.path("pkgs/api/src/lib.zig"),
.target = target,
.optimize = optimize,
});
zeam_api.addImport("@zeam/metrics", zeam_metrics);
zeam_api.addImport("@zeam/types", zeam_types);
zeam_api.addImport("@zeam/utils", zeam_utils);
// add zeam-key-manager
const zeam_key_manager = b.addModule("@zeam/key-manager", .{
.root_source_file = b.path("pkgs/key-manager/src/lib.zig"),
.target = target,
.optimize = optimize,
});
zeam_key_manager.addImport("build_options", build_options_module);
zeam_key_manager.addImport("@zeam/xmss", zeam_xmss);
zeam_key_manager.addImport("@zeam/types", zeam_types);
zeam_key_manager.addImport("@zeam/utils", zeam_utils);
zeam_key_manager.addImport("@zeam/metrics", zeam_metrics);
zeam_key_manager.addImport("ssz", ssz);
// add zeam-state-transition
const zeam_state_transition = b.addModule("@zeam/state-transition", .{
.root_source_file = b.path("pkgs/state-transition/src/lib.zig"),
.target = target,
.optimize = optimize,
});
zeam_state_transition.addImport("@zeam/utils", zeam_utils);
zeam_state_transition.addImport("@zeam/params", zeam_params);
zeam_state_transition.addImport("@zeam/types", zeam_types);
zeam_state_transition.addImport("ssz", ssz);
zeam_state_transition.addImport("@zeam/api", zeam_api);
zeam_state_transition.addImport("@zeam/xmss", zeam_xmss);
zeam_state_transition.addImport("@zeam/key-manager", zeam_key_manager);
zeam_state_transition.addImport("@zeam/metrics", zeam_metrics);
// add state proving manager
const zeam_state_proving_manager = b.addModule("@zeam/state-proving-manager", .{
.root_source_file = b.path("pkgs/state-proving-manager/src/manager.zig"),
.target = target,
.optimize = optimize,
});
zeam_state_proving_manager.addImport("@zeam/types", zeam_types);
zeam_state_proving_manager.addImport("@zeam/utils", zeam_utils);
zeam_state_proving_manager.addImport("@zeam/state-transition", zeam_state_transition);
zeam_state_proving_manager.addImport("ssz", ssz);
zeam_state_proving_manager.addImport("build_options", build_options_module);
const st_module = b.createModule(.{
.root_source_file = b.path("pkgs/state-transition/src/lib.zig"),
.target = target,
.optimize = optimize,
});
const st_lib = b.addLibrary(.{
.name = "zeam-state-transition",
.root_module = st_module,
.linkage = .static,
});
b.installArtifact(st_lib);
// add zeam-database
const zeam_database = b.addModule("@zeam/database", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/database/src/lib.zig"),
});
zeam_database.addImport("rocksdb", rocksdb);
zeam_database.addImport("ssz", ssz);
zeam_database.addImport("@zeam/utils", zeam_utils);
zeam_database.addImport("@zeam/types", zeam_types);
// add network
const zeam_network = b.addModule("@zeam/network", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/network/src/lib.zig"),
});
zeam_network.addImport("@zeam/types", zeam_types);
zeam_network.addImport("@zeam/utils", zeam_utils);
zeam_network.addImport("@zeam/params", zeam_params);
zeam_network.addImport("xev", xev);
zeam_network.addImport("ssz", ssz);
zeam_network.addImport("multiformats", multiformats);
zeam_network.addImport("multiaddr", multiaddr_mod);
zeam_network.addImport("snappyframesz", snappyframesz);
zeam_network.addImport("snappyz", snappyz);
// add beam node
const zeam_beam_node = b.addModule("@zeam/node", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/node/src/lib.zig"),
});
zeam_beam_node.addImport("xev", xev);
zeam_beam_node.addImport("ssz", ssz);
zeam_beam_node.addImport("@zeam/utils", zeam_utils);
zeam_beam_node.addImport("@zeam/params", zeam_params);
zeam_beam_node.addImport("@zeam/types", zeam_types);
zeam_beam_node.addImport("@zeam/configs", zeam_configs);
zeam_beam_node.addImport("@zeam/state-transition", zeam_state_transition);
zeam_beam_node.addImport("@zeam/network", zeam_network);
zeam_beam_node.addImport("@zeam/database", zeam_database);
zeam_beam_node.addImport("@zeam/metrics", zeam_metrics);
zeam_beam_node.addImport("@zeam/api", zeam_api);
zeam_beam_node.addImport("@zeam/key-manager", zeam_key_manager);
zeam_beam_node.addImport("@zeam/xmss", zeam_xmss);
const zeam_spectests = b.addModule("zeam_spectests", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/spectest/src/lib.zig"),
});
zeam_spectests.addImport("@zeam/utils", zeam_utils);
zeam_spectests.addImport("@zeam/types", zeam_types);
zeam_spectests.addImport("@zeam/configs", zeam_configs);
zeam_spectests.addImport("@zeam/params", zeam_params);
zeam_spectests.addImport("@zeam/key-manager", zeam_key_manager);
zeam_spectests.addImport("ssz", ssz);
zeam_spectests.addImport("build_options", build_options_module);
zeam_spectests.addImport("@zeam/state-transition", zeam_state_transition);
zeam_spectests.addImport("@zeam/node", zeam_beam_node);
// Add the cli executable
const cli_exe = b.addExecutable(.{
.name = "zeam",
.root_module = b.createModule(.{
.root_source_file = b.path("pkgs/cli/src/main.zig"),
.target = target,
.optimize = optimize,
}),
});
// Enable LTO if requested and on Linux (disabled by default for faster builds)
// Always disabled on macOS due to linker issues with Rust static libraries
// (LTO requires LLD but macOS uses its own linker by default)
if (enable_lto and target.result.os.tag == .linux) {
cli_exe.want_lto = true;
}
// addimport to root module is even required afer declaring it in mod
cli_exe.root_module.addImport("ssz", ssz);
cli_exe.root_module.addImport("build_options", build_options_module);
cli_exe.root_module.addImport("simargs", simargs);
cli_exe.root_module.addImport("xev", xev);
cli_exe.root_module.addImport("@zeam/database", zeam_database);
cli_exe.root_module.addImport("@zeam/utils", zeam_utils);
cli_exe.root_module.addImport("@zeam/params", zeam_params);
cli_exe.root_module.addImport("@zeam/types", zeam_types);
cli_exe.root_module.addImport("@zeam/configs", zeam_configs);
cli_exe.root_module.addImport("@zeam/metrics", zeam_metrics);
cli_exe.root_module.addImport("@zeam/state-transition", zeam_state_transition);
cli_exe.root_module.addImport("@zeam/state-proving-manager", zeam_state_proving_manager);
cli_exe.root_module.addImport("@zeam/network", zeam_network);
cli_exe.root_module.addImport("@zeam/node", zeam_beam_node);
cli_exe.root_module.addImport("@zeam/api", zeam_api);
cli_exe.root_module.addImport("@zeam/xmss", zeam_xmss);
cli_exe.root_module.addImport("metrics", metrics);
cli_exe.root_module.addImport("multiformats", multiformats);
cli_exe.root_module.addImport("multiaddr", multiaddr_mod);
cli_exe.root_module.addImport("enr", enr);
cli_exe.root_module.addImport("yaml", yaml);
cli_exe.root_module.addImport("@zeam/key-manager", zeam_key_manager);
cli_exe.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, cli_exe, target, prover);
cli_exe.linkLibC(); // for rust static libs to link
cli_exe.linkLibCpp(); // for rocksdb C++ library to link
cli_exe.linkSystemLibrary("unwind"); // to be able to display rust backtraces
b.installArtifact(cli_exe);
try build_zkvm_targets(b, &cli_exe.step, target, build_options_module, use_poseidon);
const run_prover = b.addRunArtifact(cli_exe);
const prover_step = b.step("run", "Run cli executable");
prover_step.dependOn(&run_prover.step);
if (b.args) |args| {
run_prover.addArgs(args);
} else {
run_prover.addArgs(&[_][]const u8{"prove"});
run_prover.addArgs(&[_][]const u8{ "-d", b.fmt("{s}/bin", .{b.install_path}) });
}
const tools_step = b.step("tools", "Build zeam tools");
const tools_cli_exe = b.addExecutable(.{
.name = "zeam-tools",
.root_module = b.createModule(.{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/tools/src/main.zig"),
}),
});
tools_cli_exe.root_module.addImport("enr", enr);
tools_cli_exe.root_module.addImport("build_options", build_options_module);
tools_cli_exe.root_module.addImport("simargs", simargs);
tools_cli_exe.root_module.addImport("@zeam/xmss", zeam_xmss);
tools_cli_exe.root_module.addImport("@zeam/types", zeam_types);
tools_cli_exe.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, tools_cli_exe, target, prover);
const install_tools_cli = b.addInstallArtifact(tools_cli_exe, .{});
tools_step.dependOn(&install_tools_cli.step);
const all_step = b.step("all", "Build all executables and tools");
all_step.dependOn(&cli_exe.step);
all_step.dependOn(tools_step);
const test_step = b.step("test", "Run zeam core tests");
// CLI integration tests (separate target) - always create this test target
const cli_integration_tests = b.addTest(.{
.root_module = b.createModule(.{
.root_source_file = b.path("pkgs/cli/test/integration.zig"),
.target = target,
.optimize = optimize,
}),
});
const integration_build_options = b.addOptions();
cli_integration_tests.step.dependOn(&cli_exe.step);
integration_build_options.addOptionPath("cli_exe_path", cli_exe.getEmittedBin());
const integration_build_options_module = integration_build_options.createModule();
cli_integration_tests.root_module.addImport("build_options", integration_build_options_module);
// Add CLI constants module to integration tests
const cli_constants = b.addModule("cli_constants", .{
.root_source_file = b.path("pkgs/cli/src/constants.zig"),
.target = target,
.optimize = optimize,
});
cli_integration_tests.root_module.addImport("cli_constants", cli_constants);
// Add error handler module to integration tests
const error_handler_module = b.addModule("error_handler", .{
.root_source_file = b.path("pkgs/cli/src/error_handler.zig"),
.target = target,
.optimize = optimize,
});
cli_integration_tests.root_module.addImport("error_handler", error_handler_module);
const types_tests = b.addTest(.{
.root_module = zeam_types,
});
types_tests.root_module.addImport("ssz", ssz);
types_tests.root_module.addImport("@zeam/key-manager", zeam_key_manager);
types_tests.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, types_tests, target, prover);
const run_types_test = b.addRunArtifact(types_tests);
setTestRunLabelFromCompile(b, run_types_test, types_tests);
test_step.dependOn(&run_types_test.step);
const transition_tests = b.addTest(.{
.root_module = zeam_state_transition,
});
// TODO(gballet) typing modules each time is quite tedious, hopefully
// this will no longer be necessary in later versions of zig.
transition_tests.root_module.addImport("@zeam/types", zeam_types);
transition_tests.root_module.addImport("@zeam/params", zeam_params);
transition_tests.root_module.addImport("@zeam/metrics", zeam_metrics);
transition_tests.root_module.addImport("ssz", ssz);
const run_transition_test = b.addRunArtifact(transition_tests);
setTestRunLabelFromCompile(b, run_transition_test, transition_tests);
test_step.dependOn(&run_transition_test.step);
const manager_tests = b.addTest(.{
.root_module = zeam_state_proving_manager,
});
manager_tests.root_module.addImport("@zeam/types", zeam_types);
addRustGlueLib(b, manager_tests, target, prover);
const run_manager_test = b.addRunArtifact(manager_tests);
setTestRunLabelFromCompile(b, run_manager_test, manager_tests);
test_step.dependOn(&run_manager_test.step);
const node_tests = b.addTest(.{
.root_module = zeam_beam_node,
});
addRustGlueLib(b, node_tests, target, prover);
const run_node_test = b.addRunArtifact(node_tests);
setTestRunLabelFromCompile(b, run_node_test, node_tests);
test_step.dependOn(&run_node_test.step);
const cli_tests = b.addTest(.{
.root_module = cli_exe.root_module,
});
cli_tests.step.dependOn(&cli_exe.step);
cli_tests.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, cli_tests, target, prover);
const run_cli_test = b.addRunArtifact(cli_tests);
setTestRunLabelFromCompile(b, run_cli_test, cli_tests);
test_step.dependOn(&run_cli_test.step);
const params_tests = b.addTest(.{
.root_module = zeam_params,
});
const run_params_tests = b.addRunArtifact(params_tests);
setTestRunLabelFromCompile(b, run_params_tests, params_tests);
test_step.dependOn(&run_params_tests.step);
const network_tests = b.addTest(.{
.root_module = zeam_network,
});
network_tests.root_module.addImport("@zeam/types", zeam_types);
network_tests.root_module.addImport("xev", xev);
network_tests.root_module.addImport("ssz", ssz);
addRustGlueLib(b, network_tests, target, prover);
const run_network_tests = b.addRunArtifact(network_tests);
setTestRunLabelFromCompile(b, run_network_tests, network_tests);
test_step.dependOn(&run_network_tests.step);
const configs_tests = b.addTest(.{
.root_module = zeam_configs,
});
configs_tests.root_module.addImport("@zeam/utils", zeam_utils);
configs_tests.root_module.addImport("@zeam/types", zeam_types);
configs_tests.root_module.addImport("@zeam/params", zeam_params);
configs_tests.root_module.addImport("yaml", yaml);
configs_tests.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, configs_tests, target, prover);
const run_configs_tests = b.addRunArtifact(configs_tests);
setTestRunLabelFromCompile(b, run_configs_tests, configs_tests);
test_step.dependOn(&run_configs_tests.step);
const utils_tests = b.addTest(.{
.root_module = zeam_utils,
});
const run_utils_tests = b.addRunArtifact(utils_tests);
setTestRunLabelFromCompile(b, run_utils_tests, utils_tests);
test_step.dependOn(&run_utils_tests.step);
const database_tests = b.addTest(.{
.root_module = zeam_database,
});
database_tests.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, database_tests, target, prover);
const run_database_tests = b.addRunArtifact(database_tests);
setTestRunLabelFromCompile(b, run_database_tests, database_tests);
test_step.dependOn(&run_database_tests.step);
const api_tests = b.addTest(.{
.root_module = zeam_api,
});
api_tests.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, api_tests, target, prover);
const run_api_tests = b.addRunArtifact(api_tests);
setTestRunLabelFromCompile(b, run_api_tests, api_tests);
test_step.dependOn(&run_api_tests.step);
const xmss_tests = b.addTest(.{
.root_module = zeam_xmss,
});
// xmss_tests.step.dependOn(&networking_build.step);
xmss_tests.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, xmss_tests, target, prover);
const run_xmss_tests = b.addRunArtifact(xmss_tests);
setTestRunLabelFromCompile(b, run_xmss_tests, xmss_tests);
test_step.dependOn(&run_xmss_tests.step);
const spectests = b.addTest(.{
.root_module = zeam_spectests,
});
spectests.root_module.addImport("@zeam/utils", zeam_utils);
spectests.root_module.addImport("@zeam/types", zeam_types);
spectests.root_module.addImport("@zeam/configs", zeam_configs);
spectests.root_module.addImport("@zeam/metrics", zeam_metrics);
spectests.root_module.addImport("@zeam/state-transition", zeam_state_transition);
spectests.root_module.addImport("ssz", ssz);
manager_tests.step.dependOn(&build_rust_lib_steps.step);
network_tests.step.dependOn(&build_rust_lib_steps.step);
node_tests.step.dependOn(&build_rust_lib_steps.step);
transition_tests.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, transition_tests, target, prover);
const tools_test_step = b.step("test-tools", "Run zeam tools tests");
const tools_cli_tests = b.addTest(.{
.root_module = tools_cli_exe.root_module,
});
tools_cli_tests.root_module.addImport("enr", enr);
tools_cli_tests.root_module.addImport("@zeam/xmss", zeam_xmss);
tools_cli_tests.root_module.addImport("@zeam/types", zeam_types);
tools_cli_tests.step.dependOn(&build_rust_lib_steps.step);
addRustGlueLib(b, tools_cli_tests, target, prover);
const run_tools_cli_test = b.addRunArtifact(tools_cli_tests);
setTestRunLabelFromCompile(b, run_tools_cli_test, tools_cli_tests);
tools_test_step.dependOn(&run_tools_cli_test.step);
test_step.dependOn(tools_test_step);
// Create simtest step that runs only integration tests
const simtests = b.step("simtest", "Run integration tests");
const run_cli_integration_test = b.addRunArtifact(cli_integration_tests);
setTestRunLabelFromCompile(b, run_cli_integration_test, cli_integration_tests);
simtests.dependOn(&run_cli_integration_test.step);
// Create spectest step that runs spec tests
const spectest_generate_exe = b.addExecutable(.{
.name = "spectest-generate",
.root_module = b.createModule(.{
.root_source_file = b.path("pkgs/spectest/src/generator.zig"),
.target = target,
.optimize = optimize,
}),
});
const run_spectest_generate = b.addRunArtifact(spectest_generate_exe);
const spectest_generate_step = b.step("spectest:generate", "Regenerate spectest fixtures");
spectest_generate_step.dependOn(&run_spectest_generate.step);
const run_spectests_after_generate = b.addRunArtifact(spectests);
run_spectests_after_generate.step.dependOn(&run_spectest_generate.step);
const run_spectests = b.addRunArtifact(spectests);
const spectests_step = b.step("spectest", "Regenerate and run spec tests");
spectests_step.dependOn(&run_spectests_after_generate.step);
try setSpectestArgsAndEnv(b, run_spectest_generate, run_spectests, run_spectests_after_generate);
const spectest_run_step = b.step("spectest:run", "Run previously generated spectests");
spectest_run_step.dependOn(&run_spectests.step);
}
fn setSpectestArgsAndEnv(
b: *Builder,
run_spectest_generate: *std.Build.Step.Run,
run_spectests: *std.Build.Step.Run,
run_spectests_after_generate: *std.Build.Step.Run,
) !void {
if (b.args) |args| {
var generator_args_builder: std.ArrayList([]const u8) = .{};
defer generator_args_builder.deinit(b.allocator);
var skip_expected_errors = false;
for (args) |arg| {
if (std.mem.startsWith(u8, arg, "--skip-expected-error-fixtures")) {
const suffix = arg["--skip-expected-error-fixtures".len..];
if (suffix.len == 0) {
skip_expected_errors = true;
continue;
}
if (suffix[0] == '=') {
const value = suffix[1..];
if (std.ascii.eqlIgnoreCase(value, "true")) {
skip_expected_errors = true;
}
continue;
}
// fallthrough to treat as a normal argument if the suffix does not
// match the supported forms.
}
try generator_args_builder.append(b.allocator, arg);
}
if (generator_args_builder.items.len != 0) {
const generator_args = try generator_args_builder.toOwnedSlice(b.allocator);
run_spectest_generate.addArgs(generator_args);
}
if (skip_expected_errors) {
run_spectests.setEnvironmentVariable("ZEAM_SPECTEST_SKIP_EXPECTED_ERRORS", "true");
run_spectests_after_generate.setEnvironmentVariable("ZEAM_SPECTEST_SKIP_EXPECTED_ERRORS", "true");
}
}
}
fn build_rust_project(b: *Builder, path: []const u8, prover: ProverChoice) *Builder.Step.Run {
// Build only the selected prover crates
// Use optimized profiles for single-prover builds to reduce binary size
const cargo_build = switch (prover) {
.dummy => b.addSystemCommand(&.{
"cargo", "+nightly", "-C", path, "-Z", "unstable-options",
"build", "--release", "-p", "libp2p-glue", "-p", "hashsig-glue",
"-p", "multisig-glue",
}),
.risc0 => b.addSystemCommand(&.{
"cargo", "+nightly", "-C", path, "-Z", "unstable-options",
"build", "--profile", "risc0-release", "-p", "libp2p-glue", "-p",
"risc0-glue", "-p", "hashsig-glue", "-p", "multisig-glue",
}),
.openvm => b.addSystemCommand(&.{
"cargo", "+nightly", "-C", path, "-Z", "unstable-options",
"build", "--profile", "openvm-release", "-p", "libp2p-glue", "-p",
"openvm-glue", "-p", "hashsig-glue", "-p", "multisig-glue",
}),
.all => b.addSystemCommand(&.{
"cargo", "+nightly", "-C", path, "-Z", "unstable-options",
"build", "--release", "--all",
}),
};
return cargo_build;
}
fn build_zkvm_targets(
b: *Builder,
main_exe: *Builder.Step,
host_target: std.Build.ResolvedTarget,
build_options_module: *std.Build.Module,
use_poseidon: bool,
) !void {
// zkvm targets (riscv32-freestanding-none) require ReleaseFast; ReleaseSafe
// triggers "invalid operand for inline asm constraint 'i'" in LLVM on riscv32.
const optimize = .ReleaseFast;
for (zkvm_targets) |zkvm_target| {
const target_query = try std.Build.parseTargetQuery(.{ .arch_os_abi = zkvm_target.triplet, .cpu_features = zkvm_target.cpu_features });
const target = b.resolveTargetQuery(target_query);
// add ssz
const ssz = b.dependency("ssz", .{
.target = target,
.optimize = optimize,
}).module("ssz.zig");
// add metrics
const metrics = b.dependency("metrics", .{
.target = target,
.optimize = optimize,
}).module("metrics");
// add zeam-params
const zeam_params = b.addModule("@zeam/params", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/params/src/lib.zig"),
});
// add zeam-utils
const zeam_utils = b.addModule("@zeam/utils", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/utils/src/lib.zig"),
});
zeam_utils.addImport("ssz", ssz);
zeam_utils.addImport("build_options", build_options_module);
if (use_poseidon) {
// add hash-zig dependency only when Poseidon hasher is enabled
const hash_zig = b.dependency("hash_zig", .{
.target = target,
.optimize = optimize,
});
const hash_zig_module = hash_zig.module("hash-zig");
zeam_utils.addImport("hash_zig", hash_zig_module);
}
// add zeam-metrics (core metrics definitions for ZKVM)
const zeam_metrics = b.addModule("@zeam/metrics", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/metrics/src/lib.zig"),
});
zeam_metrics.addImport("metrics", metrics);
// add zeam-types
const zeam_types = b.addModule("@zeam/types", .{
.target = target,
.optimize = optimize,
.root_source_file = b.path("pkgs/types/src/lib.zig"),
});
zeam_types.addImport("ssz", ssz);
zeam_types.addImport("@zeam/params", zeam_params);
zeam_types.addImport("@zeam/utils", zeam_utils);
zeam_types.addImport("@zeam/metrics", zeam_metrics);
const zkvm_module = b.addModule("zkvm", .{
.optimize = optimize,
.target = target,
.root_source_file = b.path(b.fmt("pkgs/state-transition-runtime/src/{s}/lib.zig", .{zkvm_target.name})),
});
zeam_utils.addImport("zkvm", zkvm_module);
// add state transition, create a new module for each zkvm since
// that module depends on the zkvm module.
const zeam_state_transition = b.addModule("@zeam/state-transition", .{
.root_source_file = b.path("pkgs/state-transition/src/lib.zig"),
.target = target,
.optimize = optimize,
});
zeam_state_transition.addImport("@zeam/utils", zeam_utils);
zeam_state_transition.addImport("@zeam/params", zeam_params);
zeam_state_transition.addImport("@zeam/types", zeam_types);
zeam_state_transition.addImport("ssz", ssz);
zeam_state_transition.addImport("@zeam/metrics", zeam_metrics);
zeam_state_transition.addImport("zkvm", zkvm_module);
// target has to be riscv5 runtime provable/verifiable on zkVMs
var exec_name: [256]u8 = undefined;
var exe = b.addExecutable(.{
.name = try std.fmt.bufPrint(&exec_name, "zeam-stf-{s}", .{zkvm_target.name}),
.root_module = b.createModule(.{
.root_source_file = b.path("pkgs/state-transition-runtime/src/main.zig"),
.target = target,
.optimize = optimize,
.strip = true, // Strip debug info to avoid RISC-V relocation overflow
}),
});
// addimport to root module is even required afer declaring it in mod
exe.root_module.addImport("ssz", ssz);
exe.root_module.addImport("@zeam/utils", zeam_utils);
exe.root_module.addImport("@zeam/params", zeam_params);
exe.root_module.addImport("@zeam/types", zeam_types);
exe.root_module.addImport("@zeam/metrics", zeam_metrics);
exe.root_module.addImport("@zeam/state-transition", zeam_state_transition);
exe.root_module.addImport("zkvm", zkvm_module);
exe.addAssemblyFile(b.path(b.fmt("pkgs/state-transition-runtime/src/{s}/start.s", .{zkvm_target.name})));
if (zkvm_target.set_pie) {
exe.pie = true;
}
exe.setLinkerScript(b.path(b.fmt("pkgs/state-transition-runtime/src/{s}/{s}.ld", .{ zkvm_target.name, zkvm_target.name })));
main_exe.dependOn(&b.addInstallArtifact(exe, .{}).step);
// in case of risc0, use an external tool to format the executable
// the way the executor expects it.
if (std.mem.eql(u8, zkvm_target.name, "risc0")) {
const risc0_postbuild_gen = b.addExecutable(.{
.name = "risc0ospkg",
.root_module = b.createModule(.{
.root_source_file = b.path("build/risc0.zig"),
.target = host_target,
.optimize = .ReleaseFast,
}),
});
const run_risc0_postbuild_gen_step = b.addRunArtifact(risc0_postbuild_gen);
run_risc0_postbuild_gen_step.addFileArg(exe.getEmittedBin());
const install_generated = b.addInstallBinFile(try exe.getEmittedBinDirectory().join(b.allocator, "risc0_runtime.elf"), "risc0_runtime.elf");
install_generated.step.dependOn(&run_risc0_postbuild_gen_step.step);
main_exe.dependOn(&install_generated.step);
}
}
}