Merge pull request #9 from 0xPolygon/ankit/update-readme-and-example-env

Ankit/update readme and example env

.env.example

@@ -1,16 +1,16 @@
 # COMMON
-PRIVATE_KEY=
-NETWORK=
-TRANSACTIONS_URL=
-PROOF_URL=
-RPC_URL=
-BRIDGE_CONTRACT=
-GAS_STATION_URL=
-SOURCE_NETWORKS=[]
-DESTINATION_NETWORK=1
-SLACK_URL=
+PRIVATE_KEY=0x   # The private key of the EOA which will be submitting the claim transaction 
+NETWORK=testnet # testnet/mainnet
+TRANSACTIONS_URL= https://api-gateway.polygon.technology/api/v3/transactions/testnet # The transaction list endpoint of the bridge API service
+PROOF_URL= https://api-gateway.polygon.technology/api/v3/merkle-proof/testnet # The merkle proof endpoint of the bridge API service
+RPC_URL=https://zkyoto.explorer.startale.com # The rpc of your chain
+BRIDGE_CONTRACT=0x528e26b25a34a4A5d0dbDa1d57D318153d2ED582 # contract address of your bridge contract 
+GAS_STATION_URL=https://gasstation-staging.polygon.technology/astar/zkyoto # Follow Readme to spin up your own gas estimation service
+SOURCE_NETWORKS=[0,1] # The list of soruce network ID's of the chains you want to monitor and process claim transactions from
+DESTINATION_NETWORK=2 # The network ID if your chain on the L1 lxly bridge contract
+SLACK_URL= # Not Mandatory
 
-# LOGGER_ENV
+# LOGGER_ENV - Not Mandatory
 SENTRY_DSN=
 SENTRY_ENVIRONMENT=
 DATADOG_API_KEY=

README.md

@@ -2,8 +2,7 @@
 
 ## Introduction
 
-The Auto Claim script is the script which runs on cron job to claim the transactions on particular destination
-chain in LXLY bridge.
+Autoclaim Script is a cron job service which is used to process the claim transactions for the bridge transactions initiated on the lxly bridge. Bridging involves two steps. 1st Step is done on the source chain and the second on the destination chain. The script automates the second step so that users don't have to manually execute this second step. It fetches the transaction details from the transaction list endpoint of the Bridge API service, gets the merkle proof payload for each bridge transaction and then submits the claim transaction on the destination chain. 
 
 ## Prerequisite
 
@@ -14,6 +13,9 @@ chain in LXLY bridge.
 npm install
 ```
 
+- You can host the gas price estimation service for your chain by following the instructions on this repo: https://github.com/maticnetwork/maticgasstation
+
+
 ## Running
 
 - Build using