Merge pull request #85 from signum-network/develop

Web app refresh

Author: jjos2372

.DS_Store

@@ -132,3 +132,4 @@ bin/
 /logging.xml
 /pool.properties
 /jooq-schema.mv.db
+.DS_Store

.gitignore

@@ -4,6 +4,7 @@ An open-source, fair, and auditable Signum mining pool software where miners can
 
 ## Features
 
+-   Accounts can join your pool using the [Signum XT Wallet](https://github.com/signum-network/signum-xt-wallet).
 -   PoC+ boost calculated by the pool using recent deadlines (no boost drops)
 -   Pool can be audited by API (all information is available to the public)
 -   Miners can set individually their _share model_
@@ -12,7 +13,7 @@ An open-source, fair, and auditable Signum mining pool software where miners can
 -   Payouts by multi-out transactions with the current _standard_ fee (variable)
 -   Support for multiple pool IDs (a primary and many secondaries)
 
-![image](https://user-images.githubusercontent.com/31958515/122991794-d0a75f00-d37b-11eb-9d1a-71ae44b144c6.png)
+![image](https://user-images.githubusercontent.com/35440957/166112978-39c80bee-af6c-4f4d-b41c-881d2b263d23.png)
 
 ## Pool shares
 
@@ -46,32 +47,52 @@ multiple _secondary_ IDs.
 Whenever a _secondary_ ID forges a block, its balance is transfered automatically to the primary ID so it can manage
 the payments.
 
-Check a [testnet live demo](http://nivbox.co.uk:9000) to check on the latest development version.
+## Authors
 
-Originally by [Harry1453](https://github.com/harry1453),
-updated by [jjos](https://github.com/jjos2372).
+* Originally by [Harry1453](https://github.com/harry1453)
+* Updated by [jjos](https://github.com/jjos2372)
+* Web application by [ipr0310](https://github.com/ipr0310)
 
-Donations are very welcome at [S-JJQS-MMA4-GHB4-4ZNZU](https://explorer.burstcoin.network/?action=account&account=3278233074628313816).
+## Donations are very welcome
+
+* Harry1453-[S-HARR-YJSD-6JL2-9RE46](https://explorer.signum.network/address/8217266070159336183)
+* jjos-[S-JJQS-MMA4-GHB4-4ZNZU](https://explorer.signum.network/address/3278233074628313816)
+* ipr0310-[S-36WQ-GYQN-D856-9DUJH](https://explorer.signum.network/address/8629824288351884182)
+
+## Demo
+
+-   http://testnet.btfg.space:9000
 
 ## Pools using the software
 
--   http://spacepool.btfg.space
+-   http://spacepool.lmsi.club/
 -   https://pool.signumcoin.ro
 -   http://signa.voiplanparty.com:8124
--   http://openburstpool.ddns.net:8126
--   http://signumpool.de:8080
+-   http://opensignumpool.ddns.net:8126
+-   http://signumpool.de:8080/
 -   https://signumpool.com
 -   https://signapool.notallmine.net
 -   https://fomplopool.com
 -   http://signum.land
--   https://signum.space
+
+## Powered by
+-   [Signum](https://github.com/signum-network/signum-node)
+-   [SignumJS](https://github.com/signum-network/signumjs)
+-   [React](https://reactjs.org/)
+-   [MUI](https://mui.com/)
 
 ## Requirements
 
 -   [Synced Signum node](https://github.com/signum-network/signum-node)
 -   Java 64 Bits version 8 or 11
 -   MariaDB (Optional, but recommended for advanced users)
 
+## XT Wallet integration
+
+ In order to be able to use the XT wallet module. For security reasons the pool website must be on **HTTPS** or localhost
+ 
+<img src="https://user-images.githubusercontent.com/35440957/168082091-3480557d-8bdd-455b-88f5-f0ed8d1ff87e.png" width="100" height="50">
+
 ## Installation
 
 -   [Download The Latest Release](https://github.com/signum-network/signum-pool/releases/latest)

README.md

@@ -20,7 +20,7 @@ nodeAddresses = http://localhost:8125;
 poolName = SIGNUM POOL
 
 # The URL miners should point their miner to
-miningURL = http://nivbox.co.uk:9000
+miningURL = http://testnet.btfg.space:9000
 
 # The passphrase of the pool account
 passphrase = YOUR POOL PASSPHRASE GOES HERE
@@ -104,19 +104,20 @@ site.root = ./html/
 site.miningGuide = https://signum.network/mining.html
 
 # The public node that the site will link to
-site.nodeAddress = https://wallet.burst-alliance.org:8125/index.html
-#site.nodeAddress = https://testnet-2.burst-alliance.org:6876/index.html
+# Keep the node URL formatted as the following examples
+site.nodeAddress = https://europe.signum.network
+#site.nodeAddress = https://europe3.testnet.signum.network
 
 # The discord URL that the site will link to
 site.discord = https://discord.gg/V437QK4nKQ
 
 # The explorer URL
-site.explorer = https://explorer.signum.network/
+site.explorer = https://explorer.signum.network
 site.explorerAccount = ?action=account&account=
 
 # The faucet URL (if you want to privide some)
-# site.faucet = http://faucet.burst-alliance.org/
-# site.faucet = http://nivbox.co.uk:7777/
+# site.faucet = http://faucet.burst-alliance.org
+# site.faucet = http://nivbox.co.uk:7777
 
 # The title, as displayed on the site
 site.title = SIGNUM POOL
@@ -159,7 +160,9 @@ site.showTradingLink = YES
 site.miniTradingLink = https://bit.ly/2UEd4RB
 site.largeTradingLink = https://bit.ly/3A5BIep
 
-site.price = https://min-api.cryptocompare.com/data/price?fsym=SIGNA&tsyms=USD
+site.price = https://api.coingecko.com/api/v3/simple/price?ids=signum&vs_currencies=usd
 
-# Your google tracking ID, if some
-#site.googleTrackingID = UA-ADFASDFS
+#Google Tracking ID, optional
+#Example of Tracking ID: G-XXXXXX
+#DO NOT USE THE DEPRECATED UNIVERSAL ANALYTICS PROPERTY, EXAMPLE: UA-XXXXX (DO NOT USE IT)
+#site.googleTrackingID = G-XXXXX

dist/pool.properties

@@ -4,14 +4,12 @@
 /node_modules
 /.pnp
 .pnp.js
-package-lock.json
 
 # testing
 /coverage
 
 # production
 /build
-build.rar
 
 # misc
 .DS_Store
@@ -23,11 +21,3 @@ build.rar
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-
-#vscode
-/.vscode
-
-#serverless
-.serverless
-serverless.yml
-/package-lock.json

react-pool/.env

@@ -1,43 +1,53 @@
 # Welcome to Signum's Pool website
 
-_Maybe you will find helpful tips_
+### Featured tools
+- [SignumJS](https://github.com/signum-network/signumjs)
+- [React](https://reactjs.org/)
+- [Redux Toolkit](https://redux-toolkit.js.org/)
+- [MUI](https://mui.com/)
+- [useSWR](https://swr.vercel.app/)
 
-## How to use testing or production mode 📋
+## How to use Development or Production mode 📋
 
--   **Testing mode refers to the "development enviroment"**
+-   **Development mode refers to the "development enviroment"**
 
-    > Testing mode will fetch data from a remote pool server
+    > Development mode will fetch data from a remote pool server
 
-    > **Example: you can fetch data from different pools by just changing the variable TEST_NODE in globalParameters.js**
+    > **Example: you can fetch data from different pools by just changing the variable isDevelopmentMode in enviroments/index.ts**
 
 -   **Production mode refers to the "production enviroment"**
 
     > Production mode will fetch data from the local pool server which you will host the web app
 
-Per default the testing mode is activated automatically when running `npm start`, but `npm run build` activates production mode
+Per default the Development mode is activated automatically when running `npm start`, but `npm run build` activates Production mode
 
-> _If you need - for whatever reasons - to develop on production mode you need to override the "useTestNet" variable_
+> _If you need - for whatever reasons - to develop on production mode you need to override the "isDevelopmentMode" variable_
 
-> The variable useTestnet also refers to the "development enviroment"
-
--   Go to the folder src/utils/
--   You will find the file "globalParameter.js"
--   Find the variable "useTestNet"
+-   Go to the file "enviroments/index.ts"
+-   You will find the variable "isDevelopmentMode"
 
     -   If that variable is equal to true, the website will fetch data from a remote pool node **you can change the url**
     -   If that variable is equal to false, the website will fetch data from your local pool node!
 
-> The variable "useTestNet" is assigned correspondingly, so it's not necessary to override it
+> The variable "isDevelopmentMode" is assigned correspondingly, so it's not necessary to override it
+
+## How to use pool in Testnet or Mainet network 📋
+
+-   **The isTestNet variable refers to the network which may be used**
+
+    > **Example: you can host your pool in the Testnet or Mainnet network by modifying the variable isTestNet in enviroments/index.ts**
+
+> The variable "isTestNet" is assigned correspondingly, so it's not necessary to override it
 
 ## Commands for deployment 🛠️
 
 _Use this commands if you are going to deploy changes or start the deployment_
 
--   If you have not installed the dependencies, run "npm install", if there is already a folder called "node_modules", forget this step
--   npm run build - Build project's production site
--   After the build command has finished, you will only need the folder "Build"
--   Only use the folder "Build", you can deploy the production app in your pool node
--   Always serve the file index.html
+-   If you have not installed the dependencies, run `npm install`, if there is already a folder called `/node_modules`, forget this step
+-   `npm run build` - Build project's production site
+-   After the build command has finished, you will only need the folder `/Build`
+-   You will need to move the files from  `/Build` folder to the `/html` folder, in the production app of your pool node
+-   Always serve the file `index.html`
 
 ## Available Languages 🌐
 
@@ -48,7 +58,6 @@ Discover the available languages you can set by default or users can freely choo
 -   `es` Spanish
 -   `de` Deutsche
 -   `it` Italiano
--   `kr` Korean
 -   `pt` Português
 -   `tr` Türk
 -   `nl` Nederlands
@@ -58,6 +67,19 @@ Discover the available languages you can set by default or users can freely choo
 
 > `code` -> language name
 
+
+## How to load specific language from URL 🌐
+
+If you want to share a link with some miners which talks a specific language, you can just add the following get parameter in the URL.
+Make sure that you assign a available language.
+
+> **lang=ru**
+
+> Example #1: **http://poolUrlExample.com/?lang=ru**
+
+> Example #2: **http://poolUrlExample.com/randomRoute/?random=true&lang=ru**
+
+
 ## How to implement extra links on your header 🕹️
 
 If you want extra links to be put in your header, you must go to the file `pool.properties` and find and customize the variable `extraMenuItems`
@@ -112,16 +134,17 @@ If you want your pool website to be shown on iframes, you can just add the follo
 ## How to use Google Analytics (Optional)
 
 -   Go to Google Analytics website and if you’re first time user, you’ll asked to set up an account including your data sharing settings.
--   Create a new property — remember to select the Universal Analytics property option. You have the options to create UA, or GA4 or both properties.
--   Fill up the remaining information for setting up your account and properties; and then you’ll get the tracking ID (e.g. UA-123456789–1)
--   Once you get the Tracking ID, you just need to assign that value in the variable "GOOGLETRACKINGID"
+-   Create a new property
+-   Add a ``Web Data Stream``
+-   Fill up the remaining information for setting up your ``web data stream``. Then you’ll get the tracking ID (e.g. G-XXXXXX)
+-   Once you get the Tracking ID, you just need to assign that value in the variable `GOOGLETRACKINGID`
 -   If you do not want google analytics, just leave the variable empty
 
-> Example of a tracking ID: **UA-200778790-1**
+> Example of a tracking ID: **G-XXXXXXX**
 
-## URL used for embed in trading viewer page
+> **DO NOT USE THE DEPRECATED UNIVERSAL ANALYTICS PROPERTY, EXAMPLE: UA-XXXXX**
 
-_I used bitly.com for shortening these links, the first link is the mini widget, and the second one is the large widget_
+## URL used for embed in trading viewer page
 
 -   https://s.tradingview.com/embed-widget/tickers/?locale=en#%7B%22symbols%22%3A%5B%7B%22description%22%3A%22BTC%2FSIGNA%22%2C%22proName%22%3A%22BITTREX%3ASIGNABTC%22%7D%2C%7B%22description%22%3A%22SIGNA%2FUSD%22%2C%22proName%22%3A%22BITTREX%3ASIGNAUSD%22%7D%5D%2C%22colorTheme%22%3A%22dark%22%2C%22isTransparent%22%3Afalse%2C%22showSymbolLogo%22%3Atrue%2C%22width%22%3A%22100%25%22%2C%22height%22%3A104%2C%22utm_source%22%3A%22www.tradingview.com%22%2C%22utm_medium%22%3A%22widget_new%22%2C%22utm_campaign%22%3A%22tickers%22%7D