69 | Delegate 70 | 71 | 72 | {store?.delegate.username} 73 | 74 | 75 | distributes {system?.reward_percentage}% rewards to 76 | voters {system?.donate_percentage ? `and donates ${system?.donate_percentage}% to ADAMANT Foundation` : '' } with 77 | payouts every {system?.payoutperiod}. Minimum payout is {system?.minpayout} ADM. 78 |
79 | 80 |
10 | 
11 | 
12 |
15 | Calculate and transfer voters’ rewards automatically. 16 |
17 | 18 | 19 | 20 | - :rainbow: Easy to install 21 | - :handshake: Reliable, uses decentralized network advantages 22 | - :hammer_and_wrench: Customizable (using config file) 23 | - :scroll: History stored in local files (powered by [lowdb](https://github.com/typicode/lowdb)) 24 | - :rocket: Minimum server requirements: 1 vCPU and 512 MB of RAM 25 | - :carpentry_saw: You can setup the pool on a separate machine without a node 26 | - :chart_with_upwards_trend: Dashboard for voters with mobile version support 27 | - :bell: Notification system via ADAMANT or Slack for admin 28 | 29 | ## Installation 30 | 31 | ### Requirements 32 | 33 | - NodeJS v16+ (already installed if you have a node on your machine) 34 | 35 | ### Setup 36 | 37 | Clone the repository with pool into a newly created directory: 38 | 39 | ``` 40 | git clone https://github.com/Adamant-im/pool 41 | ``` 42 | 43 | Move to directory with the cloned repository: 44 | 45 | ``` 46 | cd pool 47 | ``` 48 | 49 | Install dependencies using npm or any other package manager: 50 | 51 | ``` 52 | npm install 53 | ``` 54 | 55 | Build a website: 56 | 57 | ``` 58 | npm run build:web 59 | ``` 60 | 61 | ### Pre-launch tuning 62 | 63 | Copy default config as `config.jsonc`: 64 | 65 | ``` 66 | cp config.default.jsonc config.jsonc 67 | ``` 68 | 69 | And edit that file by inserting the pool's secret phrase as the minimum configuration, e.g. using `nano`: 70 | 71 | ``` 72 | nano config.jsonc 73 | ``` 74 | 75 | > See comments in `config.default.jsonc` for more parameters. 76 | 77 | ### Migration from v2 78 | 79 | To migrate a database from v2 run the migration script with the specified path to the target pool or database: 80 | 81 | ```sh 82 | # or ~/adamant-pool/db 83 | $ node scripts/migrate.mjs ~/adamant-pool 84 | ``` 85 | 86 | In order for the changes to take effect, you will need to restart your pool. 87 | 88 | ## Launching 89 | 90 | You can start the pool using `npm` command: 91 | 92 | ``` 93 | npm run start 94 | ``` 95 | 96 | but we recommend to use a process manager to start the pool, f.e. [`pm2`](https://pm2.keymetrics.io/): 97 | 98 | ``` 99 | pm2 start ./scripts/start.sh --name "adamantpool" 100 | ``` 101 | 102 | ## Add pool to cron 103 | 104 | Edit crontab file using the command below: 105 | 106 | ``` 107 | crontab -e 108 | ``` 109 | 110 | and paste the string: 111 | 112 | ``` 113 | @reboot cd /home/adamant/pool && pm2 start /home/adamant/pool/scripts/start.sh --name "adamantpool" 114 | ``` 115 | 116 | ## Contribution 117 | 118 | Please have a look at the [CONTRIBUTING.md](./.github/CONTRIBUTING.md) 119 | -------------------------------------------------------------------------------- /server/src/helpers/config/reader.js: -------------------------------------------------------------------------------- 1 | import jsonminify from 'jsonminify'; 2 | import keys from 'adamant-api/src/helpers/keys.js'; 3 | import fs from 'fs'; 4 | 5 | import {join, dirname} from 'path'; 6 | import {fileURLToPath} from 'url'; 7 | 8 | import validateConfig from './validate.js'; 9 | import configSchema from './schema.js'; 10 | 11 | import {MIN_PAYOUT} from '../const.js'; 12 | 13 | const __dirname = dirname(fileURLToPath(import.meta.url)); 14 | 15 | const {version} = JSON.parse( 16 | fs.readFileSync(join(__dirname, '../../../../package.json'), 'utf-8'), 17 | ); 18 | 19 | const getFullConfigPath = (configPath) => ( 20 | join(__dirname, '../../../../', configPath) 21 | ); 22 | 23 | const loadConfig = (configPath) => { 24 | return JSON.parse(jsonminify( 25 | fs.readFileSync(getFullConfigPath(configPath), 'utf-8'), 26 | )); 27 | }; 28 | 29 | let config = loadConfig('config.default.jsonc'); 30 | 31 | const configPaths = [ 32 | './config.test.jsonc', 33 | './config.jsonc', 34 | './config.json', 35 | ]; 36 | 37 | let loadedConfigPath; 38 | 39 | for (const configPath of configPaths) { 40 | if (fs.existsSync(getFullConfigPath(configPath))) { 41 | try { 42 | const loadedConfig = loadConfig(configPath); 43 | 44 | config = { 45 | ...config, 46 | ...loadedConfig, 47 | }; 48 | 49 | loadedConfigPath = configPath; 50 | 51 | break; 52 | } catch (error) { 53 | exit(`Cannot parse or read config file ${configPath}. Error:`, error); 54 | } 55 | } 56 | } 57 | 58 | config.version = version; 59 | 60 | if (!config.node_ADM) { 61 | exit(`Pool's config is wrong. ADM nodes are not set. Cannot start Pool.`); 62 | } 63 | 64 | if (!config.passPhrase) { 65 | exit(`Pool's config is wrong. No passPhrase. Cannot start Pool.`); 66 | } 67 | 68 | let keysPair; 69 | 70 | try { 71 | keysPair = keys.createKeypairFromPassPhrase(config.passPhrase); 72 | } catch (error) { 73 | exit('Pool\'s config is wrong. Invalid passPhrase. Cannot start Pool. Error: ', error); 74 | } 75 | 76 | const address = keys.createAddressFromPublicKey(keysPair.publicKey); 77 | 78 | config.publicKey = keysPair.publicKey.toString('hex'); 79 | config.address = address; 80 | 81 | const errorMessage = validateConfig(config, configSchema); 82 | 83 | if (errorMessage) { 84 | exit(errorMessage); 85 | } 86 | 87 | if (config.minpayout < MIN_PAYOUT) { 88 | exit(`Pool's ${address} config is wrong. Parameter minpayout cannot be less, than ${MIN_PAYOUT} (ADM). Cannot start Pool.`); 89 | } 90 | 91 | config.poolsShare = 100 - config.reward_percentage - config.donate_percentage; 92 | 93 | if (config.poolsShare < 0) { 94 | exit(`Pool's ${address} config is wrong. reward_percentage + donate_percentage must be <= 100. Cannot start Pool.`); 95 | } 96 | 97 | config.payoutperiod = config.payoutperiod[0].toUpperCase() + config.payoutperiod.slice(1).toLowerCase(); 98 | 99 | console.info(`Pool ${address} successfully read a config-file (${loadedConfigPath ? loadedConfigPath : 'default'}).`); 100 | 101 | function exit(...errorMessages) { 102 | console.error(...errorMessages); 103 | process.exit(-1); 104 | } 105 | 106 | export default config; 107 | -------------------------------------------------------------------------------- /server/src/helpers/utils.js: -------------------------------------------------------------------------------- 1 | import {SAT, EPOCH} from './const.js'; 2 | 3 | function replaceWithDate(text, dateObject) { 4 | return text.replace(/{([a-zA-Z_]*)}/g, (_, digit) => dateObject[digit]); 5 | } 6 | 7 | export default { 8 | /** 9 | * Strict object type check. Only returns true 10 | * for plain JavaScript objects. 11 | * @param {any} val Value to check 12 | * @return {boolean} 13 | */ 14 | isPlainObject(val) { 15 | const _toString = Object.prototype.toString; 16 | 17 | return _toString.call(val) === '[object Object]'; 18 | }, 19 | 20 | /** 21 | * Converts provided `time` to ADAMANT's epoch timestamp 22 | * @param {number=} time timestamp to convert 23 | * @return {number} 24 | */ 25 | epochTime(time) { 26 | if (!time) { 27 | time = Date.now(); 28 | } 29 | 30 | return Math.floor((time - EPOCH) / 1000); 31 | }, 32 | 33 | /** 34 | * Converts ADAMANT's epoch timestamp to a Unix timestamp 35 | * @param {number} epochTime timestamp to convert 36 | * @return {number} 37 | */ 38 | toTimestamp(epochTime) { 39 | return epochTime * 1000 + EPOCH; 40 | }, 41 | 42 | satsToADM(sats, decimals = 8) { 43 | const adm = (+sats / SAT).toFixed(decimals); 44 | 45 | return adm; 46 | }, 47 | 48 | unix() { 49 | return Date.now(); 50 | }, 51 | 52 | /** 53 | * Formats unix timestamp to string 54 | * @param {number} timestamp Timestamp to format 55 | * @return {object} Contains different formatted strings 56 | */ 57 | formatDate(timestamp) { 58 | if (!timestamp) { 59 | return false; 60 | } 61 | 62 | const dateObject = new Date(timestamp); 63 | 64 | const formattedDate = { 65 | year: dateObject.getFullYear(), 66 | month: dateObject.getMonth() + 1, 67 | date: dateObject.getDate(), 68 | hours: dateObject.getHours(), 69 | minutes: dateObject.getMinutes(), 70 | seconds: dateObject.getSeconds(), 71 | }; 72 | 73 | for (const digit in formattedDate) { 74 | if ({}.hasOwnProperty.call(formattedDate, digit)) { 75 | formattedDate[digit] = String(formattedDate[digit]).padStart(2, '0'); 76 | } 77 | } 78 | 79 | formattedDate.YYYY_MM_DD = replaceWithDate('{year}-{month}-{date}', formattedDate); 80 | formattedDate.YYYY_MM_DD_hh_mm = replaceWithDate('{YYYY_MM_DD} {hours}:{minutes}', formattedDate); 81 | formattedDate.hh_mm_ss = replaceWithDate('{hours}:{minutes}:{seconds}', formattedDate); 82 | 83 | return formattedDate; 84 | }, 85 | 86 | thousandSeparator(num, doBold) { 87 | const parts = (num + '').split('.'); 88 | const main = parts[0]; 89 | const len = main.length; 90 | let output = ''; 91 | let i = len - 1; 92 | 93 | while (i >= 0) { 94 | output = main.charAt(i) + output; 95 | if ((len - i) % 3 === 0 && i > 0) { 96 | output = ' ' + output; 97 | } 98 | --i; 99 | } 100 | if (parts.length > 1) { 101 | if (doBold) { 102 | output = `**${output}**.${parts[1]}`; 103 | } else { 104 | output = `${output}.${parts[1]}`; 105 | } 106 | } 107 | return output; 108 | }, 109 | 110 | getPrecision(decimals) { 111 | return +(Math.pow(10, -decimals).toFixed(decimals)); 112 | }, 113 | 114 | getModuleName(id) { 115 | let n = id.lastIndexOf('\\'); 116 | 117 | if (n === -1) { 118 | n = id.lastIndexOf('/'); 119 | } 120 | 121 | if (n === -1) { 122 | return ''; 123 | } else { 124 | return id.substring(n + 1); 125 | } 126 | }, 127 | }; 128 | -------------------------------------------------------------------------------- /server/tests/modules/reward_distributor.test.js: -------------------------------------------------------------------------------- 1 | import {jest} from '@jest/globals'; 2 | import {config} from '../../src/helpers/index.js'; 3 | import {dbVoters, dbBlocks} from '../../src/helpers/DB.js'; 4 | 5 | jest.unstable_mockModule('../../src/modules/store.js', () => ({ 6 | __esModule: true, 7 | default: { 8 | delegate: { 9 | votesWeight: 100000, 10 | productivity: 100, 11 | voters: [ 12 | { 13 | username: 'test', 14 | address: config.address, 15 | publicKey: config.publicKey, 16 | balance: '50000', 17 | votesCount: 2, 18 | }, 19 | { 20 | username: 'thunder', 21 | address: 'U3247657843720097949', 22 | publicKey: 'fc7151dcc08bda712c075fbfc524e10828bbbaad56ac4001cd3f5a9b93b2ea27', 23 | balance: '5000', 24 | votesCount: 50, 25 | }, 26 | ], 27 | }, 28 | }, 29 | })); 30 | 31 | const RewardDistributor = (await import('../../src/modules/distribute_rewards.js')).default; 32 | 33 | const mockBlock = { 34 | id: 1, 35 | totalForged: 1000, 36 | height: 666, 37 | }; 38 | 39 | describe('RewardDistributor.distribute', () => { 40 | beforeEach(async () => { 41 | dbVoters.data = {values: []}; 42 | await dbVoters.write(); 43 | 44 | dbBlocks.data = {values: []}; 45 | await dbBlocks.write(); 46 | }); 47 | 48 | describe('when config.considerownvote === false', () => { 49 | it('should not consider own vote', () => { 50 | const rewardDistributor = new RewardDistributor(mockBlock); 51 | 52 | const findOwnVote = () => ( 53 | rewardDistributor.voters.find((voter) => voter.address === config.address) 54 | ); 55 | 56 | rewardDistributor.disregardOwnVote(); 57 | 58 | expect(rewardDistributor.votesWeight).toBe(75000); 59 | expect(findOwnVote()).toBeUndefined(); 60 | }); 61 | }); 62 | 63 | it('should distribute rewards for voter', async () => { 64 | const rewardDistributor = new RewardDistributor(mockBlock); 65 | 66 | await dbBlocks.insert(mockBlock); 67 | 68 | const mockVoter = { 69 | address: config.address, 70 | votesCount: 10, 71 | balance: '1000000', 72 | }; 73 | 74 | await rewardDistributor.distributeForVoter(mockVoter); 75 | 76 | expect(rewardDistributor.distributed).toStrictEqual({ 77 | votersCount: 1, 78 | rewardsADM: 0.000008, 79 | percent: 80, 80 | }); 81 | expect(rewardDistributor.isDistributionComplete).toBe(true); 82 | }); 83 | }); 84 | 85 | describe('RewardDistributor.findOrCreateVoter', () => { 86 | beforeEach(() => { 87 | dbVoters.data = {values: []}; 88 | return dbVoters.write(); 89 | }); 90 | 91 | const rewardDistributor = new RewardDistributor(mockBlock); 92 | const mockVoter = {address: config.address}; 93 | 94 | describe('when there is no saved voter', () => { 95 | it('should create a new voter and return it', async () => { 96 | const voter = await rewardDistributor.findOrCreateVoter(mockVoter); 97 | 98 | const savedVoter = await dbVoters.findOne(mockVoter); 99 | 100 | expect(voter).toStrictEqual({ 101 | ...mockVoter, 102 | pending: 0, 103 | received: 0, 104 | }); 105 | expect(savedVoter).toStrictEqual(voter); 106 | }); 107 | }); 108 | 109 | describe('when there is saved voter', () => { 110 | it('should return saved voter', async () => { 111 | await dbVoters.insert({...mockVoter, pending: 1, received: 0}); 112 | 113 | const voter = await rewardDistributor.findOrCreateVoter(mockVoter); 114 | 115 | expect(voter).toStrictEqual({ 116 | ...mockVoter, 117 | pending: 1, 118 | received: 0, 119 | }); 120 | }); 121 | }); 122 | }); 123 | -------------------------------------------------------------------------------- /web/src/lib/TransactionTable.svelte: -------------------------------------------------------------------------------- 1 | 29 | 30 |