Skip to content

Commit 2d50188

Browse files
committed
fix: better naming
1 parent b6c01a4 commit 2d50188

File tree

4 files changed

+18
-17
lines changed

4 files changed

+18
-17
lines changed

target_chains/ethereum/contracts/contracts/pulse/scheduler/IScheduler.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ interface IScheduler is SchedulerEvents {
5252
function deactivateSubscription(uint256 subscriptionId) external;
5353

5454
/**
55-
* @notice Updates price feeds for a subscription
56-
* @dev Verifies the updateData using the Pyth contract and validates that all feeds have the same timestamp
55+
* @notice Updates price feeds for a subscription.
56+
* Verifies the updateData using the Pyth contract and validates that all feeds have the same timestamp.
5757
* @param subscriptionId The ID of the subscription
5858
* @param updateData The price update data from Pyth
5959
* @param priceIds The IDs of the price feeds to update

target_chains/ethereum/contracts/contracts/pulse/scheduler/Scheduler.sol

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -328,9 +328,10 @@ abstract contract Scheduler is IScheduler, SchedulerState {
328328
return (subscriptionIds, subscriptionParams);
329329
}
330330

331-
// Helper functions for access control
331+
// ACCESS CONTROL MODIFIERS
332+
332333
modifier onlyPusher() {
333-
// TODO
334+
// TODO: we may not make this permissioned.
334335
_;
335336
}
336337

@@ -349,7 +350,7 @@ abstract contract Scheduler is IScheduler, SchedulerState {
349350
}
350351

351352
// If whitelist is not used, allow any reader
352-
if (!_state.subscriptionParams[subscriptionId].useWhitelist) {
353+
if (!_state.subscriptionParams[subscriptionId].whitelistEnabled) {
353354
_;
354355
return;
355356
}

target_chains/ethereum/contracts/contracts/pulse/scheduler/SchedulerState.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ contract SchedulerState {
2727
struct SubscriptionParams {
2828
bytes32[] priceIds;
2929
address[] readerWhitelist;
30-
bool useWhitelist;
30+
bool whitelistEnabled;
3131
UpdateCriteria updateCriteria;
3232
GasConfig gasConfig;
3333
}

target_chains/ethereum/contracts/forge-test/PulseScheduler.t.sol

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ contract SchedulerTest is Test, SchedulerEvents, PulseTestUtils {
104104
.SubscriptionParams({
105105
priceIds: priceIds,
106106
readerWhitelist: readerWhitelist,
107-
useWhitelist: true,
107+
whitelistEnabled: true,
108108
updateCriteria: updateCriteria,
109109
gasConfig: gasConfig
110110
});
@@ -133,9 +133,9 @@ contract SchedulerTest is Test, SchedulerEvents, PulseTestUtils {
133133
"Whitelist length mismatch"
134134
);
135135
assertEq(
136-
storedParams.useWhitelist,
136+
storedParams.whitelistEnabled,
137137
true,
138-
"useWhitelist should be true"
138+
"whitelistEnabled should be true"
139139
);
140140
assertEq(
141141
storedParams.updateCriteria.heartbeatSeconds,
@@ -185,7 +185,7 @@ contract SchedulerTest is Test, SchedulerEvents, PulseTestUtils {
185185
.SubscriptionParams({
186186
priceIds: newPriceIds,
187187
readerWhitelist: newReaderWhitelist,
188-
useWhitelist: false, // Changed from true
188+
whitelistEnabled: false, // Changed from true
189189
updateCriteria: newUpdateCriteria,
190190
gasConfig: newGasConfig
191191
});
@@ -211,9 +211,9 @@ contract SchedulerTest is Test, SchedulerEvents, PulseTestUtils {
211211
"Whitelist length mismatch"
212212
);
213213
assertEq(
214-
storedParams.useWhitelist,
214+
storedParams.whitelistEnabled,
215215
false,
216-
"useWhitelist should be false"
216+
"whitelistEnabled should be false"
217217
);
218218
assertEq(
219219
storedParams.updateCriteria.heartbeatSeconds,
@@ -420,7 +420,7 @@ contract SchedulerTest is Test, SchedulerEvents, PulseTestUtils {
420420
}
421421

422422
function testOptionalWhitelist() public {
423-
// Add a subscription with useWhitelist = false
423+
// Add a subscription with whitelistEnabled = false
424424
bytes32[] memory priceIds = createPriceIds();
425425
address[] memory emptyWhitelist = new address[](0);
426426

@@ -441,7 +441,7 @@ contract SchedulerTest is Test, SchedulerEvents, PulseTestUtils {
441441
.SubscriptionParams({
442442
priceIds: priceIds,
443443
readerWhitelist: emptyWhitelist,
444-
useWhitelist: false, // No whitelist
444+
whitelistEnabled: false, // No whitelist
445445
updateCriteria: updateCriteria,
446446
gasConfig: gasConfig
447447
});
@@ -510,7 +510,7 @@ contract SchedulerTest is Test, SchedulerEvents, PulseTestUtils {
510510
.SubscriptionParams({
511511
priceIds: priceIds,
512512
readerWhitelist: emptyWhitelist,
513-
useWhitelist: false,
513+
whitelistEnabled: false,
514514
updateCriteria: updateCriteria,
515515
gasConfig: gasConfig
516516
});
@@ -577,7 +577,7 @@ contract SchedulerTest is Test, SchedulerEvents, PulseTestUtils {
577577
.SubscriptionParams({
578578
priceIds: priceIds,
579579
readerWhitelist: readerWhitelist,
580-
useWhitelist: true,
580+
whitelistEnabled: true,
581581
updateCriteria: updateCriteria,
582582
gasConfig: gasConfig
583583
});
@@ -610,7 +610,7 @@ contract SchedulerTest is Test, SchedulerEvents, PulseTestUtils {
610610
.SubscriptionParams({
611611
priceIds: priceIds,
612612
readerWhitelist: readerWhitelist,
613-
useWhitelist: true,
613+
whitelistEnabled: true,
614614
updateCriteria: updateCriteria,
615615
gasConfig: gasConfig
616616
});

0 commit comments

Comments
 (0)