# Change Logs

## v0.22.28
* add consts
## v0.22.27
* add consts
## v0.22.26
* support stat.service

## v0.22.25
* consul.service: support function: watchKeyValue
* add consts: GASPRICE_WATCHER related

## v0.22.24
* NBError support 'params'
* add consts: proposal related

## v0.22.23
* add consts: conciliation related and audit related
## v0.22.22
Feature:

* add consts: multi-approval related and consts.BLOCKCHAIN_FINALIZE_MODE
## v0.22.21
Feature:

* add consts: add ORDER_BIZTYPES.SWEEP_EXTERNAL, ORDER_BIZTYPES.RECHARGE_EXTERNAL, ORDER_BIZTYPES.PAY_FEE and etc.
## v0.22.19
Feature:

* msgqueue.service: consumeMessages support executeInOrder
* add consts: cold batch related activity name
## v0.22.16

Feature:

* suppport email notifications related consts
* deprecated: warning records
## v0.22.15

Feature:

* suppport wallet operationSubMode
## v0.22.14

Feature:

* add SWEEP_RECORDS and SNAPSHOT related consts
* rest-helper: support maxAmount
## v0.22.13

Feature:

* add new activity event: WALLET_CHAIN_DEPOSIT_WHITE_LIST_EDIT
## v0.22.12

Feature:

* new version activity.service
* add activity related consts
## v0.22.11

Improvement:

* add used-time log in support/action.js
* add try-cancel-order related consts
## v0.22.10

Improvement:

* fix loadChainCfg to config.service
## v0.22.9

Improvement:

* add filter of db error to httpbase.service
## v0.22.8

Improvement:

* add nodeArgs to pm.service
## v0.22.3

FIX:

* remove onDestroy logic in 'msgqueue.service': consumers of stream groups will not be deleted when onDestroy
* 'ackMessages': fix logic of the 'ackMessages' function 

## v0.22.2

FIX:

* add log in 'asyncplan.service': fastRetries logic in asyncplan has problems currently.

## v0.22.1

Improvement:

* add consts.PRIVKEY_SOURCES.HSM_HOT

## v0.22.0

Feature:

* add consul monitor service

## v0.21.0

Improvement:

* upgrade version of dependencies
* upgrade eslint and fix lint warnings
* add operator field to wallet

## v0.20.9 ~ v0.20.10

Improvement:

* consul.service support `updateKeyValue` and `getKeyValue`

## v0.20.8

Improvement:

* add version to Module

## v0.20.7

Improvement:

* add some options (like bodyParser, cors) to http services

## v0.20.6

Fixes:

* fix ActionMapValue

## v0.20.5

Improvement:

* add getCryptoKey method in crypto

## v0.20.4

Improvement:

* add useLatestNode to pm.service
* add JP_LATEST_NODE_PATH env

## v0.20.3

Improvement:

* update seed private key source

## v0.20.2

Improvement:

* add new SEED_V2 private key source to consts

## v0.20.1

Improvement:

* add buildTwofaLoginTokenPayload and generateTwofaLoginTokenBySigResult methods to twofa utility
* add buildMsgHash method to crypto utility

## v0.20.0

Feature:

* add bin/entry file
* add new Model `Activity`
* add Koa Service as a new HTTP service
* add new Model `WalletTemplate`
  * move `version` field from `Wallet` to `WalletTemplate`
* Model `Wallet` add new members
  * `options` for wallet level config
  * `mode` for wallet strategy
  * `source.user` for user address's source
  * `template` for template identify
* add `SudoKey` feature for crypto
* add setHeader method to apiEndpoints

Fixes:

* avoid rpcHelper.requestRPC parameters is undefined
* avoid http margon logging in production mode

Improvement:

* ActionLoop support empty array
* upgrade Warning model
* more test cases for `Wallet` and `WalletTemplate`

## v0.19.13

Improvement:

* array config support force merge

## v0.19.12

Fixes:

* fix typo bug extra.timetamp to extra.timestamp

## v0.19.11

Improvement:

* passing more parameters when invoke requestHttpRPC in rpcclient.services

## v0.19.10

Improvement:

* add coinUsed field to Wallet model to record all coins may used in history.

## v0.19.9

Improvement:

* add new order state `CANCELLED`

## v0.19.8

Fixes:

* fix loadConfigKeys when exclude disabled

## v0.19.7

Fixes:

