feat(contracts): rename xfunc to xrecv (#401)

Rename xfunc to xrecv task: none
omni-network · Feb 26, 2024 · 089244e · 089244e
1 parent 7a73449
commit 089244e
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/contracts/package.json b/contracts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@omni-network/contracts",
-  "version": "0.2.0-alpha.1",
+  "version": "0.2.0-alpha.2",
   "license": "GPL-3.0-only",
   "packageManager": "pnpm@8.14.0",
   "repository": "https://github.com/omni-network/omni/contracts",

diff --git a/contracts/src/examples/PingPong.sol b/contracts/src/examples/PingPong.sol
@@ -34,7 +34,7 @@ contract PingPong is XApp {
      * @param times The pingpongs in the loop
      * @param n The number of xcalls left to make
      */
-    function pingpong(uint64 times, uint64 n) external xfunc {
+    function pingpong(uint64 times, uint64 n) external xrecv {
         require(isXCall(), "PingPong: not an omni xcall");
 
         if (n == 0) {

diff --git a/contracts/src/pkg/XApp.sol b/contracts/src/pkg/XApp.sol
@@ -16,7 +16,7 @@ contract XApp {
     XTypes.Msg internal xmsg;
 
     /// @dev Read current xmsg into storage before execution, delete it afterwards
-    modifier xfunc() {
+    modifier xrecv() {
         xmsg = omni.xmsg();
         _;
         delete xmsg;

diff --git a/docs/site/docs/develop/xapp.md b/docs/site/docs/develop/xapp.md
@@ -63,8 +63,8 @@ contract XGreeter is XApp {
     }
 
     /// @dev Greet on this chain
-    ///      The `xfunc` modifier reads the current xmsg into `xmsg` storage
-    function greet(string calldata greeting) external xfunc {
+    ///      The `xrecv` modifier reads the current xmsg into `xmsg` storage
+    function greet(string calldata greeting) external xrecv {
         require(isXCall(), "XGreeter: only xcall");
         emit Greetings(xmsg.sender, xmsg.sourceChainId, greeting);
     }
@@ -103,7 +103,7 @@ function xgreet(uint64 destChainId, address to, string calldata greeting) extern
 
 <br />
 
-### `xmsg`
+### `xrecv`
 
 When receiving an `xcall`, you can read its context via `omni.xmsg()`.
 
@@ -123,21 +123,21 @@ function greet(string calldata greeting) external {
 
 <br />
 
-For convenience, `XApp` defines the `xfunc` modifier. This modifier reads the current xmsg into storage, and deletes after its function's execution.
+For convenience, `XApp` defines the `xrecv` modifier. This modifier reads the current xmsg into storage, and deletes after its function's execution.
 
 ```solidity
-modifier xfunc() {
+modifier xrecv() {
     xmsg = omni.xmsg();
     _;
     delete xmsg;
 }
 ```
 
-It also visually marks a function as the target of an `xcall`. Though, the `xfunc` modifier is not required to receive an `xcall`. Using this modifier, we can simplify our `XGreeter` a bit further.
+It also visually marks a function as the target of an `xcall`. Though, the `xrecv` modifier is not required to receive an `xcall`. Using this modifier, we can simplify our `XGreeter` a bit further.
 
 
 ```solidity
-function greet(string calldata greeting) external xfunc {
+function greet(string calldata greeting) external xrecv {
     emit Greetings(xmsg.sender, xmsg.sourceChainId, greeting);
 }
 ```
@@ -165,7 +165,7 @@ Note that not only does `isXCall` check with the portal that the current transac
 
 
 ```solidity
-function greet(string calldata greeting) external xfunc  {
+function greet(string calldata greeting) external xrecv  {
     require(isXCall(), "XGreeter: only xcall");
     emit Greetings(xmsg.sender, xmsg.sourceChainId, greeting);
 }