razor-network
diff --git a/‎README.md
+90-35 b/‎README.md
+90-35
diff --git a/‎block/block.go
+4-3 b/‎block/block.go
+4-3
diff --git a/‎cache/cache.go
+93 b/‎cache/cache.go
+93
diff --git a/‎client/alternateClient.go
+63 b/‎client/alternateClient.go
+63
@@ -93,33 +93,38 @@ Go to the `build/bin` directory where the razor binary is generated.
 There are a set of parameters that are configurable. These include:
 
 - Provider: The RPC URL of the provider you are using to connect to the blockchain.
+- Alternate Provider: This is the secondary RPC URL of the provider used to connect to the blockchain if the primary one is not working.
 - Gas Multiplier: The value with which the gas price will be multiplied while sending every transaction.
 - Buffer Size: Buffer size determines, out of all blocks in a state, in how many blocks the voting or any other operation can be performed.
 - Wait Time: This is the number of seconds the system will wait while voting.
 - Gas Price: The value of gas price if you want to set manually. If you don't provide any value or simply keep it to 1, the razor client will automatically calculate the optimum gas price and send it.
 - Log Level: Normally debug logs are not logged into the log file. But if you want you can set `logLevel` to `debug` and fetch the debug logs.
 - Gas Limit: The value with which the gas limit will be multiplied while sending every transaction.
-- Gas Limit Override: This value would be used as a gas limit for all the transactions instead of estimating for each transaction. 
+- Gas Limit Override: This value would be used as a gas limit for all the transactions instead of estimating for each transaction.
 - RPC Timeout: This is the threshold number of seconds after which any contract and client calls will time out.
+- HTTP Timeout: This is the threshold number of seconds after which an HTTP request for a job will time out.
+- Maximum size of log file: This is the maximum size of log file in MB
+- Maximum number of backups of log file: This is the maximum number of old log files to retain.
+- Maximum age of log file: This is the maximum number of days to retain old log files.
 
 The config is set while the build is generated, but if you need to change any of the above parameter, you can use the `setConfig` command.
 
 razor cli
 
 ```
-$ ./razor setConfig --provider <rpc_provider> --gasmultiplier <multiplier_value> --buffer <buffer_percentage> --wait <wait_for_n_blocks> --gasprice <gas_price> --logLevel <debug_or_info> --gasLimit <gas_limit_multiplier> --rpcTimeout <rpc_timeout>
+$ ./razor setConfig --provider <rpc_provider> --gasmultiplier <multiplier_value> --buffer <buffer_percentage> --wait <wait_for_n_blocks> --gasprice <gas_price> --logLevel <debug_or_info> --gasLimit <gas_limit_multiplier> --rpcTimeout <rpc_timeout> --httpTimeout <http_timeout> --logFileMaxSize <file_max_size> --logFileMaxBackups <file_max_backups> --logFileMaxAge <file_max_age>
 ```
 
 docker
 
 ```
-docker exec -it razor-go razor setConfig --provider <rpc_provider> --gasmultiplier <multiplier_value> --buffer <buffer_percentage> --wait <wait_for_n_blocks> --gasprice <gas_price> --logLevel <debug_or_info> --gasLimit <gas_limit_multiplier> --rpcTimeout <rpc_timeout>
+docker exec -it razor-go razor setConfig --provider <rpc_provider> --alternateProvider <alternate_rpc_provider> --gasmultiplier <multiplier_value> --buffer <buffer_percentage> --wait <wait_for_n_blocks> --gasprice <gas_price> --logLevel <debug_or_info> --gasLimit <gas_limit_multiplier> --rpcTimeout <rpc_timeout> --httpTimeout <http_timeout> --logFileMaxSize <file_max_size> --logFileMaxBackups <file_max_backups> --logFileMaxAge <file_max_age>
 ```
 
 Example:
 
 ```
-$ ./razor setConfig --provider https://mainnet.skalenodes.com/v1/turbulent-unique-scheat --gasmultiplier 1 --buffer 20 --wait 30 --gasprice 0 --logLevel debug --gasLimit 2 --rpcTimeout 10
+$ ./razor setConfig --provider https://mainnet.skalenodes.com/v1/turbulent-unique-scheat --alternateProvider https://ce2m-skale.chainode.tech:10200/ --gasmultiplier 1 --buffer 20 --wait 30 --gasprice 0 --logLevel debug --gasLimit 2 --rpcTimeout 10 --httpTimeout 10 --logFileMaxSize 200 --logFileMaxBackups 52 --logFileMaxAge 365
 ```
 
 Other than setting these parameters in the config, you can use different values of these parameters in different command. Just add the same flag to any command you want to use and the new config changes will appear for that command.
