Skip to content

Commit

Permalink
docs: Fix authz doc links and typo (#10726)
Browse files Browse the repository at this point in the history
* Fix ADR 30 links in doc

* Fix typo

* Fix more doc links

Co-authored-by: Marko <marbar3778@yahoo.com>
  • Loading branch information
migueldingli1997 and tac0turtle committed Dec 10, 2021
1 parent 3495691 commit ed05fa8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
4 changes: 2 additions & 2 deletions x/authz/spec/01_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ order: 1
## Authorization and Grant

The `x/authz` module defines interfaces and messages grant authorizations to perform actions
on behalf of one account to other accounts. The design is defined in the [ADR 030](../../../architecture/adr-030-authz-module.md).
on behalf of one account to other accounts. The design is defined in the [ADR 030](../../../docs/architecture/adr-030-authz-module.md).

A *grant* is an allowance to execute a Msg by the grantee on behalf of the granter.
Authorization is an interface that must be implemented by a concrete authorization logic to validate and execute grants. Authorizations are extensible and can be defined for any Msg service method even outside of the module where the Msg method is defined. See the `SendAuthorization` example in the next section for more details.
Expand Down Expand Up @@ -42,4 +42,4 @@ The Cosmos SDK `x/authz` module comes with following authorization types:

## Gas

In order to prevent DoS attacks, granting `StakeAuthorizaiton`s with `x/authz` incurs gas. `StakeAuthorization` allows you to authorize another account to delegate, undelegate, or redelegate to validators. The authorizer can define a list of validators they allow or deny delegations to. The Cosmos SDK iterates over these lists and charge 10 gas for each validator in both of the lists.
In order to prevent DoS attacks, granting `StakeAuthorization`s with `x/authz` incurs gas. `StakeAuthorization` allows you to authorize another account to delegate, undelegate, or redelegate to validators. The authorizer can define a list of validators they allow or deny delegations to. The Cosmos SDK iterates over these lists and charge 10 gas for each validator in both of the lists.
7 changes: 3 additions & 4 deletions x/authz/spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,19 @@ parent:

## Abstract

`x/authz` is an implementation of a Cosmos SDK module, per [ADR 30](../../../architecture/adr-030-authz-module.md), that allows
`x/authz` is an implementation of a Cosmos SDK module, per [ADR 30](../../../docs/architecture/adr-030-authz-module.md), that allows
granting arbitrary privileges from one account (the granter) to another account (the grantee). Authorizations must be granted for a particular Msg service method one by one using an implementation of the `Authorization` interface.

1. **[Concept](01_concepts.md)**
- [Authorization](01_concepts.md#Authorization)
- [Built-in Authorizations](01_concepts.md#Built-in-Authorization)
- [Authorization and Grant](01_concepts.md#Authorization-and-Grant)
- [Built-in Authorizations](01_concepts.md#Built-in-Authorizations)
- [Gas](01_concepts.md#gas)
2. **[State](02_state.md)**
3. **[Messages](03_messages.md)**
- [MsgGrant](03_messages.md#MsgGrant)
- [MsgRevoke](03_messages.md#MsgRevoke)
- [MsgExec](03_messages.md#MsgExec)
4. **[Events](04_events.md)**
- [Keeper](04_events.md#Keeper)
5. **[Client](05_client.md)**
- [CLI](05_client.md#cli)
- [gRPC](05_client.md#grpc)
Expand Down

0 comments on commit ed05fa8

Please sign in to comment.