-
Notifications
You must be signed in to change notification settings - Fork 122
feat(ethexe-rpc): add API to query announce info #5253
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.
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
Open
liferooter
wants to merge
2
commits into
master
Choose a base branch
from
gs/ethexe-rpc/add-announce-api
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| // This file is part of Gear. | ||
| // | ||
| // Copyright (C) 2026 Gear Technologies Inc. | ||
| // SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0 | ||
| // | ||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU General Public License | ||
| // along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
|
|
||
| use crate::{errors, utils}; | ||
| use ethexe_common::{Announce, ProgramStates, db::AnnounceStorageRO, gear::StateTransition}; | ||
| use ethexe_db::Database; | ||
| use jsonrpsee::{ | ||
| core::{RpcResult, async_trait}, | ||
| proc_macros::rpc, | ||
| }; | ||
| use sp_core::H256; | ||
|
|
||
| #[cfg_attr(not(feature = "client"), rpc(server))] | ||
| #[cfg_attr(feature = "client", rpc(server, client))] | ||
| pub trait Announce { | ||
| #[method(name = "announce_by_hash")] | ||
| async fn announce(&self, announce_hash: Option<H256>) -> RpcResult<(H256, Announce)>; | ||
|
|
||
| #[method(name = "announce_outcome")] | ||
| async fn announce_outcome( | ||
| &self, | ||
| announce_hash: Option<H256>, | ||
| ) -> RpcResult<Vec<StateTransition>>; | ||
|
|
||
| #[method(name = "announce_program_states")] | ||
| async fn announce_program_states( | ||
| &self, | ||
| announce_hash: Option<H256>, | ||
| ) -> RpcResult<ProgramStates>; | ||
| } | ||
|
|
||
| #[derive(Debug, Clone)] | ||
| pub struct AnnounceApi { | ||
| db: Database, | ||
| } | ||
|
|
||
| impl AnnounceApi { | ||
| pub fn new(db: Database) -> Self { | ||
| Self { db } | ||
| } | ||
| } | ||
|
|
||
| #[async_trait] | ||
| impl AnnounceServer for AnnounceApi { | ||
| async fn announce(&self, announce_hash: Option<H256>) -> RpcResult<(H256, Announce)> { | ||
| let hash = utils::announce_at_or_latest_computed(&self.db, announce_hash)?; | ||
| let announce = self | ||
| .db | ||
| .announce(hash) | ||
| .ok_or_else(|| errors::db("Announce wasn't found"))?; | ||
|
|
||
| Ok((hash.inner(), announce)) | ||
| } | ||
|
|
||
| async fn announce_outcome( | ||
| &self, | ||
| announce_hash: Option<H256>, | ||
| ) -> RpcResult<Vec<StateTransition>> { | ||
| let hash = utils::announce_at_or_latest_computed(&self.db, announce_hash)?; | ||
| self.db | ||
| .announce_outcome(hash) | ||
| .ok_or_else(|| errors::db("Announce outcome wasn't found")) | ||
| } | ||
|
|
||
| async fn announce_program_states( | ||
| &self, | ||
| announce_hash: Option<H256>, | ||
| ) -> RpcResult<ProgramStates> { | ||
| let hash = utils::announce_at_or_latest_computed(&self.db, announce_hash)?; | ||
| self.db | ||
| .announce_program_states(hash) | ||
| .ok_or_else(|| errors::db("Announce program states weren't found")) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new
AnnounceRPC API introduces several new endpoints (announce_by_hash,announce_outcome,announce_program_states). However, there are no corresponding unit or integration tests added to verify the correctness and expected behavior of these new APIs. This is a violation of the repository's review priority on "Verification Expectations" (line 44 of the style guide), specifically "Behavior changes without tests". It is crucial to add tests to ensure the reliability and stability of these new RPC functionalities.References