📝 Updated Settings documentation

docs/plugins/cex.rst

@@ -5,9 +5,11 @@ CEX
 User Guide
 ==========
 - Retrieve your CEX API Keys
+- Refer to https://docs.ccxt.com for the supported exchange
 
 
 Module Reference
 ================
 
-.. automodule::tt.plugins.default_plugins.cex_exchange_plugin
+:doc:`tt.plugins.default_plugins.cex_exchange_plugin`
+

examples/example_settings.toml

@@ -1,38 +1,38 @@
 ########################################
-###          EXAMPLE SETTINGS        ###
+###          EXAMPLE SETTINGS       ###
 #######################################
 
 
 # DISCORD BOT on ethereum chain using 
 # uniswap v2 router
 
-# bot_token = '1212121212121'
-# bot_channel_id = '121212121212'
-# apprise_url = 'discord://1212121212121/121212121212'
-# dex_wallet_address = '0x1234567890123456789012345678901234567890'
-# dex_private_key = '0xdeadbeef'
-# dex_block_explorer_api = '42342342342'
+    # bot_token = '12122121'
+    # bot_channel_id = '1221212'
+    # apprise_url = 'discord://12121/121212'
+    # dex_wallet_address = '0x123458901234567890'
+    # dex_private_key = '0xdeadbeef'
+    # dex_block_explorer_api = '42342342342'
 
 # TELEGRAM BOT on CEX Binance
-    # bot_token = '1212121212121'
-    # bot_channel_id = '-112121212121'
-    # bot_api_id = '1212121212912'
-    # bot_api_hash = '121212121212121' 
-    # apprise_url = 'tgram://1212121212121/-112121212121'
+    # bot_token = '121212121'
+    # bot_channel_id = '-1122121'
+    # bot_api_id = '1212912'
+    # bot_api_hash = '121212121' 
+    # apprise_url = 'tgram://121221/-11211212121'
     # cex_name = 'binance' 
-    # cex_api = 'abcabcabcabcabcabc' 
-    # cex_secret = 'abcabcabcabcabcabc' 
+    # cex_api = 'abcabccabc' 
+    # cex_secret = 'abcacabcabc' 
 
 #DISCORD BOT on BSC chain using pancakeswap v2 router and custom plugin setup
     # bot_token = '1212121212121'
     # bot_channel_id = '121212121212'
-    # apprise_url = 'discord://1212121212121/121212121212'
-    # dex_wallet_address = '0x1234567890123456789012345678901234567890'
+    # apprise_url = 'discord://121121/1212212'
+    # dex_wallet_address = '0x123467890'
     # dex_private_key = '0xdeadbeef'
     # dex_router_contract_addr = "0x10ED43C718714eb63d5aA57B78B54704E256024E"
     # dex_factory_contract_addr = "0xcA143Ce32Fe78f1f7019d7d551a6402fC5350c73"
     # dex_block_explorer_url = 'https://api.bscscan.com/api'
-    # dex_block_explorer_api = '42342342342'
+    # dex_block_explorer_api = '423442'
     # trading_asset_address = "0xe9e7cea3dedca5984780bafc599bd69add087d56"
     # action_identifier = "PUMP DUMP"
     # mapping = [
@@ -41,13 +41,13 @@
     # live_tv_url ='https://reuters-reutersnow-1.plex.wurl.com/manifest/playlist.m3u8'
 
 #MATRIX BOT on Polygon chain using zerox protocol
-    # bot_token = '1212121212121'
-    # bot_channel_id = '121212121212'
+    # bot_token = '12122121'
+    # bot_channel_id = '12121212'
     # bot_hostname='matrix.org'
     # bot_user='itsme'
     # bot_pass='mario'
-    # apprise_url = 'discord://1212121212121/121212121212'
-    # dex_wallet_address = '0x1234567890123456789012345678901234567890'
+    # apprise_url = 'discord://1212121/1211212'
+    # dex_wallet_address = '0x12345678901234567890'
     # dex_private_key = '0xdeadbeef'
     # dex_protocol_type = "0x"
     # dex_rpc = "https://rpc.ankr.com/polygon"

tt/bot.py

@@ -18,7 +18,13 @@
 
 @app.on_event("startup")
 async def start_bot_task():
-    """⛓️🤖BOT"""
+    """
+    ⛓️🤖BOT
+
+    Run the talky bot on startup
+    asynchronously
+
+    """
     event_loop = asyncio.get_event_loop()
     event_loop.create_task(run_bot())