Add a hashes endpoint (#600)

* add a hashes endpoint

* changelog

CHANGELOG.md

@@ -37,6 +37,7 @@ At the moment this project **does not** adhere to
 - Add `--setup-only` flag ([#588](https://github.com/entropyxyz/entropy-core/pull/588/))
 - Add --version flag and about field to TSS ([#590](https://github.com/entropyxyz/entropy-core/pull/590/))
 - Program config storage ([#593](https://github.com/entropyxyz/entropy-core/pull/593))
+- Add a hashes endpoint ([#600](https://github.com/entropyxyz/entropy-core/pull/600))
 
 ### Changed
 - Crate name refactor ([#561](https://github.com/entropyxyz/entropy-core/pull/561))

crates/shared/Cargo.toml

@@ -15,6 +15,8 @@ serde_derive   ="1.0.147"
 sp-std         ={ package="sp-std", git="https://github.com/paritytech/substrate", branch="polkadot-v1.0.0", default-features=false }
 frame-support  ={ package="frame-support", git="https://github.com/paritytech/substrate", branch="polkadot-v1.0.0", default-features=false, optional=true }
 node-primitives={ version="2.0.0", default-features=false, git='https://github.com/paritytech/substrate.git', branch="polkadot-v1.0.0", optional=true }
+strum          ="0.25.0"
+strum_macros   ="0.25.3"
 
 [features]
 default=["std"]

crates/shared/src/types.rs

@@ -24,6 +24,8 @@ use node_primitives::BlockNumber;
 use scale_info::TypeInfo;
 #[cfg(feature = "std")]
 use serde::{Deserialize, Serialize};
+#[cfg(feature = "std")]
+use strum_macros::EnumIter;
 
 /// X25519 public key used by the client in non-interactive ECDH to authenticate/encrypt
 /// interactions with the threshold server (eg distributing threshold shares).
@@ -91,7 +93,7 @@ pub struct OcwMessageProactiveRefresh {
 }
 
 /// 256-bit hashing algorithms for deriving the point to be signed.
-#[cfg_attr(feature = "std", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "std", derive(Serialize, Deserialize, EnumIter))]
 #[derive(Clone, Debug, Eq, PartialEq)]
 #[cfg_attr(feature = "std", serde(rename = "hash"))]
 #[cfg_attr(feature = "std", serde(rename_all = "lowercase"))]

crates/threshold-signature-server/Cargo.toml

@@ -22,6 +22,7 @@ hex                ="*"
 reqwest-eventsource="0.4"
 serde_derive       ="1.0.147"
 synedrion          ="0.1"
+strum              ="0.25.0"
 
 # Async
 futures="0.3"

crates/threshold-signature-server/src/lib.rs

@@ -81,7 +81,10 @@
 //! messages. This is opened by other threshold servers when the signing procotol is initiated.
 //! - [`/validator/sync_kvdb`](crate::validator::api::sync_kvdb()) - POST - Called by another
 //! threshold server when joining to get the key-shares from a member of their sub-group.
-//!
+//! - [`/version`](crate::node_info::api::version()) - Get - get the node version info
+//! - [`/heathlz`](crate::health::api::healthz()) - Get - get if the node is running
+//! - [`/hashes`](crate::node_info::api::heahes()) - Get - get the hashes supported by the node
+
 //! ### For testing / development
 //!
 //! [Unsafe](crate::unsafe::api) has additional routes which are for testing and development
@@ -107,13 +110,13 @@ pub mod chain_api;
 pub mod common;
 pub(crate) mod health;
 pub(crate) mod helpers;
+pub(crate) mod node_info;
 pub(crate) mod sign_init;
 pub(crate) mod signing_client;
 pub(crate) mod r#unsafe;
 pub(crate) mod user;
 pub mod validation;
 pub(crate) mod validator;
-pub(crate) mod version;
 
 use axum::{
     http::Method,
@@ -131,11 +134,11 @@ use validator::api::get_random_server_info;
 use crate::{
     health::api::healthz,
     launch::Configuration,
+    node_info::api::{hashes, version as get_version},
     r#unsafe::api::{delete, put, remove_keys, unsafe_get},
     signing_client::{api::*, ListenerState},
     user::api::*,
     validator::api::sync_kvdb,
-    version::api::version as get_version,
 };
 pub use crate::{
     helpers::{launch, validator::get_signer},
@@ -164,6 +167,7 @@ pub fn app(app_state: AppState) -> Router {
         .route("/validator/sync_kvdb", post(sync_kvdb))
         .route("/healthz", get(healthz))
         .route("/version", get(get_version))
+        .route("/hashes", get(hashes))
         .route("/ws", get(ws_handler));
 
     // Unsafe routes are for testing purposes only

crates/threshold-signature-server/src/version/api.rs → crates/threshold-signature-server/src/node_info/api.rs

@@ -12,9 +12,17 @@
 //
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
+use axum::Json;
+use entropy_shared::types::HashingAlgorithm;
+use strum::IntoEnumIterator;
 /// Returns the version and commit data
 #[tracing::instrument]
 pub async fn version() -> String {
     format!("{}-{}", env!("CARGO_PKG_VERSION"), env!("VERGEN_GIT_DESCRIBE"))
 }
+
+#[tracing::instrument]
+pub async fn hashes() -> Json<Vec<HashingAlgorithm>> {
+    let hashing_algos = HashingAlgorithm::iter().collect::<Vec<_>>();
+    Json(hashing_algos)
+}

crates/threshold-signature-server/src/version/tests.rs → crates/threshold-signature-server/src/node_info/tests.rs

@@ -13,9 +13,9 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-use serial_test::serial;
-
 use crate::helpers::tests::{initialize_test_logger, setup_client};
+use entropy_shared::types::HashingAlgorithm;
+use serial_test::serial;
 
 #[tokio::test]
 #[serial]
@@ -29,3 +29,23 @@ async fn version_test() {
         format!("{}-{}", env!("CARGO_PKG_VERSION"), env!("VERGEN_GIT_DESCRIBE"))
     );
 }
+
+#[tokio::test]
+#[serial]
+async fn hashes_test() {
+    initialize_test_logger().await;
+    setup_client().await;
+    let response = reqwest::get("http://127.0.0.1:3001/hashes").await.unwrap();
+
+    let algorithms: Vec<HashingAlgorithm> = response.json().await.unwrap();
+    assert_eq!(
+        algorithms,
+        vec![
+            HashingAlgorithm::Sha1,
+            HashingAlgorithm::Sha2,
+            HashingAlgorithm::Sha3,
+            HashingAlgorithm::Keccak,
+            HashingAlgorithm::Custom(0),
+        ]
+    );
+}