cw1-subkeys: Implement permission functionality #75

orkunkl · 2020-09-07T07:37:02Z

Implements permission functionality for messages:

Delegate
Undelegate
Redelegate
Withdraw

CLAassistant · 2020-09-07T07:37:07Z

All committers have signed the CLA.

packages/cw0/src/expiration.rs

contracts/cw1-subkeys/src/contract.rs

ethanfrey

Thanks for your first contract PR @orkunkl

In general, you got all the pieces connected and it looks generally correct. I added a number of comments to improve code quality. Can you go through them and also take another pass on naming design and I will then re-review this

contracts/cw1-subkeys/README.md

ethanfrey · 2020-09-07T08:04:37Z

contracts/cw1-subkeys/README.md

 }

-pub struct AllowanceResponse {


You removed the AllowanceResponse? I think you need both.

Oh, this is README....

I wanted to make helpers.ts and msg.rs naming identical

ethanfrey · 2020-09-07T08:06:06Z

contracts/cw1-subkeys/helpers.ts

@@ -135,9 +135,17 @@ const useOptions = (options: Options): Network => {

 type Expiration = { at_height: { height: number } } | { at_time: { time: number } } | { never: {}}

+interface Permissions {


Question:

If we add permissions for eg. governance votes, or calling wasm contracts, would you keep them here? Or use a separate type?

To see if we want one large "Permissions" or "StakingPermissions", "VotingPermissions", etc.

Separate permissions design brings a lot of extra code(bucket) to both smart contract and helpers.ts. This struct will not contain hundreds of booleans(max 15-20?). I guess using single permissions struct is the optimal way

If rust and buckets provides a way to define permissions generically, then multiple permissions that extend Permissions trait is better.

Fair enough, we keep one Permissions and extend it for other packages.
Please add a comment on the type explaining that choice (actually only in helpers.rs, not here)

I assume you mean state.rs by helpers.rs? or helpers.ts? I am confused 😕

I meant state.rs
I should re-review again

contracts/cw1-subkeys/src/state.rs

packages/cw0/src/expiration.rs

contracts/cw1-subkeys/src/contract.rs

ethanfrey · 2020-09-07T20:44:52Z

Looks good. One comment requested, and please cargo fmt so the linter is happy. Then I will do the final review to merge

ethanfrey

Much nicer.

If you could cover a few more cases in the test code, I can merge this

ethanfrey · 2020-09-08T20:16:54Z

contracts/cw1-subkeys/helpers.ts

@@ -150,8 +174,7 @@ interface InitMsg {
  readonly mutable: boolean,
 }

-// TODO: define more of these
-type CosmosMsg = SendMsg; 
+type CosmosMsg = SendMsg | DelegateMsg | UndelegateMsg | RedelegateMsg | WithdrawMsg


ethanfrey · 2020-09-08T20:19:02Z

contracts/cw1-subkeys/src/contract.rs

        for msg in &msgs {
            match msg {
+                CosmosMsg::Staking(staking_msg) => {
+                    let permissions = permissions(&mut deps.storage);


This is fine and explicit. I generally make this more compact.

let perm = permissions(&mut deps.storage).load(owner_raw.as_slice())?; check_staking_permissions(staking_msg, perm)?;

But it is fine as is. (and with custom error message)

ethanfrey · 2020-09-08T20:19:46Z

contracts/cw1-subkeys/src/contract.rs

+    staking_msg: &StakingMsg,
+    permissions: Permissions,
+) -> Result<bool, PermissionErr> {
+    match staking_msg {


contracts/cw1-subkeys/src/contract.rs

ethanfrey · 2020-09-08T20:22:09Z

contracts/cw1-subkeys/src/contract.rs

        QueryMsg::CanSend { sender, msg } => to_binary(&query_can_send(deps, sender, msg)?),
        QueryMsg::AllAllowances { start_after, limit } => {
            to_binary(&query_all_allowances(deps, start_after, limit)?)
        }
+        QueryMsg::AllPermissions { start_after, limit } => {


Nice addition

ethanfrey · 2020-09-08T20:25:18Z

contracts/cw1-subkeys/src/contract.rs

+            }
+        }
+        CosmosMsg::Staking(staking_msg) => {
+            permissions_read(&deps.storage)


Interesting chain.

I think the ? and match approach for allowances is more legible. But nice that you learned a bit more about map and map_or and handling Options and Results. Key skills for working with rust

Just some old scala and functional programming skills λ

Applied the ? and match case.
But can_send method looks weird to me. The return value is StdResult, but in tests, it is expected to be always boolean. Which throws the error information to the thrash 🤔

Error should only throw if we have trouble parsing from disk, and we cannot prove that will never happen.

In all normal cases (non-corrupt db), we should get true or false. You would have to write invalid json to the key to trigger an error

ethanfrey · 2020-09-08T20:27:11Z

contracts/cw1-subkeys/src/contract.rs

+        // default is no permission
+        handle(&mut deps, env.clone(), setup_perm_msg2).unwrap();
+
+        let permissions = query_permissions(&deps, spender1.clone()).unwrap();


Looks good. I would add one more test, where you set the allowance for someone with a permission and then ensure that both are set properly (setting allowance doesn't unset the permission)

ethanfrey · 2020-09-08T20:29:36Z

contracts/cw1-subkeys/src/contract.rs

+        }
+
+        // spender2 cannot execute (no permission)
+        for msg in &msgs {


I would add a few more tests where one sender has eg. 2 permissions set, 2 unset and ensure that those two pass, and the other 2 fail.

Just a double check that there is no typo in which permission is checked for which message. And ensures future changes don't break this (what if we swap delegate and redelegate permission checks? these tests would still pass)

Added the test. Developer errors must be more distinctive and functional than just a str :( CosmWasm/cosmwasm#518

ethanfrey

Looks good.

Two minor nits on code style. You can ideally change them (or ignore them if you disagree strongly) and then ready for merge.

ethanfrey · 2020-09-09T13:18:02Z

contracts/cw1-subkeys/src/contract.rs

-                })
+            let perm_opt = permissions_read(&deps.storage).may_load(owner_raw.as_slice())?;
+            match perm_opt {
+                Some(permission) => match check_staking_permissions(&staking_msg, permission) {


This could actually be:

Some(permission) => Ok(check_staking_permissions(&staking_msg, permission).is_ok())

Error only returned from may_load unable to parse.

ethanfrey · 2020-09-09T13:19:19Z

contracts/cw1-subkeys/src/contract.rs

@@ -1253,7 +1243,7 @@ mod tests {
        let spender2 = HumanAddr::from("spender0002");
        let denom = "token1";
        let amount = 10000;
-        let allow = coin(amount, denom);
+        let coin = coin(amount, denom);


This shadows the function coin for the rest of this test function. I would avoid that

(I only shadow one variable with another when transforming it, eg. let msg = msg.to_string();)

I see 👍 Renamed it to coin1. allow was not a good fit there.

ethanfrey · 2020-09-09T13:19:49Z

contracts/cw1-subkeys/src/contract.rs

+                msgs: msg_delegate.clone(),
+            },
+        );
+        // FIXME need better error check here


You want typed errors... I know we will make this happen

ethanfrey · 2020-09-09T13:20:07Z

contracts/cw1-subkeys/src/contract.rs

+
+    // tests permissions and allowances are independent features and does not affect each other
+    #[test]
+    fn permissions_allowances_independent() {


orkunkl · 2020-09-09T16:17:01Z

2 points left:

StdErr which is taken care of. We can keep this PR on hold until it is there. It's a minor improve so good to merge IMO.
This is important. In helpers.ts, wasm source URL is pointed to v0.1.1 tag. After merge, cli helper will be broken. It is a good practice to use tags in helpers.ts files but to make it work we need to release new version after every contract change.... I don't see a problem with releasing minor versions. @ethanfrey ideas?

ethanfrey · 2020-09-10T07:31:58Z

helpers.ts is a bit of an issue. current flow is this:

Create 0.2.1 tag of rust code
Package is auto-built (20 minutes later)
Update helpers.ts to point to new code binary

Meaning 0.2.1 helpers.ts points to 0.2.0 (or 0.1.1) code.

I am happy to make a new tag shortly and then we have the updated helpers, but this chicken-and-egg problem is what stops us from using tagged helpers.ts, which is the real solution. Any ideas for work-arounds?

ethanfrey · 2020-09-10T07:33:01Z

I am happy to merge this when you give the 👍

And we can cut a release of cosmwasm-plus contract today

orkunkl · 2020-09-10T08:14:53Z

Houston, the shuttle is ready to launch 🚀 👍

orkunkl added 14 commits September 2, 2020 19:37

cw1-subkeys: introduce permissions

63bc3c5

cw1-subkeys: implement handle_execute checks

6efffd9

cw0: implement display for expiration

bc9e5eb

Fix tests

ad2f705

Add PermissionsErr

91220d2

Finish tests

cb2d0a5

Generate schema

c65f00c

Commenting

c11e3ec

Rename Permissions to Permission

bc14bdc

Rename Permission to Permissions

71ae543

Add permission functionality to helper.ts

ef8c108

Improve helpers.ts

acaac36

Fix helpers.ts and add new staking msg types

0a91d03

helpers.ts works

e427a62

orkunkl requested a review from ethanfrey September 7, 2020 07:37

orkunkl commented Sep 7, 2020

View reviewed changes

packages/cw0/src/expiration.rs Show resolved Hide resolved

orkunkl commented Sep 7, 2020

View reviewed changes

contracts/cw1-subkeys/src/contract.rs Outdated Show resolved Hide resolved

Fix linter errs

40133d3

ethanfrey reviewed Sep 7, 2020

View reviewed changes

orkunkl added 10 commits September 7, 2020 11:38

Rename SetupPermissions msg to SetStakingPermissions

aaa19d7

Apply review recommendations

96e1840

Implement query methods for permissions

93f966f

Fix query

ee0257d

Refactor query

4b0285d

Simplify permission check test

67ea0ea

Add query tests

db6193a

Refactor PermissionErr

8e87951

Improve helpers.ts

2fc834c

Fix can send

6afd69b

orkunkl added 3 commits September 7, 2020 18:50

Fix helpers.ts permission function

b539e36

Change staking permissions function name

339d8e6

Generate schema

ec9f3ef

orkunkl requested a review from ethanfrey September 7, 2020 15:57

orkunkl added 4 commits September 8, 2020 10:55

Add permission comment

b353307

Run cargo fmt

bca69e1

Fix linter errors

00cab66

Fix linter errors

78fbd27

ethanfrey reviewed Sep 8, 2020

View reviewed changes

orkunkl added 2 commits September 9, 2020 15:14

Apply review recommendations

eb8d1f7

Run cargo fmt

0ca0db1

orkunkl requested a review from ethanfrey September 9, 2020 12:33

ethanfrey approved these changes Sep 9, 2020

View reviewed changes

orkunkl added 2 commits September 9, 2020 18:48

Apply review recommendations

3b49a64

Fix err

e88048b

orkunkl mentioned this pull request Sep 9, 2020

Update cw1-subkeys docs section with permissions feature CosmWasm/docs-deprecated#98

Closed

orkunkl mentioned this pull request Sep 10, 2020

cw1-subkeys: Add permission details CosmWasm/docs-deprecated#99

Merged

ethanfrey merged commit 77cf27e into master Sep 10, 2020

ethanfrey deleted the cw1-subkeys-permissions branch September 10, 2020 09:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cw1-subkeys: Implement permission functionality #75

cw1-subkeys: Implement permission functionality #75

orkunkl commented Sep 7, 2020

CLAassistant commented Sep 7, 2020 •

edited

Loading

ethanfrey left a comment

ethanfrey Sep 7, 2020

orkunkl Sep 7, 2020

ethanfrey Sep 7, 2020

orkunkl Sep 7, 2020

orkunkl Sep 7, 2020

ethanfrey Sep 7, 2020

orkunkl Sep 8, 2020

ethanfrey Sep 8, 2020

ethanfrey commented Sep 7, 2020

ethanfrey left a comment

ethanfrey Sep 8, 2020

ethanfrey Sep 8, 2020

ethanfrey Sep 8, 2020

ethanfrey Sep 8, 2020

ethanfrey Sep 8, 2020

orkunkl Sep 9, 2020

orkunkl Sep 9, 2020 •

edited

Loading

ethanfrey Sep 9, 2020

ethanfrey Sep 8, 2020

ethanfrey Sep 8, 2020

orkunkl Sep 9, 2020

ethanfrey left a comment

ethanfrey Sep 9, 2020

ethanfrey Sep 9, 2020

orkunkl Sep 9, 2020

ethanfrey Sep 9, 2020

ethanfrey Sep 9, 2020

orkunkl commented Sep 9, 2020

ethanfrey commented Sep 10, 2020

ethanfrey commented Sep 10, 2020

orkunkl commented Sep 10, 2020

		@@ -135,9 +135,17 @@ const useOptions = (options: Options): Network => {

		type Expiration = { at_height: { height: number } } \| { at_time: { time: number } } \| { never: {}}

		interface Permissions {

cw1-subkeys: Implement permission functionality #75

cw1-subkeys: Implement permission functionality #75

Conversation

orkunkl commented Sep 7, 2020

CLAassistant commented Sep 7, 2020 • edited Loading

ethanfrey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ethanfrey commented Sep 7, 2020

ethanfrey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orkunkl Sep 9, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ethanfrey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orkunkl commented Sep 9, 2020

ethanfrey commented Sep 10, 2020

ethanfrey commented Sep 10, 2020

orkunkl commented Sep 10, 2020

CLAassistant commented Sep 7, 2020 •

edited

Loading

orkunkl Sep 9, 2020 •

edited

Loading