updated openapi.yaml

Author: rdeioris

docs/rpc/openapi.yaml

@@ -229,12 +229,6 @@ paths:
           description: The Stacks chain tip to query from. If tip == latest, the query will be run from the latest
             known tip (includes unconfirmed state).
           required: false
-        - name: cost_tracker
-          in: query
-          schema:
-            type: string
-          description: the cost tracker to apply ("limited" or "free").
-          required: false
       requestBody:
         description: map of arguments and the simulated tx-sender where sender is either a Contract identifier or a normal Stacks address, and arguments is an array of hex serialized Clarity values.
         required: true
@@ -934,3 +928,64 @@ paths:
                 $ref: ./api/core-node/get-health-error.schema.json
               example:
                 $ref: ./api/core-node/get-health-error.example.json
+
+  /v2/contracts/fast-call-read/{contract_address}/{contract_name}/{function_name}:
+    post:
+      summary: Call read-only function in fast mode (no cost tracking)
+      tags:
+        - Smart Contracts
+      operationId: fast_call_read_only_function
+      description: |
+        Call a read-only public function on a given smart contract without cost tracking.
+
+        The smart contract and function are specified using the URL path. The arguments and the simulated tx-sender are supplied via the POST body in the following JSON format:
+      responses:
+        "200":
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: ./api/contract/post-call-read-only-fn.schema.json
+              examples:
+                success:
+                  $ref: ./api/contract/post-call-read-only-fn-success.example.json
+                fail:
+                  $ref: ./api/contract/post-call-read-only-fn-fail.example.json
+      parameters:
+        - name: contract_address
+          in: path
+          required: true
+          description: Stacks address
+          schema:
+            type: string
+        - name: contract_name
+          in: path
+          required: true
+          description: Contract name
+          schema:
+            type: string
+        - name: function_name
+          in: path
+          required: true
+          description: Function name
+          schema:
+            type: string
+        - name: tip
+          in: query
+          schema:
+            type: string
+          description: The Stacks chain tip to query from. If tip == latest, the query will be run from the latest
+            known tip (includes unconfirmed state).
+          required: false
+      requestBody:
+        description: map of arguments and the simulated tx-sender where sender is either a Contract identifier or a normal Stacks address, and arguments is an array of hex serialized Clarity values.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: './entities/contracts/read-only-function-args.schema.json'
+              example:
+                sender: 'SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info'
+                arguments:
+                  - '0x0011...'
+                  - '0x00231...'

stackslib/src/net/api/fastcallreadonly.rs

@@ -47,10 +47,15 @@ use crate::net::{Error as NetError, StacksNodeState, TipRequest};
 pub struct RPCFastCallReadOnlyRequestHandler {
     pub call_read_only_handler: RPCCallReadOnlyRequestHandler,
     read_only_max_execution_time: Duration,
+    pub auth: Option<String>,
 }
 
 impl RPCFastCallReadOnlyRequestHandler {
-    pub fn new(maximum_call_argument_size: u32, read_only_max_execution_time: Duration) -> Self {
+    pub fn new(
+        maximum_call_argument_size: u32,
+        read_only_max_execution_time: Duration,
+        auth: Option<String>,
+    ) -> Self {
         Self {
             call_read_only_handler: RPCCallReadOnlyRequestHandler::new(
                 maximum_call_argument_size,
@@ -63,6 +68,7 @@ impl RPCFastCallReadOnlyRequestHandler {
                 },
             ),
             read_only_max_execution_time,
+            auth,
         }
     }
 }
@@ -93,6 +99,17 @@ impl HttpRequest for RPCFastCallReadOnlyRequestHandler {
         query: Option<&str>,
         body: &[u8],
     ) -> Result<HttpRequestContents, Error> {
+        // If no authorization is set, then the block proposal endpoint is not enabled
+        let Some(password) = &self.auth else {
+            return Err(Error::Http(400, "Bad Request.".into()));
+        };
+        let Some(auth_header) = preamble.headers.get("authorization") else {
+            return Err(Error::Http(401, "Unauthorized".into()));
+        };
+        if auth_header != password {
+            return Err(Error::Http(401, "Unauthorized".into()));
+        }
+
         let content_len = preamble.get_content_length();
         if !(content_len > 0
             && content_len < self.call_read_only_handler.maximum_call_argument_size)
@@ -337,14 +354,4 @@ impl StacksHttpRequest {
         )
         .expect("FATAL: failed to construct request from infallible data")
     }
-}
-
-impl StacksHttpResponse {
-    pub fn decode_fast_call_readonly_response(self) -> Result<CallReadOnlyResponse, NetError> {
-        let contents = self.get_http_payload_ok()?;
-        let contents_json: serde_json::Value = contents.try_into()?;
-        let resp: CallReadOnlyResponse = serde_json::from_value(contents_json)
-            .map_err(|_e| NetError::DeserializeError("Failed to load from JSON".to_string()))?;
-        Ok(resp)
-    }
-}
+}

stackslib/src/net/api/mod.rs

