RPC Config commands

config/getConfig

Gets a subset of configuration values for a node

Request

{ 
  user?: boolean
  name?: string 
} | undefined

Response

Partial<
  {
    blockGraffiti: string
    blocksPerMessage: number
    bootstrapNodes: string[]
    confirmations: number
    customNetwork: string
    databaseMigrate: boolean
    editor: string
    enableListenP2P: boolean
    enableLogFile: boolean
    enableMetrics: boolean
    enableRpc: boolean
    enableRpcIpc: boolean
    enableRpcTcp: boolean
    enableRpcTls: boolean
    enableSyncing: boolean
    enableTelemetry: boolean
    explorerBlocksUrl: string
    explorerTransactionsUrl: string
    feeEstimatorMaxBlockHistory: number
    feeEstimatorPercentileAverage: number
    feeEstimatorPercentileFast: number
    feeEstimatorPercentileSlow: number
    generateNewIdentity: boolean
    getFundsApi: string
    ipcPath: string
    jsonLogs: boolean
    logLevel: string
    logPeerMessages: boolean
    logPrefix: string
    maxPeers: number
    maxSyncedAgeBlocks: number
    memPoolMaxSizeBytes: number
    memPoolRecentlyEvictedCacheSize: number
    minPeers: number
    minerBatchSize: number
    miningForce: boolean
    networkDefinitionPath: string
    networkId: number
    nodeName: string
    nodeWorkers: number
    nodeWorkersMax: number
    p2pSimulateLatency: number
    peerPort: number
    poolAccountName: string
    poolBanning: boolean
    poolDifficulty: string
    poolDiscordWebhook: ''
    poolHost: string
    poolLarkWebhook: ''
    poolMaxConnectionsPerIp: number
    poolName: string
    poolPayoutPeriodDuration: number
    poolPort: number
    poolRecentShareCutoff: number
    poolStatusNotificationInterval: number
    rpcTcpHost: string
    rpcTcpPort: number
    targetPeers: number
    telemetryApi: string
    tlsCertPath: string
    tlsKeyPath: string
    transactionExpirationDelta: number
  }
>

config/setConfig

Sets a configuration value for the node

Request

{ 
  name: string
  value: unknown 
}

Response

undefined

config/unsetConfig

Unsets a configuration value for the node and falls back to the default.

Request

{ 
  name: string
}

Response

undefined

config/uploadConfig

Uploads a set of configuration values for the node. This resets any previously set config to the default.

Request

{
  config: Record<string, unknown>
}

Response

undefined
Edit page