ERC-20 token transfer example and improvements to NFT (#209)

examples/hello/package.json

@@ -59,4 +59,4 @@
     "@solana/web3.js": "^1.95.2",
     "@zetachain/protocol-contracts": "10.0.0-rc11"
   }
-}
+}

examples/hello/yarn.lock

@@ -2434,6 +2434,16 @@
     "@zetachain/networks" "^10.0.0"
     ethers "^6.13.1"
 
+"@zetachain/[email protected]":
+  version "10.0.0-rc11"
+  resolved "https://registry.yarnpkg.com/@zetachain/protocol-contracts/-/protocol-contracts-10.0.0-rc11.tgz#53f55ead492f7b5802b1feae4e51abc75730af33"
+  integrity sha512-qWazjqnIGRngf4OmyeSIv7sHICQRdMQ1CKPIQIqxA8qFR+gHhDHSfvMdRAvgWbsfkimXOIFiHVIATypyWhviJw==
+  dependencies:
+    "@openzeppelin/contracts" "^5.0.2"
+    "@openzeppelin/contracts-upgradeable" "^5.0.2"
+    "@zetachain/networks" "^10.0.0"
+    ethers "^6.13.1"
+
 "@zetachain/[email protected]":
   version "9.0.0"
   resolved "https://registry.yarnpkg.com/@zetachain/protocol-contracts/-/protocol-contracts-9.0.0.tgz#c20ad5da43f6f3676f31556b303d1cb4ea17357e"

examples/nft/contracts/Connected.sol

@@ -65,7 +65,7 @@ contract Connected is
 
         string memory uri = tokenURI(tokenId);
         _burn(tokenId);
-        bytes memory message = abi.encode(tokenId, receiver, uri, destination);
+        bytes memory message = abi.encode(destination, receiver, tokenId, uri);
 
         RevertOptions memory revertOptions = RevertOptions(
             address(this),
@@ -85,7 +85,7 @@ contract Connected is
             );
         }
 
-        emit TokenTransfer(tokenId, receiver, destination, uri);
+        emit TokenTransfer(destination, receiver, tokenId, uri);
     }
 
     function onCall(
@@ -94,26 +94,26 @@ contract Connected is
     ) external payable onlyGateway returns (bytes4) {
         if (context.sender != counterparty) revert Unauthorized();
 
-        (uint256 tokenId, address receiver, string memory uri) = abi.decode(
+        (address receiver, uint256 tokenId, string memory uri) = abi.decode(
             message,
-            (uint256, address, string)
+            (address, uint256, string)
         );
 
         _safeMint(receiver, tokenId);
         _setTokenURI(tokenId, uri);
-        emit TokenTransferReceived(tokenId, receiver, uri);
+        emit TokenTransferReceived(receiver, tokenId, uri);
         return "";
     }
 
     function onRevert(RevertContext calldata context) external onlyGateway {
-        (uint256 tokenId, address sender, string memory uri) = abi.decode(
+        (address sender, uint256 tokenId, string memory uri) = abi.decode(
             context.revertMessage,
-            (uint256, address, string)
+            (address, uint256, string)
         );
 
         _safeMint(sender, tokenId);
         _setTokenURI(tokenId, uri);
-        emit TokenTransferReverted(tokenId, sender, uri);
+        emit TokenTransferReverted(sender, tokenId, uri);
     }
 
     receive() external payable {}

examples/nft/contracts/Universal.sol

@@ -79,7 +79,7 @@ contract Universal is
             !IZRC20(destination).transferFrom(msg.sender, address(this), gasFee)
         ) revert TransferFailed();
         IZRC20(destination).approve(address(gateway), gasFee);
-        bytes memory message = abi.encode(tokenId, receiver, uri);
+        bytes memory message = abi.encode(receiver, tokenId, uri);
 
         CallOptions memory callOptions = CallOptions(gasLimit, false);
 
@@ -99,7 +99,7 @@ contract Universal is
             revertOptions
         );
 