@@ -352,12 +357,14 @@ docker
 docker exec -it razor-go razor vote --address <address>
 ```
 
-run vote command in background
+> **Note**: _To run vote command in background you can use `tmux` for that._
+>
+> 1.  Run: `tmux new -s razor-go`
+> 2.  Run vote command
+> 3.  To exit from tmux session: press `ctrl+b`, release those keys and press `d`
+> 4.  To list your session: `tmux ls`
+> 5.  To attach Session back: `tmux attach-session -t razor-go`
 
-```
-docker exec -it -d razor-go razor vote --address <address> --password /root/.razor/<file_name>
-```
->**_NOTE:_**  To run command with password flag with the help of docker, password file should present in $HOME/.razor/ directory
 
 Example:
 
@@ -693,33 +700,29 @@ Note : _All the commands have an additional --password flag that you can provide
 
 Expose Prometheus-based metrics for monitoring
 
-Example:
-
-razor cli
-
-Without TLS
+#### Without TLS
 
 ```
 $ ./razor setConfig --exposeMetrics 2112
 ```
 
-With TLS
+#### With TLS
 
 ```
 $ ./razor setConfig --exposeMetrics 2112 --certFile /cert/file/path/certfile.crt --certKey key/file/path/keyfile.key
 ```
 
 docker
 
-```
-# Create docker network
-
-docker network create razor_network
+#### Expose Metrics without TLS
 
-# Expose Metrics without TLS
+```
 docker exec -it razor-go razor setConfig --exposeMetrics 2112
+```
+
+#### Expose Metrics with TLS
 
-# Expose Metrics with TLS
+```
 docker exec -it razor-go razor setConfig --exposeMetrics 2112 --certFile /cert/file/path/certfile.crt --certKey key/file/path/keyfile.key
 ```
 
@@ -734,18 +737,70 @@ cd monitoring
 
 - If your staker is running via binary, then
 
-  1. In `./configs/prometheus.yml`, replace `"razor-go:2112"` with `"<private/public address of host>:2112"`
+    1. In `./configs/prometheus.yml`, replace `"razor-go:2112"` with `"<private/public address of host>:2112"`
 
 - For alerting you can add webhook in `./configs/alertmanager.yml`, replace `http://127.0.0.1:5001/` with your webhook URL. This will send you an alert in every 5min if metrics stops.
 
 - If you are running multiple stakers and want to monitor via single grafana dashboard
