Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(x/authz): add limits to grant pruning and enable message to aid manually #18737

Merged
merged 6 commits into from
Dec 15, 2023
Merged

feat(x/authz): add limits to grant pruning and enable message to aid manually #18737

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f9b2474
feat(x/authz): add limits to grant pruning and enable message to aid …
julienrbrt Dec 13, 2023
1760c36
changelog
julienrbrt Dec 13, 2023
053dd0c
lint
julienrbrt Dec 14, 2023
e127412
add tests
julienrbrt Dec 14, 2023
49fc0cc
Merge branch 'main' into julien/authz
julienrbrt Dec 14, 2023
45cf516
feedback
julienrbrt Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
517 changes: 498 additions & 19 deletions api/cosmos/authz/v1beta1/event.pulsar.go
View file
Open in desktop

Large diffs are not rendered by default.

982 changes: 934 additions & 48 deletions api/cosmos/authz/v1beta1/tx.pulsar.go
View file
Open in desktop

Large diffs are not rendered by default.

49 changes: 46 additions & 3 deletions api/cosmos/authz/v1beta1/tx_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 12 additions & 1 deletion proto/cosmos/authz/v1beta1/event.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// Since: cosmos-sdk 0.43
syntax = "proto3";
package cosmos.authz.v1beta1;

Expand All @@ -7,6 +6,8 @@ import "cosmos_proto/cosmos.proto";
option go_package = "cosmossdk.io/x/authz";

// EventGrant is emitted on Msg/Grant
//
// Since: cosmos-sdk 0.43
message EventGrant {
// Msg type URL for which an authorization is granted
string msg_type_url = 2;
Expand All @@ -17,6 +18,8 @@ message EventGrant {
}

// EventRevoke is emitted on Msg/Revoke
//
// Since: cosmos-sdk 0.43
message EventRevoke {
// Msg type URL for which an authorization is revoked
string msg_type_url = 2;
Expand All @@ -25,3 +28,11 @@ message EventRevoke {
// Grantee account address
string grantee = 4 [(cosmos_proto.scalar) = "cosmos.AddressString"];
}

// EventPruneExpiredGrants is emitted on Msg/PruneExpiredGrants
//
// Since: x/authz 1.0.0
message EventPruneExpiredGrants {
// Address of the pruner
string pruner = 2 [(cosmos_proto.scalar) = "cosmos.AddressString"];
}
19 changes: 19 additions & 0 deletions proto/cosmos/authz/v1beta1/tx.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ service Msg {
// Revoke revokes any authorization corresponding to the provided method name on the
// granter's account that has been granted to the grantee.
rpc Revoke(MsgRevoke) returns (MsgRevokeResponse);

// PruneExpiredGrants prunes the expired grants. Currently up to 75 at a time.
//
// Since cosmos-sdk 0.51
rpc PruneExpiredGrants(MsgPruneExpiredGrants) returns (MsgPruneExpiredGrantsResponse);
}

// MsgGrant is a request type for Grant method. It declares authorization to the grantee
Expand Down Expand Up @@ -79,3 +84,17 @@ message MsgRevoke {

// MsgRevokeResponse defines the Msg/MsgRevokeResponse response type.
message MsgRevokeResponse {}

// MsgPruneExpiredGrants prunes the expired grants.
//
// Since x/authz v1.0.0
message MsgPruneExpiredGrants {
option (cosmos.msg.v1.signer) = "pruner";

string pruner = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
}

// MsgPruneExpiredGrantsResponse defines the Msg/MsgPruneExpiredGrantsResponse response type.
//
// Since x/authz v1.0.0
message MsgPruneExpiredGrantsResponse {}
4 changes: 4 additions & 0 deletions x/authz/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,12 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Features

* [#18737](https://github.com/cosmos/cosmos-sdk/pull/18737) Added a limit of 200 grants pruned per `BeginBlock` and the `PruneExpiredGrants` message that prunes 75 expired grants on every run.

### Improvements

### API Breaking Changes

* [#18737](https://github.com/cosmos/cosmos-sdk/pull/18737) Update the keeper method `DequeueAndDeleteExpiredGrants` to take a limit argument for the number of grants to prune.

### Bug Fixes
5 changes: 5 additions & 0 deletions x/authz/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ granting arbitrary privileges from one account (the granter) to another account
* [MsgGrant](#msggrant)
* [MsgRevoke](#msgrevoke)
* [MsgExec](#msgexec)
* [MsgPruneExpiredGrants](#msgpruneexpiredgrants)
* [Events](#events)
* [Client](#client)
* [CLI](#cli)
julienrbrt marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -181,6 +182,10 @@ The message handling should fail if:
* grantee doesn't have permission to run the transaction.
* if granted authorization is expired.

### MsgPruneExpiredGrants

Message that clean up 75 expired grants. A user has no benefit sending this transaction, it is only used by the chain to clean up expired grants.

## 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).
Expand Down
Loading
Loading