refactor: rename get clarity marf value and metadata endpoints

Author: hugoclrd

clarity/src/vm/representations.rs

@@ -51,8 +51,6 @@ lazy_static! {
         "({})|({})",
         *STANDARD_PRINCIPAL_REGEX_STRING, *CONTRACT_PRINCIPAL_REGEX_STRING
     );
-    static ref CLARITY_NAME_NO_BOUNDARIES_REGEX_STRING: String =
-        "[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*])*|[-+=/*]|[<>]=?".into();
     pub static ref CLARITY_NAME_REGEX_STRING: String =
         "^[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*])*$|^[-+=/*]$|^[<>]=?$".into();
     pub static ref CLARITY_NAME_REGEX: Regex =
@@ -66,19 +64,6 @@ lazy_static! {
         Regex::new(format!("^{}$|^__transient$", CONTRACT_NAME_REGEX_STRING.as_str()).as_str())
             .unwrap()
     };
-    pub static ref MARF_KEY_FOR_TRIP_REGEX_STRING: String = format!(
-        r"vm::{}::\d+::({})",
-        *CONTRACT_PRINCIPAL_REGEX_STRING,
-        *CLARITY_NAME_NO_BOUNDARIES_REGEX_STRING,
-    );
-    pub static ref MARF_KEY_FOR_QUAD_REGEX_STRING: String = format!(
-        r"{}::[0-9a-fA-F]+",
-        *MARF_KEY_FOR_TRIP_REGEX_STRING,
-    );
-    pub static ref METADATA_KEY_REGEX_STRING: String = format!(
-        r"vm-metadata::\d+::(contract|contract-size|contract-src|contract-data-size|({}))",
-        *CLARITY_NAME_NO_BOUNDARIES_REGEX_STRING,
-    );
 }
 
 guarded_string!(

stackslib/src/net/api/getclaritymarfvalue.rs

@@ -15,9 +15,8 @@
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 use clarity::vm::clarity::ClarityConnection;
-use clarity::vm::representations::{
-    MARF_KEY_FOR_QUAD_REGEX_STRING, MARF_KEY_FOR_TRIP_REGEX_STRING,
-};
+use clarity::vm::representations::CONTRACT_PRINCIPAL_REGEX_STRING;
+use lazy_static::lazy_static;
 use regex::{Captures, Regex};
 use stacks_common::types::net::PeerHost;
 use stacks_common::util::hash::to_hex;
@@ -32,8 +31,19 @@ use crate::net::httpcore::{
 };
 use crate::net::{Error as NetError, StacksNodeState, TipRequest};
 
+lazy_static! {
+    static ref CLARITY_NAME_NO_BOUNDARIES_REGEX_STRING: String =
+        "[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*])*|[-+=/*]|[<>]=?".into();
+    static ref MARF_KEY_FOR_TRIP_REGEX_STRING: String = format!(
+        r"vm::{}::\d+::({})",
+        *CONTRACT_PRINCIPAL_REGEX_STRING, *CLARITY_NAME_NO_BOUNDARIES_REGEX_STRING,
+    );
+    static ref MARF_KEY_FOR_QUAD_REGEX_STRING: String =
+        format!(r"{}::[0-9a-fA-F]+", *MARF_KEY_FOR_TRIP_REGEX_STRING,);
+}
+
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
-pub struct ClarityMarfValueResponse {
+pub struct ClarityMarfResponse {
     pub data: String,
     #[serde(rename = "proof")]
     #[serde(default)]
@@ -42,10 +52,10 @@ pub struct ClarityMarfValueResponse {
 }
 
 #[derive(Clone)]
-pub struct RPCGetClarityMarfValueRequestHandler {
+pub struct RPCGetClarityMarfRequestHandler {
     pub clarity_marf_key: Option<String>,
 }
-impl RPCGetClarityMarfValueRequestHandler {
+impl RPCGetClarityMarfRequestHandler {
     pub fn new() -> Self {
         Self {
             clarity_marf_key: None,
@@ -54,21 +64,21 @@ impl RPCGetClarityMarfValueRequestHandler {
 }
 
 /// Decode the HTTP request
-impl HttpRequest for RPCGetClarityMarfValueRequestHandler {
+impl HttpRequest for RPCGetClarityMarfRequestHandler {
     fn verb(&self) -> &'static str {
         "GET"
     }
 
     fn path_regex(&self) -> Regex {
         Regex::new(&format!(
-            r"^/v2/clarity_marf_value/(?P<clarity_marf_key>(vm-epoch::epoch-version)|({})|({}))$",
+            r"^/v2/clarity/marf/(?P<clarity_marf_key>(vm-epoch::epoch-version)|({})|({}))$",
             *MARF_KEY_FOR_TRIP_REGEX_STRING, *MARF_KEY_FOR_QUAD_REGEX_STRING
         ))
         .unwrap()
     }
 
     fn metrics_identifier(&self) -> &str {
-        "/v2/clarity_marf_value/:clarity_marf_key"
+        "/v2/clarity/marf/:clarity_marf_key"
     }
 
     /// Try to decode this request.
@@ -86,7 +96,11 @@ impl HttpRequest for RPCGetClarityMarfValueRequestHandler {
             ));
         }
 
-        let marf_key = request::get_clarity_key(captures, "clarity_marf_key")?;
+        let marf_key = if let Some(key_str) = captures.name("clarity_marf_key") {
+            key_str.as_str().to_string()
+        } else {
+            return Err(Error::Http(404, "Missing `clarity_marf_key`".to_string()));
+        };
 
         self.clarity_marf_key = Some(marf_key);
 
@@ -96,7 +110,7 @@ impl HttpRequest for RPCGetClarityMarfValueRequestHandler {
 }
 
 /// Handle the HTTP request
-impl RPCRequestHandler for RPCGetClarityMarfValueRequestHandler {
+impl RPCRequestHandler for RPCGetClarityMarfRequestHandler {
     /// Reset internal state
     fn restart(&mut self) {
         self.clarity_marf_key = None;
@@ -143,7 +157,7 @@ impl RPCRequestHandler for RPCGetClarityMarfValueRequestHandler {
                         };
 
                         let data = format!("0x{}", value_hex);
-                        Some(ClarityMarfValueResponse { data, marf_proof })
+                        Some(ClarityMarfResponse { data, marf_proof })
                     })
                 },
             )
@@ -177,19 +191,19 @@ impl RPCRequestHandler for RPCGetClarityMarfValueRequestHandler {
 }
 
 /// Decode the HTTP response
-impl HttpResponse for RPCGetClarityMarfValueRequestHandler {
+impl HttpResponse for RPCGetClarityMarfRequestHandler {
     fn try_parse_response(
         &self,
         preamble: &HttpResponsePreamble,
         body: &[u8],
     ) -> Result<HttpResponsePayload, Error> {
-        let marf_value: ClarityMarfValueResponse = parse_json(preamble, body)?;
+        let marf_value: ClarityMarfResponse = parse_json(preamble, body)?;
         Ok(HttpResponsePayload::try_from_json(marf_value)?)
     }
 }
 
 impl StacksHttpRequest {
-    pub fn new_getclaritymarfvalue(
+    pub fn new_getclaritymarf(
         host: PeerHost,
         clarity_marf_key: String,
         tip_req: TipRequest,
@@ -198,7 +212,7 @@ impl StacksHttpRequest {
         StacksHttpRequest::new_for_peer(
             host,
             "GET".into(),
-            format!("/v2/clarity_marf_value/{}", &clarity_marf_key),
+            format!("/v2/clarity/marf/{}", &clarity_marf_key),
             HttpRequestContents::new()
                 .for_tip(tip_req)
                 .query_arg("proof".into(), if with_proof { "1" } else { "0" }.into()),
@@ -208,10 +222,10 @@ impl StacksHttpRequest {
 }
 
 impl StacksHttpResponse {
-    pub fn decode_clarity_marf_value_response(self) -> Result<ClarityMarfValueResponse, NetError> {
+    pub fn decode_clarity_marf_response(self) -> Result<ClarityMarfResponse, NetError> {
         let contents = self.get_http_payload_ok()?;
         let contents_json: serde_json::Value = contents.try_into()?;
-        let resp: ClarityMarfValueResponse = serde_json::from_value(contents_json)
+        let resp: ClarityMarfResponse = serde_json::from_value(contents_json)
             .map_err(|_e| NetError::DeserializeError("Failed to load from JSON".to_string()))?;
         Ok(resp)
     }

stackslib/src/net/api/getclaritymetadata.rs

@@ -15,11 +15,10 @@
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 use clarity::vm::clarity::ClarityConnection;
-use clarity::vm::representations::{
-    CONTRACT_NAME_REGEX_STRING, METADATA_KEY_REGEX_STRING, STANDARD_PRINCIPAL_REGEX_STRING,
-};
+use clarity::vm::representations::{CONTRACT_NAME_REGEX_STRING, STANDARD_PRINCIPAL_REGEX_STRING};
 use clarity::vm::types::QualifiedContractIdentifier;
 use clarity::vm::ContractName;
+use lazy_static::lazy_static;
 use regex::{Captures, Regex};
 use stacks_common::types::chainstate::StacksAddress;
 use stacks_common::types::net::PeerHost;
@@ -34,6 +33,15 @@ use crate::net::httpcore::{
 };
 use crate::net::{Error as NetError, StacksNodeState, TipRequest};
 
+lazy_static! {
+    static ref CLARITY_NAME_NO_BOUNDARIES_REGEX_STRING: String =
+        "[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*])*|[-+=/*]|[<>]=?".into();
+    static ref METADATA_KEY_REGEX_STRING: String = format!(
+        r"vm-metadata::\d+::(contract|contract-size|contract-src|contract-data-size|({}))",
+        *CLARITY_NAME_NO_BOUNDARIES_REGEX_STRING,
+    );
+}
+
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 pub struct ClarityMetadataResponse {
     pub data: String,
@@ -61,7 +69,7 @@ impl HttpRequest for RPCGetClarityMetadataRequestHandler {
 
     fn path_regex(&self) -> Regex {
         Regex::new(&format!(
-            r"^/v2/clarity_metadata/(?P<address>{})/(?P<contract>{})/(?P<clarity_metadata_key>(analysis)|({}))$",
+            r"^/v2/clarity/metadata/(?P<address>{})/(?P<contract>{})/(?P<clarity_metadata_key>(analysis)|({}))$",
             *STANDARD_PRINCIPAL_REGEX_STRING,
             *CONTRACT_NAME_REGEX_STRING,
             *METADATA_KEY_REGEX_STRING
@@ -70,7 +78,7 @@ impl HttpRequest for RPCGetClarityMetadataRequestHandler {
     }
 
     fn metrics_identifier(&self) -> &str {
-        "/v2/clarity_metadata/:principal/:contract_name/:clarity_metadata_key"
+        "/v2/clarity/metadata/:principal/:contract_name/:clarity_metadata_key"
     }
 
     /// Try to decode this request.
@@ -89,7 +97,15 @@ impl HttpRequest for RPCGetClarityMetadataRequestHandler {
         }
 
         let contract_identifier = request::get_contract_address(captures, "address", "contract")?;
-        let metadata_key = request::get_clarity_key(captures, "clarity_metadata_key")?;
+
+        let metadata_key = if let Some(key_str) = captures.name("clarity_metadata_key") {
+            key_str.as_str().to_string()
+        } else {
+            return Err(Error::Http(
+                404,
+                "Missing `clarity_metadata_key`".to_string(),
+            ));
+        };
 
         self.contract_identifier = Some(contract_identifier);
         self.clarity_metadata_key = Some(metadata_key);
@@ -197,7 +213,7 @@ impl StacksHttpRequest {
             host,
             "GET".into(),
             format!(
-                "/v2/clarity_metadata/{}/{}/{}",
+                "/v2/clarity/metadata/{}/{}/{}",
                 &contract_addr, &contract_name, &clarity_metadata_key
             ),
             HttpRequestContents::new().for_tip(tip_req),

stackslib/src/net/api/mod.rs

@@ -92,9 +92,7 @@ impl StacksHttp {
         self.register_rpc_endpoint(getattachmentsinv::RPCGetAttachmentsInvRequestHandler::new());
         self.register_rpc_endpoint(getblock::RPCBlocksRequestHandler::new());
         self.register_rpc_endpoint(getblock_v3::RPCNakamotoBlockRequestHandler::new());
-        self.register_rpc_endpoint(
-            getclaritymarfvalue::RPCGetClarityMarfValueRequestHandler::new(),
-        );
+        self.register_rpc_endpoint(getclaritymarfvalue::RPCGetClarityMarfRequestHandler::new());
         self.register_rpc_endpoint(getclaritymetadata::RPCGetClarityMetadataRequestHandler::new());
         self.register_rpc_endpoint(getconstantval::RPCGetConstantValRequestHandler::new());
         self.register_rpc_endpoint(getcontractabi::RPCGetContractAbiRequestHandler::new());

stackslib/src/net/api/tests/getclaritymarfvalue.rs

@@ -43,7 +43,7 @@ fn test_try_parse_request() {
     let valid_keys = [vm_key_epoch, vm_key_trip, vm_key_quad];
 
     for key in valid_keys {
-        let request = StacksHttpRequest::new_getclaritymarfvalue(
+        let request = StacksHttpRequest::new_getclaritymarf(
             addr.into(),
             key.to_string(),
             TipRequest::SpecificTip(StacksBlockId([0x22; 32])),
@@ -58,7 +58,7 @@ fn test_try_parse_request() {
         let bytes = request.try_serialize().unwrap();
 
         let (parsed_preamble, offset) = http.read_preamble(&bytes).unwrap();
-        let mut handler = getclaritymarfvalue::RPCGetClarityMarfValueRequestHandler::new();
+        let mut handler = getclaritymarfvalue::RPCGetClarityMarfRequestHandler::new();
         let mut parsed_request = http
             .handle_try_parse_request(
                 &mut handler,
@@ -88,7 +88,7 @@ fn test_try_make_response() {
     let mut requests = vec![];
 
     // query existing
-    let request = StacksHttpRequest::new_getclaritymarfvalue(
+    let request = StacksHttpRequest::new_getclaritymarf(
         addr.into(),
         "vm::ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R.hello-world::1::bar".to_string(),
         TipRequest::UseLatestAnchoredTip,
@@ -97,7 +97,7 @@ fn test_try_make_response() {
     requests.push(request);
 
     // query existing unconfirmed
-    let request = StacksHttpRequest::new_getclaritymarfvalue(
+    let request = StacksHttpRequest::new_getclaritymarf(
         addr.into(),
         "vm::ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R.hello-world-unconfirmed::1::bar-unconfirmed"
             .to_string(),
@@ -107,7 +107,7 @@ fn test_try_make_response() {
     requests.push(request);
 
     // query non-existant var
-    let request = StacksHttpRequest::new_getclaritymarfvalue(
+    let request = StacksHttpRequest::new_getclaritymarf(
         addr.into(),
         "vm::ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R.hello-world::1::does-not-exist".to_string(),
         TipRequest::UseLatestAnchoredTip,
@@ -116,7 +116,7 @@ fn test_try_make_response() {
     requests.push(request);
 
     // query non-existant contract
-    let request = StacksHttpRequest::new_getclaritymarfvalue(
+    let request = StacksHttpRequest::new_getclaritymarf(
         addr.into(),
         "vm::ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R.does-not-exist::1::bar".to_string(),
         TipRequest::UseLatestAnchoredTip,

stackslib/src/net/httpcore.rs

@@ -247,17 +247,6 @@ pub mod request {
         Ok(txid)
     }
 
-    /// Get a clarity key (MARF or Metadata) from a path's captures, given the name of the regex field.
-    pub fn get_clarity_key(captures: &Captures, clarity_key: &str) -> Result<String, HttpError> {
-        let key = if let Some(key_str) = captures.name(clarity_key) {
-            key_str.as_str().to_string()
-        } else {
-            return Err(HttpError::Http(404, format!("Missing `{}`", clarity_key)));
-        };
-
-        Ok(key)
-    }
-
     /// Get and parse a Clarity name from a path's captures, given the name of the regex field.
     pub fn get_clarity_name(captures: &Captures, key: &str) -> Result<ClarityName, HttpError> {
         let clarity_name = if let Some(name_str) = captures.name(key) {