Checkin example

examples/checkin/.eslintignore

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

examples/checkin/.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/checkin/.gitignore

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

examples/checkin/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/checkin/README.md

@@ -0,0 +1,3 @@
+# Hello Example
+
+Tutorial: https://www.zetachain.com/docs/developers/tutorials/hello/

examples/checkin/contracts/Connected.sol

@@ -0,0 +1,51 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.26;
+
+import {RevertContext} from "@zetachain/protocol-contracts/contracts/Revert.sol";
+import "@zetachain/protocol-contracts/contracts/evm/GatewayEVM.sol";
+import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import "@openzeppelin/contracts/access/Ownable2Step.sol";
+
+contract Connected is Ownable2Step {
+    GatewayEVM public immutable gateway;
+    address public universal;
+
+    event RevertEvent(string, RevertContext);
+    event HelloEvent(string, string);
+
+    error InvalidAddress();
+    error Unauthorized();
+
+    modifier onlyGateway() {
+        if (msg.sender != address(gateway)) revert Unauthorized();
+        _;
+    }
+
+    constructor(address payable gatewayAddress, address owner) Ownable(owner) {
+        if (gatewayAddress == address(0)) revert InvalidAddress();
+        gateway = GatewayEVM(gatewayAddress);
+    }
+
+    function setUniversal(address contractAddress) external onlyOwner {
+        if (contractAddress == address(0)) revert InvalidAddress();
+        universal = contractAddress;
+    }
+
+    function checkIn() external {
+        gateway.call(
+            universal,
+            abi.encode(msg.sender),
+            RevertOptions(address(0), false, address(0), "", 0)
+        );
+    }
+
+    function onRevert(
+        RevertContext calldata revertContext
+    ) external onlyGateway {
+        emit RevertEvent("Revert on EVM", revertContext);
+    }
+
+    receive() external payable {}
+
+    fallback() external payable {}
+}

examples/checkin/contracts/Universal.sol

@@ -0,0 +1,68 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.26;
+
+import "@zetachain/protocol-contracts/contracts/zevm/GatewayZEVM.sol";
+import "@openzeppelin/contracts/access/Ownable2Step.sol";
+
+contract Universal is UniversalContract, Ownable2Step {
+    GatewayZEVM public immutable gateway;
+
+    mapping(address => address) public connected;
+    mapping(address => mapping(address => uint256)) public checkIns;
+    mapping(address => mapping(address => uint256)) public lastCheckInBlock;
+
+    uint256 public blocksDelay = 20;
+
+    event CheckIn(
+        address indexed user,
+        address indexed chainIdentifier,
+        uint256 count,
+        uint256 blockNumber
+    );
+
+    error Unauthorized();
+    error InvalidAddress();
+    error CheckInTooSoon();
+
+    modifier onlyGateway() {
+        if (msg.sender != address(gateway)) revert Unauthorized();
+        _;
+    }
+
+    constructor(address payable gatewayAddress, address owner) Ownable(owner) {
+        if (gatewayAddress == address(0)) revert InvalidAddress();
+        gateway = GatewayZEVM(gatewayAddress);
+    }
+
+    function setBlocksDelay(uint256 newBlocksDelay) external onlyOwner {
+        blocksDelay = newBlocksDelay;
+    }
+
+    function setConnected(
+        address zrc20,
+        address contractAddress
+    ) external onlyOwner {
+        connected[zrc20] = contractAddress;
+    }
+
+    function onCall(
+        MessageContext calldata context,
+        address zrc20,
+        uint256 amount,
+        bytes calldata message
+    ) external override onlyGateway {
+        if (context.sender != connected[zrc20]) revert Unauthorized();
+
+        address sender = abi.decode(message, (address));
+        uint256 currentBlock = block.number;
+
+        if (currentBlock < lastCheckInBlock[sender][zrc20] + blocksDelay) {
+            revert CheckInTooSoon();
+        }
+
+        checkIns[sender][zrc20] += 1;
+        lastCheckInBlock[sender][zrc20] = currentBlock;
+
+        emit CheckIn(sender, zrc20, checkIns[sender][zrc20], currentBlock);
+    }
+}

