authz

x/authz/README.md

@@ -1,7 +1,324 @@
 <!--
 order: 0
+title: Authz Overview
+parent:
+  title: "authz"
 -->
 
-# Authz
+# `authz`
 
-* [Authz](spec/README.md) - Authorization for accounts to perform actions on behalf of other accounts.
+## Contents
+
+## Abstract
+
+`x/authz` is an implementation of a Cosmos SDK module, per [ADR 30](https://github.com/cosmos/cosmos-sdk/blob/main/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.
+
+*[Concept](#concepts)
+	* [Authorization and Grant](#Authorization-and-Grant)
+	* [Built-in Authorizations](#Built-in-Authorizations)
+	* [Gas](#gas)
+*[State](#state)
+*[Messages](#messages)
+	* [MsgGrant](#MsgGrant)
+	* [MsgRevoke](#MsgRevoke)
+	* [MsgExec](#MsgExec)
+*[Events](#events)
+*[Client](#client)
+  * [CLI](#cli)
+  * [gRPC](#grpc)
+  * [REST](#rest)
+
+
+# Concepts
+
+## 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](https://github.com/cosmos/cosmos-sdk/blob/main/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.
+
+**Note:** The authz module is different from the [auth (authentication)](../modules/auth/) module that is responsible for specifying the base transaction and account types.
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/x/authz/authorizations.go#L11-L25
+
+## Built-in Authorizations
+
+The Cosmos SDK `x/authz` module comes with following authorization types:
+
+### GenericAuthorization
+
+`GenericAuthorization` implements the `Authorization` interface that gives unrestricted permission to execute the provided Msg on behalf of granter's account.
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/authz/v1beta1/authz.proto#L13-L20
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/x/authz/generic_authorization.go#L16-L29
+
+* `msg` stores Msg type URL.
+
+### SendAuthorization
+
+`SendAuthorization` implements the `Authorization` interface for the `cosmos.bank.v1beta1.MsgSend` Msg. It takes a (positive) `SpendLimit` that specifies the maximum amount of tokens the grantee can spend. The `SpendLimit` is updated as the tokens are spent.
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/bank/v1beta1/authz.proto#L10-L19
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/x/bank/types/send_authorization.go#L23-L38
+
+* `spend_limit` keeps track of how many coins are left in the authorization.
+
+### StakeAuthorization
+
+`StakeAuthorization` implements the `Authorization` interface for messages in the [staking module](https://docs.cosmos.network/v0.44/modules/staking/). It takes an `AuthorizationType` to specify whether you want to authorise delegating, undelegating or redelegating (i.e. these have to be authorised seperately). It also takes a required `MaxTokens` that keeps track of a limit to the amount of tokens that can be delegated/undelegated/redelegated. If left empty, the amount is unlimited. Additionally, this Msg takes an `AllowList` or a `DenyList`, which allows you to select which validators you allow or deny grantees to stake with.
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/staking/v1beta1/authz.proto#L10-L33
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/x/staking/types/authz.go#L15-L35
+
+## Gas
+
+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.
+
+Since the state maintaining a list for granter, grantee pair with same expiration, we are iterating over the list to remove the grant (incase of any revoke of paritcular `msgType`) from the list and we are charging 20 gas per iteration.
+
+# State
+
+## Grant
+
+Grants are identified by combining granter address (the address bytes of the granter), grantee address (the address bytes of the grantee) and Authorization type (its type URL). Hence we only allow one grant for the (granter, grantee, Authorization) triple.
+
+* Grant: `0x01 | granter_address_len (1 byte) | granter_address_bytes | grantee_address_len (1 byte) | grantee_address_bytes |  msgType_bytes -> ProtocolBuffer(AuthorizationGrant)`
+
+The grant object encapsulates an `Authorization` type and an expiration timestamp:
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/authz/v1beta1/authz.proto#L22-L30
+
+## GrantQueue
+
+We are maintaining a queue for authz pruning. Whenever a grant is created, an item will be added to `GrantQueue` with a key of expiration, granter, grantee.
+
+* GrantQueue: `0x02 | expiration_bytes | granter_address_len (1 byte) | granter_address_bytes | grantee_address_len (1 byte) | grantee_address_bytes -> ProtocalBuffer(GrantQueueItem)`
+
+The `expiration_bytes` are the expiration date in UTC with the format `"2006-01-02T15:04:05.000000000"`.
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/x/authz/keeper/keys.go#L78-L93
+
+The `GrantQueueItem` object contains the list of type urls between granter and grantee that expire at the time indicated in the key.
+
+# Messages
+
+In this section we describe the processing of messages for the authz module.
+
+## MsgGrant
+
+An authorization grant is created using the `MsgGrant` message.
+If there is already a grant for the `(granter, grantee, Authorization)` triple, then the new grant overwrites the previous one. To update or extend an existing grant, a new grant with the same `(granter, grantee, Authorization)` triple should be created.
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/authz/v1beta1/tx.proto#L32-L41
+
+The message handling should fail if:
+
+* both granter and grantee have the same address.
+* provided `Expiration` time is less than current unix timestamp (but a grant will be created if no `expiration` time is provided since `expiration` is optional).
+* provided `Grant.Authorization` is not implemented.
+* `Authorization.MsgTypeURL()` is not defined in the router (there is no defined handler in the app router to handle that Msg types).
+
+## MsgRevoke
+
+A grant can be removed with the `MsgRevoke` message.
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/authz/v1beta1/tx.proto#L66-L72
+
+The message handling should fail if:
+
+* both granter and grantee have the same address.
+* provided `MsgTypeUrl` is empty.
+
+NOTE: The `MsgExec` message removes a grant if the grant has expired.
+
+## MsgExec
+
+When a grantee wants to execute a transaction on behalf of a granter, they must send `MsgExec`.
+
++++ https://github.com/cosmos/cosmos-sdk/blob/v0.46.0/proto/cosmos/authz/v1beta1/tx.proto#L51-L59
+
+The message handling should fail if:
+
+* provided `Authorization` is not implemented.
+* grantee doesn't have permission to run the transaction.
+* if granted authorization is expired.
+
+# Events
+
+The authz module emits proto events defined in [the Protobuf reference](https://buf.build/cosmos/cosmos-sdk/docs/main/cosmos.authz.v1beta1#cosmos.authz.v1beta1.EventGrant).
+
+
+# Client
+
+## CLI
+
+A user can query and interact with the `authz` module using the CLI.
+
+### Query
+
+The `query` commands allow users to query `authz` state.
+
+```bash
+simd query authz --help
+```
+
+#### grants
+
+The `grants` command allows users to query grants for a granter-grantee pair. If the message type URL is set, it selects grants only for that message type.
+
+```bash
+simd query authz grants [granter-addr] [grantee-addr] [msg-type-url]? [flags]
+```
+
+Example:
+
+```bash
+simd query authz grants cosmos1.. cosmos1.. /cosmos.bank.v1beta1.MsgSend
+```
+
+Example Output:
+
+```bash
+grants:
+- authorization:
+    '@type': /cosmos.bank.v1beta1.SendAuthorization
+    spend_limit:
+    - amount: "100"
+      denom: stake
+  expiration: "2022-01-01T00:00:00Z"
+pagination: null
+```
+
+### Transactions
+
+The `tx` commands allow users to interact with the `authz` module.
+
+```bash
+simd tx authz --help
+```
+
+#### exec
+
+The `exec` command allows a grantee to execute a transaction on behalf of granter.
+
+```bash
+  simd tx authz exec [tx-json-file] --from [grantee] [flags]
+```
+
+Example:
+
+```bash
+simd tx authz exec tx.json --from=cosmos1..
+```
+
+#### grant
+
+The `grant` command allows a granter to grant an authorization to a grantee.
+
+```bash
+simd tx authz grant <grantee> <authorization_type="send"|"generic"|"delegate"|"unbond"|"redelegate"> --from <granter> [flags]
+```
+
+Example:
+
+```bash
+simd tx authz grant cosmos1.. send --spend-limit=100stake --from=cosmos1..
+```
+
+#### revoke
+
+The `revoke` command allows a granter to revoke an authorization from a grantee.
+
+```bash
+simd tx authz revoke [grantee] [msg-type-url] --from=[granter] [flags]
+```
+
+Example:
+
+```bash
+simd tx authz revoke cosmos1.. /cosmos.bank.v1beta1.MsgSend --from=cosmos1..
+```
+
+## gRPC
+
+A user can query the `authz` module using gRPC endpoints.
+
+### Grants
+
+The `Grants` endpoint allows users to query grants for a granter-grantee pair. If the message type URL is set, it selects grants only for that message type.
+
+```bash
+cosmos.authz.v1beta1.Query/Grants
+```
+
+Example:
+
+```bash
+grpcurl -plaintext \
+    -d '{"granter":"cosmos1..","grantee":"cosmos1..","msg_type_url":"/cosmos.bank.v1beta1.MsgSend"}' \
+    localhost:9090 \
+    cosmos.authz.v1beta1.Query/Grants
+```
+
+Example Output:
+
+```bash
+{
+  "grants": [
+    {
+      "authorization": {
+        "@type": "/cosmos.bank.v1beta1.SendAuthorization",
+        "spendLimit": [
+          {
+            "denom":"stake",
+            "amount":"100"
+          }
+        ]
+      },
+      "expiration": "2022-01-01T00:00:00Z"
+    }
+  ]
+}
+```
+
+## REST
+
+A user can query the `authz` module using REST endpoints.
+
+```bash
+/cosmos/authz/v1beta1/grants
+```
+
+Example:
+
+```bash
+curl "localhost:1317/cosmos/authz/v1beta1/grants?granter=cosmos1..&grantee=cosmos1..&msg_type_url=/cosmos.bank.v1beta1.MsgSend"
+```
+
+Example Output:
+
+```bash
+{
+  "grants": [
+    {
+      "authorization": {
+        "@type": "/cosmos.bank.v1beta1.SendAuthorization",
+        "spend_limit": [
+          {
+            "denom": "stake",
+            "amount": "100"
+          }
+        ]
+      },
+      "expiration": "2022-01-01T00:00:00Z"
+    }
+  ],
+  "pagination": null
+}
+```