Skip to content

Commit 29b1a95

Browse files
committed
doc: update docs for getActiveSubscriptions
1 parent 15e3901 commit 29b1a95

File tree

1 file changed

+9
-6
lines changed
  • target_chains/ethereum/contracts/contracts/pulse/scheduler

1 file changed

+9
-6
lines changed

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ interface IScheduler is SchedulerEvents {
4848

4949
/**
5050
* @notice Updates price feeds for a subscription.
51-
* Verifies the updateData using the Pyth contract and validates that all feeds have the same timestamp.
51+
* @dev Internally, this verifies the updateData using the Pyth contract and validates update conditions.
5252
* @param subscriptionId The ID of the subscription
5353
* @param updateData The price update data from Pyth
5454
* @param priceIds The IDs of the price feeds to update
@@ -73,7 +73,8 @@ interface IScheduler is SchedulerEvents {
7373
bytes32[] calldata priceIds
7474
) external view returns (PythStructs.Price[] memory prices);
7575

76-
/** @notice Returns the exponentially-weighted moving average price of a price feed without any sanity checks.
76+
/**
77+
* @notice Returns the exponentially-weighted moving average price of a price feed without any sanity checks.
7778
* @dev This function returns the same price as `getEmaPrice` in the case where the price is available.
7879
* However, if the price is not recent this function returns the latest available price.
7980
*
@@ -114,10 +115,12 @@ interface IScheduler is SchedulerEvents {
114115
) external view returns (uint256 minimumBalanceInWei);
115116

116117
/**
117-
* @notice Gets all active subscriptions with their parameters
118-
* @dev This function has no access control to allow keepers to discover active subscriptions
119-
* @param startIndex The starting index for pagination
120-
* @param maxResults The maximum number of results to return
118+
* @notice Gets all active subscriptions with their parameters, paginated.
119+
* @dev This function has no access control to allow keepers to discover active subscriptions.
120+
* @dev Note that the order of subscription IDs returned may not be sequential and can change
121+
* when subscriptions are deactivated or reactivated.
122+
* @param startIndex The starting index within the list of active subscriptions (NOT the subscription ID).
123+
* @param maxResults The maximum number of results to return starting from startIndex.
121124
* @return subscriptionIds Array of active subscription IDs
122125
* @return subscriptionParams Array of subscription parameters for each active subscription
123126
* @return totalCount Total number of active subscriptions

0 commit comments

Comments
 (0)