Browse Source

spec: update abci events (#151)

pull/7804/head
Marko 4 years ago
committed by GitHub
parent
commit
45bbbb6317
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 18 deletions
  1. +16
    -16
      spec/abci/abci.md
  2. +1
    -1
      spec/abci/apps.md
  3. +1
    -1
      spec/core/state.md

+ 16
- 16
spec/abci/abci.md View File

@ -69,26 +69,26 @@ Example:
Events: []abci.Event{ Events: []abci.Event{
{ {
Type: "validator.provisions", Type: "validator.provisions",
Attributes: kv.Pairs{
kv.Pair{Key: []byte("address"), Value: []byte("...")},
kv.Pair{Key: []byte("amount"), Value: []byte("...")},
kv.Pair{Key: []byte("balance"), Value: []byte("...")},
Attributes: []abci.EventAttribute{
abci.EventAttribute{Key: []byte("address"), Value: []byte("..."), Index: true},
abci.EventAttribute{Key: []byte("amount"), Value: []byte("..."), Index: true},
abci.EventAttribute{Key: []byte("balance"), Value: []byte("..."), Index: true},
}, },
}, },
{ {
Type: "validator.provisions", Type: "validator.provisions",
Attributes: kv.Pairs{
kv.Pair{Key: []byte("address"), Value: []byte("...")},
kv.Pair{Key: []byte("amount"), Value: []byte("...")},
kv.Pair{Key: []byte("balance"), Value: []byte("...")},
Attributes: []abci.EventAttribute{
abci.EventAttribute{Key: []byte("address"), Value: []byte("..."), Index: true},
abci.EventAttribute{Key: []byte("amount"), Value: []byte("..."), Index: false},
abci.EventAttribute{Key: []byte("balance"), Value: []byte("..."), Index: false},
}, },
}, },
{ {
Type: "validator.slashed", Type: "validator.slashed",
Attributes: kv.Pairs{
kv.Pair{Key: []byte("address"), Value: []byte("...")},
kv.Pair{Key: []byte("amount"), Value: []byte("...")},
kv.Pair{Key: []byte("reason"), Value: []byte("...")},
Attributes: []abci.EventAttribute{
abci.EventAttribute{Key: []byte("address"), Value: []byte("..."), Index: false},
abci.EventAttribute{Key: []byte("amount"), Value: []byte("..."), Index: true},
abci.EventAttribute{Key: []byte("reason"), Value: []byte("..."), Index: true},
}, },
}, },
// ... // ...
@ -305,7 +305,7 @@ via light client.
- `ByzantineValidators ([]Evidence)`: List of evidence of - `ByzantineValidators ([]Evidence)`: List of evidence of
validators that acted maliciously. validators that acted maliciously.
- **Response**: - **Response**:
- `Tags ([]kv.Pair)`: Key-Value tags for filtering and indexing
- `Events ([]abci.Event)`: Type & Key-Value events for indexing
- **Usage**: - **Usage**:
- Signals the beginning of a new block. Called prior to - Signals the beginning of a new block. Called prior to
any DeliverTxs. any DeliverTxs.
@ -332,7 +332,7 @@ via light client.
be non-deterministic. be non-deterministic.
- `GasWanted (int64)`: Amount of gas requested for transaction. - `GasWanted (int64)`: Amount of gas requested for transaction.
- `GasUsed (int64)`: Amount of gas consumed by transaction. - `GasUsed (int64)`: Amount of gas consumed by transaction.
- `Tags ([]kv.Pair)`: Key-Value tags for filtering and indexing
- `Events ([]abci.Event)`: Type & Key-Value events for indexing
transactions (eg. by account). transactions (eg. by account).
- `Codespace (string)`: Namespace for the `Code`. - `Codespace (string)`: Namespace for the `Code`.
- **Usage**: - **Usage**:
@ -360,7 +360,7 @@ via light client.
be non-deterministic. be non-deterministic.
- `GasWanted (int64)`: Amount of gas requested for transaction. - `GasWanted (int64)`: Amount of gas requested for transaction.
- `GasUsed (int64)`: Amount of gas consumed by transaction. - `GasUsed (int64)`: Amount of gas consumed by transaction.
- `Tags ([]kv.Pair)`: Key-Value tags for filtering and indexing
- `Events ([]abci.Event)`: Type & Key-Value events for indexing
transactions (eg. by account). transactions (eg. by account).
- `Codespace (string)`: Namespace for the `Code`. - `Codespace (string)`: Namespace for the `Code`.
- **Usage**: - **Usage**:
@ -377,7 +377,7 @@ via light client.
voting power to 0 to remove). voting power to 0 to remove).
- `ConsensusParamUpdates (ConsensusParams)`: Changes to - `ConsensusParamUpdates (ConsensusParams)`: Changes to
consensus-critical time, size, and other parameters. consensus-critical time, size, and other parameters.
- `Tags ([]kv.Pair)`: Key-Value tags for filtering and indexing
- `Events ([]abci.Event)`: Type & Key-Value events for indexing
- **Usage**: - **Usage**:
- Signals the end of a block. - Signals the end of a block.
- Called after all transactions, prior to each Commit. - Called after all transactions, prior to each Commit.


+ 1
- 1
spec/abci/apps.md View File

@ -196,7 +196,7 @@ not broadcasted to other peers and not included in a proposal block.
`Data` contains the result of the CheckTx transaction execution, if any. It is `Data` contains the result of the CheckTx transaction execution, if any. It is
semantically meaningless to Tendermint. semantically meaningless to Tendermint.
`Tags` include any tags for the execution, though since the transaction has not
`Events` include any events for the execution, though since the transaction has not
been committed yet, they are effectively ignored by Tendermint. been committed yet, they are effectively ignored by Tendermint.
### DeliverTx ### DeliverTx


+ 1
- 1
spec/core/state.md View File

@ -68,7 +68,7 @@ type Result struct {
It returns a result code and an arbitrary byte array (ie. a return value). It returns a result code and an arbitrary byte array (ie. a return value).
NOTE: the Result needs to be updated to include more fields returned from NOTE: the Result needs to be updated to include more fields returned from
processing transactions, like gas variables and tags - see
processing transactions, like gas variables and events - see
[issue 1007](https://github.com/tendermint/tendermint/issues/1007). [issue 1007](https://github.com/tendermint/tendermint/issues/1007).
### Validator ### Validator


Loading…
Cancel
Save