about summary refs log tree commit diff
path: root/tvix/castore/protos
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-12-09T13·22+0200
committerclbot <clbot@tvl.fyi>2023-12-11T10·24+0000
commit459d9e106f68ea2761ee2dcaaa28e67756d6bdc3 (patch)
tree46aa68022f1b41aa2e66977073c5cf41d585894a /tvix/castore/protos
parentdb3ef5255fd6f6c4c4ac0e9077803a9eb70e63d9 (diff)
chore(tvix/castore/protof): buf format r/7149
Change-Id: Idf11de78b0d6eca69fda34a89f2c57a00ed89ad5
Reviewed-on: https://cl.tvl.fyi/c/depot/+/10237
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Reviewed-by: Adam Joseph <adam@westernsemico.com>
Diffstat (limited to 'tvix/castore/protos')
-rw-r--r--tvix/castore/protos/castore.proto75
-rw-r--r--tvix/castore/protos/default.nix1
-rw-r--r--tvix/castore/protos/rpc_blobstore.proto94
-rw-r--r--tvix/castore/protos/rpc_directory.proto8
4 files changed, 89 insertions, 89 deletions
diff --git a/tvix/castore/protos/castore.proto b/tvix/castore/protos/castore.proto
index e05c43ee2f22..1ef404404504 100644
--- a/tvix/castore/protos/castore.proto
+++ b/tvix/castore/protos/castore.proto
@@ -8,8 +8,8 @@ package tvix.castore.v1;
 option go_package = "code.tvl.fyi/tvix/castore-go;castorev1";
 
 // A Directory can contain Directory, File or Symlink nodes.
-// Each of these nodes have a name attribute, which is the basename in that directory
-// and node type specific attributes.
+// Each of these nodes have a name attribute, which is the basename in that
+// directory and node type specific attributes.
 // The name attribute:
 //  - MUST not contain slashes or null bytes
 //  - MUST not be '.' or '..'
@@ -17,56 +17,55 @@ option go_package = "code.tvl.fyi/tvix/castore-go;castorev1";
 // Elements in each list need to be lexicographically ordered by the name
 // attribute.
 message Directory {
-    repeated DirectoryNode directories = 1;
-    repeated FileNode files = 2;
-    repeated SymlinkNode symlinks = 3;
+  repeated DirectoryNode directories = 1;
+  repeated FileNode files = 2;
+  repeated SymlinkNode symlinks = 3;
 }
 
 // A DirectoryNode represents a directory in a Directory.
 message DirectoryNode {
-    // The (base)name of the directory
-    bytes name = 1;
-    // The blake3 hash of a Directory message, serialized in protobuf canonical form.
-    bytes digest = 2;
-    // Number of child elements in the Directory referred to by `digest`.
-    // Calculated by summing up the numbers of `directories`, `files` and
-    // `symlinks`, and for each directory, its size field. Used for inode
-    // number calculation.
-    // This field is precisely as verifiable as any other Merkle tree edge.
-    // Resolve `digest`, and you can compute it incrementally. Resolve the
-    // entire tree, and you can fully compute it from scratch.
-    // A credulous implementation won't reject an excessive size, but this is
-    // harmless: you'll have some ordinals without nodes. Undersizing is
-    // obvious and easy to reject: you won't have an ordinal for some nodes.
-    uint64 size = 3;
+  // The (base)name of the directory
+  bytes name = 1;
+  // The blake3 hash of a Directory message, serialized in protobuf canonical form.
+  bytes digest = 2;
+  // Number of child elements in the Directory referred to by `digest`.
+  // Calculated by summing up the numbers of `directories`, `files` and
+  // `symlinks`, and for each directory, its size field. Used for inode number
+  // calculation.
+  // This field is precisely as verifiable as any other Merkle tree edge.
+  // Resolve `digest`, and you can compute it incrementally. Resolve the entire
+  // tree, and you can fully compute it from scratch.
+  // A credulous implementation won't reject an excessive size, but this is
+  // harmless: you'll have some ordinals without nodes. Undersizing is obvious
+  // and easy to reject: you won't have an ordinal for some nodes.
+  uint64 size = 3;
 }
 
 // A FileNode represents a regular or executable file in a Directory.
 message FileNode {
-    // The (base)name of the file
-    bytes name = 1;
-    // The blake3 digest of the file contents
-    bytes digest = 2;
-    // The file content size
-    uint64 size = 3;
-    // Whether the file is executable
-    bool executable = 4;
+  // The (base)name of the file
+  bytes name = 1;
+  // The blake3 digest of the file contents
+  bytes digest = 2;
+  // The file content size
+  uint64 size = 3;
+  // Whether the file is executable
+  bool executable = 4;
 }
 
 // A SymlinkNode represents a symbolic link in a Directory.
 message SymlinkNode {
-    // The (base)name of the symlink
-    bytes name = 1;
-    // The target of the symlink.
-    bytes target = 2;
+  // The (base)name of the symlink
+  bytes name = 1;
+  // The target of the symlink.
+  bytes target = 2;
 }
 
 // A Node is either a DirectoryNode, FileNode or SymlinkNode.
 message Node {
-    oneof node {
-        DirectoryNode directory = 1;
-        FileNode file = 2;
-        SymlinkNode symlink = 3;
-    }
+  oneof node {
+    DirectoryNode directory = 1;
+    FileNode file = 2;
+    SymlinkNode symlink = 3;
+  }
 }
