feat(sequencer): implement abci query for bridge account info by noot · Pull Request #1189 · astriaorg/astria

noot · 2024-06-17T18:38:48Z

Summary

implement abci query for bridge account info, so users can tell if an account is a bridge account or not, and its relevant info if it is.

Background

needed for good UX

Changes

implement abci query for bridge account info, so users can tell if an account is a bridge account or not, and its relevant info if it is
update sequencer client respectively

Testing

unit tests, sequencer client

Related Issues

closes #1118

…uery

SuperFluffy · 2024-06-18T09:47:02Z

crates/astria-sequencer/src/bridge/query.rs

Can you please provide unit tests for these query handlers? Since we have written them as free standing functions unit testing should be relatively straight forward.

SuperFluffy · 2024-06-18T09:48:02Z

proto/protocolapis/astria/protocol/bridge/v1alpha1/types.proto

+message BridgeAccountInfoResponse {
+  uint64 height = 2;
+  astria.primitive.v1.RollupId rollup_id = 3;
+  optional bytes asset_id = 4;


What does it mean if this field is not set?

Also, I wonder if we should start using IBC denoms (i.e. strings) in their place - so this would be ibc/<hash>. I think it would make things a bit neater.

it means the account is not a bridge account - will add a comment to clarify

SuperFluffy · 2024-06-18T09:48:58Z

proto/protocolapis/astria/protocol/bridge/v1alpha1/types.proto

  optional bytes tx_hash = 3;
 }
