chore: comments and description

ovidiuolteanu · Jan 14, 2025 · c5799d5 · c5799d5
1 parent f03adc2
commit c5799d5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,6 @@
-# mx-sc-dummy-proxy
+# mx-sc-dummy-proxy
+
+## Description
+
+This is a simple dummy proxy contract that can call another contract.
+Very useful, much wow.
diff --git a/dummy-proxy/src/dummy_proxy.rs b/dummy-proxy/src/dummy_proxy.rs
@@ -2,6 +2,7 @@ multiversx_sc::imports!();
 
 #[multiversx_sc::module]
 pub trait DummyProxyModule {
+    /// Simply calls the specified endpoint on given contract address
     #[endpoint(callEndpoint)]
     fn call_endpoint(
         &self,
@@ -18,6 +19,7 @@ pub trait DummyProxyModule {
             .sync_call()
     }
 
+    /// Calls the specified endpoint on given contract address while it also transfers user given tokens with the call
     #[endpoint(callInternalTransferEndpoint)]
     fn call_int_transfer_endpoint(
         &self,
@@ -36,6 +38,7 @@ pub trait DummyProxyModule {
             .sync_call()
     }
 
+    /// Calls the specified endpoint on given contract address while it also transfers specified tokens owned by the dummy proxy with the call
     #[payable("*")]
     #[endpoint(callTransferEndpoint)]
     fn call_transfer_endpoint(