Skip to content

Commit

Permalink
docs: link checker (#5860)
Browse files Browse the repository at this point in the history
  • Loading branch information
tac0turtle authored Mar 24, 2020
1 parent a1ac04c commit 999a83d
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 27 deletions.
17 changes: 9 additions & 8 deletions .github/workflows/linkchecker.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
name: Check links
on: [pull_request]
name: Check Markdown links
on:
schedule:
- cron: '* */24 * * *'
jobs:
link-check:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Link Checker
uses: peter-evans/link-checker@v1
with:
args: -v -r *
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@0.6.0
with:
folder-path: "docs"
2 changes: 1 addition & 1 deletion docs/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Please add a entry below in your Pull Request for an ADR.
- [ADR 010: Modular AnteHandler](./adr-010-modular-antehandler.md)
- [ADR 011: Generalize Genesis Accounts](./adr-011-generalize-genesis-accounts.md)
- [ADR 012: State Accessors](./adr-012-state-accessors.md)
- [ADR 013: Observability](./adr-013-observability.md)
- [ADR 013: Metrics](./adr-013-metrics.md)
- [ADR 015: IBC Packet Receiver](./adr-015-ibc-packet-receiver.md)
- [ADR 016: Validator Consensus Key Rotation](./adr-016-validator-consensus-key-rotation.md)
- [ADR 017: Historical Header Module](./adr-017-historical-header-module.md)
Expand Down
18 changes: 9 additions & 9 deletions docs/architecture/adr-009-evidence-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ evidence can be submitted, evaluated and verified resulting in some agreed upon
penalty for any misbehavior committed by a validator, such as equivocation (double-voting),
signing when unbonded, signing an incorrect state transition (in the future), etc.
Furthermore, such a mechanism is paramount for any
[IBC](https://github.com/cosmos/ics/blob/master/ibc/1_IBC_ARCHITECTURE.md) or
[IBC](https://github.com/cosmos/ics/blob/master/ibc/2_IBC_ARCHITECTURE.md) or
cross-chain validation protocol implementation in order to support the ability
for any misbehavior to be relayed back from a collateralized chain to a primary
chain so that the equivocating validator(s) can be slashed.
Expand All @@ -28,14 +28,14 @@ We will implement an evidence module in the Cosmos SDK supporting the following
functionality:

- Provide developers with the abstractions and interfaces necessary to define
custom evidence messages, message handlers, and methods to slash and penalize
accordingly for misbehavior.
custom evidence messages, message handlers, and methods to slash and penalize
accordingly for misbehavior.
- Support the ability to route evidence messages to handlers in any module to
determine the validity of submitted misbehavior.
determine the validity of submitted misbehavior.
- Support the ability, through governance, to modify slashing penalties of any
evidence type.
evidence type.
- Querier implementation to support querying params, evidence types, params, and
all submitted valid misbehavior.
all submitted valid misbehavior.

### Types

Expand Down Expand Up @@ -161,15 +161,15 @@ type GenesisState struct {
### Positive

- Allows the state machine to process misbehavior submitted on-chain and penalize
validators based on agreed upon slashing parameters.
validators based on agreed upon slashing parameters.
- Allows evidence types to be defined and handled by any module. This further allows
slashing and jailing to be defined by more complex mechanisms.
slashing and jailing to be defined by more complex mechanisms.
- Does not solely rely on Tendermint to submit evidence.

### Negative

- No easy way to introduce new evidence types through governance on a live chain
due to the inability to introduce the new evidence type's corresponding handler
due to the inability to introduce the new evidence type's corresponding handler

### Neutral

Expand Down
18 changes: 9 additions & 9 deletions docs/spec/addresses/bech32.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ In the Cosmos network, keys and addresses may refer to a number of different rol

## HRP table

| HRP | Definition |
|-------------------|---------------------------------------|
| cosmos | Cosmos Account Address |
| cosmospub | Cosmos Account Public Key |
| cosmosvalcons | Cosmos Validator Consensus Address |
| cosmosvalconspub | Cosmos Validator Consensus Public Key |
| cosmosvaloper | Cosmos Validator Operator Address |
| cosmosvaloperpub | Cosmos Validator Operator Public Key |
| HRP | Definition |
| ---------------- | ------------------------------------- |
| cosmos | Cosmos Account Address |
| cosmospub | Cosmos Account Public Key |
| cosmosvalcons | Cosmos Validator Consensus Address |
| cosmosvalconspub | Cosmos Validator Consensus Public Key |
| cosmosvaloper | Cosmos Validator Operator Address |
| cosmosvaloperpub | Cosmos Validator Operator Public Key |

## Encoding

While all user facing interfaces to Cosmos software should exposed Bech32 interfaces, many internal interfaces encode binary value in hex or base64 encoded form.

To covert between other binary representation of addresses and keys, it is important to first apply the Amino encoding process before bech32 encoding.

A complete implementation of the Amino serialization format is unnecessary in most cases. Simply prepending bytes from this [table](https://github.com/tendermint/tendermint/blob/master/docs/spec/blockchain/encoding.md#public-key-cryptography) to the byte string payload before bech32 encoding will sufficient for compatible representation.
A complete implementation of the Amino serialization format is unnecessary in most cases. Simply prepending bytes from this [table](https://github.com/tendermint/spec/blob/master/spec/blockchain/encoding.md#public-key-cryptography) to the byte string payload before bech32 encoding will sufficient for compatible representation.

0 comments on commit 999a83d

Please sign in to comment.