Initial README and necessary fixes

Author: tombeynon

.env.sample

@@ -1 +1 @@
-MNEMONIC=some seed words here
+MNEMONIC=my hot wallet seed words here that has minimal funds

README.md

@@ -1,70 +1,113 @@
-# Getting Started with Create React App
+# [REStake](https://restake.app)
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+REStake allows delegators to grant permission for a validator to compound their rewards, and provides a script validators can run to find their granted delegators and send the compounding transactions automatically.
 
-## Available Scripts
+REStake is also a convenient staking tool, allowing you to claim and compound your rewards individually or in bulk. This can save transaction fees and time, and many more features are planned.
 
-In the project directory, you can run:
+[![](./docs/screenshot.png)](https://restake.app)
 
-### `npm start`
+Try it out at [restake.app](https://restake.app).
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+## How it works / Authz
 
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
+Authz is a new feature for Tendermint chains which lets you grant permission to another wallet to carry out certain transactions for you. These transactions are sent by the grantee on behalf of the granter, meaning the validator will send and pay for the TX, but actions will affect your wallet (such as claiming rewards). 
 
-### `npm test`
+REStake specifically lets you grant a validator permission to send `WithdrawDelegatorReward` and `Delegate` transactions for their validator only (note `WithdrawDelegatorReward` is technically not restricted to a single validator). The validator cannot send any other transaction types, and has no other access to your wallet. You authorise this using Keplr as normal.
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+A script is also provided which allows a validator to automatically search their delegators, check each for the required grants, and if applicable carry out the claim and delegate transactions on their behalf in a single transaction. This script should be run daily, and the time you will run it can be specified when you [add your operator](#become-an-operator).
 
-### `npm run build`
+## Limitations
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+- As of writing, Ledger is unable to send the necessary transactions to enable Authz. This is purely due to the way transactions are sent to a Ledger device and a workaround should be possible soon.
+- Authz is also not fully supported yet. Many chains are yet to update. The REStake UI will fall back to being a manual staking app with useful manual compounding features.
+- Currently REStake needs the browser extension version of Keplr, but WalletConnect and Keplr iOS functionality will be added ASAP.
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+## Become an operator
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+Becoming an operator is extremely easy. You need to do three things:
 
-### `npm run eject`
+### Setup a bot wallet
 
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+Generate a new hot wallet you will use to automatically carry out the staking transactions. The mnemonic will need to be provided to the script so **use a dedicated wallet and only keep enough funds for transaction fees**.
 
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+You only need a single mnemonic for multiple Cosmos chains, and the script will check each network in the [networks.json](./src/networks.json) file for a matching bot address. 
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
+### Setup the autostaking script and run daily
 
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
+You can run the autostaking script using `docker-compose` or using `npm` directly. In both cases you will need to provide your mnemonic in a `MNEMONIC` environment variable. Instructions are provided for Docker Compose and will be expanded later.
 
-## Learn More
+Clone the repository and copy the sample `.env` file ready for your mnemonic.
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+```
+git clone https://github.com/eco-stake/restake
+cd restake
+cp .env.sample .env
+```
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+**Populate your new .env file with your mnemonic.**
 
-### Code Splitting
+Running the autostake script manually is then simple:
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+```
+docker-compose run app npm run autostake
+```
 
-### Analyzing the Bundle Size
+Note you might need `sudo` depending on your docker install.
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
+You should setup your script to run at the same time each day using `crontab`
 
-### Making a Progressive Web App
+```
+crontab -e
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
+0 21 * * * /bin/bash -c "cd restake && docker-compose run app npm run autostake" > ./restake.log 2>&1
+```
 
-### Advanced Configuration
+Use `git pull` to retrieve the latest version as required. The autostaking script can and will change in the near future.
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
+### Setup and submit your REStake operator
 
-### Deployment
+You now need to update the [networks.json](./src/networks.json) file at `./src/networks.json` to add your operator to any networks you want to auto-compound for. Check the existing file for examples, but the operators array is simple:
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+```
+"operators": [{
+  "address": "osmovaloper1u5v0m74mql5nzfx2yh43s2tke4mvzghr6m2n5t",
+  "botAddress": "osmo1yxsmtnxdt6gxnaqrg0j0nudg7et2gqczed559y",
+  "runTime": "21:00",
+  "minimumReward": 1000
+},
+```
 
-### `npm run build` fails to minify
+`address` is your validator's address, and `botAddress` is the address from your new hot wallet you generated earlier. Repeat this for all networks you want to REStake for.
+
+Note that the `botAddress` is the address which will be granted by the delegator to carry out their restaking transactions if it wasn't clear.
+
+#### Submit your operator
+
+You can now submit your `networks.json` update to the repository in a pull request which will be merged and deployed as soon as possible.
+
+## Running the UI
+
+Run the UI using docker with one line:
+
+```
+docker run -p 80:80 -t ghcr.io/eco-stake/restake
+```
+
+Alternative run from source using `docker-compose up` or `npm start`.
+
+## Ethos
+
+The REStake UI is both validator and network agnostic. Any validator can be added as an operator and run this tool to provide an auto-compounding service to their delegators, but they can also run their own UI if they choose and adjust the branding to suit themselves. 
+
+For this to work, we need a common source of chain information, and a common source of 'operator' information. Currently this the [networks.json](./src/networks.json) file in this repository. A helper script is included to add a chain from the [Chain Registry](https://github.com/cosmos/chain-registry), and this integration will be taken further soon.
+
+If you fork this repository to provide your own UI, please keep up to date with the upstream to ensure you have the latest [networks.json](./src/networks.json) to include all operators. Some honesty is needed until we have a more decentralised solution.
+
+## Disclaimer
+
+The initial version of REStake was built quickly to take advantage of the new authz features. I'm personally not a React or Javascript developer, and this project leans extremely heavily on the [CosmJS project](https://github.com/cosmos/cosmjs) and other fantastic codebases like [Keplr Wallet](https://github.com/chainapsis/keplr-wallet) and [Osmosis Zone frontend](https://github.com/osmosis-labs/osmosis-frontend). It functions very well and any attack surface is very limited however. Any contributions, suggestions and ideas from the community are extremely welcome.
+
+## ECO Stake 🌱
+
+ECO Stake is a climate positive validator, but we care about the Cosmos ecosystem too. We built REStake to make it easy for all validators to run an autocompounder with Authz, and it's one of many projects we work on in the ecosystem. [Delegate with us](https://ecostake.com) to support more projects like this.
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

docker-compose.yml

@@ -1,4 +1,4 @@
-version: "3.7"
+version: "3.3"
 
 services:
   app:

docs/screenshot.png

@@ -3,6 +3,7 @@
   "version": "0.1.0",
   "private": true,
   "dependencies": {
+    "@cosmjs/proto-signing": "^0.27.1",
     "@cosmjs/stargate": "^0.27.1",
     "@testing-library/jest-dom": "^5.16.2",
     "@testing-library/react": "^12.1.3",