-  1. You need to update `./config/prometheus.yml`, add new target block where `job_name: "razor-go"`
-     ```
-     - targets: ["<second-host-address>:2112"]
-       labels:
-         staker: "<staker-name>"
-     ```
-  2. Restart vmagent service `docker-compose restart vmagent`
+
+    1. You need to update `./config/prometheus.yml`, add new target block where `job_name: "razor-go"`
+        ```
+        - targets: ["<second-host-address>:2112"]
+          labels:
+            staker: "<staker-name>"
+        ```
+    2. Restart vmagent service `docker-compose restart vmagent`
+#### Start monitoring stack
+-  You can spin all agents at once via
+
+    ```
+    docker-compose up -d
+    ``` 
+   Can check the status of each service via
+    ```
+    docker-compose ps
+    ```
+
+- You can open grafana at `<private/public address of host>:3000`, and get
+    1. Can checkout `Razor` dashboard to monitor your staker.
+    2. Insight of host metrics at `Node Exporter Full` dashboard.
+    3. Containers Insight at `Docker and OS metrics ( cadvisor, node_exporter )` dashboard.
+    4. Can monitor alerts at `Alertmanager` dashboard.
+
+>**_NOTE:_** Configure firewall for port `3000` on your host to access grafana.
+
+#### Troubleshoot Alerting
+
+1. In `docker-compose.yml` uncomment ports for `alertmanager` and `vmalert`.
+2. Configure firewall to allow access to ports `8880` and `9093`.
+
+3. Check you get alerts on vmalert via `http://<host_address>:8880/vmalert/alerts`. vmalert is configured to scrap in every 2min.
+
+4. If you see alert in vmalert then look into alertmanager `http://<host_address>:9093/#/alerts?`, if you see alerts in there but you didn't get one then probably you need to check your weebhook.
+
+#### Configuration
+
+Clone repo and setup monitoring and alerting using Prometheus/Grafana
+
+```
+git clone https://github.com/razor-network/monitoring.git
+cd monitoring
+```
+
+- If your staker is running via binary, then
+
+    1. In `./configs/prometheus.yml`, replace `"razor-go:2112"` with `"<private/public address of host>:2112"`
+
+- For alerting you can add webhook in `./configs/alertmanager.yml`, replace `http://127.0.0.1:5001/` with your webhook URL. This will send you an alert in every 5min if metrics stops.
+
+- If you are running multiple stakers and want to monitor via single grafana dashboard
+    1. You need to update `./config/prometheus.yml`, add new target block where `job_name: "razor-go"`
+       ```
+       - targets: ["<second-host-address>:2112"]
+         labels:
+           staker: "<staker-name>"
+       ```
+    2. Restart vmagent service `docker-compose restart vmagent`
 
 #### Start monitoring stack
 
@@ -762,10 +817,10 @@ cd monitoring
   ```
 
 - You can open grafana at `<private/public address of host>:3000`, and get
-  1. Can checkout `Razor` dashboard to monitor your staker.
-  2. Insight of host metrics at `Node Exporter Full` dashboard.
-  3. Containers Insight at `Docker and OS metrics ( cadvisor, node_exporter )` dashboard.
-  4. Can monitor alerts at `Alertmanager` dashboard.
+    1. Can checkout `Razor` dashboard to monitor your staker.
+    2. Insight of host metrics at `Node Exporter Full` dashboard.
+    3. Containers Insight at `Docker and OS metrics ( cadvisor, node_exporter )` dashboard.
+    4. Can monitor alerts at `Alertmanager` dashboard.
 
 > **_NOTE:_** Configure firewall for port `3000` on your host to access grafana.
 
@@ -785,7 +840,7 @@ You can override the existing job and also add your custom jobs by adding `asset
 
 Shown below is an example of how your `assets.json` file should be -
 