examples/checkin/foundry.toml

@@ -0,0 +1,11 @@
+[profile.default]
+src = 'contracts'
+out = 'out'
+viaIR = true
+libs = ['node_modules', 'lib']
+test = 'test'
+cache_path  = 'cache_forge'
+verbosity = 3
+
+[dependencies]
+forge-std = { version = "1.9.2" }

examples/checkin/hardhat.config.ts

@@ -0,0 +1,19 @@
+import "./tasks/deploy";
+import "./tasks/connectedSetUniversal";
+import "./tasks/universalSetConnected";
+import "./tasks/checkIn";
+import "@zetachain/localnet/tasks";
+import "@nomicfoundation/hardhat-toolbox";
+import "@zetachain/toolkit/tasks";
+
+import { getHardhatConfigNetworks } from "@zetachain/networks";
+import { HardhatUserConfig } from "hardhat/config";
+
+const config: HardhatUserConfig = {
+  networks: {
+    ...getHardhatConfigNetworks(),
+  },
+  solidity: "0.8.26",
+};
+
+export default config;

examples/checkin/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "example-template",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint:fix": "npx eslint . --ext .js,.ts --fix",
+    "lint": "npx eslint . --ext .js,.ts",
+    "deploy:localnet": "npx hardhat compile --force && npx hardhat deploy --network localhost --gateway 0x9A676e781A523b5d0C0e43731313A708CB607508 && npx hardhat deploy --name Echo --network localhost --gateway 0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@ethersproject/abi": "^5.4.7",
+    "@ethersproject/providers": "^5.4.7",
+    "@nomicfoundation/hardhat-chai-matchers": "^1.0.0",
+    "@nomicfoundation/hardhat-foundry": "^1.1.2",
+    "@nomicfoundation/hardhat-network-helpers": "^1.0.0",
+    "@nomicfoundation/hardhat-toolbox": "^2.0.0",
+    "@nomiclabs/hardhat-ethers": "^2.0.0",
+    "@nomiclabs/hardhat-etherscan": "^3.0.0",
+    "@typechain/ethers-v5": "^10.1.0",
+    "@typechain/hardhat": "^6.1.2",
+    "@types/chai": "^4.2.0",
+    "@types/mocha": ">=9.1.0",
+    "@types/node": ">=12.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.9",
+    "@typescript-eslint/parser": "^5.59.9",
+    "@zetachain/localnet": "4.0.0-rc6",
+    "@zetachain/toolkit": "13.0.0-rc7",
+    "axios": "^1.3.6",
+    "chai": "^4.2.0",
+    "dotenv": "^16.0.3",
+    "envfile": "^6.18.0",
+    "eslint": "^8.42.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-sort-keys-fix": "^1.1.2",
+    "eslint-plugin-typescript-sort-keys": "^2.3.0",
+    "ethers": "^5.4.7",
+    "hardhat": "^2.17.2",
+    "hardhat-gas-reporter": "^1.0.8",
+    "prettier": "^2.8.8",
+    "solidity-coverage": "^0.8.0",
+    "ts-node": ">=8.0.0",
+    "typechain": "^8.1.0",
+    "typescript": ">=4.5.0"
+  },
+  "packageManager": "[email protected]+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72",
+  "dependencies": {
+    "@coral-xyz/anchor": "0.30.0",
+    "@solana-developers/helpers": "^2.4.0",
+    "@solana/spl-memo": "^0.2.5",
+    "@solana/web3.js": "^1.95.2",
+    "@zetachain/protocol-contracts": "11.0.0-rc3"
+  }
+}