-
diff --git a/tvix/castore/protos/default.nix b/tvix/castore/protos/default.nix
index e2e2f910ee51..87610689b111 100644
--- a/tvix/castore/protos/default.nix
+++ b/tvix/castore/protos/default.nix
@@ -24,6 +24,7 @@
     buildPhase = ''
       export HOME=$TMPDIR
       buf lint
+      buf format -d --exit-code
       buf generate
 
       mkdir -p $out
diff --git a/tvix/castore/protos/rpc_blobstore.proto b/tvix/castore/protos/rpc_blobstore.proto
index 93c02d397c44..195ab5bf4fa5 100644
--- a/tvix/castore/protos/rpc_blobstore.proto
+++ b/tvix/castore/protos/rpc_blobstore.proto
@@ -11,75 +11,75 @@ option go_package = "code.tvl.fyi/tvix/castore-go;castorev1";
 // return the BLAKE3 digest of it, and that's the identifier used to Read/Stat
 // them too.
 service BlobService {
-    // Stat can be used to check for the existence of a blob, as well as
-    // gathering more data about it, like more granular chunking information
-    // or baos.
-    // Server implementations are not required to provide more granular chunking
-    // information, especially if the digest specified in [StatBlobRequest] is
-    // already a chunk of a blob.
-    rpc Stat(StatBlobRequest) returns (StatBlobResponse);
+  // Stat can be used to check for the existence of a blob, as well as
+  // gathering more data about it, like more granular chunking information
+  // or baos.
+  // Server implementations are not required to provide more granular chunking
+  // information, especially if the digest specified in [StatBlobRequest] is
+  // already a chunk of a blob.
+  rpc Stat(StatBlobRequest) returns (StatBlobResponse);
 
-    // Read allows reading (all) data of a blob/chunk by the BLAKE3 digest of
-    // its contents.
-    // If the backend communicated more granular chunks in the `Stat` request,
-    // this can also be used to read chunks.
-    // This request returns a stream of BlobChunk, which is just a container for
-    // a stream of bytes.
-    // The server may decide on whatever chunking it may seem fit as a size for
-    // the individual BlobChunk sent in the response stream, this is mostly to
-    // keep individual messages at a manageable size.
-    rpc Read(ReadBlobRequest) returns (stream BlobChunk);
+  // Read allows reading (all) data of a blob/chunk by the BLAKE3 digest of
+  // its contents.
+  // If the backend communicated more granular chunks in the `Stat` request,
+  // this can also be used to read chunks.
+  // This request returns a stream of BlobChunk, which is just a container for
+  // a stream of bytes.
+  // The server may decide on whatever chunking it may seem fit as a size for
+  // the individual BlobChunk sent in the response stream, this is mostly to
+  // keep individual messages at a manageable size.
+  rpc Read(ReadBlobRequest) returns (stream BlobChunk);
 
-    // Put uploads a Blob, by reading a stream of bytes.
-    //
-    // The way the data is chunked up in individual BlobChunk messages sent in
-    // the stream has no effect on how the server ends up chunking blobs up, if
-    // it does at all.
-    rpc Put(stream BlobChunk) returns (PutBlobResponse);
+  // Put uploads a Blob, by reading a stream of bytes.
+  //
+  // The way the data is chunked up in individual BlobChunk messages sent in
+  // the stream has no effect on how the server ends up chunking blobs up, if
+  // it does at all.
+  rpc Put(stream BlobChunk) returns (PutBlobResponse);
 }
 
 message StatBlobRequest {
-    // The blake3 digest of the blob requested
-    bytes digest = 1;
+  // The blake3 digest of the blob requested
+  bytes digest = 1;
 
-    // Whether the server should reply with a list of more granular chunks.
-    bool send_chunks = 2;
+  // Whether the server should reply with a list of more granular chunks.
+  bool send_chunks = 2;
 
-    // Whether the server should reply with a bao.
-    bool send_bao = 3;
+  // Whether the server should reply with a bao.
+  bool send_bao = 3;
 }
 
 message StatBlobResponse {
-    // If `send_chunks` was set to true, this MAY contain a list of more
-    // granular chunks, which then may be read individually via the `Read`
-    // method.
-    repeated ChunkMeta chunks = 2;
+  // If `send_chunks` was set to true, this MAY contain a list of more
+  // granular chunks, which then may be read individually via the `Read`
+  // method.
+  repeated ChunkMeta chunks = 2;
 
-    message ChunkMeta {
-        // Digest of that specific chunk
-        bytes digest = 1;
+  message ChunkMeta {
+    // Digest of that specific chunk
+    bytes digest = 1;
 
-        // Length of that chunk, in bytes.
-        uint64 size = 2;
-    }
+    // Length of that chunk, in bytes.
+    uint64 size = 2;
+  }
 
-    // If `send_bao` was set to true, this MAY contain a outboard bao.
-    // The exact format and message types here will still be fleshed out.
-    bytes bao = 3;
+  // If `send_bao` was set to true, this MAY contain a outboard bao.
+  // The exact format and message types here will still be fleshed out.
+  bytes bao = 3;
 }
 
 message ReadBlobRequest {
-    // The blake3 digest of the blob or chunk requested
-    bytes digest = 1;
+  // The blake3 digest of the blob or chunk requested
+  bytes digest = 1;
 }
 
 // This represents some bytes of a blob.
 // Blobs are sent in smaller chunks to keep message sizes manageable.
 message BlobChunk {
-    bytes data = 1;
+  bytes data = 1;
 }
 
 message PutBlobResponse {
-    // The blake3 digest of the data that was sent.
-    bytes digest = 1;
+  // The blake3 digest of the data that was sent.
+  bytes digest = 1;
 }
diff --git a/tvix/castore/protos/rpc_directory.proto b/tvix/castore/protos/rpc_directory.proto
index f45227a48eca..7fccb6c75e34 100644
--- a/tvix/castore/protos/rpc_directory.proto
+++ b/tvix/castore/protos/rpc_directory.proto
@@ -30,10 +30,10 @@ service DirectoryService {
 
 message GetDirectoryRequest {
   oneof by_what {
-      // The blake3 hash of the (root) Directory message, serialized in
-      // protobuf canonical form.
-      // Keep in mind this can be a subtree of another root.
-      bytes digest = 1;
+    // The blake3 hash of the (root) Directory message, serialized in
+    // protobuf canonical form.
+    // Keep in mind this can be a subtree of another root.
+    bytes digest = 1;
   }
 
   // If set to true, recursively resolve all child Directory messages.