refactor: use templating for the MultiOutput example

omnichain/multioutput/README.md

@@ -56,18 +56,10 @@ npx hardhat balances --address <address>
 
 ### Requesting Tokens from the Faucet
 
-To request tokens from ZetaChain's faucet using the account from the `.env`
-file, run the following command in your terminal:
+To install a faucet, run the following command in your terminal:
 
 ```
-npx hardhat faucet
-```
-
-Alternatively, you can install a standalone faucet, run the following command in
-your terminal:
-
-```
-yarn global add @zetachain/faucet-cli
+yarn global add @zetachain/faucet-cli@athens3
 ```
 
 You can then use it with the following command:

omnichain/multioutput/contracts/ZetaMultiOutput.sol → omnichain/multioutput/contracts/MultiOutput.sol

@@ -1,22 +1,21 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.7;
 
-import "@openzeppelin/contracts/access/Ownable.sol";
 import "@zetachain/protocol-contracts/contracts/zevm/SystemContract.sol";
+import "@zetachain/protocol-contracts/contracts/zevm/interfaces/zContract.sol";
 import "@zetachain/toolkit/contracts/BytesHelperLib.sol";
 import "@zetachain/toolkit/contracts/SwapHelperLib.sol";
+import "@openzeppelin/contracts/access/Ownable.sol";
 
