update readme

update deps

README.md

@@ -1,7 +1,6 @@
 #### MultiDexArbBot
 
-This is an arbitrage bot that uses existing price aggregators such as `1inch`, `Paraswap`, `dex.ag`, `matcha` and more
-to get the best exchange rates across different decentralized exchanges on different blockchains and ecosystems.
+This is an arbitrage bot that uses existing price aggregators such as `1inch` to get the best exchange rates across different decentralized exchanges on different blockchains and ecosystems.
 
 #### INSTALL && RUN
 
@@ -31,30 +30,19 @@ to get the best exchange rates across different decentralized exchanges on diffe
 
 - Update `.env` to contain your trading preferences and wallet info such private and public key
 
+To receive trade notifications on telegram, you need to create a telegram bot at
+
+[BotFather](https://t.me/BotFather). Send `/start` and follow prompts to create a tg bot, finally copy the Token the one below `Use this token to access the HTTP API:`
+and set it to be the bot token value
+
+For Mongo DB you need to install mongodb for your OS according to this [guide](https://www.mongodb.com/docs/manual/installation/#mongodb-installation-tutorials)
+
 - Finally run the app by
 
 ```
     yarn start
 ```
 
-#### AUTHORS
-
-- Enock Kipkoech `(theNodeG)`
-
-- Dennoh Peter `` (Rust`edSoul) ``
-
-#### CONTRIBUTION
-
-- If you would like to add a feature or suggestion please feel free to fork, open a pull request or an issue.
-
-- Wanna Buy the Devs Some Coffee ☕️☕️☕️☕️?
-
-ETH
-
-- `theNodeG` - `0x88f852D7DB6fd080c4fA257F755A517e9db0d124`
-- `` Rust`edSoul `` - `0xE5dB9FCf40eFb3975F9C695fF89FdB51fB4C553F`
-
-BSC
+#### TODO:
 
-- `theNodeG` - `0x88f852D7DB6fd080c4fA257F755A517e9db0d124`
-- `` Rust`edSoul `` - `0xE5dB9FCf40eFb3975F9C695fF89FdB51fB4C553F`
+- I will be releasing a series of more robust and stable versions of arbitrage bots soon

example.env

@@ -1,9 +1,8 @@
 # Telegram
-BOT_TOKEN = '1981913038...'
+BOT_TOKEN = ''
 
 # Provider
-# INFURA_API_KEY = 'https://mainnet.infura.io/v3/ab96b536fe83489f8599d9e2cab6d9ce'
-INFURA_API_KEY="https://bsc-dataseed1.binance.org/"
+INFURA_API_KEY="https://bsc-dataseed1.binance.org"
 
 # Wallet
 PRIVATE_KEY = ''
@@ -18,7 +17,7 @@ ETH_IN_AMOUNT = '0.001'
 NETWORK_ID = '56'
 
 # Database
-DB_URL = 'mongodb+srv://dennoh:[email protected]/multidexarbbot?authSource=admin&replicaSet=atlas-nskznp-shard-0&readPreference=primary&appname=MongoDB%20Compass&ssl=true'
+DB_URL = 'mongodb://localhost:27017/'
 
 # Explorer to view Txs
 EXPLORER = 'https://bscscan.com/tx'

package.json

@@ -27,6 +27,8 @@
     "ethers": "^5.4.7",
     "mongoose": "^6.0.9",
     "node-cron": "^3.0.0",
-    "telegraf": "^4.4.2"
+    "telegraf": "^4.4.2",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^4.8.4"
   }
 }