mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-06 19:38:02 +00:00
Niklas Adolfsson
e16ef0861f
This is a rather big change in jsonrpsee, the major things in this bump are: - Server backpressure (the subscription impls are modified to deal with that) - Allow custom error types / return types (remove jsonrpsee::core::Error and jsonrpee::core::CallError) - Bug fixes (graceful shutdown in particular not used by substrate anyway) - Less dependencies for the clients in particular - Return type requires Clone in method call responses - Moved to tokio channels - Async subscription API (not used in this PR) Major changes in this PR: - The subscriptions are now bounded and if subscription can't keep up with the server it is dropped - CLI: add parameter to configure the jsonrpc server bounded message buffer (default is 64) - Add our own subscription helper to deal with the unbounded streams in substrate The most important things in this PR to review is the added helpers functions in `substrate/client/rpc/src/utils.rs` and the rest is pretty much chore. Regarding the "bounded buffer limit" it may cause the server to handle the JSON-RPC calls slower than before. The message size limit is bounded by "--rpc-response-size" thus "by default 10MB * 64 = 640MB" but the subscription message size is not covered by this limit and could be capped as well. Hopefully the last release prior to 1.0, sorry in advance for a big PR Previous attempt: https://github.com/paritytech/substrate/pull/13992 Resolves https://github.com/paritytech/polkadot-sdk/issues/748, resolves https://github.com/paritytech/polkadot-sdk/issues/627
75 lines
2.3 KiB
Rust
75 lines
2.3 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// 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/>.
|
|
|
|
//! Substrate offchain API.
|
|
|
|
#[cfg(test)]
|
|
mod tests;
|
|
|
|
use self::error::Error;
|
|
use jsonrpsee::core::async_trait;
|
|
use parking_lot::RwLock;
|
|
/// Re-export the API for backward compatibility.
|
|
pub use sc_rpc_api::offchain::*;
|
|
use sc_rpc_api::DenyUnsafe;
|
|
use sp_core::{
|
|
offchain::{OffchainStorage, StorageKind},
|
|
Bytes,
|
|
};
|
|
use std::sync::Arc;
|
|
|
|
/// Offchain API
|
|
#[derive(Debug)]
|
|
pub struct Offchain<T: OffchainStorage> {
|
|
/// Offchain storage
|
|
storage: Arc<RwLock<T>>,
|
|
deny_unsafe: DenyUnsafe,
|
|
}
|
|
|
|
impl<T: OffchainStorage> Offchain<T> {
|
|
/// Create new instance of Offchain API.
|
|
pub fn new(storage: T, deny_unsafe: DenyUnsafe) -> Self {
|
|
Offchain { storage: Arc::new(RwLock::new(storage)), deny_unsafe }
|
|
}
|
|
}
|
|
|
|
#[async_trait]
|
|
impl<T: OffchainStorage + 'static> OffchainApiServer for Offchain<T> {
|
|
fn set_local_storage(&self, kind: StorageKind, key: Bytes, value: Bytes) -> Result<(), Error> {
|
|
self.deny_unsafe.check_if_safe()?;
|
|
|
|
let prefix = match kind {
|
|
StorageKind::PERSISTENT => sp_offchain::STORAGE_PREFIX,
|
|
StorageKind::LOCAL => return Err(Error::UnavailableStorageKind),
|
|
};
|
|
self.storage.write().set(prefix, &key, &value);
|
|
Ok(())
|
|
}
|
|
|
|
fn get_local_storage(&self, kind: StorageKind, key: Bytes) -> Result<Option<Bytes>, Error> {
|
|
self.deny_unsafe.check_if_safe()?;
|
|
|
|
let prefix = match kind {
|
|
StorageKind::PERSISTENT => sp_offchain::STORAGE_PREFIX,
|
|
StorageKind::LOCAL => return Err(Error::UnavailableStorageKind),
|
|
};
|
|
|
|
Ok(self.storage.read().get(prefix, &key).map(Into::into))
|
|
}
|
|
}
|