refactor(warriors): update the project to templating (#57)

messaging/warriors/.eslintignore

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

messaging/warriors/.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"),
+      },
+    },
+  },
+};

messaging/warriors/README.md

@@ -11,62 +11,75 @@ installed on your system.
 
 ## Getting Started
 
-To get started, install the necessary dependencies by running the following
-command in your terminal:
+To get started, install the necessary dependencies:
 
 ```
 yarn
 ```
 
 ## Hardhat Tasks
 
-This template includes two Hardhat tasks that can be used to generate a random
-wallet and request tokens from ZetaChain's faucet.
+This template includes Hardhat tasks that can be used make it easier to build
+with ZetaChain.
 
 ### Generating a Random Wallet
 
-To generate a random wallet, run the following command in your terminal:
+To generate a random wallet:
 
 ```
 npx hardhat account --save
 ```
 
-This will generate a random wallet, print information about the wallet to the
-terminal, and save the private key to a `.env` file to make it accessible to
-Hardhat. If you don't want to save the wallet (for example, if you just need an
-address to send tokens to), you can run the command without the `--save` flag.
+This command generates a random wallet, prints information about the wallet to
+the terminal, and saves the private key to a `.env` file to make it accessible
+to Hardhat. If you don't want to save the wallet (for example, if you just need
+an address to send tokens to for testing purposes), you can run the command
+without the `--save` flag.
 
 ### Querying for Token Balances
 
-To query for token balances, run the following command in your terminal:
+To query for token balances:
 
 ```
 npx hardhat balances
 ```
 
-This command will query token balances for the account address derived from the
+This command queries token balances for the account address derived from the
 private key specified in the `.env`.
 
 If you want to query for token balances for a different account, you can use the
 `--address` flag:
 
 ```
-npx hardhat balances --address <address>
+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 request ZETA tokens from the faucet:
 
 ```
 npx hardhat faucet
 ```
 
-To install a standalone faucet, run the following command in your terminal:
+This command requests tokens from the faucet for the account address derived
+from the private key specified in the `.env`. Tokens sent to the address on
+ZetaChain. To specify a different chain use a flag:
 
 ```
-npm install -g @zetachain/faucet-cli
+npx hardhat faucet --chain goerli_testnet
+```
+
+You can also specify a different address to send the tokens to:
+
+```
+npx hardhat faucet --address ADDRESS
+```
+
+Alternatively, you can install a standalone faucet CLI:
+
+```
+yarn global add @zetachain/faucet-cli@athens3
 ```
 
 You can then use it with the following command:
@@ -75,12 +88,49 @@ You can then use it with the following command:
 zetafaucet -h
 ```
 
+### Creating an Omnichain Contract
+
+To create a new omnichain contract:
+
+```
+npx hardhat omnichain MyContract
+```
+
+This command creates a new omnichain contract in `contracts/MyContract.sol`, a
+task to deploy the contract in `tasks/deploy.ts`, and a task to interact with
+the contract in `tasks/interact.ts`.
+
+When an omnichain contract is called, it can receive data in the `data` field of
+a transaction. This data is passed to the `message` parameter of the contract's
+`onCrossChainCall` function. To specify the fields of the `message` parameter,
+use positional arguments:
+
+```
+npx hardhat omnichain MyContract recepient:address description quantity:uint256
+```
+
+A field may have a type specified after the field name, separated by a colon. If
+no type is specified, the type defaults to `bytes32`.
+
+Learn more about omnichain contracts by following the
+[tutorials](https://www.zetachain.com/docs/developers/omnichain/tutorials/hello/).
+
+### Tracking a Cross-Chain Transaction
+
+After broadcasting a cross-chain transaction on a connected chain either to a
+cross-chain messaging contract or to trigger an omnichain contract, you can
+track its status:
+
+```
+npx hardhat cctx --tx TX_HASH
+```
+
 ### Verifying a Contract
 
-You can verify a deployed contract with the following command:
+To verify a contract deployed on ZetaChain:
 
 ```
-npx hardhat verify:zeta --contract <address>
+npx hardhat verify:zeta --contract ADDRESS
 ```
 
 Select the contract to verify:
@@ -94,6 +144,38 @@ Select the contract to verify:
 
 After the confirmation the contract will be verified.
 
+### Sending Tokens
+
+Sending ZETA from ZetaChain to Goerli:
+
+```
+npx hardhat send-zeta --amount 1 --network zeta_testnet --destination goerli_testnet
+```
+
+Sending ZETA from Goerli to ZetaChain:
+
+```
+npx hardhat send-zeta --amount 1 --network goerli_testnet --destination zeta_testnet
+```
+
+Depositing gETH to ZetaChain as ZRC-20:
+
+```
+npx hardhat send-zrc20 --amount 1 --network goerli_testnet --destination zeta_testnet
+```
+
+Withdrawing ZRC-20 from ZetaChain go Goerli as gETH:
+
+```
+npx hardhat send-zrc20 --amount 1 --network zeta_testnet --destination goerli_testnet
+```
+
+Depositing tBTC from the Bitcoin testnet to ZetaChain:
+
+```
+npx hardhat send-btc --amount 1 --recipient TSS_ADDRESS --memo RECIPIENT_ADDRESS_WITHOUT_0x
+```
+
 ## Next Steps
 
 To learn more about building decentralized apps on ZetaChain, follow the