-
Notifications
You must be signed in to change notification settings - Fork 123
feat(node): add gear_readWasmCustomSection RPC endpoint #5275
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
ukint-vs
wants to merge
8
commits into
master
Choose a base branch
from
vs/read-wasm-custom-section
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
8 commits
Select commit
Hold shift + click to select a range
2826bda
feat(node): add `gear_readWasmCustomSection` RPC endpoint
ukint-vs f70af94
Merge remote-tracking branch 'origin/master' into vs/read-wasm-custom…
ukint-vs fba43fe
fix(node): address review comments for wasm_section RPC
ukint-vs 0d152b6
style(node): apply rustfmt formatting
ukint-vs b5e190b
Merge branch 'master' into vs/read-wasm-custom-section
ukint-vs 015943f
fix(core): address review feedback on wasm custom section helper
ukint-vs 3f53eb7
Merge branch 'master' into vs/read-wasm-custom-section
ukint-vs 9cb6f35
refactor: simplify wasm_section RPC and trim narration comments
ukint-vs 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
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
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,116 @@ | ||
| // This file is part of Gear. | ||
|
|
||
| // Copyright (C) 2021-2025 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/>. | ||
|
|
||
| //! RPC endpoint for reading custom sections from program WASM original code. | ||
|
|
||
| use gear_core::code::get_custom_section_data; | ||
| use jsonrpsee::{core::RpcResult, proc_macros::rpc, types::ErrorObjectOwned}; | ||
| use parity_scale_codec::{Compact, Decode}; | ||
| use sc_client_api::StorageProvider; | ||
| use sp_blockchain::HeaderBackend; | ||
| use sp_core::{Bytes, H256, twox_128}; | ||
| use sp_runtime::traits::Block as BlockT; | ||
| use sp_storage::StorageKey; | ||
| use std::{marker::PhantomData, sync::Arc}; | ||
|
|
||
| const ERROR_CODE: i32 = 9000; | ||
|
|
||
| #[rpc(server)] | ||
| pub(crate) trait WasmSection<BlockHash> { | ||
| /// Read a custom section from the original WASM code stored on-chain. | ||
| /// | ||
| /// This is commonly used to retrieve the Sails IDL embedded in the | ||
| /// `sails:idl` custom section. The returned bytes are raw section data; | ||
| /// for `sails:idl`, clients must parse the envelope (version + flags) | ||
| /// and decompress the payload. | ||
| /// | ||
| /// Returns `null` if the code is not found or the section does not exist. | ||
| #[method(name = "gear_readWasmCustomSection")] | ||
| fn read_wasm_custom_section( | ||
| &self, | ||
| code_id: H256, | ||
| section_name: String, | ||
| at: Option<BlockHash>, | ||
| ) -> RpcResult<Option<Bytes>>; | ||
| } | ||
|
|
||
| pub(crate) struct WasmSectionApi<C, Block, Backend> { | ||
| client: Arc<C>, | ||
| _marker: PhantomData<(Block, Backend)>, | ||
| } | ||
|
|
||
| impl<C, Block, Backend> WasmSectionApi<C, Block, Backend> { | ||
| pub(crate) fn new(client: Arc<C>) -> Self { | ||
| Self { | ||
| client, | ||
| _marker: PhantomData, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<C, Block, Backend> WasmSectionServer<<Block as BlockT>::Hash> | ||
| for WasmSectionApi<C, Block, Backend> | ||
| where | ||
| C: HeaderBackend<Block> + StorageProvider<Block, Backend> + Send + Sync + 'static, | ||
| Block: BlockT, | ||
| Backend: sc_client_api::Backend<Block> + Send + Sync + 'static, | ||
| { | ||
| fn read_wasm_custom_section( | ||
| &self, | ||
| code_id: H256, | ||
| section_name: String, | ||
| at: Option<Block::Hash>, | ||
| ) -> RpcResult<Option<Bytes>> { | ||
| let at = at.unwrap_or_else(|| self.client.info().best_hash); | ||
|
|
||
| // Keep in sync with `pallet-gear-program::OriginalCodeStorage` (StorageMap, Identity hasher). | ||
| let mut storage_key = twox_128(b"GearProgram").to_vec(); | ||
| storage_key.extend_from_slice(&twox_128(b"OriginalCodeStorage")); | ||
| storage_key.extend_from_slice(code_id.as_bytes()); | ||
|
|
||
| let wasm_data = self | ||
| .client | ||
| .storage(at, &StorageKey(storage_key)) | ||
| .map_err(|e| rpc_err("WASM section read error", Some(e.to_string())))?; | ||
|
|
||
| let Some(wasm_data) = wasm_data else { | ||
| return Ok(None); | ||
| }; | ||
|
|
||
| let mut input = wasm_data.0.as_slice(); | ||
| let len = <Compact<u32>>::decode(&mut input) | ||
| .map_err(|e| rpc_err("Failed to decode stored WASM length", Some(e.to_string())))? | ||
| .0 as usize; | ||
| if input.len() < len { | ||
| return Err(rpc_err("Truncated stored WASM blob", None)); | ||
| } | ||
| let wasm_bytes = &input[..len]; | ||
|
|
||
| match get_custom_section_data(wasm_bytes, §ion_name) { | ||
| Ok(Some(data)) => Ok(Some(Bytes(data.to_vec()))), | ||
| Ok(None) => Ok(None), | ||
| Err(e) => Err(rpc_err("Failed to parse stored WASM", Some(e.to_string()))), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn rpc_err(message: &str, data: Option<String>) -> ErrorObjectOwned { | ||
| use jsonrpsee::types::error::ErrorObject; | ||
|
|
||
| ErrorObject::owned(ERROR_CODE, message, data) | ||
| } | ||
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.
Move impl inside pallet gear, to use normally CodeStorage instead of this raw code