From 0a2de1394ef48bd7110e158d297ccf7aa9505704 Mon Sep 17 00:00:00 2001
From: Shaopeng Wang <spxwang@gmail.com>
Date: Fri, 6 Nov 2020 16:33:31 +1300
Subject: [PATCH] Update orml-oracle docs. (#310)
* Update orml-oracle docs.
* Update feed_values dispatchable call documentation.
---
oracle/README.md | 3 +--
oracle/src/lib.rs | 9 +++++----
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/oracle/README.md b/oracle/README.md
index 07a9c48..4e05724 100644
--- a/oracle/README.md
+++ b/oracle/README.md
@@ -5,5 +5,4 @@
This module exposes capabilities for oracle operators to feed external offchain data.
The raw values can be combined to provide an aggregated value.
-The data are submitted with unsigned transaction so it does not incure a transaction fee. However the data
-still needs to be signed by a session key to prevent spam and ensure the integrity.
+The data is valid only if feeded by an authorized operator. This module implements `frame_support::traits::InitializeMembers` and `frame_support::traits::ChangeMembers`, to provide a way to manage operators membership. Typically it could be leveraged to `pallet_membership` in FRAME.
diff --git a/oracle/src/lib.rs b/oracle/src/lib.rs
index 6a039ff..797fa82 100644
--- a/oracle/src/lib.rs
+++ b/oracle/src/lib.rs
@@ -11,9 +11,10 @@
//! offchain data. The raw values can be combined to provide an aggregated
//! value.
//!
-//! The data are submitted with unsigned transaction so it does not incure a
-//! transaction fee. However the data still needs to be signed by a session key
-//! to prevent spam and ensure the integrity.
+//! The data is valid only if feeded by an authorized operator. This module
+//! implements `frame_support::traits::InitializeMembers` and `frame_support::
+//! traits::ChangeMembers`, to provide a way to manage operators membership.
+//! Typically it could be leveraged to `pallet_membership` in FRAME.
#![cfg_attr(not(feature = "std"), no_std)]
// Disable the following two lints since they originate from an external macro (namely decl_storage)
@@ -138,7 +139,7 @@ decl_module! {
/// Feed the external value.
///
- /// Require unsigned. However a valid signature signed by session key is required along with payload.
+ /// Require authorized operator.
#[weight = (T::WeightInfo::feed_values(values.len() as u32), DispatchClass::Operational)]
pub fn feed_values(
origin,
--
GitLab