-
Notifications
You must be signed in to change notification settings - Fork 261
feat(pulse): add provider #2279
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
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4c7f090
add provider
cctdaniel 0b4d34a
remove unnecessary code
cctdaniel d68155e
fix test
cctdaniel f67734f
add exclusivity period to provider (#2282)
cctdaniel fb8a7cd
make exclusivityPeriodSeconds configurable
cctdaniel 5812d78
remove provider arg from getFee
cctdaniel db13567
remove provider from callback args
cctdaniel 7365c15
add comments
cctdaniel 6e9c08d
add comments
cctdaniel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,17 +13,30 @@ abstract contract Pulse is IPulse, PulseState { | |
address admin, | ||
uint128 pythFeeInWei, | ||
address pythAddress, | ||
bool prefillRequestStorage | ||
address defaultProvider, | ||
bool prefillRequestStorage, | ||
uint256 exclusivityPeriodSeconds | ||
) internal { | ||
require(admin != address(0), "admin is zero address"); | ||
require(pythAddress != address(0), "pyth is zero address"); | ||
require( | ||
defaultProvider != address(0), | ||
"defaultProvider is zero address" | ||
); | ||
|
||
_state.admin = admin; | ||
_state.accruedFeesInWei = 0; | ||
_state.pythFeeInWei = pythFeeInWei; | ||
_state.pyth = pythAddress; | ||
_state.currentSequenceNumber = 1; | ||
|
||
// Two-step initialization process: | ||
// 1. Set the default provider address here | ||
// 2. Provider must call registerProvider() in a separate transaction to set their fee | ||
// This ensures the provider maintains control over their own fee settings | ||
_state.defaultProvider = defaultProvider; | ||
_state.exclusivityPeriodSeconds = exclusivityPeriodSeconds; | ||
|
||
if (prefillRequestStorage) { | ||
for (uint8 i = 0; i < NUM_REQUESTS; i++) { | ||
Request storage req = _state.requests[i]; | ||
|
@@ -45,6 +58,12 @@ abstract contract Pulse is IPulse, PulseState { | |
bytes32[] calldata priceIds, | ||
uint256 callbackGasLimit | ||
) external payable override returns (uint64 requestSequenceNumber) { | ||
address provider = _state.defaultProvider; | ||
require( | ||
_state.providers[provider].isRegistered, | ||
"Provider not registered" | ||
); | ||
|
||
// NOTE: The 60-second future limit on publishTime prevents a DoS vector where | ||
// attackers could submit many low-fee requests for far-future updates when gas prices | ||
// are low, forcing executors to fulfill them later when gas prices might be much higher. | ||
|
@@ -65,13 +84,17 @@ abstract contract Pulse is IPulse, PulseState { | |
req.callbackGasLimit = callbackGasLimit; | ||
req.requester = msg.sender; | ||
req.numPriceIds = uint8(priceIds.length); | ||
req.provider = provider; | ||
|
||
// Copy price IDs to storage | ||
for (uint8 i = 0; i < priceIds.length; i++) { | ||
req.priceIds[i] = priceIds[i]; | ||
} | ||
|
||
_state.accruedFeesInWei += SafeCast.toUint128(msg.value); | ||
_state.providers[provider].accruedFeesInWei += SafeCast.toUint128( | ||
msg.value - _state.pythFeeInWei | ||
); | ||
_state.accruedFeesInWei += _state.pythFeeInWei; | ||
|
||
emit PriceUpdateRequested(req, priceIds); | ||
} | ||
|
@@ -83,6 +106,16 @@ abstract contract Pulse is IPulse, PulseState { | |
) external payable override { | ||
Request storage req = findActiveRequest(sequenceNumber); | ||
|
||
// Check provider exclusivity using configurable period | ||
if ( | ||
block.timestamp < req.publishTime + _state.exclusivityPeriodSeconds | ||
) { | ||
require( | ||
msg.sender == req.provider, | ||
"Only assigned provider during exclusivity period" | ||
); | ||
} | ||
|
||
// Verify priceIds match | ||
require( | ||
priceIds.length == req.numPriceIds, | ||
|
@@ -105,19 +138,10 @@ abstract contract Pulse is IPulse, PulseState { | |
|
||
clearRequest(sequenceNumber); | ||
|
||
// Check if enough gas remains for callback + events/cleanup | ||
// We need extra gas beyond callbackGasLimit for: | ||
// 1. Emitting success/failure events | ||
// 2. Error handling in catch blocks | ||
// 3. State cleanup operations | ||
if (gasleft() < (req.callbackGasLimit * 3) / 2) { | ||
revert InsufficientGas(); | ||
} | ||
|
||
Comment on lines
-108
to
-116
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. removed this because if insufficient gas error occurs within callback then |
||
try | ||
IPulseConsumer(req.requester).pulseCallback{ | ||
gas: req.callbackGasLimit | ||
}(sequenceNumber, msg.sender, priceFeeds) | ||
}(sequenceNumber, priceFeeds) | ||
{ | ||
// Callback succeeded | ||
emitPriceUpdate(sequenceNumber, priceIds, priceFeeds); | ||
|
@@ -173,9 +197,12 @@ abstract contract Pulse is IPulse, PulseState { | |
function getFee( | ||
uint256 callbackGasLimit | ||
) public view override returns (uint128 feeAmount) { | ||
uint128 baseFee = _state.pythFeeInWei; | ||
uint256 gasFee = callbackGasLimit * tx.gasprice; | ||
feeAmount = baseFee + SafeCast.toUint128(gasFee); | ||
uint128 baseFee = _state.pythFeeInWei; // Fixed fee to Pyth | ||
uint128 providerFeeInWei = _state | ||
.providers[_state.defaultProvider] | ||
.feeInWei; // Provider's per-gas rate | ||
uint256 gasFee = callbackGasLimit * providerFeeInWei; // Total provider fee based on gas | ||
feeAmount = baseFee + SafeCast.toUint128(gasFee); // Total fee user needs to pay | ||
} | ||
|
||
function getPythFeeInWei() | ||
|
@@ -271,21 +298,89 @@ abstract contract Pulse is IPulse, PulseState { | |
} | ||
|
||
function setFeeManager(address manager) external override { | ||
require(msg.sender == _state.admin, "Only admin can set fee manager"); | ||
address oldFeeManager = _state.feeManager; | ||
_state.feeManager = manager; | ||
emit FeeManagerUpdated(_state.admin, oldFeeManager, manager); | ||
require( | ||
_state.providers[msg.sender].isRegistered, | ||
"Provider not registered" | ||
); | ||
address oldFeeManager = _state.providers[msg.sender].feeManager; | ||
_state.providers[msg.sender].feeManager = manager; | ||
emit FeeManagerUpdated(msg.sender, oldFeeManager, manager); | ||
} | ||
|
||
function withdrawAsFeeManager(uint128 amount) external override { | ||
require(msg.sender == _state.feeManager, "Only fee manager"); | ||
require(_state.accruedFeesInWei >= amount, "Insufficient balance"); | ||
function withdrawAsFeeManager( | ||
address provider, | ||
uint128 amount | ||
) external override { | ||
require( | ||
msg.sender == _state.providers[provider].feeManager, | ||
"Only fee manager" | ||
); | ||
require( | ||
_state.providers[provider].accruedFeesInWei >= amount, | ||
"Insufficient balance" | ||
); | ||
|
||
_state.accruedFeesInWei -= amount; | ||
_state.providers[provider].accruedFeesInWei -= amount; | ||
|
||
(bool sent, ) = msg.sender.call{value: amount}(""); | ||
require(sent, "Failed to send fees"); | ||
|
||
emit FeesWithdrawn(msg.sender, amount); | ||
} | ||
|
||
function registerProvider(uint128 feeInWei) external override { | ||
ProviderInfo storage provider = _state.providers[msg.sender]; | ||
require(!provider.isRegistered, "Provider already registered"); | ||
provider.feeInWei = feeInWei; | ||
provider.isRegistered = true; | ||
emit ProviderRegistered(msg.sender, feeInWei); | ||
} | ||
|
||
function setProviderFee(uint128 newFeeInWei) external override { | ||
require( | ||
_state.providers[msg.sender].isRegistered, | ||
"Provider not registered" | ||
); | ||
uint128 oldFee = _state.providers[msg.sender].feeInWei; | ||
_state.providers[msg.sender].feeInWei = newFeeInWei; | ||
emit ProviderFeeUpdated(msg.sender, oldFee, newFeeInWei); | ||
} | ||
|
||
function getProviderInfo( | ||
address provider | ||
) external view override returns (ProviderInfo memory) { | ||
return _state.providers[provider]; | ||
} | ||
|
||
function getDefaultProvider() external view override returns (address) { | ||
return _state.defaultProvider; | ||
} | ||
|
||
function setDefaultProvider(address provider) external override { | ||
require( | ||
msg.sender == _state.admin, | ||
"Only admin can set default provider" | ||
); | ||
require( | ||
_state.providers[provider].isRegistered, | ||
"Provider not registered" | ||
); | ||
address oldProvider = _state.defaultProvider; | ||
_state.defaultProvider = provider; | ||
emit DefaultProviderUpdated(oldProvider, provider); | ||
} | ||
|
||
function setExclusivityPeriod(uint256 periodSeconds) external override { | ||
require( | ||
msg.sender == _state.admin, | ||
"Only admin can set exclusivity period" | ||
); | ||
uint256 oldPeriod = _state.exclusivityPeriodSeconds; | ||
_state.exclusivityPeriodSeconds = periodSeconds; | ||
emit ExclusivityPeriodUpdated(oldPeriod, periodSeconds); | ||
} | ||
|
||
function getExclusivityPeriod() external view override returns (uint256) { | ||
return _state.exclusivityPeriodSeconds; | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.