Feat/v0.2 (#3)

feat:  completely new app  
---------

Co-authored-by: EvgenyKhlivetsky <[email protected]>
Co-authored-by: EvgenyKhlivetsky <[email protected]>
Co-authored-by: Liver-23 <[email protected]>

Author: 3 people

.env.example

@@ -0,0 +1 @@
+TELEGRAM_BOT_TOKEN=your bot token here 

.eslintrc.cjs

@@ -0,0 +1,29 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  overrides: [
+    {
+      env: {
+        node: true,
+      },
+      files: ['.eslintrc.{js,cjs}'],
+      parserOptions: {
+        sourceType: 'script',
+      },
+    },
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {},
+}

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "printWidth": 80
+}

README.md

@@ -1,38 +1,104 @@
 # janusbot
-Self hosted Bot to easy vote in cosmos ecosystem
 
+Self hosted Bot to easy vote in cosmos ecosystem
 
 <img src="janus.jpeg" width="30%">
 
-There is no need to vote via cli or web UI, just setup a bot with your validator or wherever you want and get notifications with vote options and vote ***directly in telegram!*** 
+There is no need to vote via cli or web UI, just setup a bot with your validator or wherever you want and get notifications with vote options and vote **_directly in telegram!_**
+
+<img src="work_bot_example.png" width="30%">
 
-<img src="work_bot_example.png" width="40%">
+# How to run a bot
+### Get the binary
+#### Download the latest release
 
-## How to run a bot
-### Upload the latest release on your machine 
-For example:
+First download the latest release:
 ```
 wget https://github.com/MELLIFERA-Labs/janusbot/releases/download/v0.0.3/janusbot-linux-amd64
 ```
-
-### Add binary to bin
+#### Build from sources 
+1. install bun (JavaScript runtime). Go to site and fallow instructions: https://bun.sh
+2. Run build commands in root of project
+3. Install dependencies
+```bash 
+bun install 
 ```
- mv janusbot-linux-amd64 /usr/bin/janusbot 
+4. Build binary
+```bash 
+bun build ./src/cli/index.ts --compile --outfile janusbot 
 ```
-### Setup app config
+Now you have `janusbot` binary in root of project
+
+## Initialize the bot:
 ```
 janusbot init
 ```
-Fill all forms step by step as in example:
+## Verify that config is created
+
+```
+cat $HOME/.janus/config.toml
+```
+
+## Configure environment variables
+Set env variables, see `.env.example` or you can specify path to .env file, e.g. `dotenv = '/Home/.janus/.env'`.
+
+## Create telegram bot
+Open telegram and look for @BotFather, run command `/newbot` and follow instructions.
+In the end you should get token for your bot: something like `9999999:ASDjaiodsjioasoidj123123`.
+Set token environment variable, variable name is `TELEGRAM_BOT_TOKEN`, e.g: `TELEGRAM_BOT_TOKEN=9999999:ASDjaiodsjioasoidj123123`.
 