* upgrade crypto lib to 2.0.4 to fix ecc util `this` issue

## v0.19.6

Improvement:

* fix utils.configLoader.loadConfigKeys when startup

## v0.19.5

Improvement:

* use intersection when utils.configLoader.loadConfigKeys without parent.
* upgrade crypto lib to 2.0.3

## v0.19.4

Improvement:

* upgrade crypto lib to 2.0.2

## v0.19.3

Fixes:

* DB log ERROR URL

## v0.19.2

Fixes:

* fix actionRunJob condition

## v0.19.1

Improvement:

* add `.cfgignore` file check for utils.configLoader.loadConfigKeys method

## v0.19.0

Feature:

* add `support` folder
  * move some class to support folder
  * add Action class for executable action
  * add some general Action classes
* add `utils.validateParameter` method
* add new Model Name `STAKEPOOL` `COMPOUND_INTEREST`

Improvement:

* config.serivce client mode join rpc service with authWithTimestamp = true
* useUnifiedTopology then remove mongoOptions.reconnectTries/reconnectInterval/autoReconnect parameter
* pm2.service support list non-self controlled process

Fixes:

* Fix ConfigDat requires server field (no required now)
* Fix jadepool.initModules missing root folder alias
* Fix jobqueue.service.registerMethod parameter error

## v0.18.5

Improvement:

* add new test cases for jobqueue/consul/rpc services
* using registerMethod in async plan service

## v0.18.4

Fixes:

* fix msg consumer id bug finally.

## v0.18.3

Feature:

* add msg queue service test cases

Fixes:

* fix msg consumer id bug

## v0.18.2

Fixes:

* fix msg consumer id reused bug

## v0.18.1

Fixes:

* fix msgqueue.service ACK without group

## v0.18.0

Feature:

* add msgqueue.service for adding and consuming message
  * using RedisMessager as MQ provider

## v0.17.1

Fixes:

* fix internal service

## v0.17.0

Feature:

* add ttlCheckMethod parameter to consul.registerService method
  * pass for ttlCheckMethod return `true` in 60 seconds
  * warn for ttlCheckMethod return `true` more than 60 seconds
  * fail for ttlCheckMethod return false or throw error
* add registerMethod method to jobqueue.service

Fixes:

* turn back await when pm2 stop

## v0.16.11

Improvement:

* reduce Jadepool process prefix

## v0.16.10

Fixes:

* fix node 8 (missing URL object)

## v0.16.9

Improvement:

* upgrade bull to v3.11.0

## v0.16.8

Improvement:

* adjust job.queue cleaner interval

## v0.16.7

Improvement:

* add pm2 start options maxMemoryRestart, default value is 800M

## v0.16.6

Improvement:

* remove useless log

## v0.16.5

Improvement:

* fix pm2.service onDestroy error

## v0.16.4

Improvement:

* improve consul log

## v0.16.3

Fixes:

* service graceful exiting using first-in-last-out ordering

## v0.16.2

Improvement:

* avoid too many error log when running at dist folder with NODE_ENV=dev

## v0.16.1

Fixes:

* fix mongoose warning message
* fix module feature for non-executable module

## v0.16.0

Features:

* add module feature
* now modules in seperated folders can be loaded in runtime

## v0.15.8

Fixes:

* avoid pm2.start/stop/restart null reference

## v0.15.7

Improvement:

* pm2.service.start add mergeLogs parameter

## v0.15.6

Fixes:

* pm2.start will pass env from parent to the started process

## v0.15.5

Fixes:

* fix jobqueue.service.fetchQueue, type of redisOpts.port maybe 'number' or 'string'

## v0.15.4

Improvement:

* add masterKey to pm2.service that will add to processPrefix
* add more env processTypes

## v0.15.3

Fixes:

* fix pm2.service opts.force cannot be set

## v0.15.2

Fixes:

* fix pm2.service start instance cannot increase instanceId

## v0.15.1

Fixes:

* fix jobqueue.service `clean` too frequently

## v0.15.0

Breaking Changes:

* !!REMOVE agenda.service is removed now.
* !!REMOVE consts.SERVICE_NAMES.AGENDA is removed now.
* Task implement should using new Job Task (based on jobqueue.service)
* semver version check now only major and minor
* JP_AUTO_START now default as false
* !!REMOVE JP_MULTI_WORKERS limit

Features:

* add new service constants
  * consts.SERVICE_NAMES.JOB_QUEUE for job queue service
  * consts.SERVICE_NAMES.PM2_PROCESS for pm2 service
* add jobqueue.service with Bull job queue
* using redis based Bull job queue for Task instead of Agenda
  * async.plan now depend on jobqueue.service
* add pm2.service for easy to use pm2 features

## v0.14.9

Improvement:

* using logger 2.0

Fixes:

* fix jsonrpc.services signature validate

## v0.14.8

Fixes:

* fix models/index.d.ts

## V0.14.7

Fixes:

* fix asyncplan use wrong refer plan

## V0.14.6

Improvement:

* add finalized field to async plan
* change wallet source data 'cachedAt' from one to many

Fixes:

* fix avoid rpc result is null

## V0.14.5

Improvement:

* 优化env参数
* consul服务添加waitForService方法，等待到发现任意服务

## V0.14.4

Fixes:

* fix rpcclient verifyInternal bug

## V0.14.3

Fixes:

* fix rpcHelper.requestRPC opts undefined

## V0.14.2

Improvement:

* upgrade logger to 2.0.0

Fixes:

* fix config.service connect failed will break process

## V0.14.1

Improvement:

* consul.service在注册服务时，当host非127.0.0.1时才进行设置

## V0.14.0

Feature:

* 新增ConsulService，支持服务发现（必选，需安装consul）
* app.service, config.service, internalrpc.service, socketio.service, sioworker.service均使用consul进行服务发现

Fixes:

* 修复asyncPlan的index错误
* 修复AgendaJobs的index错误

## V0.13.2

Fixes:

* agenda.task出错时，save warning报错

## V0.13.1

Improvement:

* 更新一些库
* config, internalrpc等内部jsonrpc调用使用authWithTimestamp方式
* cryptoUtils新增方法encryptData，decryptData 并支持timestamp模式的内部签名

## V0.13.0

Feature:

* 新增InternalRPCService, 依赖JSONRPCService和JSONRPCClientService，可实现内部任意微服务间的RPC调用
* 新增utils.rpcHelper工具类，以便捷地使用JSONRPCClientService

Improvement:

* AppService可通过直接的参数传入设置监听端口
* ErrorCodeService现在依赖Redis
  * 目前仅需要一个host进行配置读取并写入redis
  * 非host serice将直接从redis中读取error code配置
* ConfigService使用rpcHelper进行rpc调用
* 修改JSONRPCService的验证实现
  * 可以直接使用AppService的监听端口
  * 使用显式upgrade的方法进行连接

Fixes:

* 修复ConfigServic host模式下url无法从redis中移除的bug

Breaking Chagnes:

* 移除不再使用的常量： CLUSTER_MODES， LAUNCH_MODES.ALL_IN_ONE

## V0.12.12

Fixes:

* jadepool.createAsyncPlan sourceId missing

## V0.12.11

Fixes:

* configLoader.loadConfigKeys当存在parent时无法正确找到别名

## V0.12.10

Fixes:

* 修复连接redis时配置可能异常

## V0.12.9

Fixes:

* 修复config.service alias判断的bug

## V0.12.8

Improvement:

* App Model添加state delete_at 字段
* RedisManager添加返回Multi的方法

## V0.12.7

Fixes:

* config.service non host模式下自动重连

## V0.12.6

Fixes:

* 修复socketio.service缺少timeout的问题

## V0.12.5

Fixes:

* 修复saveConfig无法geneTemplates的问题
* 修复配置写入的问题

## V0.12.4

Fixes:

* config.service host模式当setAutoSaveWhenLoad被设置时强制从db读取配置

Improvement:

* rpcclient的error日志需为warn级别

## V0.12.3

Fixes:

* 修复config.service的alias机制

## V0.12.2

Fixes:

* 修复config.service load/save config时的null检测

## V0.12.1

Fixes:

* 修复config.service onDestroy时redisClient失效

## V0.12.0

Features:

* 新增config.service服务，全权处理全部的配置读取与写入事宜
* utils.configSetuper下的所有方法设置为deprecated，同时将不再往config对象中写入内容，仅提供初始化功能
* 移除utils.config.fetch**系列方法
* 移除utils.config.applyIgnoreKeys方法

## V0.11.18

Fixes:

* 移除tokenTypes覆盖

Improvement:

* 优化agendaJobs的db index
* 优化redisMessager的日志

## V0.11.17

Improvement:

* string.geneHashId移除0，O，I，l
* crypto添加工具函数keyBufferFrom，创建buffer时自动识别字符串base64 or hex的encode
* rpcclient.service在join时添加opts.verifier，制定验签公钥
* jsonrpc.service可配置更多签名参数
* jsonrpc.service支持batch reqeust

## V0.11.16

Fixes:

* 更新lodash到4.17.14以修复致命漏洞
* wallet.setSourceData 可设置 cached

## V0.11.15

Merge:

* 合并0.9.4

## V0.11.14

Fixes:

* 修复别名目录下无法根据perent找到配置的bug

## V0.11.13

Fixes:

* utils.config.loadAllCoinNames 支持 includeDisabled 参数

## V0.11.12

Fixes:

* bizType REFUND 属于 ORDER_BIZTYPES_OUT

Improvement:

* 添加ISSUE_TYPES.ORDER_UNEXPECTED 和 CONTRACT_UNKNOWN_ISSUE

## V0.11.11

Improvement:

* 新增bizTypes: REVERT, REFUND

## V0.11.10

Improvement:

* agenda task config中保存平均运行时间

## V0.11.9

Fixes:

* 修复wallet保存数组时的异常

## V0.11.8

Fixes:

* 修复redisMessager中可能的报错

## V0.11.7

Fixes:

* 修复Wallet保存数据时的错误
* 避免一些redisManager中可能的报错

Improvement:

* 减少RedisManager中的日志输出

## V0.11.6

Improvement:

* 调整Wallet Model的实现，修改为多表记录
* 添加Wallet测试用例
* ConfigDat.toMerged 添加参数id，key

Fixes:

* redisMessager consumeMsgs时设置data需先确认array存在

## V0.11.5

Fixes:

* 修复redisMessager consumeMessages时因自动设置block造成的卡死

## V0.11.4

Fixes:

* 移除wallet.getTokenInfo时，对configWatchers的修改

## V0.11.3

Fixes:

* 修复wallet机制下configLoader自动升级版本时，带parent的配置无法正常升级的bug
* 移除utils.configLoader.loadConfig中的无用参数forceSelf

## V0.11.2

Improvement:

* utils.crypto.buildSignedObj 支持传入多种参数

## V0.11.1

Improvement:

* 在wallet的d.ts中添加seed_db模式，配置冷热钱包地址的提示

## V0.11.0

Features:

* 添加utils函数：string类和assert类
* 新增Redis工具：RedisMessager，可便捷使用Redis 5.0的消息队列功能
  * 修复RedisMessager，新Group无法收到最新消息的Bug
  * 独立ensureGroup方法，支持不同Group的consumeMessages

## V0.10.1

Fixes:

* 修复agenda.service.runningJobs方法中带id查询时的query错误

## V0.10.0

Breaking Changes:

由于瑶池支持多wallet，因此不能依赖coinCfg

* 移除utils.config.fetchCoinCfg
* 移除utils.config.fetchAllCoinNames
* 重构setuper，仅将default钱包中的数据缓存到内存config
* 移除crypto.fetchPubKey，仅使用新方法fetchPublicKeys

Features:

* 新增Wallet模型，支持多热钱包模式
  * Application记录中需配置Wallet参数
* utils.crypto的internal签名支持以timestamp + secret的形式做为私钥
* rpcclient.service可以预设invokeMethod时的namespace

Improvement:

* agenda.service支持带id的runningJobs查询
* utils.db中添加AutoIncrement

## V0.9.4

Improvement:

* 添加常量consts.MODEL_NAMES.ITEM
* 添加常量consts.ITEM_STATE

## V0.9.3

Fixes:

* asyncplan.service以series模式运行Plan时，一旦出现error即停止plan并认为失败

## V0.9.2

Improvement:

* api.endpoint 添加setTimeout方法

## V0.9.1

Fixes:

* 当执行plan时有error，也应该算作完成

## V0.9.0

Feature:

* 新增通用Model: AsyncPlan 用于记录异步队列任务，在默认context中已加载
* 新增Service：asyncplan.service 用于监控和运行异步任务
* consts中新增AsyncPlan相关常量
* jadepool新增方法：createAsyncPlan 可用于创建新的异步队列任务
* jadepool新增方法可用性检验函数：invokeMethodValid
* 新增asyncplan相关测试用例

