Update to Zig 0.13

Author: joncinque

.gitignore

@@ -5,3 +5,4 @@
 solana-zig/
 zig-cache/
 zig-out/
+.zig-cache/

README.md

@@ -1,4 +1,4 @@
-# solana-zig-sdk
+# solana-program-sdk-zig
 
 Write Solana on-chain programs in Zig!
 
@@ -10,6 +10,7 @@ which also provides tests and a CLI.
 
 Here are some other packages to help with developing Solana programs with Zig:
 
+* [Base-58](https://github.com/joncinque/base58-zig)
 * [Bincode](https://github.com/joncinque/bincode-zig)
 * [Borsh](https://github.com/joncinque/borsh-zig)
 * [Solana Program Library](https://github.com/joncinque/solana-program-library-zig)
@@ -36,16 +37,24 @@ You can run the convenience script in this repo to download the compiler to
 1. Add this package and `base58-zig` to your project:
 
 ```console
-zig fetch --save https://github.com/joncinque/base58-zig/archive/refs/tags/v0.12.2.tar.gz
-zig fetch --save https://github.com/joncinque/solana-sdk-zig/archive/refs/tags/v0.12.0.tar.gz
+zig fetch --save https://github.com/joncinque/base58-zig/archive/refs/tags/v0.13.3.tar.gz
+zig fetch --save https://github.com/joncinque/solana-program-sdk-zig/archive/refs/tags/v0.13.0.tar.gz
 ```
 
-2. In your build.zig, add the modules that you want one by one, or use the
+2. (Optional) if you want to generate a keypair during building, you'll also
+need to install clap:
+
+```console
+zig fetch --save https://github.com/Hejsil/zig-clap/archive/refs/tags/0.9.1.tar.gz
+```
+
+3. In your build.zig, add the modules that you want one by one, or use the
 helpers in `build.zig`:
 
 ```zig
 const std = @import("std");
 const solana = @import("solana-program-sdk");
+const base58 = @import("base58");
 
 pub fn build(b: *std.build.Builder) !void {
     // Choose the on-chain target (bpf, sbf v1, sbf v2, etc)
@@ -60,28 +69,33 @@ pub fn build(b: *std.build.Builder) !void {
     const program = b.addSharedLibrary(.{
         .name = "program_name",
         // Give the root of your program, where the entrypoint is defined
-        .root_source_file = .{ .path = "src/main.zig" },
+        .root_source_file = b.path("src/main.zig"),
         .optimize = optimize,
         .target = target,
     });
     // Use the `buildProgram` helper to create the solana-sdk module, add all
-    // of its required dependencies, link the program properly, and generate
-    // a keypair in `zig-out/lib` along with the compiled program.
+    // of its required dependencies, link the program properly.
     const solana_mod = solana.buildProgram(b, program, target, optimize);
 
+    // Install the program artifact
+    b.installArtifact(program);
+
+    // Optional: to generate a keypair in `zig-out/lib`, be sure to run this too:
+    base58.generateProgramKeypair(b, program);
+
     // Optional, but if you define unit tests in your program files, you can run
     // them with `zig build test` with this step included
     const test_step = b.step("test", "Run unit tests");
     const lib_unit_tests = b.addTest(.{
-        .root_source_file = .{ .path = "src/main.zig" },
+        .root_source_file = b.path("src/main.zig"),
     });
     lib_unit_tests.root_module.addImport("solana-program-sdk", solana_mod);
     const run_unit_tests = b.addRunArtifact(lib_unit_tests);
     test_step.dependOn(&run_unit_tests.step);
 }
 ```
 
-3. Setup `src/main.zig`:
+4. Setup `src/main.zig`:
 
 ```zig
 const solana = @import("solana-program-sdk");
@@ -92,13 +106,13 @@ export fn entrypoint(_: [*]u8) callconv(.C) u64 {
 }
 ```
 
-4. Download the solana-zig compiler using the script in this repository:
+5. Download the solana-zig compiler using the script in this repository:
 
 ```console
 $ ./install-solana-zig.sh
 ```
 
-5. Build and deploy your program on Solana devnet:
+6. Build and deploy your program on Solana devnet:
 
 ```console
 $ ./solana-zig/zig build --summary all
@@ -123,8 +137,8 @@ The helpers in build.zig contain various Solana targets. Here are their analogue
 to the Rust build tools:
 
 * `sbf_target` -> `cargo build-sbf`
-* `bpf_target` -> `cargo build-bpf`
 * `sbfv2_target` -> `cargo build-sbf --arch sbfv2`
+* **Deprecated** `bpf_target` -> `cargo build-bpf`
 
 ## Unit tests
 
@@ -150,4 +164,4 @@ cd program-test/
 ```
 
 These tests require a Rust compiler along with the solana-zig compiler, as
-mentioned in the prerequisites.
+mentioned in the prerequisites. Be sure to run `./install-solana-zig.sh` first.

build.zig

@@ -1,5 +1,4 @@
 const std = @import("std");
-const generateKeypairRunStep = @import("base58").generateKeypairRunStep;
 
 pub fn build(b: *std.Build) void {
     const target = b.standardTargetOptions(.{});
@@ -38,7 +37,7 @@ pub fn build(b: *std.Build) void {
     test_step.dependOn(&run_lib_unit_tests.step);
 }
 
-pub fn addDependencies(b: *std.Build, solana_mod: *std.Build.Module, target: std.Build.ResolvedTarget, optimize: std.builtin.OptimizeMode) void {
+fn addDependencies(b: *std.Build, solana_mod: *std.Build.Module, target: std.Build.ResolvedTarget, optimize: std.builtin.OptimizeMode) void {
     const base58_dep = b.dependency("base58", .{
         .target = target,
         .optimize = optimize,
@@ -48,8 +47,7 @@ pub fn addDependencies(b: *std.Build, solana_mod: *std.Build.Module, target: std
 }
 
 // General helper function to do all the tricky build steps, by creating the
-// solana-sdk module, adding its dependencies, adding the BPF link script, and
-// generating a keypair to use for deployments
+// solana-sdk module, adding its dependencies, adding the BPF link script
 pub fn buildProgram(b: *std.Build, program: *std.Build.Step.Compile, target: std.Build.ResolvedTarget, optimize: std.builtin.OptimizeMode) *std.Build.Module {
     const solana_dep = b.dependency("solana-program-sdk", .{
         .target = target,
@@ -59,19 +57,9 @@ pub fn buildProgram(b: *std.Build, program: *std.Build.Step.Compile, target: std
     program.root_module.addImport("solana-program-sdk", solana_mod);
     addDependencies(b, solana_mod, target, optimize);
     linkSolanaProgram(b, program);
-    generateKeypair(b, program);
-    b.installArtifact(program);
     return solana_mod;
 }
 
-pub fn generateKeypair(b: *std.Build, program: *std.Build.Step.Compile) void {
-    const program_name = program.out_filename[0 .. program.out_filename.len - std.fs.path.extension(program.out_filename).len];
-    const path = b.fmt("{s}-keypair.json", .{program_name});
-    const lib_path = b.getInstallPath(.lib, path);
-    const run_step = generateKeypairRunStep(b, lib_path);
-    b.getInstallStep().dependOn(&run_step.step);
-}
-
 pub const sbf_target: std.Target.Query = .{
     .cpu_arch = .sbf,
     .os_tag = .solana,
@@ -94,9 +82,6 @@ pub const bpf_target: std.Target.Query = .{
 };
 
 pub fn linkSolanaProgram(b: *std.Build, lib: *std.Build.Step.Compile) void {
-    // TODO: Due to https://github.com/ziglang/zig/issues/18404, this script
-    // maps .data into .rodata, which only catches issues at runtime rather than
-    // compile-time, if the program tries to use .data
     const linker_script = b.addWriteFile("bpf.ld",
         \\PHDRS
         \\{
@@ -111,7 +96,7 @@ pub fn linkSolanaProgram(b: *std.Build, lib: *std.Build.Step.Compile) void {
         \\. = SIZEOF_HEADERS;
         \\.text : { *(.text*) } :text
         \\.rodata : { *(.rodata*) } :rodata
-        \\.rodata : { *(.data*) } :data
+        \\.data : { *(.data*) } :data
         \\.data.rel.ro : { *(.data.rel.ro*) } :rodata
         \\.dynamic : { *(.dynamic) } :dynamic
         \\.dynsym : { *(.dynsym) } :data

build.zig.zon

@@ -1,6 +1,6 @@
 .{
     .name = "solana-program-sdk",
-    .version = "0.12.0",
+    .version = "0.13.0",
     .minimum_zig_version = "0.12.0",
 
     // This field is optional.
@@ -10,8 +10,8 @@
     // internet connectivity.
     .dependencies = .{
         .base58 = .{
-            .url = "https://github.com/joncinque/base58-zig/archive/refs/tags/v0.12.2.tar.gz",
-            .hash = "12203cf62befaa692c11ed82c1cea15ae6da153a87d89a969b006d99267fc4ba8626",
+            .url = "https://github.com/joncinque/base58-zig/archive/refs/tags/v0.13.3.tar.gz",
+            .hash = "1220fd067bf167b9062cc29ccf715ff97643c2d3f8958beea863b6036876bb71bcb8",
         },
     },
     .paths = .{

install-solana-zig.sh

@@ -3,7 +3,7 @@
 if [[ -n $SOLANA_ZIG_VERSION ]]; then
   solana_zig_version="$SOLANA_ZIG_VERSION"
 else
-  solana_zig_version="v1.41"
+  solana_zig_version="v1.43.0"
 fi
 solana_zig_release_url="https://github.com/joncinque/solana-zig-bootstrap/releases/download/solana-$solana_zig_version"
 

program-test/build.zig

@@ -1,17 +1,20 @@
 const std = @import("std");
 const solana = @import("solana-program-sdk");
+const base58 = @import("base58");
 
 pub fn build(b: *std.Build) !void {
     const optimize = .ReleaseSmall;
     const target = b.resolveTargetQuery(solana.sbf_target);
     const program = b.addSharedLibrary(.{
         .name = "pubkey",
-        .root_source_file = .{ .path = "pubkey/main.zig" },
+        .root_source_file = b.path("pubkey/main.zig"),
         .optimize = optimize,
         .target = target,
     });
 
     // Adding required dependencies, link the program properly, and get a
     // prepared modules
     _ = solana.buildProgram(b, program, target, optimize);
+    b.installArtifact(program);
+    base58.generateProgramKeypair(b, program);
 }

program-test/build.zig.zon

@@ -4,12 +4,12 @@
     .minimum_zig_version = "0.12.0",
     .dependencies = .{
         .base58 = .{
-            .url = "https://github.com/joncinque/base58-zig/archive/refs/tags/v0.12.2.tar.gz",
-            .hash = "12203cf62befaa692c11ed82c1cea15ae6da153a87d89a969b006d99267fc4ba8626",
+            .url = "https://github.com/joncinque/base58-zig/archive/refs/tags/v0.13.3.tar.gz",
+            .hash = "1220fd067bf167b9062cc29ccf715ff97643c2d3f8958beea863b6036876bb71bcb8",
         },
         .clap = .{
-            .url = "https://github.com/Hejsil/zig-clap/archive/refs/tags/0.8.0.tar.gz",
-            .hash = "1220949d4e88864579067b6d4cdad6476c6176f27e782782c2c39b7f2c4817a10efb",
+            .url = "https://github.com/Hejsil/zig-clap/archive/refs/tags/0.9.1.tar.gz",
+            .hash = "122062d301a203d003547b414237229b09a7980095061697349f8bef41be9c30266b",
         },
         .@"solana-program-sdk" = .{
             .path = "..",