-<img src="fill_init_example.png" width="90%">
+## Retrieve chat_id 
+Now we need chat_id, so our bot knows where to send messages. It may be either group or private chat. In telegram look for `@username_to_id_bot`, or any other way you prefer to get chat_id.
+Add chat_id to config.toml, e.g: `chat_id = 123456789`.
+Update `key` in config.toml, string and no spaces, e.g: `key = 'telegram_cosmos_proposals'`.
+Currently we support only telegram, so `type = 'telegram'`.
+
+## Configure bot
+### Keys management
+Now let's proceed with keys setup. These keys will be used to vote for proposals.
+If you want to create new wallet run:
+
+```
+janusbot keys add WALLET_NAME
+```
+If you want to import existing one run:
+```
+janusbot keys add WALLET_NAME --recover
+```
+Follow instructions.
+
+### Setup network
+Currently we have initial values for cosmos network, edit those for your preferred network.
+`transport` is your transport key, we added before: `telegram_cosmos_proposals` in our case.
+Here is a [complete example](./config.example.toml) of config.toml you should have in the end.
+#### Lava integration 
+> [Lava](https://lavanet.xyz) is a modular data network for scaling access to any blockchain. The network can flexibly support any RPC and API, and node providers compete to offer the fastest and most reliable service
+
+If you want to use RPC with Lava network, you can add `lava` section to config.toml, e.g:
+```toml
+[[network]]
+#... 
+lava = { chain = 'COS5' }
+```
+It's also require `LAVA_PRIV_KEY` environment variable to be set. Set it in .env or in any other way you prefer.
+To get `LAVA_PRIV_KEY` look at [lava doc](https://docs.lavanet.xyz/sdk-backend/#%EF%B8%8F-recommended-flow).
+
+## Run the bot
+```
+janusbot run start
+```
+And that's it! The bot will check for new proposals every five minutes and send you a message if there are any.
+
+## Setup service file
+
+1. Create service file
 
-### Setup service file 
-1. Create service file 
 ```
  touch /etc/systemd/system/janusbot.service
 ```
+
 2. Fill service file:
+
 ```
 cat <<EOF >> /etc/systemd/system/janusbot.service
 [Unit]
@@ -41,7 +107,7 @@ After=network-online.target
 
 [Service]
 User=<USER>
-ExecStart=/usr/bin/janusbot start
+ExecStart=/usr/bin/janusbot run start
 Restart=on-failure
 RestartSec=3
 LimitNOFILE=4096
@@ -50,22 +116,33 @@ LimitNOFILE=4096
 WantedBy=multi-user.target
 EOF
 ```
-3. Reload systemctl 
+
+3. Reload systemctl
+
 ```
 systemctl daemon-reload
 ```
+
 4. Start service
+
 ```
  systemctl start janusbot.service
 ```
+
 4. In order to watch the service run, you can do the following:
- ```
-   journalctl -u janusbot.service -f
- ```
-### VIDEO GUIDES
- - EN - https://www.youtube.com/watch?v=U3DSN1M8tQM
- - RU - https://www.youtube.com/watch?v=LDzwrBmEOS0
+
+```
+  journalctl -u janusbot.service -f
+```
+## Well tested networks
+
+- Cosmos Hub
+- Lava Network
+- Osmosis
+- May work for many others cosmos SDK based networks, but not tested yet.
+
 ## SUPPORT US
+
 - COSMOS: `cosmos1qcual5kgmw3gqc9q22hlp0aluc3t7rnsprewgy`
 - JUNO: `juno1qcual5kgmw3gqc9q22hlp0aluc3t7rnsh3640c`
 - OSMOSIS: `osmo1qcual5kgmw3gqc9q22hlp0aluc3t7rnsfc277k`

bun.lockb

@@ -0,0 +1,35 @@
+# options parameter for file with env variables. Remove if you don't need it
+dotenv = '.env'
+# transports configuration
+[[transport]]
+# The unique name of the transport
+key = 'telegram_cosmos_proposals'
+# transport type
+type = 'telegram'
+# telegram chat id. Put your chat id here. Can be channel or your id for direct messages
+chat-id = '<id>'
+
+# Networks configuration
+[[network]]
+# The unique name of the network (Required)
+key = 'cosmos_mainnet'
+# The chain id (Required)
+chain-id = 'cosmoshub-4'
+# The coin type (Required). This default value for most cosmos based networks. Check the your network docs to provide the correct value
+hd-path = "m/44'/118'/0'/0/0"
+# denom (Required)
+denom = 'uatom'
+# Address prefix (Required)
+prefix = 'cosmos'
+# Decimals (Required)
+decimals = 6
+wallet-key = ['my_wallet']
+# RPC endpoints (Optional)
+net = { rpc = ['https://rpc.cosmos.directory/cosmoshub'] }
+# Lava protocol configuration (Optinal) 
+lava = { chain = "COS5" }
+# `lava` or `net`.One of this configuration is required 
+# This will be used to create links to the block explorer. Links to proposals and trx result 
+explorer = { proposal = 'https://www.mintscan.io/cosmos/proposals/:id', trx = 'https://www.mintscan.io/cosmos/txs/:hash' }
+# Specify the transport to send notifications. Which is defined above (Required)
+transport = 'telegram_cosmos_proposals'