Update comment for with_use_call_v3_endpoint

dfinity · Jul 23, 2024 · a6bbae1 · a6bbae1
1 parent 23f1430
commit a6bbae1
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/ic-agent/src/agent/http_transport/hyper_transport.rs b/ic-agent/src/agent/http_transport/hyper_transport.rs
@@ -146,7 +146,13 @@ where
         }
     }
 
-    /// Use call v3 endpoint for update calls.
+    /// Use call v3 endpoint for synchronous update calls.
+    /// __This is an experimental feature, and should not be used in production,
+    /// as the endpoint is not available yet on the mainnet IC.__
+    ///
+    /// By enabling this feature, the agent will use the `v3` endpoint for update calls,
+    /// which is synchronous. This means the replica will wait for a certificate for the call,
+    /// meaning the agent will not need to poll for the certificate.
     #[cfg(feature = "experimental_sync_call")]
     pub fn with_use_call_v3_endpoint(self) -> Self {
         Self {

diff --git a/ic-agent/src/agent/http_transport/reqwest_transport.rs b/ic-agent/src/agent/http_transport/reqwest_transport.rs
@@ -89,7 +89,13 @@ impl ReqwestTransport {
         }
     }
 
-    /// Use call v3 endpoint for update calls.
+    /// Use call v3 endpoint for synchronous update calls.
+    /// __This is an experimental feature, and should not be used in production,
+    /// as the endpoint is not available yet on the mainnet IC.__
+    ///
+    /// By enabling this feature, the agent will use the `v3` endpoint for update calls,
+    /// which is synchronous. This means the replica will wait for a certificate for the call,
+    /// meaning the agent will not need to poll for the certificate.
     #[cfg(feature = "experimental_sync_call")]
     pub fn with_use_call_v3_endpoint(self) -> Self {
         ReqwestTransport {