Improvement:

* agenda.service添加参数opts.processEvery
* jsonrpc.service和rpclient.service导出方法setAcceptMethods，可自行设置acceptMethods

Fixes:

* socketio.service在调用分发调用的result为数组时，依然可以自动添加namespace和sid

## V0.8.1

Fixes:

* 修复ApiEndpoint.connected错误

## V0.8.0

Feature:

* 新增工具类 utils.api 可用于对多个节点地址进行restapi或jsonrpc请求。

## V0.7.11

Improvement:

* d.ts定义文件 - 新增coinCfg.jadepool下的通用内容
* d.ts定义文件 - 调整部分consts的提示内容

## V0.7.10

Improvement:

* 增加utils.db.fetchConnection的定义

Fixes:

* 修复MODEL_NAME，mongoose在写入数据库时会将name全部小写

## V0.7.9

Fixes:

* 修复AUDIT_BALANCE所在的DB

## V0.7.8

Improvement:

* 添加常量`consts.DB_KEYS`, `consts.MODEL_LIST_ADMIN`, `consts.MODEL_LIST_CONFIG`, `consts.MODEL_LIST_DEFAULT`
* 添加常量字段`consts.ORDER_DEFAULT_ACTIONS.UTXO_SCATTER`
* 移除ChainCfg中的非必要字段 systemCallEnabled

## V0.7.7

Improvement:

* 命名并更新index

## V0.7.6

Fixes:

* instanceId可以使用NODE_INSTANCE_ID来设置，以避免Node-config冲突

## V0.7.5

Fixes:

* consts.d.ts中字段错误，修正为 consts.ADDRESS_BIZ_MODES.NORMAL

## V0.7.4

Fixes:

* 修复agenda.cancelFinishedJobs未删除干净的问题，启动时只要lockedAt为null都可以删除

## V0.7.3

Improvement:

1. 移除ADDRESS_BIZ_MODES.DELEGATE系列，因为它们在业务上不能成立
2. 【更新*.d.ts】 ChainConfig中添加addressWaitForUse和addressBizModes

## V0.7.2

Features:

1. consts调整。移除ADDRESS_ACCEPT_MODE，添加更多的ADDRESS_BIZ_MODES

Fixes:

1. agenda.service为runningJobs添加index

## V0.7.1

Features:

1. utils.config.loadAllCoinNames返回时带chainKey
2. utils.config.loadCoinCfg支持单个coinName作为参数，但必须为`chainKey.coinName`格式
3. 新增consts.ADDRESS_BIZ_MODES

## V0.7.0

Features:

1. utils.config新增方法loadCoinCfg, loadChainCfg, loadAllCoinNames, loadAllChainNames
2. 增加utils.config的测试用例

## V0.6.3

Fixes:

1. agenda.service，当normal Task存在autoRunAmount时需要先检测数据库中的现存jobs

## V0.6.2

Features:

1. ProcessorRunner新增方法restart
2. process.service方法 requestChild修改为requestProcess

## V0.6.1

Fixes:

1. 修复ProcessorRunner启动是cwd和script混淆的问题
2. utils.config.fetchAllChainNames仅在env.server为main是需要调节

## V0.6.0

Feature:

1. 新增process.service, 该service负责全部子进程管理

Fixes: 修复Process相关事件监听

1. processRunner将相同的signal传递给child_process
2. jadepool主进程处理exit信号时直接使用传入的signal参数, 最后以process.exit(0)结束进程

## V0.5.2

1. `cancelFinishedJobs`方法中包含disabled Tasks

## V0.5.1

1. 新增环境变量`jadepool.env.instanceId`表示pm2启动时的进程序号
2. 移除agenda.task中的自动disable和enable
3. agenda.service在onDestroy时先进行stop()，以确保无多余task会后续执行
4. agenda.service在启动进程时调用`cancelFinishedJobs`方法，仅删除没有locked 且完全完成的任务

## V0.5.0

1. 模型TaskConfig新增字段autoRunAmount，用于NORMAL类型的jobtype
2. agenda.service 处理Task时，当TaskConfig中jobtype为NORMAL，则会在启动时自动运行{autoRunAmount}数量个Job
3. agenda.service 添加接口 runningJobs，可返回正在运行中的任务

## V0.1.x ~ V0.4.x

TODO, 建议从V0.5.0开始使用