|
| 1 | +// Copyright (C) 2013-2020 Blockstack PBC, a public benefit corporation |
| 2 | +// Copyright (C) 2020-2024 Stacks Open Internet Foundation |
| 3 | +// |
| 4 | +// This program is free software: you can redistribute it and/or modify |
| 5 | +// it under the terms of the GNU General Public License as published by |
| 6 | +// the Free Software Foundation, either version 3 of the License, or |
| 7 | +// (at your option) any later version. |
| 8 | +// |
| 9 | +// This program is distributed in the hope that it will be useful, |
| 10 | +// but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | +// GNU General Public License for more details. |
| 13 | +// |
| 14 | +// You should have received a copy of the GNU General Public License |
| 15 | +// along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 16 | + |
| 17 | +use clarity::vm::clarity::ClarityConnection; |
| 18 | +use clarity::vm::representations::{ |
| 19 | + CONTRACT_NAME_REGEX_STRING, METADATA_KEY_REGEX_STRING, STANDARD_PRINCIPAL_REGEX_STRING, |
| 20 | +}; |
| 21 | +use clarity::vm::types::QualifiedContractIdentifier; |
| 22 | +use clarity::vm::ContractName; |
| 23 | +use regex::{Captures, Regex}; |
| 24 | +use stacks_common::types::chainstate::StacksAddress; |
| 25 | +use stacks_common::types::net::PeerHost; |
| 26 | + |
| 27 | +use crate::net::http::{ |
| 28 | + parse_json, Error, HttpNotFound, HttpRequest, HttpRequestContents, HttpRequestPreamble, |
| 29 | + HttpResponse, HttpResponseContents, HttpResponsePayload, HttpResponsePreamble, |
| 30 | +}; |
| 31 | +use crate::net::httpcore::{ |
| 32 | + request, HttpPreambleExtensions, HttpRequestContentsExtensions, RPCRequestHandler, |
| 33 | + StacksHttpRequest, StacksHttpResponse, |
| 34 | +}; |
| 35 | +use crate::net::{Error as NetError, StacksNodeState, TipRequest}; |
| 36 | + |
| 37 | +#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] |
| 38 | +pub struct ClarityMetadataResponse { |
| 39 | + pub data: String, |
| 40 | +} |
| 41 | + |
| 42 | +#[derive(Clone)] |
| 43 | +pub struct RPCGetClarityMetadataRequestHandler { |
| 44 | + pub clarity_metadata_key: Option<String>, |
| 45 | + pub contract_identifier: Option<QualifiedContractIdentifier>, |
| 46 | +} |
| 47 | +impl RPCGetClarityMetadataRequestHandler { |
| 48 | + pub fn new() -> Self { |
| 49 | + Self { |
| 50 | + clarity_metadata_key: None, |
| 51 | + contract_identifier: None, |
| 52 | + } |
| 53 | + } |
| 54 | +} |
| 55 | + |
| 56 | +/// Decode the HTTP request |
| 57 | +impl HttpRequest for RPCGetClarityMetadataRequestHandler { |
| 58 | + fn verb(&self) -> &'static str { |
| 59 | + "GET" |
| 60 | + } |
| 61 | + |
| 62 | + fn path_regex(&self) -> Regex { |
| 63 | + Regex::new(&format!( |
| 64 | + r"^/v2/clarity_metadata/(?P<address>{})/(?P<contract>{})/(?P<clarity_metadata_key>(analysis)|({}))$", |
| 65 | + *STANDARD_PRINCIPAL_REGEX_STRING, |
| 66 | + *CONTRACT_NAME_REGEX_STRING, |
| 67 | + *METADATA_KEY_REGEX_STRING |
| 68 | + )) |
| 69 | + .unwrap() |
| 70 | + } |
| 71 | + |
| 72 | + fn metrics_identifier(&self) -> &str { |
| 73 | + "/v2/clarity_metadata/:principal/:contract_name/:clarity_metadata_key" |
| 74 | + } |
| 75 | + |
| 76 | + /// Try to decode this request. |
| 77 | + /// There's nothing to load here, so just make sure the request is well-formed. |
| 78 | + fn try_parse_request( |
| 79 | + &mut self, |
| 80 | + preamble: &HttpRequestPreamble, |
| 81 | + captures: &Captures, |
| 82 | + query: Option<&str>, |
| 83 | + _body: &[u8], |
| 84 | + ) -> Result<HttpRequestContents, Error> { |
| 85 | + if preamble.get_content_length() != 0 { |
| 86 | + return Err(Error::DecodeError( |
| 87 | + "Invalid Http request: expected 0-length body".to_string(), |
| 88 | + )); |
| 89 | + } |
| 90 | + |
| 91 | + let contract_identifier = request::get_contract_address(captures, "address", "contract")?; |
| 92 | + let metadata_key = request::get_key(captures, "clarity_metadata_key")?; |
| 93 | + |
| 94 | + self.contract_identifier = Some(contract_identifier); |
| 95 | + self.clarity_metadata_key = Some(metadata_key); |
| 96 | + |
| 97 | + let contents = HttpRequestContents::new().query_string(query); |
| 98 | + Ok(contents) |
| 99 | + } |
| 100 | +} |
| 101 | + |
| 102 | +/// Handle the HTTP request |
| 103 | +impl RPCRequestHandler for RPCGetClarityMetadataRequestHandler { |
| 104 | + /// Reset internal state |
| 105 | + fn restart(&mut self) { |
| 106 | + self.contract_identifier = None; |
| 107 | + self.clarity_metadata_key = None; |
| 108 | + } |
| 109 | + |
| 110 | + /// Make the response |
| 111 | + fn try_handle_request( |
| 112 | + &mut self, |
| 113 | + preamble: HttpRequestPreamble, |
| 114 | + contents: HttpRequestContents, |
| 115 | + node: &mut StacksNodeState, |
| 116 | + ) -> Result<(HttpResponsePreamble, HttpResponseContents), NetError> { |
| 117 | + let contract_identifier = self.contract_identifier.take().ok_or(NetError::SendError( |
| 118 | + "`contract_identifier` not set".to_string(), |
| 119 | + ))?; |
| 120 | + let clarity_metadata_key = self.clarity_metadata_key.take().ok_or(NetError::SendError( |
| 121 | + "`clarity_metadata_key` not set".to_string(), |
| 122 | + ))?; |
| 123 | + |
| 124 | + let tip = match node.load_stacks_chain_tip(&preamble, &contents) { |
| 125 | + Ok(tip) => tip, |
| 126 | + Err(error_resp) => { |
| 127 | + return error_resp.try_into_contents().map_err(NetError::from); |
| 128 | + } |
| 129 | + }; |
| 130 | + |
| 131 | + let data_opt = node.with_node_state(|_network, sortdb, chainstate, _mempool, _rpc_args| { |
| 132 | + chainstate.maybe_read_only_clarity_tx( |
| 133 | + &sortdb.index_handle_at_block(chainstate, &tip)?, |
| 134 | + &tip, |
| 135 | + |clarity_tx| { |
| 136 | + clarity_tx.with_clarity_db_readonly(|clarity_db| { |
| 137 | + let data = clarity_db |
| 138 | + .store |
| 139 | + .get_metadata(&contract_identifier, &clarity_metadata_key) |
| 140 | + .ok() |
| 141 | + .flatten()?; |
| 142 | + |
| 143 | + Some(ClarityMetadataResponse { data }) |
| 144 | + }) |
| 145 | + }, |
| 146 | + ) |
| 147 | + }); |
| 148 | + |
| 149 | + let data_resp = match data_opt { |
| 150 | + Ok(Some(Some(data))) => data, |
| 151 | + Ok(Some(None)) => { |
| 152 | + return StacksHttpResponse::new_error( |
| 153 | + &preamble, |
| 154 | + &HttpNotFound::new("Metadata not found".to_string()), |
| 155 | + ) |
| 156 | + .try_into_contents() |
| 157 | + .map_err(NetError::from); |
| 158 | + } |
| 159 | + Ok(None) | Err(_) => { |
| 160 | + return StacksHttpResponse::new_error( |
| 161 | + &preamble, |
| 162 | + &HttpNotFound::new("Chain tip not found".to_string()), |
| 163 | + ) |
| 164 | + .try_into_contents() |
| 165 | + .map_err(NetError::from); |
| 166 | + } |
| 167 | + }; |
| 168 | + |
| 169 | + let mut preamble = HttpResponsePreamble::ok_json(&preamble); |
| 170 | + preamble.set_canonical_stacks_tip_height(Some(node.canonical_stacks_tip_height())); |
| 171 | + let body = HttpResponseContents::try_from_json(&data_resp)?; |
| 172 | + Ok((preamble, body)) |
| 173 | + } |
| 174 | +} |
| 175 | + |
| 176 | +/// Decode the HTTP response |
| 177 | +impl HttpResponse for RPCGetClarityMetadataRequestHandler { |
| 178 | + fn try_parse_response( |
| 179 | + &self, |
| 180 | + preamble: &HttpResponsePreamble, |
| 181 | + body: &[u8], |
| 182 | + ) -> Result<HttpResponsePayload, Error> { |
| 183 | + let metadata: ClarityMetadataResponse = parse_json(preamble, body)?; |
| 184 | + Ok(HttpResponsePayload::try_from_json(metadata)?) |
| 185 | + } |
| 186 | +} |
| 187 | + |
| 188 | +impl StacksHttpRequest { |
| 189 | + pub fn new_getclaritymetadata( |
| 190 | + host: PeerHost, |
| 191 | + contract_addr: StacksAddress, |
| 192 | + contract_name: ContractName, |
| 193 | + clarity_metadata_key: String, |
| 194 | + tip_req: TipRequest, |
| 195 | + ) -> StacksHttpRequest { |
| 196 | + StacksHttpRequest::new_for_peer( |
| 197 | + host, |
| 198 | + "GET".into(), |
| 199 | + format!( |
| 200 | + "/v2/clarity_metadata/{}/{}/{}", |
| 201 | + &contract_addr, &contract_name, &clarity_metadata_key |
| 202 | + ), |
| 203 | + HttpRequestContents::new().for_tip(tip_req), |
| 204 | + ) |
| 205 | + .expect("FATAL: failed to construct request from infallible data") |
| 206 | + } |
| 207 | +} |
| 208 | + |
| 209 | +impl StacksHttpResponse { |
| 210 | + pub fn decode_clarity_metadata_response(self) -> Result<ClarityMetadataResponse, NetError> { |
| 211 | + let contents = self.get_http_payload_ok()?; |
| 212 | + let contents_json: serde_json::Value = contents.try_into()?; |
| 213 | + let resp: ClarityMetadataResponse = serde_json::from_value(contents_json) |
| 214 | + .map_err(|_e| NetError::DeserializeError("Failed to load from JSON".to_string()))?; |
| 215 | + Ok(resp) |
| 216 | + } |
| 217 | +} |
0 commit comments