examples/checkin/scripts/localnet.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+set -e
+set -o pipefail
+set -x
+
+if [ "$1" = "start" ]; then npx hardhat localnet --exit-on-error & sleep 10; fi
+
+echo -e "\n🚀 Compiling contracts..."
+npx hardhat compile --force --quiet
+
+ZRC20_ETHEREUM=$(jq -r '.addresses[] | select(.type=="ZRC-20 ETH on 5") | .address' localnet.json)
+ZRC20_BNB=$(jq -r '.addresses[] | select(.type=="ZRC-20 BNB on 97") | .address' localnet.json)
+GATEWAY_ZETACHAIN=$(jq -r '.addresses[] | select(.type=="gatewayZEVM" and .chain=="zetachain") | .address' localnet.json)
+GATEWAY_ETHEREUM=$(jq -r '.addresses[] | select(.type=="gatewayEVM" and .chain=="ethereum") | .address' localnet.json)
+GATEWAY_BNB=$(jq -r '.addresses[] | select(.type=="gatewayEVM" and .chain=="bnb") | .address' localnet.json)
+UNISWAP_ROUTER=$(jq -r '.addresses[] | select(.type=="uniswapRouterInstance" and .chain=="zetachain") | .address' localnet.json)
+SENDER=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
+
+CONTRACT_ZETACHAIN=$(npx hardhat deploy --network localhost --gateway "$GATEWAY_ZETACHAIN" --json | jq -r '.contractAddress')
+echo -e "\n🚀 Deployed NFT contract on ZetaChain: $CONTRACT_ZETACHAIN"
+
+CONTRACT_ETHEREUM=$(npx hardhat deploy --name Connected --json --network localhost --gateway "$GATEWAY_ETHEREUM" | jq -r '.contractAddress')
+echo -e "🚀 Deployed NFT contract on Ethereum: $CONTRACT_ETHEREUM"
+
+CONTRACT_BNB=$(npx hardhat deploy --name Connected --json --network localhost --gateway "$GATEWAY_BNB" | jq -r '.contractAddress')
+echo -e "🚀 Deployed NFT contract on BNB chain: $CONTRACT_BNB"
+
+echo -e "\n📮 User Address: $SENDER"
+
+echo -e "\n🔗 Setting universal and connected contracts..."
+npx hardhat connected-set-universal --network localhost --contract "$CONTRACT_ETHEREUM" --universal "$CONTRACT_ZETACHAIN" --json
+npx hardhat connected-set-universal --network localhost --contract "$CONTRACT_BNB" --universal "$CONTRACT_ZETACHAIN" --json
+npx hardhat universal-set-connected --network localhost --contract "$CONTRACT_ZETACHAIN" --connected "$CONTRACT_ETHEREUM" --zrc20 "$ZRC20_ETHEREUM" --json
+npx hardhat universal-set-connected --network localhost --contract "$CONTRACT_ZETACHAIN" --connected "$CONTRACT_BNB" --zrc20 "$ZRC20_BNB" --json
+
+npx hardhat check-in --network localhost --contract "$CONTRACT_ETHEREUM" --json
+npx hardhat localnet-check
+
+npx hardhat check-in --network localhost --contract "$CONTRACT_ETHEREUM" --json
+npx hardhat localnet-check
+
+cast call "$CONTRACT_ZETACHAIN" "checkIns(address,address)(uint256)" "$SENDER" "$ZRC20_ETHEREUM"
+
+if [ "$1" = "start" ]; then npx hardhat localnet-stop; fi

examples/checkin/tasks/checkIn.ts

@@ -0,0 +1,28 @@
+import { task } from "hardhat/config";
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+
+const main = async (args: any, hre: HardhatRuntimeEnvironment) => {
+  const [signer] = await hre.ethers.getSigners();
+  if (signer === undefined) {
+    throw new Error(
+      `Wallet not found. Please, run "npx hardhat account --save" or set PRIVATE_KEY env variable (for example, in a .env file)`
+    );
+  }
+
+  const contract = await hre.ethers.getContractAt(
+    args.name as "Universal" | "Connected",
+    args.contract
+  );
+
+  const tx = await contract.checkIn();
+  await tx.wait();
+};
+
+task("check-in", "Check in", main)
+  .addParam("contract", "The address of the contract")
+  .addOptionalParam(
+    "to",
+    "The recipient address, defaults to the signer address"
+  )
+  .addOptionalParam("name", "The contract name to interact with", "Connected")
+  .addFlag("json", "Output the result in JSON format");