· 6 years ago · Sep 13, 2019, 05:22 PM
1config-database.properties
2==========================
3
4.. csv-table::
5 :header: "Property", "Type", "Description", "Default"
6 :delim: ;
7
8 **database**; ; ;
9 databaseUri; string; Database uri.; mongodb://127.0.0.1:27017
10 databaseName; string; Database name.; catapult
11 maxWriterThreads; uint32_t; Maximum number of database writer threads.; 8
12 **plugins**; ; ;
13 catapult.mongo.plugins.accountlink; ; ; true
14 catapult.mongo.plugins.aggregate; ; ; true
15 catapult.mongo.plugins.lockhash; ; ; true
16 catapult.mongo.plugins.locksecret; ; ; true
17 catapult.mongo.plugins.metadata; ; ; true
18 catapult.mongo.plugins.mosaic; ; ; true
19 catapult.mongo.plugins.multisig; ; ; true
20 catapult.mongo.plugins.namespace; ; ; true
21 catapult.mongo.plugins.restrictionaccount; ; ; true
22 catapult.mongo.plugins.restrictionmosaic; ; ; true
23 catapult.mongo.plugins.transfer; ; ; true
24
25config-extensions-broker.properties
26===================================
27
28.. csv-table::
29 :header: "Property", "Type", "Description", "Default"
30 :delim: ;
31
32 **extensions**; ; ;
33 extension.addressextraction; ; ; true
34 extension.mongo; ; ; true
35 extension.zeromq; ; ; true
36 extension.hashcache; ; ; true
37
38config-extensions-recovery.properties
39=====================================
40
41.. csv-table::
42 :header: "Property", "Type", "Description", "Default"
43 :delim: ;
44
45 **extensions**; ; ;
46 extension.addressextraction; ; ; false
47 extension.mongo; ; ; false
48 extension.zeromq; ; ; false
49 extension.hashcache; ; ; true
50
51config-extensions-server.properties
52===================================
53
54.. csv-table::
55 :header: "Property", "Type", "Description", "Default"
56 :delim: ;
57
58 **extensions**; ; ;
59 extension.filespooling; ; ; false
60 extension.partialtransaction; ; ; false
61 extension.addressextraction; ; ; false
62 extension.mongo; ; ; false
63 extension.zeromq; ; ; false
64 extension.eventsource; ; ; true
65 extension.harvesting; ; ; true
66 extension.syncsource; ; ; true
67 extension.diagnostics; ; ; true
68 extension.hashcache; ; ; true
69 extension.networkheight; ; ; true
70 extension.nodediscovery; ; ; true
71 extension.packetserver; ; ; true
72 extension.pluginhandlers; ; ; true
73 extension.sync; ; ; true
74 extension.timesync; ; ; true
75 extension.transactionsink; ; ; true
76 extension.unbondedpruning; ; ; true
77
78config-harvesting.properties
79============================
80
81.. csv-table::
82 :header: "Property", "Type", "Description", "Default"
83 :delim: ;
84
85 **harvesting**; ; ;
86 harvesterPrivateKey; string; Harvester private key.;
87 enableAutoHarvesting; bool; Set to true if auto harvesting is enabled.; false
88 maxUnlockedAccounts; uint32_t; Maximum number of unlocked accounts.; 5
89 delegatePrioritizationPolicy; harvesting::DelegatePrioritizationPolicy; Delegate harvester prioritization policy.; Importance
90 beneficiaryPublicKey; string; Public key of the account receiving part of the harvested fee.; 0000000000000000000000000000000000000000000000000000000000000000
91
92config-inflation.properties
93===========================
94
95.. csv-table::
96 :header: "Property", "Type", "Description", "Default"
97 :delim: ;
98
99 **inflation**; ; ;
100 starting-at-height-1; ; ; 100
101 starting-at-height-10000; ; ; 0
102
103config-logging-broker.properties
104================================
105
106.. csv-table::
107 :header: "Property", "Type", "Description", "Default"
108 :delim: ;
109
110 **console**; ; ;
111 sinkType; utils::LogSinkType; Log sink type.; Sync
112 level; utils::LogLevel; Log level.; Info
113 colorMode; utils::LogColorMode; Console color mode.; Ansi
114 **console.component.levels**; ; ;
115 **file**; ; ;
116 sinkType; utils::LogSinkType; Log sink type.; Async
117 level; utils::LogLevel; Log level.; Debug
118 directory; string; Log file directory.; logs
119 filePattern; string; Log file pattern.; catapult_recovery%4N.log
120 rotationSize; utils::FileSize; File rotation size.; 25MB
121 maxTotalSize; utils::FileSize; Maximum size of all log files.; 2500MB
122 minFreeSpace; utils::FileSize; Minimum size of free disk space in order to create log files.; 100MB
123 **file.component.levels**; ; ;
124
125config-logging-recovery.properties
126==================================
127
128.. csv-table::
129 :header: "Property", "Type", "Description", "Default"
130 :delim: ;
131
132 **console**; ; ;
133 sinkType; utils::LogSinkType; Log sink type.; Sync
134 level; utils::LogLevel; Log level.; Info
135 colorMode; utils::LogColorMode; Console color mode.; Ansi
136 **console.component.levels**; ; ;
137 **file**; ; ;
138 sinkType; utils::LogSinkType; Log sink type.; Async
139 level; utils::LogLevel; Log level.; Debug
140 directory; string; Log file directory.; logs
141 filePattern; string; Log file pattern.; catapult_recovery%4N.log
142 rotationSize; utils::FileSize; File rotation size.; 25MB
143 maxTotalSize; utils::FileSize; Maximum size of all log files.; 2500MB
144 minFreeSpace; utils::FileSize; Minimum size of free disk space in order to create log files.; 100MB
145 **file.component.levels**; ; ;
146
147config-logging-server.properties
148================================
149
150.. csv-table::
151 :header: "Property", "Type", "Description", "Default"
152 :delim: ;
153
154 **console**; ; ;
155 sinkType; utils::LogSinkType; Log sink type.; Sync
156 level; utils::LogLevel; Log level.; Info
157 colorMode; utils::LogColorMode; Console color mode.; Ansi
158 **console.component.levels**; ; ;
159 **file**; ; ;
160 sinkType; utils::LogSinkType; Log sink type.; Async
161 level; utils::LogLevel; Log level.; Info
162 directory; string; Log file directory.; logs
163 filePattern; string; Log file pattern.; catapult_server%4N.log
164 rotationSize; utils::FileSize; File rotation size.; 25MB
165 maxTotalSize; utils::FileSize; Maximum size of all log files.; 2500MB
166 minFreeSpace; utils::FileSize; Minimum size of free disk space in order to create log files.; 100MB
167 **file.component.levels**; ; ;
168
169config-messaging.properties
170===========================
171
172.. csv-table::
173 :header: "Property", "Type", "Description", "Default"
174 :delim: ;
175
176 **messaging**; ; ;
177 subscriberPort; unsigned short; Subscriber port.; 7902
178
179config-network.properties
180=========================
181
182.. csv-table::
183 :header: "Property", "Type", "Description", "Default"
184 :delim: ;
185
186 **network**; ; ;
187 identifier; NetworkIdentifier; Network identifier.; mijin-test
188 publicKey; Key; Nemesis public key.; B4F12E7C9F6946091E2CB8B6D3A12B50D17CCBBF646386EA27CE2946A7423DCF
189 generationHash; catapult::GenerationHash; Nemesis generation hash.; 57F7DA205008026C776CB6AED843393F04CD458E0AA2D9F1D5F31A402072B2D6
190 **chain**; ; ;
191 enableVerifiableState; bool; Set to true if block chain should calculate state hashes so that state is fully verifiable at each block.; true
192 enableVerifiableReceipts; bool; Set to true if block chain should calculate receipts so that state changes are fully verifiable at each block.; true
193 currencyMosaicId; MosaicId; Mosaic id used as primary chain currency.; 0x0DC6'7FBE'1CAD'29E3
194 harvestingMosaicId; MosaicId; Mosaic id used to provide harvesting ability.; 0x2651'4E2A'1EF3'3824
195 blockGenerationTargetTime; utils::TimeSpan; Targeted time between blocks.; 15s
196 blockTimeSmoothingFactor; uint32_t; *Note*: A higher value makes the network more biased. *Note*: This can lower security because it will increase the influence of time relative to importance.; 3000
197 importanceGrouping; uint64_t; Number of blocks that should be treated as a group for importance purposes. *Note*: Importances will only be calculated at blocks that are multiples of this grouping number.; 39
198 importanceActivityPercentage; uint8_t; Percentage of importance resulting from fee generation and beneficiary usage.; 5
199 maxRollbackBlocks; uint32_t; Maximum number of blocks that can be rolled back.; 40
200 maxDifficultyBlocks; uint32_t; Maximum number of blocks to use in a difficulty calculation.; 60
201 defaultDynamicFeeMultiplier; BlockFeeMultiplier; Default multiplier to use for dynamic fees.; 10'000
202 maxTransactionLifetime; utils::TimeSpan; Maximum lifetime a transaction can have before it expires.; 24h
203 maxBlockFutureTime; utils::TimeSpan; Maximum future time of a block that can be accepted.; 10s
204 initialCurrencyAtomicUnits; Amount; Initial currency atomic units available in the network.; 8'998'999'998'000'000
205 maxMosaicAtomicUnits; Amount; Maximum atomic units (total-supply * 10 ^ divisibility) of a mosaic allowed in the network.; 9'000'000'000'000'000
206 totalChainImportance; Importance; Total whole importance units available in the network.; 15'000'000
207 minHarvesterBalance; Amount; Minimum number of harvesting mosaic atomic units needed for an account to be eligible for harvesting.; 500
208 harvestBeneficiaryPercentage; uint8_t; Percentage of the harvested fee that is collected by the beneficiary account.; 10
209 blockPruneInterval; uint32_t; Number of blocks between cache pruning.; 360
210 maxTransactionsPerBlock; uint32_t; Maximum number of transactions per block.; 200'000
211 **plugin:catapult.plugins.accountlink**; ; ;
212 dummy; ; ; to trigger plugin load
213 **plugin:catapult.plugins.aggregate**; ; ;
214 maxTransactionsPerAggregate; uint32_t; Maximum number of transactions per aggregate.; 1'000
215 maxCosignaturesPerAggregate; uint8_t; Maximum number of cosignatures per aggregate.; 15
216 enableStrictCosignatureCheck; bool; Set to true if cosignatures must exactly match component signers. Set to false if cosignatures should be validated externally.; false
217 enableBondedAggregateSupport; bool; Set to true if bonded aggregates should be allowed. Set to false if bonded aggregates should be rejected.; true
218 maxBondedTransactionLifetime; utils::TimeSpan; Maximum lifetime a bonded transaction can have before it expires.; 48h
219 **plugin:catapult.plugins.lockhash**; ; ;
220 lockedFundsPerAggregate; Amount; Amount that has to be locked per aggregate in partial cache.; 10'000'000
221 maxHashLockDuration; utils::BlockSpan; Maximum number of blocks for which a hash lock can exist.; 2d
222 **plugin:catapult.plugins.locksecret**; ; ;
223 maxSecretLockDuration; utils::BlockSpan; Maximum number of blocks for which a secret lock can exist.; 30d
224 minProofSize; uint16_t; Minimum size of a proof in bytes.; 1
225 maxProofSize; uint16_t; Maximum size of a proof in bytes.; 1000
226 **plugin:catapult.plugins.metadata**; ; ;
227 maxValueSize; uint16_t; Maximum metadata value size.; 1024
228 **plugin:catapult.plugins.mosaic**; ; ;
229 maxMosaicsPerAccount; uint16_t; Maximum number of mosaics that an account can own.; 10'000
230 maxMosaicDuration; utils::BlockSpan; Maximum mosaic duration.; 3650d
231 maxMosaicDivisibility; uint8_t; Maximum mosaic divisibility.; 6
232 mosaicRentalFeeSinkPublicKey; Key; Public key of the mosaic rental fee sink account.; 53E140B5947F104CABC2D6FE8BAEDBC30EF9A0609C717D9613DE593EC2A266D3
233 mosaicRentalFee; Amount; Mosaic rental fee.; 500'000'000
234 **plugin:catapult.plugins.multisig**; ; ;
235 maxMultisigDepth; uint8_t; Maximum number of multisig levels.; 3
236 maxCosignatoriesPerAccount; uint8_t; Maximum number of cosignatories per account.; 10
237 maxCosignedAccountsPerAccount; uint8_t; Maximum number of accounts a single account can cosign.; 5
238 **plugin:catapult.plugins.namespace**; ; ;
239 maxNameSize; uint8_t; Maximum namespace and mosaic name size.; 64
240 maxChildNamespaces; uint16_t; Maximum number of children for a root namespace.; 500
241 maxNamespaceDepth; uint8_t; Maximum namespace depth.; 3
242 minNamespaceDuration; utils::BlockSpan; Minimum namespace duration.; 1m
243 maxNamespaceDuration; utils::BlockSpan; Maximum namespace duration.; 365d
244 namespaceGracePeriodDuration; utils::BlockSpan; Grace period during which time only the previous owner can renew an expired namespace.; 2m
245 reservedRootNamespaceNames; unordered_set<string>; Reserved root namespaces that cannot be claimed.; xem, nem, user, account, org, com, biz, net, edu, mil, gov, info
246 namespaceRentalFeeSinkPublicKey; Key; Public key of the namespace rental fee sink account.; 3E82E1C1E4A75ADAA3CBA8C101C3CD31D9817A2EB966EB3B511FB2ED45B8E262
247 rootNamespaceRentalFeePerBlock; Amount; Root namespace rental fee per block.; 1'000'000
248 childNamespaceRentalFee; Amount; Child namespace rental fee.; 100'000'000
249 **plugin:catapult.plugins.restrictionaccount**; ; ;
250 maxAccountRestrictionValues; uint16_t; Maximum number of account restriction values.; 512
251 **plugin:catapult.plugins.restrictionmosaic**; ; ;
252 maxMosaicRestrictionValues; uint8_t; Maximum number of mosaic restriction values.; 20
253 **plugin:catapult.plugins.transfer**; ; ;
254 maxMessageSize; uint16_t; Maximum transaction message size.; 1024
255
256config-networkheight.properties
257===============================
258
259.. csv-table::
260 :header: "Property", "Type", "Description", "Default"
261 :delim: ;
262
263 **networkheight**; ; ;
264 maxNodes; uint8_t; Number of nodes that this node should communicate with during network height detection.; 5
265
266config-node.properties
267======================
268
269.. csv-table::
270 :header: "Property", "Type", "Description", "Default"
271 :delim: ;
272
273 **node**; ; ;
274 port; unsigned short; Server port.; 7900
275 apiPort; unsigned short; Server api port.; 7901
276 enableAddressReuse; bool; Set to true if the server should reuse ports already in use.; false
277 enableSingleThreadPool; bool; Set to true if a single thread pool should be used, Set to false if multiple thread pools should be used.; false
278 enableCacheDatabaseStorage; bool; Set to true if cache data should be saved in a database.; true
279 enableAutoSyncCleanup; bool; Set to true if temporary sync files should be automatically cleaned up. *Note*: This should be Set to false if broker process is running.; true
280 enableTransactionSpamThrottling; bool; Set to true if transaction spam throttling should be enabled.; true
281 transactionSpamThrottlingMaxBoostFee; Amount; Maximum fee that will boost a transaction through the spam throttle when spam throttling is enabled.; 10'000'000
282 maxBlocksPerSyncAttempt; uint32_t; Maximum number of blocks per sync attempt.; 400
283 maxChainBytesPerSyncAttempt; utils::FileSize; Maximum chain bytes per sync attempt.; 100MB
284 shortLivedCacheTransactionDuration; utils::TimeSpan; Duration of a transaction in the short lived cache.; 10m
285 shortLivedCacheBlockDuration; utils::TimeSpan; Duration of a block in the short lived cache.; 100m
286 shortLivedCachePruneInterval; utils::TimeSpan; Time between short lived cache pruning.; 90s
287 shortLivedCacheMaxSize; uint32_t; Maximum size of a short lived cache.; 10'000'000
288 minFeeMultiplier; BlockFeeMultiplier; Minimum fee multiplier of transactions to propagate and include in blocks.; 0
289 transactionSelectionStrategy; model::TransactionSelectionStrategy; Transaction selection strategy used for syncing and harvesting unconfirmed transactions.; oldest
290 unconfirmedTransactionsCacheMaxResponseSize; utils::FileSize; Maximum size of an unconfirmed transactions response.; 20MB
291 unconfirmedTransactionsCacheMaxSize; uint32_t; Maximum size of the unconfirmed transactions cache.; 1'000'000
292 connectTimeout; utils::TimeSpan; Timeout for connecting to a peer.; 10s
293 syncTimeout; utils::TimeSpan; Timeout for syncing with a peer.; 60s
294 socketWorkingBufferSize; utils::FileSize; Initial socket working buffer size (socket reads will attempt to read buffers of roughly this size).; 512KB
295 socketWorkingBufferSensitivity; uint32_t; Socket working buffer sensitivity (lower values will cause memory to be more aggressively reclaimed). *Note*: Set to 0 will disable memory reclamation.; 100
296 maxPacketDataSize; utils::FileSize; Maximum packet data size.; 150MB
297 blockDisruptorSize; uint32_t; Size of the block disruptor circular buffer.; 4096
298 blockElementTraceInterval; uint32_t; Multiple of elements at which a block element should be traced through queue and completion.; 1
299 transactionDisruptorSize; uint32_t; Size of the transaction disruptor circular buffer.; 16384
300 transactionElementTraceInterval; uint32_t; Multiple of elements at which a transaction element should be traced through queue and completion.; 10
301 enableDispatcherAbortWhenFull; bool; Set to true if the process should terminate when any dispatcher is full.; true
302 enableDispatcherInputAuditing; bool; Set to true if all dispatcher inputs should be audited.; true
303 outgoingSecurityMode; ionet::ConnectionSecurityMode; Security mode of outgoing connections initiated by this node.; None
304 incomingSecurityModes; ionet::ConnectionSecurityMode; Accepted security modes of incoming connections initiated by other nodes.; None
305 maxCacheDatabaseWriteBatchSize; utils::FileSize; Maximum cache database write batch size.; 5MB
306 maxTrackedNodes; uint32_t; Maximum number of nodes to track in memory.; 5'000
307 trustedHosts; unordered_set<string>; Trusted hosts that are allowed to execute protected API calls on this node.;
308 **localnode**; ; ;
309 host; string; Node host (leave empty to auto-detect IP).;
310 friendlyName; string; Node friendly name (leave empty to use address).;
311 version; uint32_t; Node version.; 0
312 roles; ionet::NodeRoles; Node roles.; Peer
313 **outgoing_connections**; ; ;
314 maxConnections; uint16_t; Maximum number of active connections.; 10
315 maxConnectionAge; uint16_t; Maximum connection age.; 5
316 maxConnectionBanAge; uint16_t; Maximum connection ban age.; 20
317 numConsecutiveFailuresBeforeBanning; uint16_t; Number of consecutive connection failures before a connection is banned.; 3
318 **incoming_connections**; ; ;
319 maxConnections; uint16_t; Maximum number of active connections.; 512
320 maxConnectionAge; uint16_t; Maximum connection age.; 10
321 maxConnectionBanAge; uint16_t; Maximum connection ban age.; 20
322 numConsecutiveFailuresBeforeBanning; uint16_t; Number of consecutive connection failures before a connection is banned.; 3
323 backlogSize; uint16_t; Maximum size of the pending connections queue.; 512
324
325config-pt.properties
326====================
327
328.. csv-table::
329 :header: "Property", "Type", "Description", "Default"
330 :delim: ;
331
332 **partialtransactions**; ; ;
333 cacheMaxResponseSize; utils::FileSize; Maximum size of a partial transactions response.; 20MB
334 cacheMaxSize; uint32_t; Maximum size of the partial transactions cache.; 1'000'000
335
336config-task.properties
337======================
338
339.. csv-table::
340 :header: "Property", "Type", "Description", "Default"
341 :delim: ;
342
343 **age peers task for service Api Writers**; ; ;
344 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 1m
345 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 1m
346 **age peers task for service Readers**; ; ;
347 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 1m
348 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 1m
349 **batch partial transaction task**; ; ;
350 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 500ms
351 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 500ms
352 **batch transaction task**; ; ;
353 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 500ms
354 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 500ms
355 **connect peers task for service Pt**; ; ;
356 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 10ms
357 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 1m
358 **connect peers task for service Sync**; ; ;
359 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 10ms
360 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 1m
361 **harvesting task**; ; ;
362 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 30s
363 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 1s
364 **logging task**; ; ;
365 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 1m
366 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 10m
367 **network chain height detection**; ; ;
368 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 1s
369 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 15s
370 **node discovery peers task**; ; ;
371 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 1m
372 minDelay; utils::TimeSpan; Minimum delay between task executions.; 1m
373 maxDelay; utils::TimeSpan; Maximum delay between task executions.; 10m
374 numPhaseOneRounds; uint32_t; Number of rounds before deceleration starts.; 10
375 numTransitionRounds; uint32_t; Number of transition rounds from minimum to maximum delay.; 20
376 **node discovery ping task**; ; ;
377 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 2m
378 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 5m
379 **pull partial transactions task**; ; ;
380 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 10s
381 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 3s
382 **pull unconfirmed transactions task**; ; ;
383 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 4s
384 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 3s
385 **synchronizer task**; ; ;
386 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 3s
387 repeatDelay; utils::TimeSpan; Delay until subsequent executions of the task.; 3s
388 **time synchronization task**; ; ;
389 startDelay; utils::TimeSpan; Delay until the first execution of the task.; 1m
390 minDelay; utils::TimeSpan; Minimum delay between task executions.; 3m
391 maxDelay; utils::TimeSpan; Maximum delay between task executions.; 180m
392 numPhaseOneRounds; uint32_t; Number of rounds before deceleration starts.; 5
393 numTransitionRounds; uint32_t; Number of transition rounds from minimum to maximum delay.; 10
394
395config-timesync.properties
396==========================
397
398.. csv-table::
399 :header: "Property", "Type", "Description", "Default"
400 :delim: ;
401
402 **timesynchronization**; ; ;
403 maxNodes; uint8_t; Number of nodes that this node should communicate with during time synchronization.; 20
404
405config-user.properties
406======================
407
408.. csv-table::
409 :header: "Property", "Type", "Description", "Default"
410 :delim: ;
411
412 **account**; ; ;
413 bootPrivateKey; string; Boot private key.; 0000000000000000000000000000000000000000000000000000000000000000
414 shouldAutoDetectDelegatedHarvesters; bool; Set to true if potential delegated harvesters should be automatically detected.; true
415 **storage**; ; ;
416 dataDirectory; string; Data directory.; ../data
417 pluginsDirectory; string; Plugins directory.; .