Initial protobuf/grpc scaffold

Author: bladyjoker

proto/Setup.hs

@@ -0,0 +1,3 @@
+import Data.ProtoLens.Setup (defaultMainGeneratingProtos)
+
+main = defaultMainGeneratingProtos "."

proto/oracle.proto

@@ -0,0 +1,62 @@
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+
+package orcfax;
+
+service Oracle {
+  // Get a list of all resource types supported by this oracle
+  rpc getCatalog(google.protobuf.Empty) returns (GetCatalogResponse) {}
+
+  // Get signatories that will include their signature in the fact producing transactions
+  rpc getSignatories(google.protobuf.Empty) returns (GetSignatoriesResponse) {}
+
+  // Create a transaction with the desired information
+  rpc createResourceTransaction(CreateResourceTransactionRequest) returns (CreateResourceTransactionResponse) {}
+}
+
+
+message GetCatalogResponse {
+  repeated ResourceDescription catalog = 1;
+}
+
+message ResourceDescription {
+  // Uniform resource name
+  string urn = 1;
+  // Resource type
+  oneof type {
+    // Used by MVP version
+    RealNumber price = 2;
+    // When Cardano DApp schema lands (aka typez)
+    Typez typez = 3;
+  }
+}
+
+message RealNumber {
+}
+
+message Typez {
+  string typez = 1;
+}
+
+message GetSignatoriesResponse {
+  repeated PubKeyHash signatories = 1;
+}
+
+message PubKeyHash {
+  // Base16 (hex) encoded public key hash
+  string value = 1;
+}
+
+message CreateResourceTransactionRequest {
+  // Which resource to observe
+  string resource_urn = 1;
+  // The PubKeyHash of the user that will submit the transaction
+  PubKeyHash submitter = 2;
+  // User provided trx output to use as collateral
+  UTXORef collateral = 3;
+}
+
+message CreateResourceTransactionResponse {}
+
+message UTXORef {}

proto/orcfax-proto.cabal

@@ -0,0 +1,36 @@
+cabal-version:      3.0
+name:               orcfax-proto
+version:            0.1.0.0
+maintainer:         [email protected]
+author:             Drazen Popovic
+synopsis:           A Cabal project for Orcfax protobufs
+build-type:         Custom
+extra-source-files: **/*.proto
+
+custom-setup
+  setup-depends:
+    , base
+    , Cabal
+    , proto-lens-protobuf-types
+    , proto-lens-setup
+
+library
+  exposed-modules:
+    Proto.Oracle
+    Proto.Oracle_Fields
+
+  autogen-modules:
+    Proto.Oracle
+    Proto.Oracle_Fields
+
+  default-language: Haskell2010
+  build-depends:
+    , base
+    , http2-grpc-types
+    , microlens
+    , proto-lens
+    , proto-lens-protobuf-types
+    , proto-lens-runtime
+    , warp
+    , warp-grpc
+    , warp-tls

proto/proto.nix

@@ -0,0 +1,97 @@
+{ pkgs, haskell-nix, compiler-nix-name, http2-grpc-native }:
+haskell-nix.cabalProject' {
+  src = ./.;
+  name = "orcfax-proto";
+  inherit compiler-nix-name;
+  index-state = "2022-01-21T23:44:46Z";
+  extraSources = [
+    {
+      src = http2-grpc-native + /http2-client-grpc;
+      subdirs = [
+        "."
+      ];
+    }
+    {
+      src = http2-grpc-native + /http2-grpc-proto-lens;
+      subdirs = [
+        "."
+      ];
+    }
+    {
+      src = http2-grpc-native + /http2-grpc-proto3-wire;
+      subdirs = [
+        "."
+      ];
+    }
+    {
+      src = http2-grpc-native + /http2-grpc-types;
+      subdirs = [
+        "."
+      ];
+    }
+
+    {
+      src = http2-grpc-native + /warp-grpc;
+      subdirs = [
+        "."
+      ];
+    }
+  ];
+  modules = [
+    (_: {
+      packages = {
+        allComponent.doHoogle = true;
+
+        # Add proto compilation execs
+        proto-lens-protobuf-types.components.library.build-tools = [
+          pkgs.protobuf
+          pkgs.haskellPackages.proto-lens-protoc
+        ];
+
+        orcfax-proto.components.library.build-tools = [
+          pkgs.protobuf
+          pkgs.haskellPackages.proto-lens-protoc
+        ];
+      };
+    })
+  ];
+  shell = {
+
+    withHoogle = true;
+
+    exactDeps = true;
+
+    # We use the ones from vanilla Nixpkgs, since they are cached reliably.
+    nativeBuildInputs = with pkgs; [
+      # Building code
+      protobuf
+      haskellPackages.proto-lens-protoc
+      # Code quality
+      ## Haskell/Cabal
+      haskellPackages.fourmolu
+      haskellPackages.cabal-fmt
+      ## Nix
+      nixpkgs-fmt
+    ];
+
+    # additional = ps: [
+    #   ps.http2-client-grpc
+    #   ps.http2-grpc-proto-lens
+    #   ps.http2-grpc-proto3-wire
+    #   ps.http2-grpc-types
+    #   ps.warp-grpc
+    # ];
+
+    tools = {
+      cabal = { };
+      hlint = { };
+      haskell-language-server = { };
+    };
+
+    shellHook = ''
+      export LC_CTYPE=C.UTF-8
+      export LC_ALL=C.UTF-8
+      export LANG=C.UTF-8
+    '';
+  };
+}