refactor(multisig)!: move from triggers to custom instructions #5217

s8sato · 2024-11-02T21:27:50Z

Context

Calling a trigger with args as a multisig operation was not a clear interface
The multisig implementation as triggers introduced validation exceptions for registering and executing triggers to bridge the authority gap between the caller and the executor: feat: improve multisig utility and usability #5027

Addresses Ergonomic MST #4930: encapsulate multisig operations
Resolves as for multisig Dedup wasm blobs #5185

Solution

Assign dedicated custom instructions to the multisig operations
Switch to the executor context and package validation and execution logics as the custom instructions

As a side benefit of removing triggers i.e. no event pools, recursive approvals immediately propagate without ticking time

Migration Guide

Introduces MultisigRegister MultisigPropose MultisigApprove custom instructions that replace MultisigAccountArgs MultisigTransactionsArgs
Removes CanRegisterAnyTrigger CanUnregisterAnyTrigger permissions that become useless and are unlikely to be used
Though it becomes useless for multisig, retains the capability to register wasm triggers in genesis

Future Work

Checklist

I've read CONTRIBUTING.md.
All review comments have been resolved.
All CI checks pass.

github-actions · 2024-11-02T21:28:06Z

@BAStos525

wasm/libs/default_executor/src/lib.rs

wasm/libs/default_executor/src/multisig/account.rs

wasm/libs/default_executor/src/multisig/transaction.rs

mversic

amazing stuff, so much better

crates/iroha_executor/src/default.rs

crates/iroha_executor/src/lib.rs

crates/iroha_multisig_data_model/src/lib.rs

crates/iroha_telemetry_derive/Cargo.toml

defaults/genesis.json

crates/iroha_multisig_data_model/src/lib.rs

crates/iroha/tests/multisig.rs

crates/iroha_multisig_data_model/src/lib.rs

s8sato · 2024-11-04T07:15:19Z

Self-reviewed and made fixes 4e4a6b9 0e4fc3a for now. I'm going to address your comments tomorrow @mversic

crates/iroha_multisig_data_model/src/lib.rs

wasm/libs/default_executor/src/multisig/account.rs

wasm/libs/default_executor/src/multisig/transaction.rs

BREAKING CHANGES: - (api-changes) `MultisigRegister` `MultisigPropose` `MultisigApprove` custom instructions Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

…ssions Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

…ions Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

crates/iroha_executor/src/default/isi/multisig/transaction.rs

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

…ecution" This reverts commit 17287d3. Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

s8sato · 2024-11-11T15:41:38Z

Updates:

(partially) dedup and delegate MultisigApprove validation to execution

Left to next PR #4930 (comment):

suspect every metadata existence and format

crates/iroha_executor/src/default/isi/multisig/account.rs

crates/iroha_executor/src/default/isi/multisig/transaction.rs

crates/iroha_executor/src/default/mod.rs

crates/iroha_executor/src/default/isi/multisig/transaction.rs

s8sato · 2024-11-15T04:20:30Z

Updates:

minor updates since refactor(multisig)!: move from triggers to custom instructions #5217 (comment)

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

This reverts commit 9108bb7. Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

DCNick3

Only minor comments, otherwise LGTM

DCNick3 · 2024-11-15T13:13:41Z

crates/iroha/tests/multisig.rs

