Merge pull request #95 from clearmatics/fix-command-names

Fixed command naming inconstencies

README.md

@@ -8,7 +8,7 @@ This project can be used to:
 
 :rotating_light: **WARNING** This project is a Work In Progress (WIP). It is highly inefficient and has not been thoroughly reviewed. Please do not use in production!
 
-## Building and running the `aggregator_server`:
+## Building and running the `aggregator-server`:
 
 :computer: **Warning** This project primarily targets x86_64 Linux and macOS platforms.
 
@@ -60,8 +60,8 @@ make
 make check
 # Alternatively, run: make build_tests && make test
 
-# Start the aggregator_server process
-aggregator_server
+# Start the aggregator-server process
+aggregator-server
 ```
 
 ### Build and run in a docker container

aggregator_server/CMakeLists.txt

@@ -21,14 +21,14 @@ include_directories(SYSTEM ${Boost_INCLUDE_DIR})
 # so that we will find zecale_config.h
 include_directories(${PROJECT_BINARY_DIR})
 
-# aggregator_server executable
+# aggregator-server executable
 file(
   GLOB_RECURSE
   AGGREGATOR_SERVER_SOURCE
   aggregator_server.cpp
 )
 add_executable(
-  aggregator_server
+  aggregator-server
   ${AGGREGATOR_SERVER_SOURCE}
   ${GRPC_SRCS}
 )
@@ -39,7 +39,7 @@ if (NOT APPLE)
 endif()
 
 target_link_libraries(
-  aggregator_server
+  aggregator-server
 
   zecale
   ${Boost_SYSTEM_LIBRARY}

client/README.md

@@ -71,7 +71,7 @@ $ depends/zeth/scripts/ganache-start
 
 ## Execute testing scripts
 
-Once the `aggregator_server` and a custom `ganache-cli` instance are running, several scripts can be executed to test the CLIs as well as various aspects of the client and the contracts:
+Once the `aggregator-server` and a custom `ganache-cli` instance are running, several scripts can be executed to test the CLIs as well as various aspects of the client and the contracts:
 
 ```console
 (env)$ python test_commands/<script-name> <script-arguments>
@@ -98,7 +98,7 @@ The `zecale` command exposes Zecale operations via a command line interface. A b
 Depending on the operation being performed, the `zecale` client must:
 - interact with an Ethereum RPC host **that supports BW6 arithmetic** (e.g. [here](https://github.com/clearmatics/ganache-cli/tree/v6.10.1-clearmatics)),
 - interact with the deployed Zecale contracts,
-- request proofs and proof verification keys from `aggregator_server`
+- request proofs and proof verification keys from `aggregator-server`
 
 In a similar way as in Zeth, data is stored in files with
 default file names (which can be overridden on the zecale commands).

client/zecale/cli/zecale_nested_verification_key_hash.py

@@ -14,7 +14,7 @@ def nested_verification_key_hash(
         ctx: Context,
         verification_key_file: str) -> None:
     """
-    Query the aggregator_server for the hash of a specific nested verification
+    Query the aggregator-server for the hash of a specific nested verification
     key. The verification key does not have to be registered.
     """
     cmd_ctx: CommandContext = ctx.obj

scripts/check_copyright → scripts/check-copyright

@@ -8,7 +8,7 @@ function check_copyright_files() {
     count=0
     while read -r file ; do
         if ! (head -n 4 ${file} | grep -q "Copyright\|DISCLAIMER") ; then
-            echo "check_copyright: ${file}"
+            echo "check-copyright: ${file}"
             count=$((${count} + 1))
         fi
     done
@@ -20,6 +20,6 @@ if ! (git ls-files '*.py' | check_copyright_files && \
           git ls-files 'mpc/commands' | check_copyright_files && \
           git ls-files '*.hpp' '*.cpp' '*.tcc' | check_copyright_files)
 then
-    echo "check_copyright: ERROR: the above files have missing copyright notices"
+    echo "check-copyright: ERROR: the above files have missing copyright notices"
     exit 1
 fi

scripts/ci

@@ -23,7 +23,7 @@ function check_format() {
     fi
 
     # Perform the check for copyright notices here
-    scripts/check_copyright
+    scripts/check-copyright
 }
 
 function check_cpp() {

scripts/ci_utils.sh

@@ -17,7 +17,7 @@ function aggregator_start() {
     pushd build
 
     server_start \
-        ./aggregator_server/aggregator_server \
+        ./aggregator_server/aggregator-server \
         aggregator_is_active \
         aggregator.pid \
         aggregator.stdout

setup_env.sh

@@ -7,4 +7,4 @@ export ZECALE_SETUP_DIR=$ZECALE/zecale_setup
 mkdir -p $ZECALE_SETUP_DIR
 
 # Add the zecale executables in the PATH
-export PATH=$ZECALE/build/aggregator_server:$ZECALE/build/libzecale/tests:$PATH
+export PATH=$ZECALE/build/aggregator_server:$ZECALE/build/libzecale/tests:$PATH