-        emit TokenTransfer(tokenId, receiver, destination, uri);
+        emit TokenTransfer(receiver, destination, tokenId, uri);
     }
 
     function safeMint(address to, string memory uri) public onlyOwner {
@@ -125,16 +125,16 @@ contract Universal is
             revert("Unauthorized");
 
         (
-            uint256 tokenId,
+            address destination,
             address sender,
-            string memory uri,
-            address destination
-        ) = abi.decode(message, (uint256, address, string, address));
+            uint256 tokenId,
+            string memory uri
+        ) = abi.decode(message, (address, address, uint256, string));
 
         if (destination == address(0)) {
             _safeMint(sender, tokenId);
             _setTokenURI(tokenId, uri);
-            emit TokenTransferReceived(tokenId, sender, uri);
+            emit TokenTransferReceived(sender, tokenId, uri);
         } else {
             (, uint256 gasFee) = IZRC20(destination).withdrawGasFeeWithGasLimit(
                 gasLimit
@@ -152,23 +152,23 @@ contract Universal is
             gateway.call(
                 counterparty[destination],
                 destination,
-                abi.encode(tokenId, sender, uri),
+                abi.encode(sender, tokenId, uri),
                 CallOptions(gasLimit, false),
                 RevertOptions(address(0), false, address(0), "", 0)
             );
-            emit TokenTransferToDestination(tokenId, sender, destination, uri);
+            emit TokenTransferToDestination(sender, destination, tokenId, uri);
         }
     }
 
     function onRevert(RevertContext calldata context) external onlyGateway {
-        (uint256 tokenId, address sender, string memory uri) = abi.decode(
+        (address sender, uint256 tokenId, string memory uri) = abi.decode(
             context.revertMessage,
-            (uint256, address, string)
+            (address, uint256, string)
         );
 
         _safeMint(sender, tokenId);
         _setTokenURI(tokenId, uri);
-        emit TokenTransferReverted(tokenId, sender, uri);
+        emit TokenTransferReverted(sender, tokenId, uri);
     }
 
     // The following functions are overrides required by Solidity.

examples/nft/contracts/shared/Events.sol

@@ -5,26 +5,26 @@ contract Events {
     event SetCounterparty(address indexed newCounterparty);
     event TokenMinted(address indexed to, uint256 indexed tokenId, string uri);
     event TokenTransfer(
-        uint256 indexed tokenId,
-        address indexed receiver,
         address indexed destination,
+        address indexed receiver,
+        uint256 indexed tokenId,
         string uri
     );
     event TokenTransferReceived(
-        uint256 indexed tokenId,
         address indexed receiver,
+        uint256 indexed tokenId,
         string uri
     );
     event TokenTransferReverted(
-        uint256 indexed tokenId,
         address indexed sender,
+        uint256 indexed tokenId,
         string uri
     );
     event CounterpartySet(address indexed zrc20, bytes indexed contractAddress);
     event TokenTransferToDestination(
-        uint256 indexed tokenId,
-        address indexed sender,
         address indexed destination,
+        address indexed sender,
+        uint256 indexed tokenId,
         string uri
     );
 }

examples/swap/yarn.lock

@@ -2172,6 +2172,16 @@
     "@zetachain/networks" "^10.0.0"
     ethers "^6.13.1"
 
+"@zetachain/[email protected]":
+  version "10.0.0-rc11"
+  resolved "https://registry.yarnpkg.com/@zetachain/protocol-contracts/-/protocol-contracts-10.0.0-rc11.tgz#53f55ead492f7b5802b1feae4e51abc75730af33"
+  integrity sha512-qWazjqnIGRngf4OmyeSIv7sHICQRdMQ1CKPIQIqxA8qFR+gHhDHSfvMdRAvgWbsfkimXOIFiHVIATypyWhviJw==
+  dependencies:
+    "@openzeppelin/contracts" "^5.0.2"
+    "@openzeppelin/contracts-upgradeable" "^5.0.2"
+    "@zetachain/networks" "^10.0.0"
+    ethers "^6.13.1"
+
 "@zetachain/[email protected]":
   version "9.0.0"
   resolved "https://registry.yarnpkg.com/@zetachain/protocol-contracts/-/protocol-contracts-9.0.0.tgz#c20ad5da43f6f3676f31556b303d1cb4ea17357e"

examples/token/.eslintignore

@@ -0,0 +1,6 @@
+.yarn
+artifacts
+cache
+coverage
+node_modules
+typechain-types

examples/token/.eslintrc.js

@@ -0,0 +1,47 @@
+const path = require("path");
+
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true,
+  },
+  extends: ["plugin:prettier/recommended"],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  plugins: [
+    "@typescript-eslint",
+    "prettier",
+    "simple-import-sort",
+    "sort-keys-fix",
+    "typescript-sort-keys",
+  ],
+  rules: {
+    "@typescript-eslint/sort-type-union-intersection-members": "error",
+    camelcase: "off",
+    "simple-import-sort/exports": "error",
+    "simple-import-sort/imports": "error",
+    "sort-keys-fix/sort-keys-fix": "error",
+    "typescript-sort-keys/interface": "error",
+    "typescript-sort-keys/string-enum": "error",
+  },
+  settings: {
+    "import/parsers": {
+      "@typescript-eslint/parser": [".js", ".jsx", ".ts", ".tsx", ".d.ts"],
+    },
+    "import/resolver": {
+      node: {
+        extensions: [".js", ".jsx", ".ts", ".tsx", ".d.ts"],
+      },
+      typescript: {
+        project: path.join(__dirname, "tsconfig.json"),
+      },
+    },
+  },
+};

