flatbuffers: build new message definitions with flatbuffers

Author: mjain-jump

Cargo.lock

@@ -13,6 +13,8 @@ links = "protosol"
 
 [build-dependencies]
 prost-build = "0.11.9"
+flatc-rust = "0.2.0"
 
 [dependencies]
 prost = "0.11.9"
+flatbuffers = "25.9.23"

Cargo.toml

@@ -1,4 +1,8 @@
-use std::{env, fs, path::{Path, PathBuf}};
+extern crate flatc_rust;
+use std::{
+    env, fs,
+    path::{Path, PathBuf},
+};
 
 /// Normalize path only on Windows, else just return unchanged.
 fn maybe_normalize_windows_path(path: &Path) -> PathBuf {
@@ -18,34 +22,74 @@ fn maybe_normalize_windows_path(path: &Path) -> PathBuf {
     }
 }
 
-fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let proto_dir = PathBuf::from("proto");
+fn monitor_and_get_files(
+    dir: &PathBuf,
+    env_var: &str,
+    extension: &str,
+) -> Result<(Vec<PathBuf>, PathBuf), Box<dyn std::error::Error>> {
     let abs = env::current_dir()
         .expect("cwd")
-        .join(&proto_dir)
+        .join(dir)
         .canonicalize()
         .map(|p| maybe_normalize_windows_path(&p))
-        .expect("canonicalize proto dir");
+        .expect("canonicalize dir");
 
     println!("cargo:rerun-if-changed={}", abs.display());
-    println!("cargo:PROTO_DIR={}", abs.display());
+    println!("cargo:{}={}", env_var, abs.display());
 
-    let mut proto_files = vec![];
+    let mut files = vec![];
     for entry in fs::read_dir(&abs)? {
         let path = entry?.path();
-        if path.extension().and_then(|e| e.to_str()) == Some("proto") {
+        if path.extension().and_then(|e| e.to_str()) == Some(extension) {
             println!("cargo:rerun-if-changed={}", path.display());
-            proto_files.push(path);
+            files.push(path);
         }
     }
 
+    Ok((files, abs))
+}
+
+fn compile_protos() -> Result<(), Box<dyn std::error::Error>> {
+    let proto_dir = PathBuf::from("proto");
+    let (proto_files, abs) = monitor_and_get_files(&proto_dir, "PROTO_DIR", "proto")?;
+
     let out_dir = PathBuf::from(env::var("OUT_DIR")?);
     let mut config = prost_build::Config::new();
     config.out_dir(&out_dir);
     config.compile_protos(
-        &proto_files.iter().map(|p| p.display().to_string()).collect::<Vec<_>>(),
+        &proto_files
+            .iter()
+            .map(|p| p.display().to_string())
+            .collect::<Vec<_>>(),
         &[abs],
     )?;
 
     Ok(())
 }
+
+fn compile_flatbuffers() -> Result<(), Box<dyn std::error::Error>> {
+    let flatbuffers_dir = PathBuf::from("flatbuffers");
+    let (flatbuffers_files, abs) =
+        monitor_and_get_files(&flatbuffers_dir, "FLATBUFFERS_DIR", "fbs")?;
+
+    let out_dir = PathBuf::from(env::var("OUT_DIR")?);
+    flatc_rust::run(flatc_rust::Args {
+        lang: "rust",
+        inputs: flatbuffers_files
+            .iter()
+            .map(|p| p.as_path())
+            .collect::<Vec<_>>()
+            .as_slice(),
+        out_dir: out_dir.as_path(),
+        includes: &[abs.as_path()],
+        ..Default::default()
+    })?;
+
+    Ok(())
+}
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    compile_protos()?;
+    compile_flatbuffers()?;
+    Ok(())
+}

build.rs