-```
+``` json
 {
   "assets": {
     "collection": {
@@ -951,7 +1006,7 @@ $ ./razor contractAddresses
 
 9. To Start **Voting**,
 
-   1. Provide password through **CLI**
+    1. Provide password through **CLI**
 
    ```bash
    # Run process in foreground and provide password through cli
 
@@ -2,12 +2,13 @@ package block
 
 import (
 	"context"
-	"github.com/ethereum/go-ethereum/core/types"
-	"github.com/ethereum/go-ethereum/ethclient"
-	"github.com/sirupsen/logrus"
 	"razor/core"
 	"sync"
 	"time"
+
+	"github.com/ethereum/go-ethereum/core/types"
+	"github.com/ethereum/go-ethereum/ethclient"
+	"github.com/sirupsen/logrus"
 )
 
 var latestBlock *types.Header
 
@@ -0,0 +1,93 @@
+package cache
+
+import (
+	"errors"
+	"sync"
+	"time"
+)
+
+var (
+	errDataNotInCache = errors.New("data not present in cache")
+)
+
+type cachedData struct {
+	Result            []byte
+	expireAtTimestamp int64
+}
+
+type LocalCache struct {
+	stop chan struct{}
+
+	wg   sync.WaitGroup
+	mu   sync.RWMutex
+	URLs map[string]cachedData //URLs
+}
+
+func NewLocalCache(cleanupInterval time.Duration) *LocalCache {
+	lc := &LocalCache{
+		URLs: make(map[string]cachedData),
+		stop: make(chan struct{}),
+	}
+
+	lc.wg.Add(1)
+	go func(cleanupInterval time.Duration) {
+		defer lc.wg.Done()
+		lc.cleanupLoop(cleanupInterval)
+	}(cleanupInterval)
+
+	return lc
+}
+
+func (lc *LocalCache) cleanupLoop(interval time.Duration) {
+	t := time.NewTicker(interval)
+	defer t.Stop()
+
+	for {
+		select {
+		case <-lc.stop:
+			return
+		case <-t.C:
+			lc.mu.Lock()
+			for url, cu := range lc.URLs {
+				if cu.expireAtTimestamp <= time.Now().Unix() {
+					delete(lc.URLs, url)
+				}
+			}
+			lc.mu.Unlock()
+		}
+	}
+}
+
+func (lc *LocalCache) StopCleanup() {
+	close(lc.stop)
+	lc.wg.Wait()
+}
+
+func (lc *LocalCache) Update(data []byte, url string, expireAtTimestamp int64) {
+	lc.mu.Lock()
+	defer lc.mu.Unlock()
+
+	lc.URLs[url] = cachedData{
+		Result:            data,
+		expireAtTimestamp: expireAtTimestamp,
+	}
+}
+
+func (lc *LocalCache) Read(url string) ([]byte, error) {
+	lc.mu.RLock()
+	defer lc.mu.RUnlock()
+
+	cacheData, ok := lc.URLs[url]
+	if !ok {
+		return []byte{}, errDataNotInCache
+	}
+
+	return cacheData.Result, nil
+}
+
+func (lc *LocalCache) Delete(url string) {
+	lc.mu.Lock()
+	defer lc.mu.Unlock()
+
+	delete(lc.URLs, url)
+}
@@ -0,0 +1,63 @@
+package client
+
+import (
+	"github.com/ethereum/go-ethereum/ethclient"
+	"razor/logger"
+	"reflect"
+	"time"
+)
+
+var (
+	log                   = logger.NewLogger()
+	alternateClientStruct AlternateClientStruct
+)
+
+type AlternateClientStruct struct {
+	switchToAlternateClient bool
+	alternateProvider       string
+}
+
+func StartTimerForAlternateClient(switchClientAfterTime uint64) {
+	log.Infof("StartTimerForAlternateClient: Alternate client will be switched back to primary client in %v seconds!", switchClientAfterTime)
+	time.Sleep(time.Duration(switchClientAfterTime) * time.Second)
+	log.Info("Switching back to primary RPC..")
+	SetSwitchToAlternateClientStatus(false)
+}
+
+//ReplaceClientWithAlternateClient will replace the primary client(client from primary RPC) with secondary client which would be created using alternate RPC
+func ReplaceClientWithAlternateClient(arguments []reflect.Value) []reflect.Value {
+	clientDataType := reflect.TypeOf((*ethclient.Client)(nil)).Elem()
+	for i := range arguments {
+		argument := arguments[i]
+		argumentDataType := reflect.TypeOf(argument.Interface()).Elem()
+		if argumentDataType != nil {
+			if argumentDataType == clientDataType {
+				alternateProvider := GetAlternateProvider()
+				alternateClient, dialErr := ethclient.Dial(alternateProvider)
+				if dialErr != nil {
+					log.Errorf("Error in connecting using alternate RPC %v: %v", alternateProvider, dialErr)
+					return arguments
+				}
+				arguments[i] = reflect.ValueOf(alternateClient)
+				return arguments
+			}
+		}
+	}
+	return arguments
+}
+
+func GetSwitchToAlternateClientStatus() bool {
+	return alternateClientStruct.switchToAlternateClient
+}
+
+func SetSwitchToAlternateClientStatus(status bool) {
+	alternateClientStruct.switchToAlternateClient = status
+}
+
+func GetAlternateProvider() string {
+	return alternateClientStruct.alternateProvider
+}
+
+func SetAlternateProvider(alternateProvider string) {
+	alternateClientStruct.alternateProvider = alternateProvider
+}