Skip to content

Oracles: use BoundedVec for feed values #925

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

Merged
merged 1 commit into from
Jun 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions oracle/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ pub mod module {
/// Maximum size of HasDispatched
#[pallet::constant]
type MaxHasDispatchedSize: Get<u32>;

/// Maximum size the vector used for feed values
#[pallet::constant]
type MaxFeedValues: Get<u32>;
}

#[pallet::error]
Expand Down Expand Up @@ -158,7 +162,7 @@ pub mod module {
#[pallet::weight(T::WeightInfo::feed_values(values.len() as u32))]
pub fn feed_values(
origin: OriginFor<T>,
values: Vec<(T::OracleKey, T::OracleValue)>,
values: BoundedVec<(T::OracleKey, T::OracleValue), T::MaxFeedValues>,
) -> DispatchResultWithPostInfo {
let feeder = ensure_signed(origin.clone())
.map(Some)
Expand All @@ -172,7 +176,7 @@ pub mod module {
Error::<T, I>::AlreadyFeeded
);

Self::do_feed_values(who, values)?;
Self::do_feed_values(who, values.into())?;
Ok(Pays::No.into())
}
}
Expand Down
1 change: 1 addition & 0 deletions oracle/src/mock.rs
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ impl Config for Test {
type Members = Members;
type WeightInfo = ();
type MaxHasDispatchedSize = ConstU32<100>;
type MaxFeedValues = ConstU32<5>;
}

type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;
Expand Down
115 changes: 89 additions & 26 deletions oracle/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@ fn should_feed_values_from_member() {
let account_id: AccountId = 1;

assert_noop!(
ModuleOracle::feed_values(RuntimeOrigin::signed(5), vec![(50, 1000), (51, 900), (52, 800)]),
ModuleOracle::feed_values(
RuntimeOrigin::signed(5),
vec![(50, 1000), (51, 900), (52, 800)].try_into().unwrap()
),
Error::<Test, _>::NoPermission,
);

assert_eq!(
ModuleOracle::feed_values(
RuntimeOrigin::signed(account_id),
vec![(50, 1000), (51, 900), (52, 800)]
vec![(50, 1000), (51, 900), (52, 800)].try_into().unwrap()
)
.unwrap()
.pays_fee,
Expand Down Expand Up @@ -62,7 +65,7 @@ fn should_feed_values_from_root() {

assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::root(),
vec![(50, 1000), (51, 900), (52, 800)]
vec![(50, 1000), (51, 900), (52, 800)].try_into().unwrap()
));

// Or feed from root using the DataFeeder trait with None
Expand Down Expand Up @@ -110,7 +113,7 @@ fn should_not_feed_values_from_root_directly() {
assert_noop!(
ModuleOracle::feed_values(
RuntimeOrigin::signed(root_feeder),
vec![(50, 1000), (51, 900), (52, 800)]
vec![(50, 1000), (51, 900), (52, 800)].try_into().unwrap()
),
Error::<Test, _>::NoPermission,
);
Expand All @@ -125,8 +128,14 @@ fn should_read_raw_values() {
let raw_values = ModuleOracle::read_raw_values(&key);
assert_eq!(raw_values, vec![]);

assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(key, 1000)]));
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(2), vec![(key, 1200)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(1),
vec![(key, 1000)].try_into().unwrap()
));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(2),
vec![(key, 1200)].try_into().unwrap()
));

let raw_values = ModuleOracle::read_raw_values(&key);
assert_eq!(
Expand All @@ -150,9 +159,18 @@ fn should_combined_data() {
new_test_ext().execute_with(|| {
let key: u32 = 50;

assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(key, 1300)]));
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(2), vec![(key, 1000)]));
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(3), vec![(key, 1200)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(1),
vec![(key, 1300)].try_into().unwrap()
));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(2),
vec![(key, 1000)].try_into().unwrap()
));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(3),
vec![(key, 1200)].try_into().unwrap()
));