+    let approver = approvers.next().unwrap();
+    let res = alt_client(approver, &test_client).submit_blocking(approve.clone());
+    match (&transaction_ttl_ms_opt, &unauthorized_target_opt) {
+        (None, None) => assert!(res.is_ok()),


nit: (here and below) res.unwrap() and res.unwrap_err() provide better diagnostics than plain assert!(res.is_ok()), since they would print the error message

DCNick3 · 2024-11-15T13:39:29Z

crates/iroha_executor/src/default/mod.rs

+            }
+
+            if role.id().name().as_ref().starts_with(MULTISIG_SIGNATORY) {
+                if let Some(multisig_account) = multisig_account_from(role.id()) {


Would

let Some(multisig_account) = multisig_account_from(role.id()) else { deny!(executor, "violates multisig role name format") }

work here? I find it when the shorter case of the if-else comes first it's easier to read.

DCNick3 · 2024-11-15T13:46:31Z

crates/iroha_executor/src/default/isi/multisig/transaction.rs

+            );
+
+            if is_expired {
+                // TODO Notify that the proposal has expired, while returning Ok for the entry deletion to take effect


Would using Log instruction work here? Or do you have some kind of client-retrievable notification?

Good idea. Reflected every feedback in another PR #5240

github-actions bot added api-changes Changes in the API for client libraries config-changes Changes in configuration and start up of the Iroha labels Nov 2, 2024

s8sato force-pushed the refactor/4930/custom_instructions branch from e8e1316 to a6b0dce Compare November 2, 2024 21:39

s8sato commented Nov 2, 2024

View reviewed changes

wasm/libs/default_executor/src/lib.rs Outdated Show resolved Hide resolved

wasm/libs/default_executor/src/multisig/account.rs Outdated Show resolved Hide resolved

s8sato self-assigned this Nov 2, 2024

s8sato marked this pull request as ready for review November 2, 2024 22:11

s8sato requested review from mversic, SamHSmith, outoftardis, 0x009922 and dima74 as code owners November 2, 2024 22:11

s8sato enabled auto-merge (squash) November 2, 2024 22:13

s8sato commented Nov 3, 2024

View reviewed changes

wasm/libs/default_executor/src/multisig/transaction.rs Outdated Show resolved Hide resolved

mversic requested changes Nov 3, 2024

View reviewed changes

s8sato force-pushed the refactor/4930/custom_instructions branch from 5b0dbeb to 4e4a6b9 Compare November 4, 2024 07:14

s8sato force-pushed the refactor/4930/custom_instructions branch 2 times, most recently from 48753cb to 0e4fc3a Compare November 4, 2024 10:42

mversic reviewed Nov 5, 2024

View reviewed changes

crates/iroha_multisig_data_model/src/lib.rs Outdated Show resolved Hide resolved

mversic reviewed Nov 5, 2024

View reviewed changes

wasm/libs/default_executor/src/multisig/account.rs Outdated Show resolved Hide resolved

mversic reviewed Nov 5, 2024

View reviewed changes

wasm/libs/default_executor/src/multisig/transaction.rs Outdated Show resolved Hide resolved

s8sato added 8 commits November 5, 2024 16:39

refactor!: move multisig logics to custom instructions

e37bb4d

BREAKING CHANGES: - (api-changes) `MultisigRegister` `MultisigPropose` `MultisigApprove` custom instructions Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

fix: don't continue to grant a role on failing to register the role

00ec667

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

docs: fix doc test

a4ac5b0

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

chore: remove CanRegisterAnyTrigger CanUnregisterAnyTrigger permi…

657d3ad

…ssions Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

refactor: don't branch into visit and execute until leaf instruct…

b158c59

…ions Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

refactor: clone and drop executor instance on recursive execution

4eedd61

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

fix: don't just execute arbitrary approved instructions

da8e7fb

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

fix: propagate executor verdict

f54bd6e

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

review: exclude custom instructions from schema types!

f54d3d9

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

s8sato force-pushed the refactor/4930/custom_instructions branch from e0390e9 to f3eae2c Compare November 8, 2024 14:12

review: dedup and delegate MultisigRegister validation to execution

bd20861

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

s8sato force-pushed the refactor/4930/custom_instructions branch from f3eae2c to bd20861 Compare November 8, 2024 14:49

mversic reviewed Nov 11, 2024

View reviewed changes

crates/iroha_executor/src/default/isi/multisig/transaction.rs Outdated Show resolved Hide resolved

mversic reviewed Nov 11, 2024

View reviewed changes

crates/iroha_executor/src/default/isi/multisig/transaction.rs Show resolved Hide resolved

mversic reviewed Nov 11, 2024

View reviewed changes

crates/iroha_executor/src/default/isi/multisig/transaction.rs Show resolved Hide resolved

s8sato added 4 commits November 12, 2024 00:16

review: dedup and delegate MultisigPropose validation to execution

17287d3

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

Revert "review: dedup and delegate MultisigPropose validation to ex…

d1a167c

…ecution" This reverts commit 17287d3. Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

review: dedup and delegate MultisigApprove validation to execution

e41ba88

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

Merge branch 'main' into refactor/4930/custom_instructions-wip

35b3865

s8sato force-pushed the refactor/4930/custom_instructions branch from 8ff9018 to 35b3865 Compare November 11, 2024 17:57

DCNick3 self-assigned this Nov 12, 2024

s8sato mentioned this pull request Nov 13, 2024

Ergonomic MST #4930

Open

mversic requested changes Nov 14, 2024

View reviewed changes

mversic reviewed Nov 14, 2024

View reviewed changes

crates/iroha_executor/src/default/isi/multisig/transaction.rs Outdated Show resolved Hide resolved

mversic reviewed Nov 14, 2024

View reviewed changes

crates/iroha_executor/src/default/isi/multisig/transaction.rs Show resolved Hide resolved

mversic previously approved these changes Nov 14, 2024

View reviewed changes

s8sato dismissed mversic’s stale review via 0306c05 November 15, 2024 04:18

s8sato added 4 commits November 15, 2024 13:23

review: minor updates since issuecomment-2468473163

0bb6250

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

review: visit_grant_account_role in visit_register_role

2522e18

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

Revert "review: visit_grant_account_role in visit_register_role"

11800b6

This reverts commit 9108bb7. Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

Merge branch 'main' into refactor/4930/custom_instructions

6eac0f6

Signed-off-by: Shunkichi Sato <49983831+s8sato@users.noreply.github.com>

s8sato force-pushed the refactor/4930/custom_instructions branch from 0306c05 to 6eac0f6 Compare November 15, 2024 04:24

mversic self-requested a review November 15, 2024 07:17

mversic approved these changes Nov 15, 2024

View reviewed changes

DCNick3 reviewed Nov 15, 2024

View reviewed changes

s8sato mentioned this pull request Nov 16, 2024

feat(multisig)!: pretty list of pending proposals #5240

Draft

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(multisig)!: move from triggers to custom instructions #5217

refactor(multisig)!: move from triggers to custom instructions #5217

s8sato commented Nov 2, 2024 •

edited

Loading

github-actions bot commented Nov 2, 2024

mversic left a comment

s8sato commented Nov 4, 2024 •

edited

Loading

s8sato commented Nov 11, 2024 •

edited

Loading

s8sato commented Nov 15, 2024 •

edited

Loading

DCNick3 left a comment

DCNick3 Nov 15, 2024

DCNick3 Nov 15, 2024

DCNick3 Nov 15, 2024

s8sato Nov 16, 2024

refactor(multisig)!: move from triggers to custom instructions #5217

Are you sure you want to change the base?

refactor(multisig)!: move from triggers to custom instructions #5217

Conversation

s8sato commented Nov 2, 2024 • edited Loading

Context

Solution

Migration Guide

Future Work

Checklist

github-actions bot commented Nov 2, 2024

mversic left a comment

Choose a reason for hiding this comment

s8sato commented Nov 4, 2024 • edited Loading

s8sato commented Nov 11, 2024 • edited Loading

s8sato commented Nov 15, 2024 • edited Loading

DCNick3 left a comment

Choose a reason for hiding this comment

DCNick3 Nov 15, 2024

Choose a reason for hiding this comment

DCNick3 Nov 15, 2024

Choose a reason for hiding this comment

DCNick3 Nov 15, 2024

Choose a reason for hiding this comment

s8sato Nov 16, 2024

Choose a reason for hiding this comment

s8sato commented Nov 2, 2024 •

edited

Loading

s8sato commented Nov 4, 2024 •

edited

Loading

s8sato commented Nov 11, 2024 •

edited

Loading

s8sato commented Nov 15, 2024 •

edited

Loading