You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1013 lines
35 KiB

deps: update gogo/protobuf version from v1.2.1 to v1.3.0 (#3947) * update gogo/protobuf version from v1.2.1 to v1.3.0 Also errcheck from v1.1.0 to v1.2.0 See full diff in - https://github.com/gogo/protobuf/compare/v1.2.1...v1.3.0 - https://github.com/kisielk/errcheck/compare/v1.1.0...v1.2.0 Changelog: Tested versions: go 1.12.9 protoc 3.7.1 Improvements: plugin/stringer - Handle repeated and/or nullable types a bit better now. plugin/size - Remove the loop in sovXXX by using bit twiddling. Thanks: https://github.com/apelisse plugin/marshalto - Implemented a reverse marshal strategy which allows for faster marshalling. This now avoids a recursive (and repeated) call to Size(). Thanks: https://github.com/apelisse plugin/compare - Added support for for oneof types. Bug fixes: protoc-gen-gogo/generator - Fix assignment to entry in nil map. Thanks: https://github.com/tgulacsi protoc-gen-gogo/generator - Allows plugins to call RecordTypeUse without panicking. Thanks: https://github.com/fedenusy proto/extensions - Fixed set extension regression. We did not clear the extensions before setting. io/uint32 - fix uint32reader bug that causes ReadMsg to recreate buffer when lengths are the same. Thanks: https://github.com/SebiSujar proto/table_merge: Fix merge of non-nullable slices. Thanks: https://github.com/euroelessar Upstream commits: merged in golang/protobuf commit 318d17de72747ed1c16502681db4b2bb709a92d0 - Add UnimplementedServer for server interface merged in golang/protobuf commit b85cd75de734650db18a99a943fe351d41387800 - protoc-gen-go/grpc: inline errUnimplemented function merged in golang/protobuf commit d3c38a4eb4970272b87a425ae00ccc4548e2f9bb - protoc-gen-go/grpc: use status and code packages only if needed merged in golang/protobuf commit e91709a02e0e8ff8b86b7aa913fdc9ae9498e825 - fix indentation in jsonpb with Any messages merged in golang/protobuf commit 8d0c54c1246661d9a51ca0ba455d22116d485eaa - protoc-gen-go: generate XXX_OneofWrappers instead of XXX_OneofFuncs Misc: extensions.md - Markdown update. Thanks: https://github.com/TennyZhuang Readme.md - Added user. go/protoc update - Updated to go1.12.x and protoc 3.7.1 Makefile update - fix go vet shadow tool reference test/mixbench - Update mixbench tool. Expose runnable benchmarks via flags. * update certstrap * update golangci-lint from v1.13.2 to v1.17.1 * update gox as well * test * comment out golangci temporary * comment out go-deadlock deps
5 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
limit number of /subscribe clients and queries per client (#3269) * limit number of /subscribe clients and queries per client Add the following config variables (under [rpc] section): * max_subscription_clients * max_subscriptions_per_client * timeout_broadcast_tx_commit Fixes #2826 new HTTPClient interface for subscriptions finalize HTTPClient events interface remove EventSubscriber fix data race ``` WARNING: DATA RACE Read at 0x00c000a36060 by goroutine 129: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe.func1() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:168 +0x1f0 Previous write at 0x00c000a36060 by goroutine 132: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:191 +0x4e0 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 129 (running) created at: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:164 +0x4b7 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 132 (running) created at: testing.(*T).Run() /usr/local/go/src/testing/testing.go:878 +0x659 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:119 +0x186 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 ================== ``` lite client works (tested manually) godoc comments httpclient: do not close the out channel use TimeoutBroadcastTxCommit no timeout for unsubscribe but 1s Local (5s HTTP) timeout for resubscribe format code change Subscribe#out cap to 1 and replace config vars with RPCConfig TimeoutBroadcastTxCommit can't be greater than rpcserver.WriteTimeout rpc: Context as first parameter to all functions reformat code fixes after my own review fixes after Ethan's review add test stubs fix config.toml * fixes after manual testing - rpc: do not recommend to use BroadcastTxCommit because it's slow and wastes Tendermint resources (pubsub) - rpc: better error in Subscribe and BroadcastTxCommit - HTTPClient: do not resubscribe if err = ErrAlreadySubscribed * fixes after Ismail's review * Update rpc/grpc/grpc_test.go Co-Authored-By: melekes <anton.kalyaev@gmail.com>
6 years ago
limit number of /subscribe clients and queries per client (#3269) * limit number of /subscribe clients and queries per client Add the following config variables (under [rpc] section): * max_subscription_clients * max_subscriptions_per_client * timeout_broadcast_tx_commit Fixes #2826 new HTTPClient interface for subscriptions finalize HTTPClient events interface remove EventSubscriber fix data race ``` WARNING: DATA RACE Read at 0x00c000a36060 by goroutine 129: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe.func1() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:168 +0x1f0 Previous write at 0x00c000a36060 by goroutine 132: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:191 +0x4e0 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 129 (running) created at: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:164 +0x4b7 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 132 (running) created at: testing.(*T).Run() /usr/local/go/src/testing/testing.go:878 +0x659 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:119 +0x186 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 ================== ``` lite client works (tested manually) godoc comments httpclient: do not close the out channel use TimeoutBroadcastTxCommit no timeout for unsubscribe but 1s Local (5s HTTP) timeout for resubscribe format code change Subscribe#out cap to 1 and replace config vars with RPCConfig TimeoutBroadcastTxCommit can't be greater than rpcserver.WriteTimeout rpc: Context as first parameter to all functions reformat code fixes after my own review fixes after Ethan's review add test stubs fix config.toml * fixes after manual testing - rpc: do not recommend to use BroadcastTxCommit because it's slow and wastes Tendermint resources (pubsub) - rpc: better error in Subscribe and BroadcastTxCommit - HTTPClient: do not resubscribe if err = ErrAlreadySubscribed * fixes after Ismail's review * Update rpc/grpc/grpc_test.go Co-Authored-By: melekes <anton.kalyaev@gmail.com>
6 years ago
deps: update gogo/protobuf version from v1.2.1 to v1.3.0 (#3947) * update gogo/protobuf version from v1.2.1 to v1.3.0 Also errcheck from v1.1.0 to v1.2.0 See full diff in - https://github.com/gogo/protobuf/compare/v1.2.1...v1.3.0 - https://github.com/kisielk/errcheck/compare/v1.1.0...v1.2.0 Changelog: Tested versions: go 1.12.9 protoc 3.7.1 Improvements: plugin/stringer - Handle repeated and/or nullable types a bit better now. plugin/size - Remove the loop in sovXXX by using bit twiddling. Thanks: https://github.com/apelisse plugin/marshalto - Implemented a reverse marshal strategy which allows for faster marshalling. This now avoids a recursive (and repeated) call to Size(). Thanks: https://github.com/apelisse plugin/compare - Added support for for oneof types. Bug fixes: protoc-gen-gogo/generator - Fix assignment to entry in nil map. Thanks: https://github.com/tgulacsi protoc-gen-gogo/generator - Allows plugins to call RecordTypeUse without panicking. Thanks: https://github.com/fedenusy proto/extensions - Fixed set extension regression. We did not clear the extensions before setting. io/uint32 - fix uint32reader bug that causes ReadMsg to recreate buffer when lengths are the same. Thanks: https://github.com/SebiSujar proto/table_merge: Fix merge of non-nullable slices. Thanks: https://github.com/euroelessar Upstream commits: merged in golang/protobuf commit 318d17de72747ed1c16502681db4b2bb709a92d0 - Add UnimplementedServer for server interface merged in golang/protobuf commit b85cd75de734650db18a99a943fe351d41387800 - protoc-gen-go/grpc: inline errUnimplemented function merged in golang/protobuf commit d3c38a4eb4970272b87a425ae00ccc4548e2f9bb - protoc-gen-go/grpc: use status and code packages only if needed merged in golang/protobuf commit e91709a02e0e8ff8b86b7aa913fdc9ae9498e825 - fix indentation in jsonpb with Any messages merged in golang/protobuf commit 8d0c54c1246661d9a51ca0ba455d22116d485eaa - protoc-gen-go: generate XXX_OneofWrappers instead of XXX_OneofFuncs Misc: extensions.md - Markdown update. Thanks: https://github.com/TennyZhuang Readme.md - Added user. go/protoc update - Updated to go1.12.x and protoc 3.7.1 Makefile update - fix go vet shadow tool reference test/mixbench - Update mixbench tool. Expose runnable benchmarks via flags. * update certstrap * update golangci-lint from v1.13.2 to v1.17.1 * update gox as well * test * comment out golangci temporary * comment out go-deadlock deps
5 years ago
limit number of /subscribe clients and queries per client (#3269) * limit number of /subscribe clients and queries per client Add the following config variables (under [rpc] section): * max_subscription_clients * max_subscriptions_per_client * timeout_broadcast_tx_commit Fixes #2826 new HTTPClient interface for subscriptions finalize HTTPClient events interface remove EventSubscriber fix data race ``` WARNING: DATA RACE Read at 0x00c000a36060 by goroutine 129: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe.func1() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:168 +0x1f0 Previous write at 0x00c000a36060 by goroutine 132: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:191 +0x4e0 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 129 (running) created at: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:164 +0x4b7 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 132 (running) created at: testing.(*T).Run() /usr/local/go/src/testing/testing.go:878 +0x659 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:119 +0x186 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 ================== ``` lite client works (tested manually) godoc comments httpclient: do not close the out channel use TimeoutBroadcastTxCommit no timeout for unsubscribe but 1s Local (5s HTTP) timeout for resubscribe format code change Subscribe#out cap to 1 and replace config vars with RPCConfig TimeoutBroadcastTxCommit can't be greater than rpcserver.WriteTimeout rpc: Context as first parameter to all functions reformat code fixes after my own review fixes after Ethan's review add test stubs fix config.toml * fixes after manual testing - rpc: do not recommend to use BroadcastTxCommit because it's slow and wastes Tendermint resources (pubsub) - rpc: better error in Subscribe and BroadcastTxCommit - HTTPClient: do not resubscribe if err = ErrAlreadySubscribed * fixes after Ismail's review * Update rpc/grpc/grpc_test.go Co-Authored-By: melekes <anton.kalyaev@gmail.com>
6 years ago
limit number of /subscribe clients and queries per client (#3269) * limit number of /subscribe clients and queries per client Add the following config variables (under [rpc] section): * max_subscription_clients * max_subscriptions_per_client * timeout_broadcast_tx_commit Fixes #2826 new HTTPClient interface for subscriptions finalize HTTPClient events interface remove EventSubscriber fix data race ``` WARNING: DATA RACE Read at 0x00c000a36060 by goroutine 129: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe.func1() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:168 +0x1f0 Previous write at 0x00c000a36060 by goroutine 132: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:191 +0x4e0 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 129 (running) created at: github.com/tendermint/tendermint/rpc/client.(*Local).Subscribe() /go/src/github.com/tendermint/tendermint/rpc/client/localclient.go:164 +0x4b7 github.com/tendermint/tendermint/rpc/client.WaitForOneEvent() /go/src/github.com/tendermint/tendermint/rpc/client/helpers.go:64 +0x178 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync.func1() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:139 +0x298 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 Goroutine 132 (running) created at: testing.(*T).Run() /usr/local/go/src/testing/testing.go:878 +0x659 github.com/tendermint/tendermint/rpc/client_test.TestTxEventsSentWithBroadcastTxSync() /go/src/github.com/tendermint/tendermint/rpc/client/event_test.go:119 +0x186 testing.tRunner() /usr/local/go/src/testing/testing.go:827 +0x162 ================== ``` lite client works (tested manually) godoc comments httpclient: do not close the out channel use TimeoutBroadcastTxCommit no timeout for unsubscribe but 1s Local (5s HTTP) timeout for resubscribe format code change Subscribe#out cap to 1 and replace config vars with RPCConfig TimeoutBroadcastTxCommit can't be greater than rpcserver.WriteTimeout rpc: Context as first parameter to all functions reformat code fixes after my own review fixes after Ethan's review add test stubs fix config.toml * fixes after manual testing - rpc: do not recommend to use BroadcastTxCommit because it's slow and wastes Tendermint resources (pubsub) - rpc: better error in Subscribe and BroadcastTxCommit - HTTPClient: do not resubscribe if err = ErrAlreadySubscribed * fixes after Ismail's review * Update rpc/grpc/grpc_test.go Co-Authored-By: melekes <anton.kalyaev@gmail.com>
6 years ago
blockchain: Reorg reactor (#3561) * go routines in blockchain reactor * Added reference to the go routine diagram * Initial commit * cleanup * Undo testing_logger change, committed by mistake * Fix the test loggers * pulled some fsm code into pool.go * added pool tests * changes to the design added block requests under peer moved the request trigger in the reactor poolRoutine, triggered now by a ticker in general moved everything required for making block requests smarter in the poolRoutine added a simple map of heights to keep track of what will need to be requested next added a few more tests * send errors to FSM in a different channel than blocks send errors (RemovePeer) from switch on a different channel than the one receiving blocks renamed channels added more pool tests * more pool tests * lint errors * more tests * more tests * switch fast sync to new implementation * fixed data race in tests * cleanup * finished fsm tests * address golangci comments :) * address golangci comments :) * Added timeout on next block needed to advance * updating docs and cleanup * fix issue in test from previous cleanup * cleanup * Added termination scenarios, tests and more cleanup * small fixes to adr, comments and cleanup * Fix bug in sendRequest() If we tried to send a request to a peer not present in the switch, a missing continue statement caused the request to be blackholed in a peer that was removed and never retried. While this bug was manifesting, the reactor kept asking for other blocks that would be stored and never consumed. Added the number of unconsumed blocks in the math for requesting blocks ahead of current processing height so eventually there will be no more blocks requested until the already received ones are consumed. * remove bpPeer's didTimeout field * Use distinct err codes for peer timeout and FSM timeouts * Don't allow peers to update with lower height * review comments from Ethan and Zarko * some cleanup, renaming, comments * Move block execution in separate goroutine * Remove pool's numPending * review comments * fix lint, remove old blockchain reactor and duplicates in fsm tests * small reorg around peer after review comments * add the reactor spec * verify block only once * review comments * change to int for max number of pending requests * cleanup and godoc * Add configuration flag fast sync version * golangci fixes * fix config template * move both reactor versions under blockchain * cleanup, golint, renaming stuff * updated documentation, fixed more golint warnings * integrate with behavior package * sync with master * gofmt * add changelog_pending entry * move to improvments * suggestion to changelog entry
5 years ago
  1. package config
  2. import (
  3. "fmt"
  4. "net/http"
  5. "os"
  6. "path/filepath"
  7. "time"
  8. "github.com/pkg/errors"
  9. )
  10. const (
  11. // FuzzModeDrop is a mode in which we randomly drop reads/writes, connections or sleep
  12. FuzzModeDrop = iota
  13. // FuzzModeDelay is a mode in which we randomly sleep
  14. FuzzModeDelay
  15. // LogFormatPlain is a format for colored text
  16. LogFormatPlain = "plain"
  17. // LogFormatJSON is a format for json output
  18. LogFormatJSON = "json"
  19. )
  20. // NOTE: Most of the structs & relevant comments + the
  21. // default configuration options were used to manually
  22. // generate the config.toml. Please reflect any changes
  23. // made here in the defaultConfigTemplate constant in
  24. // config/toml.go
  25. // NOTE: libs/cli must know to look in the config dir!
  26. var (
  27. DefaultTendermintDir = ".tendermint"
  28. defaultConfigDir = "config"
  29. defaultDataDir = "data"
  30. defaultConfigFileName = "config.toml"
  31. defaultGenesisJSONName = "genesis.json"
  32. defaultPrivValKeyName = "priv_validator_key.json"
  33. defaultPrivValStateName = "priv_validator_state.json"
  34. defaultNodeKeyName = "node_key.json"
  35. defaultAddrBookName = "addrbook.json"
  36. defaultConfigFilePath = filepath.Join(defaultConfigDir, defaultConfigFileName)
  37. defaultGenesisJSONPath = filepath.Join(defaultConfigDir, defaultGenesisJSONName)
  38. defaultPrivValKeyPath = filepath.Join(defaultConfigDir, defaultPrivValKeyName)
  39. defaultPrivValStatePath = filepath.Join(defaultDataDir, defaultPrivValStateName)
  40. defaultNodeKeyPath = filepath.Join(defaultConfigDir, defaultNodeKeyName)
  41. defaultAddrBookPath = filepath.Join(defaultConfigDir, defaultAddrBookName)
  42. )
  43. var (
  44. oldPrivVal = "priv_validator.json"
  45. oldPrivValPath = filepath.Join(defaultConfigDir, oldPrivVal)
  46. )
  47. // Config defines the top level configuration for a Tendermint node
  48. type Config struct {
  49. // Top level options use an anonymous struct
  50. BaseConfig `mapstructure:",squash"`
  51. // Options for services
  52. RPC *RPCConfig `mapstructure:"rpc"`
  53. P2P *P2PConfig `mapstructure:"p2p"`
  54. Mempool *MempoolConfig `mapstructure:"mempool"`
  55. FastSync *FastSyncConfig `mapstructure:"fastsync"`
  56. Consensus *ConsensusConfig `mapstructure:"consensus"`
  57. TxIndex *TxIndexConfig `mapstructure:"tx_index"`
  58. Instrumentation *InstrumentationConfig `mapstructure:"instrumentation"`
  59. }
  60. // DefaultConfig returns a default configuration for a Tendermint node
  61. func DefaultConfig() *Config {
  62. return &Config{
  63. BaseConfig: DefaultBaseConfig(),
  64. RPC: DefaultRPCConfig(),
  65. P2P: DefaultP2PConfig(),
  66. Mempool: DefaultMempoolConfig(),
  67. FastSync: DefaultFastSyncConfig(),
  68. Consensus: DefaultConsensusConfig(),
  69. TxIndex: DefaultTxIndexConfig(),
  70. Instrumentation: DefaultInstrumentationConfig(),
  71. }
  72. }
  73. // TestConfig returns a configuration that can be used for testing
  74. func TestConfig() *Config {
  75. return &Config{
  76. BaseConfig: TestBaseConfig(),
  77. RPC: TestRPCConfig(),
  78. P2P: TestP2PConfig(),
  79. Mempool: TestMempoolConfig(),
  80. FastSync: TestFastSyncConfig(),
  81. Consensus: TestConsensusConfig(),
  82. TxIndex: TestTxIndexConfig(),
  83. Instrumentation: TestInstrumentationConfig(),
  84. }
  85. }
  86. // SetRoot sets the RootDir for all Config structs
  87. func (cfg *Config) SetRoot(root string) *Config {
  88. cfg.BaseConfig.RootDir = root
  89. cfg.RPC.RootDir = root
  90. cfg.P2P.RootDir = root
  91. cfg.Mempool.RootDir = root
  92. cfg.Consensus.RootDir = root
  93. return cfg
  94. }
  95. // ValidateBasic performs basic validation (checking param bounds, etc.) and
  96. // returns an error if any check fails.
  97. func (cfg *Config) ValidateBasic() error {
  98. if err := cfg.BaseConfig.ValidateBasic(); err != nil {
  99. return err
  100. }
  101. if err := cfg.RPC.ValidateBasic(); err != nil {
  102. return errors.Wrap(err, "Error in [rpc] section")
  103. }
  104. if err := cfg.P2P.ValidateBasic(); err != nil {
  105. return errors.Wrap(err, "Error in [p2p] section")
  106. }
  107. if err := cfg.Mempool.ValidateBasic(); err != nil {
  108. return errors.Wrap(err, "Error in [mempool] section")
  109. }
  110. if err := cfg.FastSync.ValidateBasic(); err != nil {
  111. return errors.Wrap(err, "Error in [fastsync] section")
  112. }
  113. if err := cfg.Consensus.ValidateBasic(); err != nil {
  114. return errors.Wrap(err, "Error in [consensus] section")
  115. }
  116. return errors.Wrap(
  117. cfg.Instrumentation.ValidateBasic(),
  118. "Error in [instrumentation] section",
  119. )
  120. }
  121. //-----------------------------------------------------------------------------
  122. // BaseConfig
  123. // BaseConfig defines the base configuration for a Tendermint node
  124. type BaseConfig struct { //nolint: maligned
  125. // chainID is unexposed and immutable but here for convenience
  126. chainID string
  127. // The root directory for all data.
  128. // This should be set in viper so it can unmarshal into this struct
  129. RootDir string `mapstructure:"home"`
  130. // TCP or UNIX socket address of the ABCI application,
  131. // or the name of an ABCI application compiled in with the Tendermint binary
  132. ProxyApp string `mapstructure:"proxy_app"`
  133. // A custom human readable name for this node
  134. Moniker string `mapstructure:"moniker"`
  135. // If this node is many blocks behind the tip of the chain, FastSync
  136. // allows them to catchup quickly by downloading blocks in parallel
  137. // and verifying their commits
  138. FastSyncMode bool `mapstructure:"fast_sync"`
  139. // Database backend: goleveldb | cleveldb | boltdb | rocksdb
  140. // * goleveldb (github.com/syndtr/goleveldb - most popular implementation)
  141. // - pure go
  142. // - stable
  143. // * cleveldb (uses levigo wrapper)
  144. // - fast
  145. // - requires gcc
  146. // - use cleveldb build tag (go build -tags cleveldb)
  147. // * boltdb (uses etcd's fork of bolt - github.com/etcd-io/bbolt)
  148. // - EXPERIMENTAL
  149. // - may be faster is some use-cases (random reads - indexer)
  150. // - use boltdb build tag (go build -tags boltdb)
  151. // * rocksdb (uses github.com/tecbot/gorocksdb)
  152. // - EXPERIMENTAL
  153. // - requires gcc
  154. // - use rocksdb build tag (go build -tags rocksdb)
  155. DBBackend string `mapstructure:"db_backend"`
  156. // Database directory
  157. DBPath string `mapstructure:"db_dir"`
  158. // Output level for logging
  159. LogLevel string `mapstructure:"log_level"`
  160. // Output format: 'plain' (colored text) or 'json'
  161. LogFormat string `mapstructure:"log_format"`
  162. // Path to the JSON file containing the initial validator set and other meta data
  163. Genesis string `mapstructure:"genesis_file"`
  164. // Path to the JSON file containing the private key to use as a validator in the consensus protocol
  165. PrivValidatorKey string `mapstructure:"priv_validator_key_file"`
  166. // Path to the JSON file containing the last sign state of a validator
  167. PrivValidatorState string `mapstructure:"priv_validator_state_file"`
  168. // TCP or UNIX socket address for Tendermint to listen on for
  169. // connections from an external PrivValidator process
  170. PrivValidatorListenAddr string `mapstructure:"priv_validator_laddr"`
  171. // A JSON file containing the private key to use for p2p authenticated encryption
  172. NodeKey string `mapstructure:"node_key_file"`
  173. // Mechanism to connect to the ABCI application: socket | grpc
  174. ABCI string `mapstructure:"abci"`
  175. // TCP or UNIX socket address for the profiling server to listen on
  176. ProfListenAddress string `mapstructure:"prof_laddr"`
  177. // If true, query the ABCI app on connecting to a new peer
  178. // so the app can decide if we should keep the connection or not
  179. FilterPeers bool `mapstructure:"filter_peers"` // false
  180. }
  181. // DefaultBaseConfig returns a default base configuration for a Tendermint node
  182. func DefaultBaseConfig() BaseConfig {
  183. return BaseConfig{
  184. Genesis: defaultGenesisJSONPath,
  185. PrivValidatorKey: defaultPrivValKeyPath,
  186. PrivValidatorState: defaultPrivValStatePath,
  187. NodeKey: defaultNodeKeyPath,
  188. Moniker: defaultMoniker,
  189. ProxyApp: "tcp://127.0.0.1:26658",
  190. ABCI: "socket",
  191. LogLevel: DefaultPackageLogLevels(),
  192. LogFormat: LogFormatPlain,
  193. ProfListenAddress: "",
  194. FastSyncMode: true,
  195. FilterPeers: false,
  196. DBBackend: "goleveldb",
  197. DBPath: "data",
  198. }
  199. }
  200. // TestBaseConfig returns a base configuration for testing a Tendermint node
  201. func TestBaseConfig() BaseConfig {
  202. cfg := DefaultBaseConfig()
  203. cfg.chainID = "tendermint_test"
  204. cfg.ProxyApp = "kvstore"
  205. cfg.FastSyncMode = false
  206. cfg.DBBackend = "memdb"
  207. return cfg
  208. }
  209. func (cfg BaseConfig) ChainID() string {
  210. return cfg.chainID
  211. }
  212. // GenesisFile returns the full path to the genesis.json file
  213. func (cfg BaseConfig) GenesisFile() string {
  214. return rootify(cfg.Genesis, cfg.RootDir)
  215. }
  216. // PrivValidatorKeyFile returns the full path to the priv_validator_key.json file
  217. func (cfg BaseConfig) PrivValidatorKeyFile() string {
  218. return rootify(cfg.PrivValidatorKey, cfg.RootDir)
  219. }
  220. // PrivValidatorFile returns the full path to the priv_validator_state.json file
  221. func (cfg BaseConfig) PrivValidatorStateFile() string {
  222. return rootify(cfg.PrivValidatorState, cfg.RootDir)
  223. }
  224. // OldPrivValidatorFile returns the full path of the priv_validator.json from pre v0.28.0.
  225. // TODO: eventually remove.
  226. func (cfg BaseConfig) OldPrivValidatorFile() string {
  227. return rootify(oldPrivValPath, cfg.RootDir)
  228. }
  229. // NodeKeyFile returns the full path to the node_key.json file
  230. func (cfg BaseConfig) NodeKeyFile() string {
  231. return rootify(cfg.NodeKey, cfg.RootDir)
  232. }
  233. // DBDir returns the full path to the database directory
  234. func (cfg BaseConfig) DBDir() string {
  235. return rootify(cfg.DBPath, cfg.RootDir)
  236. }
  237. // ValidateBasic performs basic validation (checking param bounds, etc.) and
  238. // returns an error if any check fails.
  239. func (cfg BaseConfig) ValidateBasic() error {
  240. switch cfg.LogFormat {
  241. case LogFormatPlain, LogFormatJSON:
  242. default:
  243. return errors.New("unknown log_format (must be 'plain' or 'json')")
  244. }
  245. return nil
  246. }
  247. // DefaultLogLevel returns a default log level of "error"
  248. func DefaultLogLevel() string {
  249. return "error"
  250. }
  251. // DefaultPackageLogLevels returns a default log level setting so all packages
  252. // log at "error", while the `state` and `main` packages log at "info"
  253. func DefaultPackageLogLevels() string {
  254. return fmt.Sprintf("main:info,state:info,*:%s", DefaultLogLevel())
  255. }
  256. //-----------------------------------------------------------------------------
  257. // RPCConfig
  258. // RPCConfig defines the configuration options for the Tendermint RPC server
  259. type RPCConfig struct {
  260. RootDir string `mapstructure:"home"`
  261. // TCP or UNIX socket address for the RPC server to listen on
  262. ListenAddress string `mapstructure:"laddr"`
  263. // A list of origins a cross-domain request can be executed from.
  264. // If the special '*' value is present in the list, all origins will be allowed.
  265. // An origin may contain a wildcard (*) to replace 0 or more characters (i.e.: http://*.domain.com).
  266. // Only one wildcard can be used per origin.
  267. CORSAllowedOrigins []string `mapstructure:"cors_allowed_origins"`
  268. // A list of methods the client is allowed to use with cross-domain requests.
  269. CORSAllowedMethods []string `mapstructure:"cors_allowed_methods"`
  270. // A list of non simple headers the client is allowed to use with cross-domain requests.
  271. CORSAllowedHeaders []string `mapstructure:"cors_allowed_headers"`
  272. // TCP or UNIX socket address for the gRPC server to listen on
  273. // NOTE: This server only supports /broadcast_tx_commit
  274. GRPCListenAddress string `mapstructure:"grpc_laddr"`
  275. // Maximum number of simultaneous connections.
  276. // Does not include RPC (HTTP&WebSocket) connections. See max_open_connections
  277. // If you want to accept a larger number than the default, make sure
  278. // you increase your OS limits.
  279. // 0 - unlimited.
  280. GRPCMaxOpenConnections int `mapstructure:"grpc_max_open_connections"`
  281. // Activate unsafe RPC commands like /dial_persistent_peers and /unsafe_flush_mempool
  282. Unsafe bool `mapstructure:"unsafe"`
  283. // Maximum number of simultaneous connections (including WebSocket).
  284. // Does not include gRPC connections. See grpc_max_open_connections
  285. // If you want to accept a larger number than the default, make sure
  286. // you increase your OS limits.
  287. // 0 - unlimited.
  288. // Should be < {ulimit -Sn} - {MaxNumInboundPeers} - {MaxNumOutboundPeers} - {N of wal, db and other open files}
  289. // 1024 - 40 - 10 - 50 = 924 = ~900
  290. MaxOpenConnections int `mapstructure:"max_open_connections"`
  291. // Maximum number of unique clientIDs that can /subscribe
  292. // If you're using /broadcast_tx_commit, set to the estimated maximum number
  293. // of broadcast_tx_commit calls per block.
  294. MaxSubscriptionClients int `mapstructure:"max_subscription_clients"`
  295. // Maximum number of unique queries a given client can /subscribe to
  296. // If you're using GRPC (or Local RPC client) and /broadcast_tx_commit, set
  297. // to the estimated maximum number of broadcast_tx_commit calls per block.
  298. MaxSubscriptionsPerClient int `mapstructure:"max_subscriptions_per_client"`
  299. // How long to wait for a tx to be committed during /broadcast_tx_commit
  300. // WARNING: Using a value larger than 10s will result in increasing the
  301. // global HTTP write timeout, which applies to all connections and endpoints.
  302. // See https://github.com/tendermint/tendermint/issues/3435
  303. TimeoutBroadcastTxCommit time.Duration `mapstructure:"timeout_broadcast_tx_commit"`
  304. // Maximum size of request body, in bytes
  305. MaxBodyBytes int64 `mapstructure:"max_body_bytes"`
  306. // Maximum size of request header, in bytes
  307. MaxHeaderBytes int `mapstructure:"max_header_bytes"`
  308. // The path to a file containing certificate that is used to create the HTTPS server.
  309. // Migth be either absolute path or path related to tendermint's config directory.
  310. //
  311. // If the certificate is signed by a certificate authority,
  312. // the certFile should be the concatenation of the server's certificate, any intermediates,
  313. // and the CA's certificate.
  314. //
  315. // NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server.
  316. // Otherwise, HTTP server is run.
  317. TLSCertFile string `mapstructure:"tls_cert_file"`
  318. // The path to a file containing matching private key that is used to create the HTTPS server.
  319. // Migth be either absolute path or path related to tendermint's config directory.
  320. //
  321. // NOTE: both tls_cert_file and tls_key_file must be present for Tendermint to create HTTPS server.
  322. // Otherwise, HTTP server is run.
  323. TLSKeyFile string `mapstructure:"tls_key_file"`
  324. }
  325. // DefaultRPCConfig returns a default configuration for the RPC server
  326. func DefaultRPCConfig() *RPCConfig {
  327. return &RPCConfig{
  328. ListenAddress: "tcp://127.0.0.1:26657",
  329. CORSAllowedOrigins: []string{},
  330. CORSAllowedMethods: []string{http.MethodHead, http.MethodGet, http.MethodPost},
  331. CORSAllowedHeaders: []string{"Origin", "Accept", "Content-Type", "X-Requested-With", "X-Server-Time"},
  332. GRPCListenAddress: "",
  333. GRPCMaxOpenConnections: 900,
  334. Unsafe: false,
  335. MaxOpenConnections: 900,
  336. MaxSubscriptionClients: 100,
  337. MaxSubscriptionsPerClient: 5,
  338. TimeoutBroadcastTxCommit: 10 * time.Second,
  339. MaxBodyBytes: int64(1000000), // 1MB
  340. MaxHeaderBytes: 1 << 20, // same as the net/http default
  341. TLSCertFile: "",
  342. TLSKeyFile: "",
  343. }
  344. }
  345. // TestRPCConfig returns a configuration for testing the RPC server
  346. func TestRPCConfig() *RPCConfig {
  347. cfg := DefaultRPCConfig()
  348. cfg.ListenAddress = "tcp://0.0.0.0:36657"
  349. cfg.GRPCListenAddress = "tcp://0.0.0.0:36658"
  350. cfg.Unsafe = true
  351. return cfg
  352. }
  353. // ValidateBasic performs basic validation (checking param bounds, etc.) and
  354. // returns an error if any check fails.
  355. func (cfg *RPCConfig) ValidateBasic() error {
  356. if cfg.GRPCMaxOpenConnections < 0 {
  357. return errors.New("grpc_max_open_connections can't be negative")
  358. }
  359. if cfg.MaxOpenConnections < 0 {
  360. return errors.New("max_open_connections can't be negative")
  361. }
  362. if cfg.MaxSubscriptionClients < 0 {
  363. return errors.New("max_subscription_clients can't be negative")
  364. }
  365. if cfg.MaxSubscriptionsPerClient < 0 {
  366. return errors.New("max_subscriptions_per_client can't be negative")
  367. }
  368. if cfg.TimeoutBroadcastTxCommit < 0 {
  369. return errors.New("timeout_broadcast_tx_commit can't be negative")
  370. }
  371. if cfg.MaxBodyBytes < 0 {
  372. return errors.New("max_body_bytes can't be negative")
  373. }
  374. if cfg.MaxHeaderBytes < 0 {
  375. return errors.New("max_header_bytes can't be negative")
  376. }
  377. return nil
  378. }
  379. // IsCorsEnabled returns true if cross-origin resource sharing is enabled.
  380. func (cfg *RPCConfig) IsCorsEnabled() bool {
  381. return len(cfg.CORSAllowedOrigins) != 0
  382. }
  383. func (cfg RPCConfig) KeyFile() string {
  384. path := cfg.TLSKeyFile
  385. if filepath.IsAbs(path) {
  386. return path
  387. }
  388. return rootify(filepath.Join(defaultConfigDir, path), cfg.RootDir)
  389. }
  390. func (cfg RPCConfig) CertFile() string {
  391. path := cfg.TLSCertFile
  392. if filepath.IsAbs(path) {
  393. return path
  394. }
  395. return rootify(filepath.Join(defaultConfigDir, path), cfg.RootDir)
  396. }
  397. func (cfg RPCConfig) IsTLSEnabled() bool {
  398. return cfg.TLSCertFile != "" && cfg.TLSKeyFile != ""
  399. }
  400. //-----------------------------------------------------------------------------
  401. // P2PConfig
  402. // P2PConfig defines the configuration options for the Tendermint peer-to-peer networking layer
  403. type P2PConfig struct { //nolint: maligned
  404. RootDir string `mapstructure:"home"`
  405. // Address to listen for incoming connections
  406. ListenAddress string `mapstructure:"laddr"`
  407. // Address to advertise to peers for them to dial
  408. ExternalAddress string `mapstructure:"external_address"`
  409. // Comma separated list of seed nodes to connect to
  410. // We only use these if we can’t connect to peers in the addrbook
  411. Seeds string `mapstructure:"seeds"`
  412. // Comma separated list of nodes to keep persistent connections to
  413. PersistentPeers string `mapstructure:"persistent_peers"`
  414. // UPNP port forwarding
  415. UPNP bool `mapstructure:"upnp"`
  416. // Path to address book
  417. AddrBook string `mapstructure:"addr_book_file"`
  418. // Set true for strict address routability rules
  419. // Set false for private or local networks
  420. AddrBookStrict bool `mapstructure:"addr_book_strict"`
  421. // Maximum number of inbound peers
  422. MaxNumInboundPeers int `mapstructure:"max_num_inbound_peers"`
  423. // Maximum number of outbound peers to connect to, excluding persistent peers
  424. MaxNumOutboundPeers int `mapstructure:"max_num_outbound_peers"`
  425. // List of node IDs, to which a connection will be (re)established ignoring any existing limits
  426. UnconditionalPeerIDs string `mapstructure:"unconditional_peer_ids"`
  427. // Maximum pause when redialing a persistent peer (if zero, exponential backoff is used)
  428. PersistentPeersMaxDialPeriod time.Duration `mapstructure:"persistent_peers_max_dial_period"`
  429. // Time to wait before flushing messages out on the connection
  430. FlushThrottleTimeout time.Duration `mapstructure:"flush_throttle_timeout"`
  431. // Maximum size of a message packet payload, in bytes
  432. MaxPacketMsgPayloadSize int `mapstructure:"max_packet_msg_payload_size"`
  433. // Rate at which packets can be sent, in bytes/second
  434. SendRate int64 `mapstructure:"send_rate"`
  435. // Rate at which packets can be received, in bytes/second
  436. RecvRate int64 `mapstructure:"recv_rate"`
  437. // Set true to enable the peer-exchange reactor
  438. PexReactor bool `mapstructure:"pex"`
  439. // Seed mode, in which node constantly crawls the network and looks for
  440. // peers. If another node asks it for addresses, it responds and disconnects.
  441. //
  442. // Does not work if the peer-exchange reactor is disabled.
  443. SeedMode bool `mapstructure:"seed_mode"`
  444. // Comma separated list of peer IDs to keep private (will not be gossiped to
  445. // other peers)
  446. PrivatePeerIDs string `mapstructure:"private_peer_ids"`
  447. // Toggle to disable guard against peers connecting from the same ip.
  448. AllowDuplicateIP bool `mapstructure:"allow_duplicate_ip"`
  449. // Peer connection configuration.
  450. HandshakeTimeout time.Duration `mapstructure:"handshake_timeout"`
  451. DialTimeout time.Duration `mapstructure:"dial_timeout"`
  452. // Testing params.
  453. // Force dial to fail
  454. TestDialFail bool `mapstructure:"test_dial_fail"`
  455. // FUzz connection
  456. TestFuzz bool `mapstructure:"test_fuzz"`
  457. TestFuzzConfig *FuzzConnConfig `mapstructure:"test_fuzz_config"`
  458. }
  459. // DefaultP2PConfig returns a default configuration for the peer-to-peer layer
  460. func DefaultP2PConfig() *P2PConfig {
  461. return &P2PConfig{
  462. ListenAddress: "tcp://0.0.0.0:26656",
  463. ExternalAddress: "",
  464. UPNP: false,
  465. AddrBook: defaultAddrBookPath,
  466. AddrBookStrict: true,
  467. MaxNumInboundPeers: 40,
  468. MaxNumOutboundPeers: 10,
  469. PersistentPeersMaxDialPeriod: 0 * time.Second,
  470. FlushThrottleTimeout: 100 * time.Millisecond,
  471. MaxPacketMsgPayloadSize: 1024, // 1 kB
  472. SendRate: 5120000, // 5 mB/s
  473. RecvRate: 5120000, // 5 mB/s
  474. PexReactor: true,
  475. SeedMode: false,
  476. AllowDuplicateIP: false,
  477. HandshakeTimeout: 20 * time.Second,
  478. DialTimeout: 3 * time.Second,
  479. TestDialFail: false,
  480. TestFuzz: false,
  481. TestFuzzConfig: DefaultFuzzConnConfig(),
  482. }
  483. }
  484. // TestP2PConfig returns a configuration for testing the peer-to-peer layer
  485. func TestP2PConfig() *P2PConfig {
  486. cfg := DefaultP2PConfig()
  487. cfg.ListenAddress = "tcp://0.0.0.0:36656"
  488. cfg.FlushThrottleTimeout = 10 * time.Millisecond
  489. cfg.AllowDuplicateIP = true
  490. return cfg
  491. }
  492. // AddrBookFile returns the full path to the address book
  493. func (cfg *P2PConfig) AddrBookFile() string {
  494. return rootify(cfg.AddrBook, cfg.RootDir)
  495. }
  496. // ValidateBasic performs basic validation (checking param bounds, etc.) and
  497. // returns an error if any check fails.
  498. func (cfg *P2PConfig) ValidateBasic() error {
  499. if cfg.MaxNumInboundPeers < 0 {
  500. return errors.New("max_num_inbound_peers can't be negative")
  501. }
  502. if cfg.MaxNumOutboundPeers < 0 {
  503. return errors.New("max_num_outbound_peers can't be negative")
  504. }
  505. if cfg.FlushThrottleTimeout < 0 {
  506. return errors.New("flush_throttle_timeout can't be negative")
  507. }
  508. if cfg.PersistentPeersMaxDialPeriod < 0 {
  509. return errors.New("persistent_peers_max_dial_period can't be negative")
  510. }
  511. if cfg.MaxPacketMsgPayloadSize < 0 {
  512. return errors.New("max_packet_msg_payload_size can't be negative")
  513. }
  514. if cfg.SendRate < 0 {
  515. return errors.New("send_rate can't be negative")
  516. }
  517. if cfg.RecvRate < 0 {
  518. return errors.New("recv_rate can't be negative")
  519. }
  520. return nil
  521. }
  522. // FuzzConnConfig is a FuzzedConnection configuration.
  523. type FuzzConnConfig struct {
  524. Mode int
  525. MaxDelay time.Duration
  526. ProbDropRW float64
  527. ProbDropConn float64
  528. ProbSleep float64
  529. }
  530. // DefaultFuzzConnConfig returns the default config.
  531. func DefaultFuzzConnConfig() *FuzzConnConfig {
  532. return &FuzzConnConfig{
  533. Mode: FuzzModeDrop,
  534. MaxDelay: 3 * time.Second,
  535. ProbDropRW: 0.2,
  536. ProbDropConn: 0.00,
  537. ProbSleep: 0.00,
  538. }
  539. }
  540. //-----------------------------------------------------------------------------
  541. // MempoolConfig
  542. // MempoolConfig defines the configuration options for the Tendermint mempool
  543. type MempoolConfig struct {
  544. RootDir string `mapstructure:"home"`
  545. Recheck bool `mapstructure:"recheck"`
  546. Broadcast bool `mapstructure:"broadcast"`
  547. WalPath string `mapstructure:"wal_dir"`
  548. Size int `mapstructure:"size"`
  549. MaxTxsBytes int64 `mapstructure:"max_txs_bytes"`
  550. CacheSize int `mapstructure:"cache_size"`
  551. MaxTxBytes int `mapstructure:"max_tx_bytes"`
  552. }
  553. // DefaultMempoolConfig returns a default configuration for the Tendermint mempool
  554. func DefaultMempoolConfig() *MempoolConfig {
  555. return &MempoolConfig{
  556. Recheck: true,
  557. Broadcast: true,
  558. WalPath: "",
  559. // Each signature verification takes .5ms, Size reduced until we implement
  560. // ABCI Recheck
  561. Size: 5000,
  562. MaxTxsBytes: 1024 * 1024 * 1024, // 1GB
  563. CacheSize: 10000,
  564. MaxTxBytes: 1024 * 1024, // 1MB
  565. }
  566. }
  567. // TestMempoolConfig returns a configuration for testing the Tendermint mempool
  568. func TestMempoolConfig() *MempoolConfig {
  569. cfg := DefaultMempoolConfig()
  570. cfg.CacheSize = 1000
  571. return cfg
  572. }
  573. // WalDir returns the full path to the mempool's write-ahead log
  574. func (cfg *MempoolConfig) WalDir() string {
  575. return rootify(cfg.WalPath, cfg.RootDir)
  576. }
  577. // WalEnabled returns true if the WAL is enabled.
  578. func (cfg *MempoolConfig) WalEnabled() bool {
  579. return cfg.WalPath != ""
  580. }
  581. // ValidateBasic performs basic validation (checking param bounds, etc.) and
  582. // returns an error if any check fails.
  583. func (cfg *MempoolConfig) ValidateBasic() error {
  584. if cfg.Size < 0 {
  585. return errors.New("size can't be negative")
  586. }
  587. if cfg.MaxTxsBytes < 0 {
  588. return errors.New("max_txs_bytes can't be negative")
  589. }
  590. if cfg.CacheSize < 0 {
  591. return errors.New("cache_size can't be negative")
  592. }
  593. if cfg.MaxTxBytes < 0 {
  594. return errors.New("max_tx_bytes can't be negative")
  595. }
  596. return nil
  597. }
  598. //-----------------------------------------------------------------------------
  599. // FastSyncConfig
  600. // FastSyncConfig defines the configuration for the Tendermint fast sync service
  601. type FastSyncConfig struct {
  602. Version string `mapstructure:"version"`
  603. }
  604. // DefaultFastSyncConfig returns a default configuration for the fast sync service
  605. func DefaultFastSyncConfig() *FastSyncConfig {
  606. return &FastSyncConfig{
  607. Version: "v0",
  608. }
  609. }
  610. // TestFastSyncConfig returns a default configuration for the fast sync.
  611. func TestFastSyncConfig() *FastSyncConfig {
  612. return DefaultFastSyncConfig()
  613. }
  614. // ValidateBasic performs basic validation.
  615. func (cfg *FastSyncConfig) ValidateBasic() error {
  616. switch cfg.Version {
  617. case "v0":
  618. return nil
  619. case "v1":
  620. return nil
  621. default:
  622. return fmt.Errorf("unknown fastsync version %s", cfg.Version)
  623. }
  624. }
  625. //-----------------------------------------------------------------------------
  626. // ConsensusConfig
  627. // ConsensusConfig defines the configuration for the Tendermint consensus service,
  628. // including timeouts and details about the WAL and the block structure.
  629. type ConsensusConfig struct {
  630. RootDir string `mapstructure:"home"`
  631. WalPath string `mapstructure:"wal_file"`
  632. walFile string // overrides WalPath if set
  633. TimeoutPropose time.Duration `mapstructure:"timeout_propose"`
  634. TimeoutProposeDelta time.Duration `mapstructure:"timeout_propose_delta"`
  635. TimeoutPrevote time.Duration `mapstructure:"timeout_prevote"`
  636. TimeoutPrevoteDelta time.Duration `mapstructure:"timeout_prevote_delta"`
  637. TimeoutPrecommit time.Duration `mapstructure:"timeout_precommit"`
  638. TimeoutPrecommitDelta time.Duration `mapstructure:"timeout_precommit_delta"`
  639. TimeoutCommit time.Duration `mapstructure:"timeout_commit"`
  640. // Make progress as soon as we have all the precommits (as if TimeoutCommit = 0)
  641. SkipTimeoutCommit bool `mapstructure:"skip_timeout_commit"`
  642. // EmptyBlocks mode and possible interval between empty blocks
  643. CreateEmptyBlocks bool `mapstructure:"create_empty_blocks"`
  644. CreateEmptyBlocksInterval time.Duration `mapstructure:"create_empty_blocks_interval"`
  645. // Reactor sleep duration parameters
  646. PeerGossipSleepDuration time.Duration `mapstructure:"peer_gossip_sleep_duration"`
  647. PeerQueryMaj23SleepDuration time.Duration `mapstructure:"peer_query_maj23_sleep_duration"`
  648. }
  649. // DefaultConsensusConfig returns a default configuration for the consensus service
  650. func DefaultConsensusConfig() *ConsensusConfig {
  651. return &ConsensusConfig{
  652. WalPath: filepath.Join(defaultDataDir, "cs.wal", "wal"),
  653. TimeoutPropose: 3000 * time.Millisecond,
  654. TimeoutProposeDelta: 500 * time.Millisecond,
  655. TimeoutPrevote: 1000 * time.Millisecond,
  656. TimeoutPrevoteDelta: 500 * time.Millisecond,
  657. TimeoutPrecommit: 1000 * time.Millisecond,
  658. TimeoutPrecommitDelta: 500 * time.Millisecond,
  659. TimeoutCommit: 1000 * time.Millisecond,
  660. SkipTimeoutCommit: false,
  661. CreateEmptyBlocks: true,
  662. CreateEmptyBlocksInterval: 0 * time.Second,
  663. PeerGossipSleepDuration: 100 * time.Millisecond,
  664. PeerQueryMaj23SleepDuration: 2000 * time.Millisecond,
  665. }
  666. }
  667. // TestConsensusConfig returns a configuration for testing the consensus service
  668. func TestConsensusConfig() *ConsensusConfig {
  669. cfg := DefaultConsensusConfig()
  670. cfg.TimeoutPropose = 40 * time.Millisecond
  671. cfg.TimeoutProposeDelta = 1 * time.Millisecond
  672. cfg.TimeoutPrevote = 10 * time.Millisecond
  673. cfg.TimeoutPrevoteDelta = 1 * time.Millisecond
  674. cfg.TimeoutPrecommit = 10 * time.Millisecond
  675. cfg.TimeoutPrecommitDelta = 1 * time.Millisecond
  676. cfg.TimeoutCommit = 10 * time.Millisecond
  677. cfg.SkipTimeoutCommit = true
  678. cfg.PeerGossipSleepDuration = 5 * time.Millisecond
  679. cfg.PeerQueryMaj23SleepDuration = 250 * time.Millisecond
  680. return cfg
  681. }
  682. // WaitForTxs returns true if the consensus should wait for transactions before entering the propose step
  683. func (cfg *ConsensusConfig) WaitForTxs() bool {
  684. return !cfg.CreateEmptyBlocks || cfg.CreateEmptyBlocksInterval > 0
  685. }
  686. // Propose returns the amount of time to wait for a proposal
  687. func (cfg *ConsensusConfig) Propose(round int) time.Duration {
  688. return time.Duration(
  689. cfg.TimeoutPropose.Nanoseconds()+cfg.TimeoutProposeDelta.Nanoseconds()*int64(round),
  690. ) * time.Nanosecond
  691. }
  692. // Prevote returns the amount of time to wait for straggler votes after receiving any +2/3 prevotes
  693. func (cfg *ConsensusConfig) Prevote(round int) time.Duration {
  694. return time.Duration(
  695. cfg.TimeoutPrevote.Nanoseconds()+cfg.TimeoutPrevoteDelta.Nanoseconds()*int64(round),
  696. ) * time.Nanosecond
  697. }
  698. // Precommit returns the amount of time to wait for straggler votes after receiving any +2/3 precommits
  699. func (cfg *ConsensusConfig) Precommit(round int) time.Duration {
  700. return time.Duration(
  701. cfg.TimeoutPrecommit.Nanoseconds()+cfg.TimeoutPrecommitDelta.Nanoseconds()*int64(round),
  702. ) * time.Nanosecond
  703. }
  704. // Commit returns the amount of time to wait for straggler votes after receiving +2/3 precommits
  705. // for a single block (ie. a commit).
  706. func (cfg *ConsensusConfig) Commit(t time.Time) time.Time {
  707. return t.Add(cfg.TimeoutCommit)
  708. }
  709. // WalFile returns the full path to the write-ahead log file
  710. func (cfg *ConsensusConfig) WalFile() string {
  711. if cfg.walFile != "" {
  712. return cfg.walFile
  713. }
  714. return rootify(cfg.WalPath, cfg.RootDir)
  715. }
  716. // SetWalFile sets the path to the write-ahead log file
  717. func (cfg *ConsensusConfig) SetWalFile(walFile string) {
  718. cfg.walFile = walFile
  719. }
  720. // ValidateBasic performs basic validation (checking param bounds, etc.) and
  721. // returns an error if any check fails.
  722. func (cfg *ConsensusConfig) ValidateBasic() error {
  723. if cfg.TimeoutPropose < 0 {
  724. return errors.New("timeout_propose can't be negative")
  725. }
  726. if cfg.TimeoutProposeDelta < 0 {
  727. return errors.New("timeout_propose_delta can't be negative")
  728. }
  729. if cfg.TimeoutPrevote < 0 {
  730. return errors.New("timeout_prevote can't be negative")
  731. }
  732. if cfg.TimeoutPrevoteDelta < 0 {
  733. return errors.New("timeout_prevote_delta can't be negative")
  734. }
  735. if cfg.TimeoutPrecommit < 0 {
  736. return errors.New("timeout_precommit can't be negative")
  737. }
  738. if cfg.TimeoutPrecommitDelta < 0 {
  739. return errors.New("timeout_precommit_delta can't be negative")
  740. }
  741. if cfg.TimeoutCommit < 0 {
  742. return errors.New("timeout_commit can't be negative")
  743. }
  744. if cfg.CreateEmptyBlocksInterval < 0 {
  745. return errors.New("create_empty_blocks_interval can't be negative")
  746. }
  747. if cfg.PeerGossipSleepDuration < 0 {
  748. return errors.New("peer_gossip_sleep_duration can't be negative")
  749. }
  750. if cfg.PeerQueryMaj23SleepDuration < 0 {
  751. return errors.New("peer_query_maj23_sleep_duration can't be negative")
  752. }
  753. return nil
  754. }
  755. //-----------------------------------------------------------------------------
  756. // TxIndexConfig
  757. // Remember that Event has the following structure:
  758. // type: [
  759. // key: value,
  760. // ...
  761. // ]
  762. //
  763. // CompositeKeys are constructed by `type.key`
  764. // TxIndexConfig defines the configuration for the transaction indexer,
  765. // including composite keys to index.
  766. type TxIndexConfig struct {
  767. // What indexer to use for transactions
  768. //
  769. // Options:
  770. // 1) "null"
  771. // 2) "kv" (default) - the simplest possible indexer,
  772. // backed by key-value storage (defaults to levelDB; see DBBackend).
  773. Indexer string `mapstructure:"indexer"`
  774. // Comma-separated list of compositeKeys to index (by default the only key is "tx.hash")
  775. //
  776. // You can also index transactions by height by adding "tx.height" key here.
  777. //
  778. // It's recommended to index only a subset of keys due to possible memory
  779. // bloat. This is, of course, depends on the indexer's DB and the volume of
  780. // transactions.
  781. IndexKeys string `mapstructure:"index_keys"`
  782. // When set to true, tells indexer to index all compositeKeys (predefined keys:
  783. // "tx.hash", "tx.height" and all keys from DeliverTx responses).
  784. //
  785. // Note this may be not desirable (see the comment above). IndexKeys has a
  786. // precedence over IndexAllKeys (i.e. when given both, IndexKeys will be
  787. // indexed).
  788. IndexAllKeys bool `mapstructure:"index_all_keys"`
  789. }
  790. // DefaultTxIndexConfig returns a default configuration for the transaction indexer.
  791. func DefaultTxIndexConfig() *TxIndexConfig {
  792. return &TxIndexConfig{
  793. Indexer: "kv",
  794. IndexKeys: "",
  795. IndexAllKeys: false,
  796. }
  797. }
  798. // TestTxIndexConfig returns a default configuration for the transaction indexer.
  799. func TestTxIndexConfig() *TxIndexConfig {
  800. return DefaultTxIndexConfig()
  801. }
  802. //-----------------------------------------------------------------------------
  803. // InstrumentationConfig
  804. // InstrumentationConfig defines the configuration for metrics reporting.
  805. type InstrumentationConfig struct {
  806. // When true, Prometheus metrics are served under /metrics on
  807. // PrometheusListenAddr.
  808. // Check out the documentation for the list of available metrics.
  809. Prometheus bool `mapstructure:"prometheus"`
  810. // Address to listen for Prometheus collector(s) connections.
  811. PrometheusListenAddr string `mapstructure:"prometheus_listen_addr"`
  812. // Maximum number of simultaneous connections.
  813. // If you want to accept a larger number than the default, make sure
  814. // you increase your OS limits.
  815. // 0 - unlimited.
  816. MaxOpenConnections int `mapstructure:"max_open_connections"`
  817. // Instrumentation namespace.
  818. Namespace string `mapstructure:"namespace"`
  819. }
  820. // DefaultInstrumentationConfig returns a default configuration for metrics
  821. // reporting.
  822. func DefaultInstrumentationConfig() *InstrumentationConfig {
  823. return &InstrumentationConfig{
  824. Prometheus: false,
  825. PrometheusListenAddr: ":26660",
  826. MaxOpenConnections: 3,
  827. Namespace: "tendermint",
  828. }
  829. }
  830. // TestInstrumentationConfig returns a default configuration for metrics
  831. // reporting.
  832. func TestInstrumentationConfig() *InstrumentationConfig {
  833. return DefaultInstrumentationConfig()
  834. }
  835. // ValidateBasic performs basic validation (checking param bounds, etc.) and
  836. // returns an error if any check fails.
  837. func (cfg *InstrumentationConfig) ValidateBasic() error {
  838. if cfg.MaxOpenConnections < 0 {
  839. return errors.New("max_open_connections can't be negative")
  840. }
  841. return nil
  842. }
  843. //-----------------------------------------------------------------------------
  844. // Utils
  845. // helper function to make config creation independent of root dir
  846. func rootify(path, root string) string {
  847. if filepath.IsAbs(path) {
  848. return path
  849. }
  850. return filepath.Join(root, path)
  851. }
  852. //-----------------------------------------------------------------------------
  853. // Moniker
  854. var defaultMoniker = getDefaultMoniker()
  855. // getDefaultMoniker returns a default moniker, which is the host name. If runtime
  856. // fails to get the host name, "anonymous" will be returned.
  857. func getDefaultMoniker() string {
  858. moniker, err := os.Hostname()
  859. if err != nil {
  860. moniker = "anonymous"
  861. }
  862. return moniker
  863. }