let expected = Some(TimestampedValue {
value: 1200,
Expand All @@ -177,11 +195,14 @@ fn should_return_none_for_non_exist_key() {
#[test]
fn multiple_calls_should_fail() {
new_test_ext().execute_with(|| {
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(50, 1300)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(1),
vec![(50, 1300)].try_into().unwrap()
));

// Fails feeding by the the extrinsic
assert_noop!(
ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(50, 1300)]),
ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(50, 1300)].try_into().unwrap()),
Error::<Test, _>::AlreadyFeeded,
);

Expand All @@ -190,7 +211,10 @@ fn multiple_calls_should_fail() {

ModuleOracle::on_finalize(1);

assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(50, 1300)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(1),
vec![(50, 1300)].try_into().unwrap()
));
});
}

Expand All @@ -203,9 +227,18 @@ fn get_all_values_should_work() {
assert_eq!(ModuleOracle::get_all_values(), vec![]);

// feed eur & jpy
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(eur, 1300)]));
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(2), vec![(eur, 1000)]));
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(3), vec![(jpy, 9000)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(1),
vec![(eur, 1300)].try_into().unwrap()
));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(2),
vec![(eur, 1000)].try_into().unwrap()
));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(3),
vec![(jpy, 9000)].try_into().unwrap()
));

// not enough eur & jpy prices
assert_eq!(ModuleOracle::get(&eur), None);
Expand All @@ -216,8 +249,14 @@ fn get_all_values_should_work() {
ModuleOracle::on_finalize(1);

// feed eur & jpy
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(3), vec![(eur, 1200)]));
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(jpy, 8000)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(3),
vec![(eur, 1200)].try_into().unwrap()
));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(1),
vec![(jpy, 8000)].try_into().unwrap()
));

// enough eur prices
let eur_price = Some(TimestampedValue {
Expand All @@ -232,7 +271,10 @@ fn get_all_values_should_work() {
assert_eq!(ModuleOracle::get_all_values(), vec![(eur, eur_price)]);

// feed jpy
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(2), vec![(jpy, 7000)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(2),
vec![(jpy, 7000)].try_into().unwrap()
));

// enough jpy prices
let jpy_price = Some(TimestampedValue {
Expand All @@ -251,19 +293,31 @@ fn change_member_should_work() {
OracleMembers::set(vec![2, 3, 4]);
<ModuleOracle as ChangeMembers<AccountId>>::change_members_sorted(&[4], &[1], &[2, 3, 4]);
assert_noop!(
ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(50, 1000)]),
ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(50, 1000)].try_into().unwrap()),
Error::<Test, _>::NoPermission,
);
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(2), vec![(50, 1000)]));
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(4), vec![(50, 1000)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(2),
vec![(50, 1000)].try_into().unwrap()
));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(4),
vec![(50, 1000)].try_into().unwrap()
));
});
}

#[test]
fn should_clear_data_for_removed_members() {
new_test_ext().execute_with(|| {
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(50, 1000)]));
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(2), vec![(50, 1000)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(1),
vec![(50, 1000)].try_into().unwrap()
));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(2),
vec![(50, 1000)].try_into().unwrap()
));

ModuleOracle::change_members_sorted(&[4], &[1], &[2, 3, 4]);

Expand All @@ -274,14 +328,23 @@ fn should_clear_data_for_removed_members() {
#[test]
fn values_are_updated_on_feed() {
new_test_ext().execute_with(|| {
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(1), vec![(50, 900)]));
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(2), vec![(50, 1000)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(1),
vec![(50, 900)].try_into().unwrap()
));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(2),
vec![(50, 1000)].try_into().unwrap()
));

assert_eq!(ModuleOracle::values(50), None);

// Upon the third price feed, the value is updated immediately after `combine`
// can produce valid result.
assert_ok!(ModuleOracle::feed_values(RuntimeOrigin::signed(3), vec![(50, 1100)]));
assert_ok!(ModuleOracle::feed_values(
RuntimeOrigin::signed(3),
vec![(50, 1100)].try_into().unwrap()
));
assert_eq!(
ModuleOracle::values(50),
Some(TimestampedValue {
Expand Down