R4R: Update slashing spec for slashing-by-period

docs/spec/slashing/README.md

@@ -0,0 +1,29 @@
+# Slashing module specification
+
+## Abstract
+
+This section specifies the slashing module of the Cosmos SDK, which implements functionality
+first outlined in the [Cosmos Whitepaper](https://cosmos.network/about/whitepaper) in June 2016.
+
+The slashing module enables Cosmos SDK-based blockchains to disincentivize any attributable action
+by a protocol-recognized actor with value at stake by "slashing" them: burning some amount of their
+stake - and possibly also removing their ability to vote on future blocks for a period of time.
+
+This module will be used by the Cosmos Hub, the first hub in the Cosmos ecosystem.
+
+## Contents
+
+1. **[State](state.md)**
+    1. [SigningInfo](state.md#signing-info)
+    1. [SlashingPeriod](state.md#slashing-period)
+1. **[State Machine](state-machine.md)**
+    1. [Transactions](state-machine.md#transactions)
+          1. Unjail
+    1. [Interactions](state-machine.md#interactions)
+          1. Validator Bonded
+          1. Validator Unbonding
+          1. Validator Slashed
+    1. [State Cleanup](state-machine.md#state-cleanup)
+1. **[Begin Block](begin-block.md)**
+    1. [Evidence handling](begin-block.md#evidence-handling)
+    1. [Uptime tracking](begin-block.md#uptime-tracking)

docs/spec/slashing/end_block.md → docs/spec/slashing/begin-block.md

@@ -1,12 +1,13 @@
-# End-Block
+# Begin-Block
 
-## Slashing
+## Evidence handling
 
 Tendermint blocks can include
 [Evidence](https://github.com/tendermint/tendermint/blob/develop/docs/spec/blockchain/blockchain.md#evidence), which indicates that a validator
 committed malicious behaviour. The relevant information is forwarded to the
 application as [ABCI
-Evidence](https://github.com/tendermint/tendermint/blob/develop/abci/types/types.proto#L259), so the validator an be accordingly punished.
+Evidence](https://github.com/tendermint/tendermint/blob/develop/abci/types/types.proto#L259) in `abci.RequestBeginBlock`
+so that the validator an be accordingly punished.
 
 For some `evidence` to be valid, it must satisfy:
 
@@ -75,7 +76,7 @@ This ensures that offending validators are punished the same amount whether they
 act as a single validator with X stake or as N validators with collectively X
 stake.
 
-## Automatic Unbonding
+## Uptime tracking
 
 At the beginning of each block, we update the signing info for each validator and check if they should be automatically unbonded:
 

docs/spec/slashing/state-machine.md

@@ -0,0 +1,120 @@
+## Transaction & State Machine Interaction Overview
+
+### Transactions
+
+In this section we describe the processing of transactions for the `slashing` module.
+
+#### TxUnjail
+
+If a validator was automatically unbonded due to downtime and wishes to come back online &
+possibly rejoin the bonded set, it must send `TxUnjail`:
+
+```golang
+type TxUnjail struct {
+    ValidatorAddr sdk.AccAddress
+}
+
+handleMsgUnjail(tx TxUnjail)
+
+    validator := getValidator(tx.ValidatorAddr)
+    if validator == nil
+      fail with "No validator found"
+
+    if !validator.Jailed
+      fail with "Validator not jailed, cannot unjail"
+
+    info := getValidatorSigningInfo(operator)
+    if BlockHeader.Time.Before(info.JailedUntil)
+      fail with "Validator still jailed, cannot unjail until period has expired"
+
+    // Update the start height so the validator won't be immediately unbonded again
+    info.StartHeight = BlockHeight
+    setValidatorSigningInfo(info)
+
+    validator.Jailed = false
+    setValidator(validator)
+
+    return
+```
+
+If the validater has enough stake to be in the top hundred, they will be automatically rebonded,
+and all delegators still delegated to the validator will be rebonded and begin to again collect
+provisions and rewards.
+
+### Interactions
+
+In this section we describe the "hooks" - slashing module code that runs when other events happen.
+
+#### Validator Bonded
+
+Upon successful bonding of a validator (a given validator changing from "unbonded" state to "bonded" state,
+which may happen on delegation, on unjailing, etc), we create a new `SlashingPeriod` structure for the
+now-bonded validator, which `StartHeight` of the current block, `EndHeight` of `0` (sentinel value for not-yet-ended),
+and `SlashedSoFar` of `0`:
+
+```golang
+onValidatorBonded(address sdk.ValAddress)
+
+  slashingPeriod := SlashingPeriod{
+      ValidatorAddr : address,
+      StartHeight   : CurrentHeight,
+      EndHeight     : 0,    
+      SlashedSoFar  : 0,
+  }
+  setSlashingPeriod(slashingPeriod)
+
+  return
+```
+
+#### Validator Unbonded
+
+When a validator is unbonded, we update the in-progress `SlashingPeriod` with the current block as the `EndHeight`:
+
+```golang
+onValidatorUnbonded(address sdk.ValAddress)
+
+  slashingPeriod = getSlashingPeriod(address, CurrentHeight)
+  slashingPeriod.EndHeight = CurrentHeight
+  setSlashingPeriod(slashingPeriod)
+
+  return
+```
+
+#### Validator Power Changed
+
+When a validator's power changes, we update the in-progress `SlashingPeriod` with the validator's current power:
+
+```golang
+onValidatorPowerChanged(address sdk.ValAddress, stakeBonded sdk.Rat)
+
+  slashingPeriod = getSlashingPeriod(address, CurrentHeight)
+  slashingPeriod.MaxStakeBonded = max(slashingPeriod.MaxStakeBonded, stakeBonded)
+  setSlashingPeriod(slashingPeriod)
+
+  return
+```
+
+#### Validator Slashed
+
+When a validator is slashed, we look up the appropriate `SlashingPeriod` based on the validator
+address and the time of infraction, cap the fraction slashed as `max(SlashFraction, SlashedSoFar)`
+(which may be `0`), and update the `SlashingPeriod` with the increased `SlashedSoFar`:
+
+```golang
+beforeValidatorSlashed(address sdk.ValAddress, fraction sdk.Rat, infractionHeight int64)
+
+  slashingPeriod = getSlashingPeriod(address, infractionHeight)
+  totalFractionToSlash = max(slashingPeriod.SlashedSoFar, fraction)
+  slashingPeriod.FractionSlashedSoFar = totalToSlash
+  setSlashingPeriod(slashingPeriod)
+
+  remainderToSlash = slashingPeriod.FractionSlashedSoFar - totalToSlash
+  fraction = remainderToSlash
+
+  continue with slashing
+```
+
+### State Cleanup
+
+Once no evidence for a given slashing period can possibly be valid (the end time plus the unbonding period is less than the current time),
+old slashing periods should be cleaned up. This will be implemented post-launch.

docs/spec/slashing/state.md

@@ -36,10 +36,11 @@ The information stored for tracking validator liveness is as follows:
 
 ```go
 type ValidatorSigningInfo struct {
-  StartHeight           int64
-  IndexOffset           int64
-  JailedUntil           int64
-  SignedBlocksCounter   int64
+    StartHeight           int64     // Height at which the validator became able to sign blocks
+    IndexOffset           int64     // Offset into the signed block bit array
+    JailedUntilHeight     int64     // Block height until which the validator is jailed,
+                                    // or sentinel value of 0 for not jailed
+    SignedBlocksCounter   int64     // Running counter of signed blocks
 }
 
 ```
@@ -49,3 +50,33 @@ Where:
 * `IndexOffset` is incremented each time the candidate was a bonded validator in a block (and may have signed a precommit or not).
 * `JailedUntil` is set whenever the candidate is revoked due to downtime
 * `SignedBlocksCounter` is a counter kept to avoid unnecessary array reads. `SignedBlocksBitArray.Sum() == SignedBlocksCounter` always.
+
+### Slashing Period
+
+A slashing period is a start and end block height associated with a particular validator,
+within which only the "worst infraction counts": the total amount of slashing for
+infractions committed within the period (and discovered whenever) is capped at the
+penalty for the worst offense.
+
+This period starts when a validator is first bonded and ends when a validator is slashed & jailed
+for any reason. When the validator rejoins the validator set (perhaps through unjailing themselves,
+and perhaps also changing signing keys), they enter into a new period.
+
+Slashing periods are indexed in the store as follows:
+
+- SlashingPeriod: ` 0x03 | ValTendermintAddr | StartHeight -> amino(slashingPeriod) `
+
+This allows us to look up slashing period by a validator's address, the only lookup necessary,
+and iterate over start height to efficiently retrieve the most recent slashing period(s)
+or those beginning after a given height.
+
+```go
+type SlashingPeriod struct {
+    ValidatorAddr         sdk.ValAddress      // Tendermint address of the validator
+    StartHeight           int64               // Block height at which slashing period begin
+    EndHeight             int64               // Block height at which slashing period ended
+    MaxBondedStake        sdk.Rat             // Maximum bonded stake during period
+    StakeSlashedSoFar     sdk.Rat             // Amount of stake slashed so far
+    FractionSlashedSoFar  sdk.Rat             // Fraction slashed so far, cumulative
+}
+```