@@ -78,6 +78,7 @@ impl StacksHttp {
         self.register_rpc_endpoint(fastcallreadonly::RPCFastCallReadOnlyRequestHandler::new(
             self.maximum_call_argument_size,
             self.read_only_max_execution_time,
+            self.auth_token.clone(),
         ));
         self.register_rpc_endpoint(getaccount::RPCGetAccountRequestHandler::new());
         self.register_rpc_endpoint(getattachment::RPCGetAttachmentRequestHandler::new());

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

@@ -36,7 +36,7 @@ fn test_try_parse_request() {
     let addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 33333);
     let mut http = StacksHttp::new(addr.clone(), &ConnectionOptions::default());
 
-    let request = StacksHttpRequest::new_fastcallreadonlyfunction(
+    let mut request = StacksHttpRequest::new_fastcallreadonlyfunction(
         addr.into(),
         StacksAddress::from_string("ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R").unwrap(),
         "hello-world-unconfirmed".try_into().unwrap(),
@@ -48,6 +48,10 @@ fn test_try_parse_request() {
         vec![],
         TipRequest::SpecificTip(StacksBlockId([0x22; 32])),
     );
+
+    // add the authorization header
+    request.add_header("authorization".into(), "password".into());
+
     assert_eq!(
         request.contents().tip_request(),
         TipRequest::SpecificTip(StacksBlockId([0x22; 32]))
@@ -58,8 +62,11 @@ fn test_try_parse_request() {
     debug!("Request:\n{}\n", std::str::from_utf8(&bytes).unwrap());
 
     let (parsed_preamble, offset) = http.read_preamble(&bytes).unwrap();
-    let mut handler =
-        fastcallreadonly::RPCFastCallReadOnlyRequestHandler::new(4096, Duration::from_secs(30));
+    let mut handler = fastcallreadonly::RPCFastCallReadOnlyRequestHandler::new(
+        4096,
+        Duration::from_secs(30),
+        Some("password".into()),
+    );
     let mut parsed_request = http
         .handle_try_parse_request(
             &mut handler,
@@ -89,8 +96,9 @@ fn test_try_parse_request() {
     assert_eq!(handler.call_read_only_handler.sponsor, None);
     assert_eq!(handler.call_read_only_handler.arguments, Some(vec![]));
 
-    // parsed request consumes headers that would not be in a constructed reqeuest
+    // parsed request consumes headers that would not be in a constructed request
     parsed_request.clear_headers();
+    parsed_request.add_header("authorization".into(), "password".into());
     let (preamble, contents) = parsed_request.destruct();
 
     assert_eq!(&preamble, request.preamble());
@@ -111,7 +119,7 @@ fn test_try_make_response() {
     let mut requests = vec![];
 
     // query confirmed tip
-    let request = StacksHttpRequest::new_fastcallreadonlyfunction(
+    let mut request = StacksHttpRequest::new_fastcallreadonlyfunction(
         addr.into(),
         StacksAddress::from_string("ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R").unwrap(),
         "hello-world".try_into().unwrap(),
@@ -123,10 +131,12 @@ fn test_try_make_response() {
         vec![],
         TipRequest::UseLatestAnchoredTip,
     );
+    request.add_header("authorization".into(), "password".into());
+
     requests.push(request);
 
     // query unconfirmed tip
-    let request = StacksHttpRequest::new_fastcallreadonlyfunction(
+    let mut request = StacksHttpRequest::new_fastcallreadonlyfunction(
         addr.into(),
         StacksAddress::from_string("ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R").unwrap(),
         "hello-world-unconfirmed".try_into().unwrap(),
@@ -138,10 +148,12 @@ fn test_try_make_response() {
         vec![],
         TipRequest::UseLatestUnconfirmedTip,
     );
+    request.add_header("authorization".into(), "password".into());
+
     requests.push(request);
 
     // query non-existent function
-    let request = StacksHttpRequest::new_fastcallreadonlyfunction(
+    let mut request = StacksHttpRequest::new_fastcallreadonlyfunction(
         addr.into(),
         StacksAddress::from_string("ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R").unwrap(),
         "hello-world-unconfirmed".try_into().unwrap(),
@@ -153,10 +165,12 @@ fn test_try_make_response() {
         vec![],
         TipRequest::UseLatestUnconfirmedTip,
     );
+    request.add_header("authorization".into(), "password".into());
+
     requests.push(request);
 
     // query non-existent contract
-    let request = StacksHttpRequest::new_fastcallreadonlyfunction(
+    let mut request = StacksHttpRequest::new_fastcallreadonlyfunction(
         addr.into(),
         StacksAddress::from_string("ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R").unwrap(),
         "does-not-exist".try_into().unwrap(),
@@ -168,10 +182,12 @@ fn test_try_make_response() {
         vec![],
         TipRequest::UseLatestUnconfirmedTip,
     );
+    request.add_header("authorization".into(), "password".into());
+
     requests.push(request);
 
     // query non-existent tip
-    let request = StacksHttpRequest::new_fastcallreadonlyfunction(
+    let mut request = StacksHttpRequest::new_fastcallreadonlyfunction(
         addr.into(),
         StacksAddress::from_string("ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R").unwrap(),
         "hello-world".try_into().unwrap(),
@@ -183,6 +199,8 @@ fn test_try_make_response() {
         vec![],
         TipRequest::SpecificTip(StacksBlockId([0x11; 32])),
     );
+    request.add_header("authorization".into(), "password".into());
+
     requests.push(request);
 
     let mut responses = test_rpc(function_name!(), requests);
@@ -280,7 +298,7 @@ fn test_try_make_response_free_cost_tracker() {
     let mut requests = vec![];
 
     // query confirmed tip
-    let request = StacksHttpRequest::new_fastcallreadonlyfunction(
+    let mut request = StacksHttpRequest::new_fastcallreadonlyfunction(
         addr.into(),
         StacksAddress::from_string("ST2DS4MSWSGJ3W9FBC6BVT0Y92S345HY8N3T6AV7R").unwrap(),
         "hello-world".try_into().unwrap(),
@@ -292,6 +310,8 @@ fn test_try_make_response_free_cost_tracker() {
         vec![],
         TipRequest::UseLatestAnchoredTip,
     );
+    request.add_header("authorization".into(), "password".into());
+
     requests.push(request);
 
     let mut responses = test_rpc_with_config(