examples/token/.gitignore

@@ -0,0 +1,17 @@
+node_modules
+.env
+coverage
+coverage.json
+typechain
+typechain-types
+dependencies
+
+# Hardhat files
+cache
+artifacts
+
+# Foundry files
+out
+cache_forge
+
+access_token

examples/token/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ZetaChain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

examples/token/README.md

@@ -0,0 +1,4 @@
+# NFT Example
+
+This example currently only works with localnet `v4.0.0-rc*`, which supports
+authenticated calls and multiple EVM chains.

examples/token/contracts/Connected.sol

@@ -0,0 +1,89 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.26;
+
+import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+import "@openzeppelin/contracts/access/Ownable2Step.sol";
+import "@zetachain/protocol-contracts/contracts/evm/GatewayEVM.sol";
+import {RevertContext} from "@zetachain/protocol-contracts/contracts/Revert.sol";
+import "./shared/Events.sol";
+
+contract Connected is ERC20, Ownable2Step, Events {
+    GatewayEVM public immutable gateway;
+    address public counterparty;
+
+    error InvalidAddress();
+    error Unauthorized();
+
+    modifier onlyGateway() {
+        require(msg.sender == address(gateway), "Caller is not the gateway");
+        _;
+    }
+
+    function setCounterparty(address contractAddress) external onlyOwner {
+        counterparty = contractAddress;
+        emit CounterpartySet(contractAddress);
+    }
+
+    constructor(
+        address payable gatewayAddress,
+        address owner,
+        string memory name,
+        string memory symbol
+    ) ERC20(name, symbol) Ownable(owner) {
+        if (gatewayAddress == address(0) || owner == address(0))
+            revert InvalidAddress();
+        gateway = GatewayEVM(gatewayAddress);
+    }
+
+    function mint(address to, uint256 amount) public onlyOwner {
+        _mint(to, amount);
+    }
+
+    function transferCrossChain(
+        address destination,
+        address receiver,
+        uint256 amount
+    ) external payable {
+        _burn(msg.sender, amount);
+        bytes memory message = abi.encode(destination, receiver, amount);
+
+        RevertOptions memory revertOptions = RevertOptions(
+            address(this),
+            true,
+            address(0),
+            message,
+            0
+        );
+
+        if (destination == address(0)) {
+            gateway.call(counterparty, message, revertOptions);
+        } else {
+            gateway.depositAndCall{value: msg.value}(
+                counterparty,
+                message,
+                revertOptions
+            );
+        }
+        emit TokenTransfer(destination, receiver, amount);
+    }
+
+    function onCall(
+        MessageContext calldata context,
+        bytes calldata message
+    ) external payable onlyGateway returns (bytes4) {
+        if (context.sender != counterparty) revert Unauthorized();
+        (address receiver, uint256 amount) = abi.decode(
+            message,
+            (address, uint256)
+        );
+        _mint(receiver, amount);
+        emit TokenTransferReceived(receiver, amount);
+        return "";
+    }
+
+    function onRevert(RevertContext calldata context) external onlyGateway {}
+
+    receive() external payable {}
+
+    fallback() external payable {}
+}