chore: bb contract command now returns the templated contract along with the verification key

barretenberg/cpp/src/barretenberg/dsl/acir_proofs/acir_composer.cpp

@@ -5,6 +5,7 @@
 #include "barretenberg/dsl/acir_format/recursion_constraint.hpp"
 #include "barretenberg/dsl/types.hpp"
 #include "barretenberg/plonk/proof_system/proving_key/serialize.hpp"
+#include "barretenberg/plonk/proof_system/verification_key/flat_ultra_verification_library/ultra_verifier_templated.h"
 #include "barretenberg/plonk/proof_system/verification_key/sol_gen.hpp"
 #include "barretenberg/plonk/proof_system/verification_key/verification_key.hpp"
 #include "barretenberg/srs/factories/crs_factory.hpp"
@@ -141,7 +142,7 @@ std::string AcirComposer::get_solidity_verifier()
 {
     std::ostringstream stream;
     output_vk_sol(stream, verification_key_, "UltraVerificationKey");
-    return stream.str();
+    return stream.str() + ultra_verifier_template;
 }
 
 /**

circuits/cpp/barretenberg/cpp/src/barretenberg/plonk/proof_system/verification_key/flat_ultra_verification_library/readme.md

@@ -0,0 +1,22 @@
+## Why is this here?
+
+For producing a verifier library that is able to verify a plonk proof, we want all data structures to be in one file instead of distributed over multiple files. This means that when one asks for an plonk verifier proof, we just need to paste in the verifier key and send the whole object as a string.
+
+## Why is it only UltraPlonk?
+
+This is currently only being used by the bb binary which exposes the ultra plonk proving system and so we only need to do this for the ultra plonk solidity library.
+
+## Whats with the python script?
+
+When the bb binary is produced, we want to embed the templated contract in the binary, so that we can concatenate it with the verification key. To do this, we need to embed the templated contract into the binary which requires either xxd or the python script which will escape the necessary characters. xxd was not chosen because it converts everything to bytes and is not remotely legible anymore
+
+## Whats the final solution?
+
+We want to ship the binary with a resource folder, that then references the `contract.sol` file and any other resources needed by the binary that we do not want to embed.
+
+## Using the Python script
+
+```
+python3 sol_to_cpp_embed.py ultra_verifier_template_contract.sol > ultra
+_verifier_templated.h
+```

circuits/cpp/barretenberg/cpp/src/barretenberg/plonk/proof_system/verification_key/flat_ultra_verification_library/sol_to_cpp_embed.py

@@ -0,0 +1,15 @@
+import sys
+
+if len(sys.argv) != 2:
+    print("Usage: python sol_to_cpp_embed.py <filename>")
+    sys.exit(1)
+
+filename = sys.argv[1]
+
+with open(filename, 'r') as file:
+    content = file.read()
+
+# Escape special characters
+escaped_content = content.replace("\\", "\\\\").replace("\"", "\\\"").replace("\n", "\\n")
+
+print(f"static const char* ultra_verifier_template = \"{escaped_content}\";")