+
+message BridgeAccountInfoResponse {


Small doc for what this is supposed to be the response to? I think this should mention ABCI because there is not (yet?) a matching grpc service.

SuperFluffy · 2024-06-18T09:50:35Z

crates/astria-core/src/protocol/bridge/v1alpha1/mod.rs

+    }
+}
+
+impl raw::BridgeAccountInfoResponse {


It was pretty annoying having to update all these .into_native/from_native methods. I think I introduced these utilities prematurely and we should get rid of them/not introduce them for now (also since thehy are only used in astria-sequencer-client).

…uery

SuperFluffy · 2024-07-01T16:43:02Z

proto/protocolapis/astria/protocol/bridge/v1alpha1/types.proto

Should these live under protocol? They don't seem to be protocol-relevant?

we can move them to a different protobuf package, can do in a follow-up

SuperFluffy · 2024-07-01T16:44:43Z

proto/protocolapis/astria/protocol/bridge/v1alpha1/types.proto

+// containing the account information given some bridge address,
+// if it exists.
+message BridgeAccountInfoResponse {
+  uint64 height = 2;


Why is this not indexed starting at 1? Is field number 1 reserved for something else?

this matches the original response types which i think you wrote :p

// A response containing the balance of an account. message BalanceResponse { uint64 height = 2; repeated AssetBalance balances = 3; } // A response containing the current nonce for an account. message NonceResponse { uint64 height = 2; uint32 nonce = 3; }

so not sure, we can change?

yeah, starting later is indeed weird. I wasn't aware that these are with us for a year already. :-S

In this PR, let them start at 1. The others we can fix in the followup breaking these request-response types out into a separate proto package.

SuperFluffy · 2024-07-01T16:55:29Z

crates/astria-sequencer/src/bridge/query.rs

+    code: AbciErrorCode,
+    info: &str,
+) -> response::Query {
+    if err.is_none() {


You can simplify the body of this function considerably by doing:

let log = match err { Some(err) => format!("{info}: {err:?}"), None => info.into(), }; response::Query { code: code.into(), info: code.to_string(), log, ..response::Query::default() }

SuperFluffy · 2024-07-01T16:55:32Z

crates/astria-sequencer/src/bridge/query.rs

    state_ext::StateReadExt as _,
 };

+fn error_query_response(


I like this helper.

SuperFluffy · 2024-07-01T17:01:31Z

crates/astria-sequencer/src/bridge/query.rs

+) -> response::Query {
+    use astria_core::protocol::bridge::v1alpha1::BridgeAccountInfoResponse;
+
+    let address = match preprocess_request(&params) {


I think you can apply the ? operator here because this method returns a response::Query?

Also, other queries check the address prefix against the globally configured address prefixes, see the astria_sequencer::address submodule.

Should this also do that?

I think you can apply the ? operator here because this method returns a response::Query?

doesn't work since this function doesn't return a result, just a Query :/

Should this also do that?

yes, will add

doesn't work since this function doesn't return a result, just a Query :/

Ah, yeah. :S

SuperFluffy · 2024-07-01T17:03:42Z

crates/astria-sequencer/src/bridge/query.rs

+fn error_query_response(
+    err: Option<anyhow::Error>,
+    code: AbciErrorCode,
+    info: &str,


IMO rename this as msg or something because the info field in the query response (which is the human readable code) and this info argument tripped me up

Also to add to this: I think you can forego the info field entirely and lean on anyhow. If you encounter a None, you can either None.context("something was not set").map_err(|e| error_to_query_response(e, <code>), or just match thing_that_can_none() { None => ... } as before.

* main: (27 commits) refactor(sequencer): fix prepare proposal metrics (#1211) refactor(bridge-withdrawer): move generated contract bindings to crate (#1237) fix(sequencer) fix wrong metric and remove unused metric (#1240) feat(sequencer): implement transaction fee query (#1196) chore(cli)!: remove unmaintained rollup subcommand (#1235) release(sequencer): 0.14.1 patch release (#1233) feat(sequencer-utils): generate example genesis state (#1224) feat(sequencer): implement abci query for bridge account info (#1189) feat(charts): bridge-withdrawer, smoke test, various chart improvements (#1141) chore(charts): update for new geth update (#1226) chore(chart)!: dusk-8 chart version updates (#1223) release(conductor): fix conductor release version (#1222) release: dusk-8 versions (#1219) fix(core): revert `From` ed25519_consensus types for crypto mod (#1220) Refactor(chart, sequencer): restructure sequencer chart, adjust configs (#1193) refactor(withdrawer): read from block subscription stream and get events on each block (#1207) feat(core): implement with verification key for address builder and crypto improvements (#1218) feat(proto, sequencer)!: use full IBC ICS20 denoms instead of IDs (#1209) chore(chart): update evm chart for new prefix field (#1214) chore: bump penumbra deps (#1216) ...

## Summary implement abci query for bridge account info, so users can tell if an account is a bridge account or not, and its relevant info if it is. ## Background needed for good UX ## Changes - implement abci query for bridge account info, so users can tell if an account is a bridge account or not, and its relevant info if it is - update sequencer client respectively ## Testing unit tests, sequencer client ## Related Issues closes #1118

noot added 2 commits June 17, 2024 14:31

implement bridge account info query

4f1f4f9

update sequencer-client

ed72944

noot requested review from a team as code owners June 17, 2024 18:38

noot requested a review from SuperFluffy June 17, 2024 18:38

github-actions bot added proto pertaining to the Astria Protobuf spec sequencer pertaining to the astria-sequencer crate labels Jun 17, 2024

noot temporarily deployed to BUF June 17, 2024 18:39 — with GitHub Actions Inactive

noot added 2 commits June 17, 2024 14:43

Merge branch 'main' of github.com:astriaorg/astria into noot/bridge-q…

efb1531

…uery

clippy

66b1c60

noot temporarily deployed to BUF June 17, 2024 18:48 — with GitHub Actions Inactive

clippy

402c28c

noot temporarily deployed to BUF June 17, 2024 19:59 — with GitHub Actions Inactive

noot added 2 commits June 17, 2024 16:10

clippy

099a7c4

Merge branch 'main' of github.com:astriaorg/astria into noot/bridge-q…

51c75d9

…uery

noot temporarily deployed to BUF June 17, 2024 20:10 — with GitHub Actions Inactive

clippy

164e26d

noot temporarily deployed to BUF June 17, 2024 21:07 — with GitHub Actions Inactive

SuperFluffy reviewed Jun 18, 2024

View reviewed changes

noot added 3 commits June 19, 2024 16:49

Merge branch 'main' of github.com:astriaorg/astria into noot/bridge-q…

5fe8f3a

…uery

wip unit test

83152a8

merge and address comments

e236e87

noot requested a review from SuperFluffy June 26, 2024 20:35

noot temporarily deployed to BUF June 26, 2024 20:35 — with GitHub Actions Inactive

fix tests

a1fdfe7

noot temporarily deployed to BUF June 26, 2024 20:41 — with GitHub Actions Inactive

SuperFluffy reviewed Jul 1, 2024

View reviewed changes

merge w main and update for asset changes

93a553b

noot temporarily deployed to BUF July 1, 2024 20:04 — with GitHub Actions Inactive

fix testS

f5e4f2d

noot temporarily deployed to BUF July 1, 2024 20:05 — with GitHub Actions Inactive

rename arg

51d72df

noot requested a review from SuperFluffy July 1, 2024 20:06

noot temporarily deployed to BUF July 1, 2024 20:06 — with GitHub Actions Inactive

clippy

ffc5611

noot temporarily deployed to BUF July 1, 2024 21:23 — with GitHub Actions Inactive

SuperFluffy approved these changes Jul 2, 2024

View reviewed changes

Merge branch 'main' into noot/bridge-query

fad7121

noot enabled auto-merge July 2, 2024 18:51

noot temporarily deployed to BUF July 2, 2024 18:51 — with GitHub Actions Inactive

noot added this pull request to the merge queue Jul 2, 2024

Merged via the queue into main with commit a8db883 Jul 2, 2024

noot deleted the noot/bridge-query branch July 2, 2024 19:03

SuperFluffy mentioned this pull request Oct 25, 2024

Add unit tests for queries missing tests #1741

Closed

Conversation

noot commented Jun 17, 2024

Summary

Background

Changes

Testing

Related Issues

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

noot Jul 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SuperFluffy Jul 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

noot Jul 1, 2024 •

edited

Loading

SuperFluffy Jul 2, 2024 •

edited

Loading