pool/config.default.jsonc at dev · Adamant-im/pool · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
{
  /**
    List of nodes used to fetch forging information.
    If one node becomes unavailable, the pool will use a healthy one.
  **/
  "node_ADM": [
    "https://bid.adamant.im",
    "http://localhost:36666",
    "https://endless.adamant.im",
    "https://debate.adamant.im",
    "https://sunshine.adamant.im"
  ],

  /**
    The pool's secret phrase. The pool's ADM address/account will correspond to this passPhrase.
    The account should be a delegate of the ADAMANT blockchain.

    Two accepted forms:
      1. A plain passphrase (not recommended; kept for compatibility).
      2. An operator-encrypted passphrase (recommended). Generate it with:
           npm run adm-pool encrypt
         and paste the resulting "admpool-enc-v1...." string here.

    With an encrypted passphrase the pool boots LOCKED: block sync, the web UI,
    and the public API all work, but payouts and ADM notifications are paused
    until you unlock it:
      - In a terminal, the pool prompts for the operator password on start.
      - Under pm2/systemd (no terminal), the pool keeps running LOCKED; unlock it with:
           npm run adm-pool unlock
    Other commands: `adm-pool status`, `adm-pool lock`.
  **/
  "passPhrase": "",

  /**
    Path to the local control socket used by the `adm-pool` CLI to unlock/lock/
    inspect the running pool. Leave empty to use a default derived from the port
    (in the system temp directory).
  **/
  "controlSocket": "",

  /** Percentage of rewards to distribute to voters **/
  "reward_percentage": 80,

  /** Percentage of rewards to donate to the ADAMANT developer community **/
  "donate_percentage": 0,

  /**
    Wallet for donation.
    Make sure it's the same as on https://adamant.im/donate
  **/
  "donatewallet": "U380651761819723095",

  /**
    Maintenance wallet to receive (100 - reward_percentage - donate_percentage) rewards.
    To keep this share on the pool wallet, set this value to an empty string.
  **/
  "maintenancewallet": "",

  /**
    How often the pool processes payouts. All schedules run at 00:00.
    1d -> every day
    5d -> days 1, 5, 10, 15, 20, 25 of the month
    10d -> days 1, 10, 20 of the month
    15d -> days 1, 15 of the month
    30d -> 30th of each month
    Mon, Tue, Wed, Thu, Fri, Sat or Sun -> every week
  **/
  "payoutperiod": "Sun",

  /**
    Minimum amount in ADM for a payout. Must not be lower than 0.51.
    If a voter's reward is lower than minpayout at the end of a payout period, it remains pending for the next period.
    Voter pays a transaction fee.
  **/
  "minpayout": 10,

  /** Whether to include the delegate's own vote in reward distribution **/
  "considerownvote": false,

  /**
    ADAMANT address for monitoring notifications.
    Note: sending an ADAMANT message is signed with the pool passphrase, so while
    the pool is LOCKED (encrypted passphrase not yet unlocked) ADM notifications
    are paused — including the "payouts are locked" alert itself. If you use an
    encrypted passphrase, also configure `slack` below (it does not need the
    passphrase) so you still receive lock alerts.
  **/
  "adamant_notify": "",

  /** Slack key for monitoring notifications (works even while the pool is locked) **/
  "slack": "",

  /**
    The software will use verbosity according to log_level.
    Supported levels: none < error < warn < info < log < debug.
  **/
  "log_level": "log",

  /** Port for pool's public Web panel **/
  "port": 36667,

  /**
    Express server CORS configuration.
    The API is public and read-only, so `credentials` is false by default.
    Only set `credentials` to true together with a specific (non-"*") `origin`;
    a wildcard origin with credentials is an invalid combination browsers reject.
  **/
  "cors": {
    "origin": "*",
    "credentials": false
  },

  /** MongoDB connection parameters **/
  "mongodb": {
    "uri": "mongodb://localhost:27017",
    "dbName": "adamant-pool"
  }
}