referrerpolicy=no-referrer-when-downgrade

sc_rpc_api/offchain/
mod.rs

1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
5
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the GNU General Public License as published by
8// the Free Software Foundation, either version 3 of the License, or
9// (at your option) any later version.
10
11// This program is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License
17// along with this program. If not, see <https://www.gnu.org/licenses/>.
18
19//! Substrate offchain API.
20
21pub mod error;
22
23use error::Error;
24use jsonrpsee::proc_macros::rpc;
25use sp_core::{offchain::StorageKind, Bytes};
26
27/// Substrate offchain RPC API
28#[rpc(client, server)]
29pub trait OffchainApi {
30	/// Set offchain local storage under given key and prefix.
31	#[method(name = "offchain_localStorageSet", with_extensions)]
32	fn set_local_storage(&self, kind: StorageKind, key: Bytes, value: Bytes) -> Result<(), Error>;
33
34	/// Clear offchain local storage under given key and prefix.
35	#[method(name = "offchain_localStorageClear", with_extensions)]
36	fn clear_local_storage(&self, kind: StorageKind, key: Bytes) -> Result<(), Error>;
37
38	/// Get offchain local storage under given key and prefix.
39	#[method(name = "offchain_localStorageGet", with_extensions)]
40	fn get_local_storage(&self, kind: StorageKind, key: Bytes) -> Result<Option<Bytes>, Error>;
41}