@@ -0,0 +1,84 @@
+// Generated from block.proto
+
+include "metadata.fbs";
+include "context.fbs";
+include "txn.fbs";
+
+namespace org.solana.sealevel.v2;
+
+table CostTracker {
+  block_cost:ulong;
+  vote_cost:ulong;
+}
+
+table Inflation {
+  initial:double;
+  terminal:double;
+  taper:double;
+  foundation:double;
+  foundation_term:double;
+}
+
+table FeeRateGovernor {
+  target_lamports_per_signature:ulong;
+  target_signatures_per_slot:ulong;
+  min_lamports_per_signature:ulong;
+  max_lamports_per_signature:ulong;
+  burn_percent:ubyte;
+}
+
+table BankFields {
+  block_height:ulong;
+  poh:Hash (required);
+  parent_bank_hash:Hash (required);
+  parent_lthash:LtHash (required);
+  current_slot:ulong;
+  parent_slot:ulong;
+  prev_lps:ulong;
+  fee_rate_governor:FeeRateGovernor (required);
+  parent_signature_count:ulong;
+  hashes_per_tick:ulong;
+  ticks_per_slot:ulong;
+  slots_per_year:double;
+  inflation:Inflation (required);
+  genesis_creation_time:ulong;
+  prev_epoch_capitalization:ulong;
+  vote_accounts_t_1:[VoteAccount] (required);
+  vote_accounts_t_2:[VoteAccount] (required);
+}
+
+struct LeaderScheduleHash {
+  hash:[ubyte:16];
+}
+
+table LeaderScheduleEffects {
+  leaders_epoch:ulong;
+  leaders_slot0:ulong;
+  leaders_slot_cnt:ulong;
+  leader_pub_cnt:ulong;
+  leaders_sched_cnt:ulong;
+  leader_schedule_hash:LeaderScheduleHash (required);
+}
+
+table BlockContext {
+  transactions:[TransactionMessage] (required);
+  account_states:[Account] (required);
+  blockhash_queue:[Hash] (required);
+  bank_fields:BankFields (required);
+  features:FeatureSet;
+}
+
+table BlockEffects {
+  has_err:bool;
+  slot_capitalization:ulong;
+  bank_hash:Hash;
+  cost_tracker:CostTracker;
+  leader_schedule:LeaderScheduleEffects;
+}
+
+table BlockFixture {
+  metadata:FixtureMetadata (required);
+  input:BlockContext (required);
+  output:BlockEffects (required);
+}
+

flatbuffers/block.fbs

@@ -0,0 +1,36 @@
+// Generated from context.proto
+
+namespace org.solana.sealevel.v2;
+
+struct Pubkey {
+  address:[ubyte:32];
+}
+
+struct Signature {
+  signature:[ubyte:64];
+}
+
+struct Hash {
+  hash:[ubyte:32];
+}
+
+struct LtHash {
+  hash:[ushort:1024];
+}
+
+table FeatureSet {
+  features:[ulong];
+}
+
+table Account {
+  address:Pubkey (required);
+  lamports:ulong;
+  data:[ubyte] (required);
+  executable:bool;
+  owner:Pubkey (required);
+}
+
+table VoteAccount {
+  vote_account:Account (required);
+  stake:ulong;
+}

flatbuffers/context.fbs

@@ -0,0 +1,33 @@
+// Generated from elf.proto
+
+include "metadata.fbs";
+include "context.fbs";
+
+namespace org.solana.sealevel.v2;
+
+table ELFBinary {
+  data:[ubyte] (required);
+}
+
+table ELFLoaderCtx {
+  elf:ELFBinary (required);
+  features:FeatureSet;
+  deploy_checks:bool;
+}
+
+table ELFLoaderEffects {
+  rodata:[ubyte];
+  rodata_sz:ulong;
+  text_cnt:ulong;
+  text_off:ulong;
+  entry_pc:ulong;
+  calldests:[ulong];
+  err_code:ubyte;
+}
+
+table ELFLoaderFixture {
+  metadata:FixtureMetadata (required);
+  input:ELFLoaderCtx (required);
+  output:ELFLoaderEffects (required);
+}
+

flatbuffers/elf.fbs

@@ -0,0 +1,36 @@
+// Generated from invoke.proto
+
+include "metadata.fbs";
+include "context.fbs";
+
+namespace org.solana.sealevel.v2;
+
+table InstrAccount {
+  index:ubyte;
+  is_writable:bool;
+  is_signer:bool;
+}
+
+table InstrContext {
+  program_id:Pubkey (required);
+  account_states:[Account] (required);
+  instr_accounts:[InstrAccount] (required);
+  instr_data:[ubyte] (required);
+  cu_avail:ulong;
+  features:FeatureSet;
+}
+
+table InstrEffects {
+  err_code:ubyte;
+  custom_err_code:uint;
+  modified_accounts:[Account];
+  cu_remaining:ulong;
+  return_data:[ubyte];
+}
+
+table InstrFixture {
+  metadata:FixtureMetadata (required);
+  input:InstrContext (required);
+  output:InstrEffects (required);
+}
+

flatbuffers/instr.fbs

@@ -0,0 +1,8 @@
+// Generated from metadata.proto
+
+namespace org.solana.sealevel.v2;
+
+table FixtureMetadata {
+  fn_entrypoint:string (required);
+}
+