-interface ZetaMultiOutputErrors {
+contract MultiOutput is zContract, Ownable {
     error NoAvailableTransfers();
-}
-
-contract ZetaMultiOutput is zContract, Ownable, ZetaMultiOutputErrors {
-    SystemContract public immutable systemContract;
-    address[] public destinationTokens;
 
     event DestinationRegistered(address);
     event Withdrawal(address, uint256, address);
 
+    address[] public destinationTokens;
+    SystemContract public immutable systemContract;
+
     constructor(address systemContractAddress) {
         systemContract = SystemContract(systemContractAddress);
     }
@@ -43,9 +42,9 @@ contract ZetaMultiOutput is zContract, Ownable, ZetaMultiOutputErrors {
         uint256 amount,
         bytes calldata message
     ) external virtual override {
+        address recipient = abi.decode(message, (address));
         if (_getTotalTransfers(zrc20) == 0) revert NoAvailableTransfers();
 
-        address receipient = BytesHelperLib.bytesToAddress(message, 0);
         uint256 amountToTransfer = amount / _getTotalTransfers(zrc20);
         uint256 leftOver = amount -
             amountToTransfer *
@@ -77,9 +76,9 @@ contract ZetaMultiOutput is zContract, Ownable, ZetaMultiOutputErrors {
             SwapHelperLib._doWithdrawal(
                 targetZRC20,
                 outputAmount,
-                BytesHelperLib.addressToBytes(receipient)
+                BytesHelperLib.addressToBytes(recipient)
             );
-            emit Withdrawal(targetZRC20, outputAmount, receipient);
+            emit Withdrawal(targetZRC20, outputAmount, recipient);
         }
     }
 }

omnichain/multioutput/hardhat.config.ts

@@ -1,12 +1,11 @@
+import "./tasks/interact";
+import "./tasks/deploy";
+import "./tasks/destination";
 import "@nomicfoundation/hardhat-toolbox";
 import { getHardhatConfigNetworks } from "@zetachain/networks";
 import "@zetachain/toolkit/tasks";
 import { HardhatUserConfig } from "hardhat/config";
 
-import "./tasks/deploy";
-import "./tasks/destination";
-import "./tasks/send";
-
 const config: HardhatUserConfig = {
   solidity: "0.8.7",
   networks: {

omnichain/multioutput/package.json

@@ -20,19 +20,18 @@
     "@nomicfoundation/hardhat-toolbox": "^2.0.0",
     "@nomiclabs/hardhat-ethers": "^2.0.0",
     "@nomiclabs/hardhat-etherscan": "^3.0.0",
-    "@openzeppelin/contracts": "^4.9.2",
     "@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/faucet-cli": "^2.0.1",
+    "@zetachain/faucet-cli": "^2.0.1-beta.2",
     "@zetachain/interfaces": "^0.0.1",
     "@zetachain/networks": "^2.3.0-athens3",
-    "@zetachain/protocol-contracts": "^1.0.0-athens3",
-    "@zetachain/toolkit": "^1.0.3-athens3",
+    "@zetachain/protocol-contracts": "^1.0.1-athens3",
+    "@zetachain/toolkit": "^1.0.8-athens3",
     "axios": "^1.3.6",
     "chai": "^4.2.0",
     "dotenv": "^16.0.3",

omnichain/multioutput/tasks/deploy.ts

@@ -1,8 +1,6 @@
+import { getAddress } from "@zetachain/protocol-contracts";
 import { task } from "hardhat/config";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
-import { getAddress } from "@zetachain/protocol-contracts";
-
-const contractName = "ZetaMultiOutput";
 
 const main = async (args: any, hre: HardhatRuntimeEnvironment) => {
   if (hre.network.name !== "zeta_testnet") {
@@ -14,10 +12,10 @@ const main = async (args: any, hre: HardhatRuntimeEnvironment) => {
   const [signer] = await hre.ethers.getSigners();
   console.log(`🔑 Using account: ${signer.address}\n`);
 
-  const SYSTEM_CONTRACT = getAddress("systemContract", hre.network.name);
+  const systemContract = getAddress("systemContract", "zeta_testnet");
 
-  const factory = await hre.ethers.getContractFactory(contractName);
-  const contract = await factory.deploy(SYSTEM_CONTRACT);
+  const factory = await hre.ethers.getContractFactory("MultiOutput");
+  const contract = await factory.deploy(systemContract);
   await contract.deployed();
 
   console.log(`🚀 Successfully deployed contract on ZetaChain.

omnichain/multioutput/tasks/destination.ts

@@ -2,15 +2,13 @@ import { task } from "hardhat/config";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import { getAddress } from "@zetachain/protocol-contracts";
 
-const contractName = "ZetaMultiOutput";
-
 const main = async (args: any, hre: HardhatRuntimeEnvironment) => {
   const [signer] = await hre.ethers.getSigners();
   console.log(`🔑 Using account: ${signer.address}\n`);
 
   const destinationToken = getAddress("zrc20" as any, args.destination as any);
-  const ZetaMultiOutput = await ethers.getContractAt(
-    contractName,
+  const ZetaMultiOutput = await hre.ethers.getContractAt(
+    "MultiOutput",
     args.contract
   );
 

omnichain/multioutput/tasks/interact.ts

@@ -0,0 +1,31 @@
+import { task } from "hardhat/config";
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+import { parseEther } from "@ethersproject/units";
+import { getAddress } from "@zetachain/protocol-contracts";
+import { prepareData, trackCCTX } from "@zetachain/toolkit/helpers";
+
+const main = async (args: any, hre: HardhatRuntimeEnvironment) => {
+  const [signer] = await hre.ethers.getSigners();
+  console.log(`🔑 Using account: ${signer.address}\n`);
+
+  const data = prepareData(
+    args.contract,
+    ["address", ],
+    [args.recipient, ]
+  );
+  const to = getAddress("tss", hre.network.name);
+  const value = parseEther(args.amount);
+
+  const tx = await signer.sendTransaction({ data, to, value });
+
+  console.log(`
+🚀 Successfully broadcasted a token transfer transaction on ${hre.network.name} network.
+📝 Transaction hash: ${tx.hash}
+`);
+  await trackCCTX(tx.hash);
+};
+
+task("interact", "Interact with the contract", main)
+  .addParam("contract", "The address of the withdraw contract on ZetaChain")
+  .addParam("amount", "Amount of tokens to send")
+  .addParam("recipient")