Property | Type | Description | Default |
---|---|---|---|
database | |||
databaseUri | string | Database uri. | mongodb://127.0.0.1:27017 |
databaseName | string | Database name. | catapult |
maxWriterThreads | uint32_t | Maximum number of database writer threads. | 8 |
plugins | |||
catapult.mongo.plugins.accountlink | true | ||
catapult.mongo.plugins.aggregate | true | ||
catapult.mongo.plugins.lockhash | true | ||
catapult.mongo.plugins.locksecret | true | ||
catapult.mongo.plugins.metadata | true | ||
catapult.mongo.plugins.mosaic | true | ||
catapult.mongo.plugins.multisig | true | ||
catapult.mongo.plugins.namespace | true | ||
catapult.mongo.plugins.restrictionaccount | true | ||
catapult.mongo.plugins.restrictionmosaic | true | ||
catapult.mongo.plugins.transfer | true |
Property | Type | Description | Default |
---|---|---|---|
extensions | |||
extension.addressextraction | true | ||
extension.mongo | true | ||
extension.zeromq | true | ||
extension.hashcache | true |
Property | Type | Description | Default |
---|---|---|---|
extensions | |||
extension.addressextraction | false | ||
extension.mongo | false | ||
extension.zeromq | false | ||
extension.hashcache | true |
Property | Type | Description | Default |
---|---|---|---|
extensions | |||
extension.filespooling | false | ||
extension.partialtransaction | false | ||
extension.addressextraction | false | ||
extension.mongo | false | ||
extension.zeromq | false | ||
extension.harvesting | true | ||
extension.syncsource | true | ||
extension.diagnostics | true | ||
extension.hashcache | true | ||
extension.networkheight | true | ||
extension.nodediscovery | true | ||
extension.packetserver | true | ||
extension.pluginhandlers | true | ||
extension.sync | true | ||
extension.timesync | true | ||
extension.transactionsink | true | ||
extension.unbondedpruning | true |
Property | Type | Description | Default |
---|---|---|---|
harvesting | |||
harvesterSigningPrivateKey | string | Harvester signing private key. | |
harvesterVrfPrivateKey | string | Harvester vrf private key. | |
enableAutoHarvesting | bool | Set to true if auto harvesting is enabled. | false |
maxUnlockedAccounts | uint32_t | Maximum number of unlocked accounts. | 5 |
delegatePrioritizationPolicy | harvesting::DelegatePrioritizationPolicy | Delegate harvester prioritization policy. | Importance |
beneficiaryPublicKey | string | Public key of the account receiving part of the harvested fee. | 0000000000000000000000000000000000000000000000000000000000000000 |
Property | Type | Description | Default |
---|---|---|---|
inflation | |||
starting-at-height-1 | 100 | ||
starting-at-height-10000 | 0 |
Property | Type | Description | Default |
---|---|---|---|
console | |||
sinkType | utils::LogSinkType | Log sink type. | Sync |
level | utils::LogLevel | Log level. | Info |
colorMode | utils::LogColorMode | Console color mode. | Ansi |
console.component.levels | |||
file | |||
sinkType | utils::LogSinkType | Log sink type. | Async |
level | utils::LogLevel | Log level. | Debug |
directory | string | Log file directory. | logs |
filePattern | string | Log file pattern. | catapult_recovery%4N.log |
rotationSize | utils::FileSize | File rotation size. | 25MB |
maxTotalSize | utils::FileSize | Maximum size of all log files. | 2500MB |
minFreeSpace | utils::FileSize | Minimum size of free disk space in order to create log files. | 100MB |
file.component.levels |
Property | Type | Description | Default |
---|---|---|---|
console | |||
sinkType | utils::LogSinkType | Log sink type. | Sync |
level | utils::LogLevel | Log level. | Info |
colorMode | utils::LogColorMode | Console color mode. | Ansi |
console.component.levels | |||
file | |||
sinkType | utils::LogSinkType | Log sink type. | Async |
level | utils::LogLevel | Log level. | Debug |
directory | string | Log file directory. | logs |
filePattern | string | Log file pattern. | catapult_recovery%4N.log |
rotationSize | utils::FileSize | File rotation size. | 25MB |
maxTotalSize | utils::FileSize | Maximum size of all log files. | 2500MB |
minFreeSpace | utils::FileSize | Minimum size of free disk space in order to create log files. | 100MB |
file.component.levels |
Property | Type | Description | Default |
---|---|---|---|
console | |||
sinkType | utils::LogSinkType | Log sink type. | Sync |
level | utils::LogLevel | Log level. | Info |
colorMode | utils::LogColorMode | Console color mode. | Ansi |
console.component.levels | |||
file | |||
sinkType | utils::LogSinkType | Log sink type. | Async |
level | utils::LogLevel | Log level. | Info |
directory | string | Log file directory. | logs |
filePattern | string | Log file pattern. | catapult_server%4N.log |
rotationSize | utils::FileSize | File rotation size. | 25MB |
maxTotalSize | utils::FileSize | Maximum size of all log files. | 2500MB |
minFreeSpace | utils::FileSize | Minimum size of free disk space in order to create log files. | 100MB |
file.component.levels |
Property | Type | Description | Default |
---|---|---|---|
messaging | |||
subscriberPort | unsigned short | Subscriber port. | 7902 |
Property | Type | Description | Default |
---|---|---|---|
network | |||
identifier | NetworkIdentifier | Network identifier. | mijin-test |
nodeEqualityStrategy | NodeIdentityEqualityStrategy | Node equality strategy. | host |
publicKey | Key | Nemesis public key. | C67F465087EF681824805B7E9FF3B2728A4EE847DE044DE5D9FA415F7660B08E |
generationHashSeed | catapult::GenerationHashSeed | Nemesis generation hash seed. | 57F7DA205008026C776CB6AED843393F04CD458E0AA2D9F1D5F31A402072B2D6 |
epochAdjustment | utils::TimeSpan | Nemesis epoch time adjustment. | 1573430400s |
chain | |||
enableVerifiableState | bool | Set to true if block chain should calculate state hashes so that state is fully verifiable at each block. | true |
enableVerifiableReceipts | bool | Set to true if block chain should calculate receipts so that state changes are fully verifiable at each block. | true |
currencyMosaicId | MosaicId | Mosaic id used as primary chain currency. | 0x621E'C5B4'0385'6FC2 |
harvestingMosaicId | MosaicId | Mosaic id used to provide harvesting ability. | 0x4291'ED23'000A'037A |
blockGenerationTargetTime | utils::TimeSpan | Targeted time between blocks. | 30s |
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 |
blockFinalizationInterval | uint32_t | Number of blocks between successive finalization attempts. | 30 |
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 |
importanceActivityPercentage | uint8_t | Percentage of importance resulting from fee generation and beneficiary usage. | 5 |
maxRollbackBlocks | uint32_t | Maximum number of blocks that can be rolled back. | 40 |
maxDifficultyBlocks | uint32_t | Maximum number of blocks to use in a difficulty calculation. | 60 |
defaultDynamicFeeMultiplier | BlockFeeMultiplier | Default multiplier to use for dynamic fees. | 10'000 |
maxTransactionLifetime | utils::TimeSpan | Maximum lifetime a transaction can have before it expires. | 24h |
maxBlockFutureTime | utils::TimeSpan | Maximum future time of a block that can be accepted. | 500ms |
initialCurrencyAtomicUnits | Amount | Initial currency atomic units available in the network. | 8'998'999'998'000'000 |
maxMosaicAtomicUnits | Amount | Maximum atomic units (total-supply * 10 ^ divisibility) of a mosaic allowed in the network. | 9'000'000'000'000'000 |
totalChainImportance | Importance | Total whole importance units available in the network. | 15'000'000 |
minHarvesterBalance | Amount | Minimum number of harvesting mosaic atomic units needed for an account to be eligible for harvesting. | 500 |
maxHarvesterBalance | Amount | Maximum number of harvesting mosaic atomic units needed for an account to be eligible for harvesting. | 4'000'000 |
minVoterBalance | Amount | Minimum number of harvesting mosaic atomic units needed for an account to be eligible for voting. | 50'000 |
harvestBeneficiaryPercentage | uint8_t | Percentage of the harvested fee that is collected by the beneficiary account. | 10 |
harvestNetworkPercentage | uint8_t | Percentage of the harvested fee that is collected by the network. | 5 |
harvestNetworkFeeSinkPublicKey | Key | Public key of the harvest network fee sink account. | FF5563F1C5824EE0CD868799FBE8744B46D5549973FDA499939C952D951494E4 |
blockPruneInterval | uint32_t | Number of blocks between cache pruning. | 360 |
maxTransactionsPerBlock | uint32_t | Maximum number of transactions per block. | 200'000 |
plugin:catapult.plugins.accountlink | |||
dummy | to trigger plugin load | ||
plugin:catapult.plugins.aggregate | |||
maxTransactionsPerAggregate | uint32_t | Maximum number of transactions per aggregate. | 1'000 |
maxCosignaturesPerAggregate | uint8_t | Maximum number of cosignatures per aggregate. | 15 |
enableStrictCosignatureCheck | bool | Set to true if cosignatures must exactly match component signers. Set to false if cosignatures should be validated externally. | false |
enableBondedAggregateSupport | bool | Set to true if bonded aggregates should be allowed. Set to false if bonded aggregates should be rejected. | true |
maxBondedTransactionLifetime | utils::TimeSpan | Maximum lifetime a bonded transaction can have before it expires. | 48h |
plugin:catapult.plugins.lockhash | |||
lockedFundsPerAggregate | Amount | Amount that has to be locked per aggregate in partial cache. | 10'000'000 |
maxHashLockDuration | utils::BlockSpan | Maximum number of blocks for which a hash lock can exist. | 2d |
plugin:catapult.plugins.locksecret | |||
maxSecretLockDuration | utils::BlockSpan | Maximum number of blocks for which a secret lock can exist. | 30d |
minProofSize | uint16_t | Minimum size of a proof in bytes. | 1 |
maxProofSize | uint16_t | Maximum size of a proof in bytes. | 1000 |
plugin:catapult.plugins.metadata | |||
maxValueSize | uint16_t | Maximum metadata value size. | 1024 |
plugin:catapult.plugins.mosaic | |||
maxMosaicsPerAccount | uint16_t | Maximum number of mosaics that an account can own. | 10'000 |
maxMosaicDuration | utils::BlockSpan | Maximum mosaic duration. | 3650d |
maxMosaicDivisibility | uint8_t | Maximum mosaic divisibility. | 6 |
mosaicRentalFeeSinkPublicKey | Key | Public key of the mosaic rental fee sink account. | 53E140B5947F104CABC2D6FE8BAEDBC30EF9A0609C717D9613DE593EC2A266D3 |
mosaicRentalFee | Amount | Mosaic rental fee. | 500 |
plugin:catapult.plugins.multisig | |||
maxMultisigDepth | uint8_t | Maximum number of multisig levels. | 3 |
maxCosignatoriesPerAccount | uint32_t | Maximum number of cosignatories per account. | 10 |
maxCosignedAccountsPerAccount | uint32_t | Maximum number of accounts a single account can cosign. | 5 |
plugin:catapult.plugins.namespace | |||
maxNameSize | uint8_t | Maximum namespace name size. | 64 |
maxChildNamespaces | uint16_t | Maximum number of children for a root namespace. | 500 |
maxNamespaceDepth | uint8_t | Maximum namespace depth. | 3 |
minNamespaceDuration | utils::BlockSpan | Minimum namespace duration. | 1m |
maxNamespaceDuration | utils::BlockSpan | Maximum namespace duration. | 365d |
namespaceGracePeriodDuration | utils::BlockSpan | Grace period during which time only the previous owner can renew an expired namespace. | 2m |
reservedRootNamespaceNames | unordered_set<string> | Reserved root namespaces that cannot be claimed. | xem, nem, user, account, org, com, biz, net, edu, mil, gov, info |
namespaceRentalFeeSinkPublicKey | Key | Public key of the namespace rental fee sink account. | 3E82E1C1E4A75ADAA3CBA8C101C3CD31D9817A2EB966EB3B511FB2ED45B8E262 |
rootNamespaceRentalFeePerBlock | Amount | Root namespace rental fee per block. | 1 |
childNamespaceRentalFee | Amount | Child namespace rental fee. | 100 |
plugin:catapult.plugins.restrictionaccount | |||
maxAccountRestrictionValues | uint16_t | Maximum number of account restriction values. | 512 |
plugin:catapult.plugins.restrictionmosaic | |||
maxMosaicRestrictionValues | uint8_t | Maximum number of mosaic restriction values. | 20 |
plugin:catapult.plugins.transfer | |||
maxMessageSize | uint16_t | Maximum transaction message size. | 1024 |
Property | Type | Description | Default |
---|---|---|---|
networkheight | |||
maxNodes | uint8_t | Number of nodes that this node should communicate with during network height detection. | 5 |
Property | Type | Description | Default |
---|---|---|---|
node | |||
port | unsigned short | Server port. | 7900 |
maxIncomingConnectionsPerIdentity | uint32_t | Maximum number of incoming connections per identity over primary port. | 3 |
enableAddressReuse | bool | Set to true if the server should reuse ports already in use. | false |
enableSingleThreadPool | bool | Set to true if a single thread pool should be used, Set to false if multiple thread pools should be used. | false |
enableCacheDatabaseStorage | bool | Set to true if cache data should be saved in a database. | true |
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 |
enableTransactionSpamThrottling | bool | Set to true if transaction spam throttling should be enabled. | true |
transactionSpamThrottlingMaxBoostFee | Amount | Maximum fee that will boost a transaction through the spam throttle when spam throttling is enabled. | 10'000'000 |
maxBlocksPerSyncAttempt | uint32_t | Maximum number of blocks per sync attempt. | 42 |
maxChainBytesPerSyncAttempt | utils::FileSize | Maximum chain bytes per sync attempt. | 100MB |
shortLivedCacheTransactionDuration | utils::TimeSpan | Duration of a transaction in the short lived cache. | 10m |
shortLivedCacheBlockDuration | utils::TimeSpan | Duration of a block in the short lived cache. | 100m |
shortLivedCachePruneInterval | utils::TimeSpan | Time between short lived cache pruning. | 90s |
shortLivedCacheMaxSize | uint32_t | Maximum size of a short lived cache. | 10'000'000 |
minFeeMultiplier | BlockFeeMultiplier | Minimum fee multiplier of transactions to propagate and include in blocks. | 0 |
transactionSelectionStrategy | model::TransactionSelectionStrategy | Transaction selection strategy used for syncing and harvesting unconfirmed transactions. | oldest |
unconfirmedTransactionsCacheMaxResponseSize | utils::FileSize | Maximum size of an unconfirmed transactions response. | 20MB |
unconfirmedTransactionsCacheMaxSize | uint32_t | Maximum size of the unconfirmed transactions cache. | 1'000'000 |
connectTimeout | utils::TimeSpan | Timeout for connecting to a peer. | 10s |
syncTimeout | utils::TimeSpan | Timeout for syncing with a peer. | 60s |
socketWorkingBufferSize | utils::FileSize | Initial socket working buffer size (socket reads will attempt to read buffers of roughly this size). | 512KB |
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 |
maxPacketDataSize | utils::FileSize | Maximum packet data size. | 150MB |
blockDisruptorSize | uint32_t | Size of the block disruptor circular buffer. | 4096 |
blockElementTraceInterval | uint32_t | Multiple of elements at which a block element should be traced through queue and completion. | 1 |
transactionDisruptorSize | uint32_t | Size of the transaction disruptor circular buffer. | 16384 |
transactionElementTraceInterval | uint32_t | Multiple of elements at which a transaction element should be traced through queue and completion. | 10 |
enableDispatcherAbortWhenFull | bool | Set to true if the process should terminate when any dispatcher is full. | true |
enableDispatcherInputAuditing | bool | Set to true if all dispatcher inputs should be audited. | true |
maxCacheDatabaseWriteBatchSize | utils::FileSize | Maximum cache database write batch size. | 5MB |
maxTrackedNodes | uint32_t | Maximum number of nodes to track in memory. | 5'000 |
batchVerificationRandomSource | string | Source of random numbers used in batch verification. | /dev/urandom |
trustedHosts | unordered_set<string> | Trusted hosts that are allowed to execute protected API calls on this node. | |
localNetworks | unordered_set<string> | Networks that should be treated as local. | 127.0.0.1 |
localnode | |||
host | string | Node host (leave empty to auto-detect IP). | |
friendlyName | string | Node friendly name (leave empty to use address). | |
version | uint32_t | Node version. | 0 |
roles | ionet::NodeRoles | Node roles. | Peer |
outgoing_connections | |||
maxConnections | uint16_t | Maximum number of active connections. | 10 |
maxConnectionAge | uint16_t | Maximum connection age. | 200 |
maxConnectionBanAge | uint16_t | Maximum connection ban age. | 20 |
numConsecutiveFailuresBeforeBanning | uint16_t | Number of consecutive connection failures before a connection is banned. | 3 |
incoming_connections | |||
maxConnections | uint16_t | Maximum number of active connections. | 512 |
maxConnectionAge | uint16_t | Maximum connection age. | 200 |
maxConnectionBanAge | uint16_t | Maximum connection ban age. | 20 |
numConsecutiveFailuresBeforeBanning | uint16_t | Number of consecutive connection failures before a connection is banned. | 3 |
backlogSize | uint16_t | Maximum size of the pending connections queue. | 512 |
banning | |||
defaultBanDuration | utils::TimeSpan | Default duration for banning. | 12h |
maxBanDuration | utils::TimeSpan | Maximum duration for banning. | 72h |
keepAliveDuration | utils::TimeSpan | Duration to keep account in container after the ban expired. | 48h |
maxBannedNodes | uint32_t | Maximum number of banned nodes. | 5'000 |
numReadRateMonitoringBuckets | uint16_t | Number of read rate monitoring buckets (Set to 0 to disable read rate monitoring). | 4 |
readRateMonitoringBucketDuration | utils::TimeSpan | Duration of each read rate monitoring bucket. | 15s |
maxReadRateMonitoringTotalSize | utils::FileSize | Maximum size allowed during full read rate monitoring period. | 100MB |
Property | Type | Description | Default |
---|---|---|---|
partialtransactions | |||
cacheMaxResponseSize | utils::FileSize | Maximum size of a partial transactions response. | 20MB |
cacheMaxSize | uint32_t | Maximum size of the partial transactions cache. | 1'000'000 |
Property | Type | Description | Default |
---|---|---|---|
age peers task for service Api Writers | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 1m |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 1m |
age peers task for service Readers | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 1m |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 1m |
batch partial transaction task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 500ms |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 500ms |
batch transaction task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 500ms |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 500ms |
connect peers task for service Pt | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 1s |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 1m |
connect peers task for service Sync | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 1s |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 1m |
harvesting task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 30s |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 1s |
logging task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 1m |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 10m |
network chain height detection | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 1s |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 15s |
node discovery peers task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 1m |
minDelay | utils::TimeSpan | Minimum delay between task executions. | 1m |
maxDelay | utils::TimeSpan | Maximum delay between task executions. | 10m |
numPhaseOneRounds | uint32_t | Number of rounds before deceleration starts. | 10 |
numTransitionRounds | uint32_t | Number of transition rounds from minimum to maximum delay. | 20 |
node discovery ping task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 2m |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 5m |
pull partial transactions task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 10s |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 3s |
pull unconfirmed transactions task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 4s |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 3s |
static node refresh task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 5ms |
minDelay | utils::TimeSpan | Minimum delay between task executions. | 15s |
maxDelay | utils::TimeSpan | Maximum delay between task executions. | 24h |
numPhaseOneRounds | uint32_t | Number of rounds before deceleration starts. | 20 |
numTransitionRounds | uint32_t | Number of transition rounds from minimum to maximum delay. | 20 |
synchronizer task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 3s |
repeatDelay | utils::TimeSpan | Delay until subsequent executions of the task. | 3s |
time synchronization task | |||
startDelay | utils::TimeSpan | Delay until the first execution of the task. | 1m |
minDelay | utils::TimeSpan | Minimum delay between task executions. | 3m |
maxDelay | utils::TimeSpan | Maximum delay between task executions. | 180m |
numPhaseOneRounds | uint32_t | Number of rounds before deceleration starts. | 5 |
numTransitionRounds | uint32_t | Number of transition rounds from minimum to maximum delay. | 10 |
Property | Type | Description | Default |
---|---|---|---|
timesynchronization | |||
maxNodes | uint8_t | Number of nodes that this node should communicate with during time synchronization. | 20 |
minImportance | Importance | Minimum importance a node must have in order to be considered as a synchronization partner. | 3'750 |
Property | Type | Description | Default |
---|---|---|---|
account | |||
enableDelegatedHarvestersAutoDetection | bool | Set to true if potential delegated harvesters should be automatically detected. | true |
storage | |||
dataDirectory | string | Data directory. | ../data |
certificateDirectory | string | Certificate directory. | ../certificate |
pluginsDirectory | string | Plugins directory. | . |