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.

142 lines
3.3 KiB

9 years ago
9 years ago
8 years ago
9 years ago
abci: Refactor tagging events using list of lists (#3643) ## PR This PR introduces a fundamental breaking change to the structure of ABCI response and tx tags and the way they're processed. Namely, the SDK can support more complex and aggregated events for distribution and slashing. In addition, block responses can include duplicate keys in events. Implement new Event type. An event has a type and a list of KV pairs (ie. list-of-lists). Typical events may look like: "rewards": [{"amount": "5000uatom", "validator": "...", "recipient": "..."}] "sender": [{"address": "...", "balance": "100uatom"}] The events are indexed by {even.type}.{even.attribute[i].key}/.... In this case a client would subscribe or query for rewards.recipient='...' ABCI response types and related types now include Events []Event instead of Tags []cmn.KVPair. PubSub logic now publishes/matches against map[string][]string instead of map[string]string to support duplicate keys in response events (from #1385). A match is successful if the value is found in the slice of strings. closes: #1859 closes: #2905 ## Commits: * Implement Event ABCI type and updates responses to use events * Update messages_test.go * Update kvstore.go * Update event_bus.go * Update subscription.go * Update pubsub.go * Update kvstore.go * Update query logic to handle slice of strings in events * Update Empty#Matches and unit tests * Update pubsub logic * Update EventBus#Publish * Update kv tx indexer * Update godocs * Update ResultEvent to use slice of strings; update RPC * Update more tests * Update abci.md * Check for key in validateAndStringifyEvents * Fix KV indexer to skip empty keys * Fix linting errors * Update CHANGELOG_PENDING.md * Update docs/spec/abci/abci.md Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update abci/types/types.proto Co-Authored-By: Ethan Buchman <ethan@coinculture.info> * Update docs/spec/abci/abci.md Co-Authored-By: Ethan Buchman <ethan@coinculture.info> * Update libs/pubsub/query/query.go Co-Authored-By: Ethan Buchman <ethan@coinculture.info> * Update match function to match if ANY value matches * Implement TestSubscribeDuplicateKeys * Update TestMatches to include multi-key test cases * Update events.go * Update Query interface godoc * Update match godoc * Add godoc for matchValue * DRY-up tx indexing * Return error from PublishWithEvents in EventBus#Publish * Update PublishEventNewBlockHeader to return an error * Fix build * Update events doc in ABCI * Update ABCI events godoc * Implement TestEventBusPublishEventTxDuplicateKeys * Update TestSubscribeDuplicateKeys to be table-driven * Remove mod file * Remove markdown from events godoc * Implement TestTxSearchDeprecatedIndexing test
6 years ago
abci: Refactor tagging events using list of lists (#3643) ## PR This PR introduces a fundamental breaking change to the structure of ABCI response and tx tags and the way they're processed. Namely, the SDK can support more complex and aggregated events for distribution and slashing. In addition, block responses can include duplicate keys in events. Implement new Event type. An event has a type and a list of KV pairs (ie. list-of-lists). Typical events may look like: "rewards": [{"amount": "5000uatom", "validator": "...", "recipient": "..."}] "sender": [{"address": "...", "balance": "100uatom"}] The events are indexed by {even.type}.{even.attribute[i].key}/.... In this case a client would subscribe or query for rewards.recipient='...' ABCI response types and related types now include Events []Event instead of Tags []cmn.KVPair. PubSub logic now publishes/matches against map[string][]string instead of map[string]string to support duplicate keys in response events (from #1385). A match is successful if the value is found in the slice of strings. closes: #1859 closes: #2905 ## Commits: * Implement Event ABCI type and updates responses to use events * Update messages_test.go * Update kvstore.go * Update event_bus.go * Update subscription.go * Update pubsub.go * Update kvstore.go * Update query logic to handle slice of strings in events * Update Empty#Matches and unit tests * Update pubsub logic * Update EventBus#Publish * Update kv tx indexer * Update godocs * Update ResultEvent to use slice of strings; update RPC * Update more tests * Update abci.md * Check for key in validateAndStringifyEvents * Fix KV indexer to skip empty keys * Fix linting errors * Update CHANGELOG_PENDING.md * Update docs/spec/abci/abci.md Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update abci/types/types.proto Co-Authored-By: Ethan Buchman <ethan@coinculture.info> * Update docs/spec/abci/abci.md Co-Authored-By: Ethan Buchman <ethan@coinculture.info> * Update libs/pubsub/query/query.go Co-Authored-By: Ethan Buchman <ethan@coinculture.info> * Update match function to match if ANY value matches * Implement TestSubscribeDuplicateKeys * Update TestMatches to include multi-key test cases * Update events.go * Update Query interface godoc * Update match godoc * Add godoc for matchValue * DRY-up tx indexing * Return error from PublishWithEvents in EventBus#Publish * Update PublishEventNewBlockHeader to return an error * Fix build * Update events doc in ABCI * Update ABCI events godoc * Implement TestEventBusPublishEventTxDuplicateKeys * Update TestSubscribeDuplicateKeys to be table-driven * Remove mod file * Remove markdown from events godoc * Implement TestTxSearchDeprecatedIndexing test
6 years ago
abci: Refactor tagging events using list of lists (#3643) ## PR This PR introduces a fundamental breaking change to the structure of ABCI response and tx tags and the way they're processed. Namely, the SDK can support more complex and aggregated events for distribution and slashing. In addition, block responses can include duplicate keys in events. Implement new Event type. An event has a type and a list of KV pairs (ie. list-of-lists). Typical events may look like: "rewards": [{"amount": "5000uatom", "validator": "...", "recipient": "..."}] "sender": [{"address": "...", "balance": "100uatom"}] The events are indexed by {even.type}.{even.attribute[i].key}/.... In this case a client would subscribe or query for rewards.recipient='...' ABCI response types and related types now include Events []Event instead of Tags []cmn.KVPair. PubSub logic now publishes/matches against map[string][]string instead of map[string]string to support duplicate keys in response events (from #1385). A match is successful if the value is found in the slice of strings. closes: #1859 closes: #2905 ## Commits: * Implement Event ABCI type and updates responses to use events * Update messages_test.go * Update kvstore.go * Update event_bus.go * Update subscription.go * Update pubsub.go * Update kvstore.go * Update query logic to handle slice of strings in events * Update Empty#Matches and unit tests * Update pubsub logic * Update EventBus#Publish * Update kv tx indexer * Update godocs * Update ResultEvent to use slice of strings; update RPC * Update more tests * Update abci.md * Check for key in validateAndStringifyEvents * Fix KV indexer to skip empty keys * Fix linting errors * Update CHANGELOG_PENDING.md * Update docs/spec/abci/abci.md Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update abci/types/types.proto Co-Authored-By: Ethan Buchman <ethan@coinculture.info> * Update docs/spec/abci/abci.md Co-Authored-By: Ethan Buchman <ethan@coinculture.info> * Update libs/pubsub/query/query.go Co-Authored-By: Ethan Buchman <ethan@coinculture.info> * Update match function to match if ANY value matches * Implement TestSubscribeDuplicateKeys * Update TestMatches to include multi-key test cases * Update events.go * Update Query interface godoc * Update match godoc * Add godoc for matchValue * DRY-up tx indexing * Return error from PublishWithEvents in EventBus#Publish * Update PublishEventNewBlockHeader to return an error * Fix build * Update events doc in ABCI * Update ABCI events godoc * Implement TestEventBusPublishEventTxDuplicateKeys * Update TestSubscribeDuplicateKeys to be table-driven * Remove mod file * Remove markdown from events godoc * Implement TestTxSearchDeprecatedIndexing test
6 years ago
9 years ago
9 years ago
9 years ago
  1. package kvstore
  2. import (
  3. "bytes"
  4. "encoding/binary"
  5. "encoding/json"
  6. "fmt"
  7. "github.com/tendermint/tendermint/abci/example/code"
  8. "github.com/tendermint/tendermint/abci/types"
  9. cmn "github.com/tendermint/tendermint/libs/common"
  10. "github.com/tendermint/tendermint/version"
  11. dbm "github.com/tendermint/tm-cmn/db"
  12. )
  13. var (
  14. stateKey = []byte("stateKey")
  15. kvPairPrefixKey = []byte("kvPairKey:")
  16. ProtocolVersion version.Protocol = 0x1
  17. )
  18. type State struct {
  19. db dbm.DB
  20. Size int64 `json:"size"`
  21. Height int64 `json:"height"`
  22. AppHash []byte `json:"app_hash"`
  23. }
  24. func loadState(db dbm.DB) State {
  25. stateBytes := db.Get(stateKey)
  26. var state State
  27. if len(stateBytes) != 0 {
  28. err := json.Unmarshal(stateBytes, &state)
  29. if err != nil {
  30. panic(err)
  31. }
  32. }
  33. state.db = db
  34. return state
  35. }
  36. func saveState(state State) {
  37. stateBytes, err := json.Marshal(state)
  38. if err != nil {
  39. panic(err)
  40. }
  41. state.db.Set(stateKey, stateBytes)
  42. }
  43. func prefixKey(key []byte) []byte {
  44. return append(kvPairPrefixKey, key...)
  45. }
  46. //---------------------------------------------------
  47. var _ types.Application = (*KVStoreApplication)(nil)
  48. type KVStoreApplication struct {
  49. types.BaseApplication
  50. state State
  51. }
  52. func NewKVStoreApplication() *KVStoreApplication {
  53. state := loadState(dbm.NewMemDB())
  54. return &KVStoreApplication{state: state}
  55. }
  56. func (app *KVStoreApplication) Info(req types.RequestInfo) (resInfo types.ResponseInfo) {
  57. return types.ResponseInfo{
  58. Data: fmt.Sprintf("{\"size\":%v}", app.state.Size),
  59. Version: version.ABCIVersion,
  60. AppVersion: ProtocolVersion.Uint64(),
  61. }
  62. }
  63. // tx is either "key=value" or just arbitrary bytes
  64. func (app *KVStoreApplication) DeliverTx(req types.RequestDeliverTx) types.ResponseDeliverTx {
  65. var key, value []byte
  66. parts := bytes.Split(req.Tx, []byte("="))
  67. if len(parts) == 2 {
  68. key, value = parts[0], parts[1]
  69. } else {
  70. key, value = req.Tx, req.Tx
  71. }
  72. app.state.db.Set(prefixKey(key), value)
  73. app.state.Size += 1
  74. events := []types.Event{
  75. {
  76. Type: "app",
  77. Attributes: []cmn.KVPair{
  78. {Key: []byte("creator"), Value: []byte("Cosmoshi Netowoko")},
  79. {Key: []byte("key"), Value: key},
  80. },
  81. },
  82. }
  83. return types.ResponseDeliverTx{Code: code.CodeTypeOK, Events: events}
  84. }
  85. func (app *KVStoreApplication) CheckTx(req types.RequestCheckTx) types.ResponseCheckTx {
  86. return types.ResponseCheckTx{Code: code.CodeTypeOK, GasWanted: 1}
  87. }
  88. func (app *KVStoreApplication) Commit() types.ResponseCommit {
  89. // Using a memdb - just return the big endian size of the db
  90. appHash := make([]byte, 8)
  91. binary.PutVarint(appHash, app.state.Size)
  92. app.state.AppHash = appHash
  93. app.state.Height += 1
  94. saveState(app.state)
  95. return types.ResponseCommit{Data: appHash}
  96. }
  97. // Returns an associated value or nil if missing.
  98. func (app *KVStoreApplication) Query(reqQuery types.RequestQuery) (resQuery types.ResponseQuery) {
  99. if reqQuery.Prove {
  100. value := app.state.db.Get(prefixKey(reqQuery.Data))
  101. resQuery.Index = -1 // TODO make Proof return index
  102. resQuery.Key = reqQuery.Data
  103. resQuery.Value = value
  104. if value != nil {
  105. resQuery.Log = "exists"
  106. } else {
  107. resQuery.Log = "does not exist"
  108. }
  109. return
  110. } else {
  111. resQuery.Key = reqQuery.Data
  112. value := app.state.db.Get(prefixKey(reqQuery.Data))
  113. resQuery.Value = value
  114. if value != nil {
  115. resQuery.Log = "exists"
  116. } else {
  117. resQuery.Log = "does not exist"
  118. }
  119. return
  120. }
  121. }