Skip to content
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.

Sign up for GitHub

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

Split maxSettlementFee into maxSyncFee and maxAsyncFee #508

Merged
merged 9 commits into from
Dec 17, 2024
Merged

Split maxSettlementFee into maxSyncFee and maxAsyncFee #508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
48d1b95
remove maxSettlementFee, add maxSyncFee and maxAsyncFee
prateekdefi Dec 2, 2024
f1a7de2
fix oracle unit tests
prateekdefi Dec 2, 2024
d54b4a0
remove maxSettlementFee from integration tests
prateekdefi Dec 3, 2024
d34b4e1
set async fee based on callbacks
prateekdefi Dec 6, 2024
27fea51
update unit tests
prateekdefi Dec 6, 2024
4a33bef
Revert "set async fee based on callbacks"
prateekdefi Dec 12, 2024
9b12444
Revert "update unit tests"
prateekdefi Dec 12, 2024
3de1997
PR feedback
prateekdefi Dec 12, 2024
aac4ffe
remove applyFeeMaximum
prateekdefi Dec 13, 2024
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
3 changes: 2 additions & 1 deletion packages/core/test/integration/helpers/setupHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,8 @@ export async function deployProtocol(chainlinkContext?: ChainlinkContext): Promi
await oracleFactory.connect(owner).register(chainlink.oracleFactory.address)
await oracleFactory.connect(owner).updateParameter({
maxGranularity: 10000,
maxSettlementFee: parse6decimal('1000'),
maxAsyncFee: parse6decimal('500'),
maxSyncFee: parse6decimal('500'),
maxOracleFee: parse6decimal('0.5'),
})
const oracle = IOracle__factory.connect(
Expand Down
2 changes: 1 addition & 1 deletion packages/oracle/contracts/OracleFactory.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ contract OracleFactory is IOracleFactory, Factory {
// Re-initialize if owner is unset
if (owner() == address(0)) __Factory__initialize();

_parameter.store(OracleParameter(1, UFixed6Lib.ZERO, UFixed6Lib.ZERO));
_parameter.store(OracleParameter(1, UFixed6Lib.ZERO, UFixed6Lib.ZERO, UFixed6Lib.ZERO));
}

/// @notice Returns the global oracle parameter
Expand Down
12 changes: 6 additions & 6 deletions packages/oracle/contracts/keeper/KeeperOracle.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,13 +203,13 @@ contract KeeperOracle is IKeeperOracle, Instance {
priceResponse.valid = false;
}

priceResponse.syncFee = UFixed6Lib.from(factory.commitmentGasOracle().cost(value), true);
priceResponse.asyncFee = UFixed6Lib.from(factory.settlementGasOracle().cost(0), true);
// Apply maximum fee limits
priceResponse.syncFee = UFixed6Lib.from(factory.commitmentGasOracle().cost(value), true)
.min(oracleParameter.maxSyncFee);
priceResponse.asyncFee = UFixed6Lib.from(factory.settlementGasOracle().cost(0), true)
.min(oracleParameter.maxAsyncFee);

priceResponse.oracleFee = keeperOracleParameter.oracleFee;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually now that applyFeeMaximum is so simple, maybe we can just apply the .min(oracleParameter....) directly on these above and delete the helper function altogether.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed helper method in aac4ffe

priceResponse.applyFeeMaximum(
oracleParameter.maxSettlementFee,
_localCallbacks[oracleVersion.timestamp].length()
);

_responses[oracleVersion.timestamp].store(priceResponse);
_global.latestIndex++;
Expand Down
11 changes: 0 additions & 11 deletions packages/oracle/contracts/keeper/types/PriceResponse.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,6 @@ library PriceResponseLib {
function settlementFee(PriceResponse memory self, uint256 callbacks) internal pure returns (UFixed6) {
return self.syncFee.add(self.asyncFee.mul(UFixed6Lib.from(callbacks)));
}

/// @notice Scales down sync and async fees if they exceed the maximum settlement fee
/// @param self The price response object
/// @param maxSettlementFee The maximum settlement fee
function applyFeeMaximum(PriceResponse memory self, UFixed6 maxSettlementFee, uint256 callbacks) internal pure {
UFixed6 totalSettlementFee = settlementFee(self, callbacks);
if (totalSettlementFee.gt(maxSettlementFee)) {
self.syncFee = self.syncFee.muldiv(maxSettlementFee, totalSettlementFee);
self.asyncFee = self.asyncFee.muldiv(maxSettlementFee, totalSettlementFee);
}
}
}

/// @dev (external-safe): this library is safe to externalize
Expand Down
6 changes: 0 additions & 6 deletions packages/oracle/contracts/test/PriceResponseTester.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,4 @@ contract PriceResponseTester {
function settlementFee(PriceResponse memory self, uint256 callbacks) external pure returns (UFixed6) {
return PriceResponseLib.settlementFee(self, callbacks);
}

function applyFeeMaximum(UFixed6 maxSettlementFee, uint256 callbacks) external {
PriceResponse memory newPriceResponse = read();
newPriceResponse.applyFeeMaximum(maxSettlementFee, callbacks);
store(newPriceResponse);
}
}
19 changes: 13 additions & 6 deletions packages/oracle/contracts/types/OracleParameter.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,20 @@ struct OracleParameter {
/// @dev The cap for the granularity setting in seconds
uint256 maxGranularity;

/// @dev the cap for the settle fee in absolute terms
UFixed6 maxSettlementFee;
/// @dev the cap for the sync fee in absolute terms
UFixed6 maxSyncFee;

/// @dev the cap for the async fee in absolute terms
UFixed6 maxAsyncFee;

/// @dev The cap for the oracle fee in relative terms
UFixed6 maxOracleFee;
}
struct StoredOracleParameter {
/* slot 0 */
uint16 maxGranularity; // <= 65k
uint48 maxSettlementFee; // <= 281m
uint48 maxSyncFee; // <= 281m
uint48 maxAsyncFee; // <= 281m
uint24 maxOracleFee; // <= 100%
}
struct OracleParameterStorage { StoredOracleParameter value; }
Expand All @@ -31,7 +35,8 @@ library OracleParameterStorageLib {
StoredOracleParameter memory storedValue = self.value;
return OracleParameter(
uint256(storedValue.maxGranularity),
UFixed6.wrap(uint256(storedValue.maxSettlementFee)),
UFixed6.wrap(uint256(storedValue.maxSyncFee)),
UFixed6.wrap(uint256(storedValue.maxAsyncFee)),
UFixed6.wrap(uint256(storedValue.maxOracleFee))
);
}
Expand All @@ -45,12 +50,14 @@ library OracleParameterStorageLib {
validate(newValue);

if (newValue.maxGranularity > type(uint16).max) revert OracleParameterStorageInvalidError();
if (newValue.maxSettlementFee.gt(UFixed6.wrap(type(uint48).max))) revert OracleParameterStorageInvalidError();
if (newValue.maxSyncFee.gt(UFixed6.wrap(type(uint48).max))) revert OracleParameterStorageInvalidError();
if (newValue.maxAsyncFee.gt(UFixed6.wrap(type(uint48).max))) revert OracleParameterStorageInvalidError();
if (newValue.maxOracleFee.gt(UFixed6.wrap(type(uint24).max))) revert OracleParameterStorageInvalidError();

self.value = StoredOracleParameter(
uint16(newValue.maxGranularity),
uint48(UFixed6.unwrap(newValue.maxSettlementFee)),
uint48(UFixed6.unwrap(newValue.maxSyncFee)),
uint48(UFixed6.unwrap(newValue.maxAsyncFee)),
uint24(UFixed6.unwrap(newValue.maxOracleFee))
);
}
Expand Down
3 changes: 2 additions & 1 deletion packages/oracle/test/integration/metaquants/MetaQuantsOracleFactory.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,8 @@ testOracles.forEach(testOracle => {
await oracleFactory.initialize()
await oracleFactory.connect(owner).updateParameter({
maxGranularity: 10000,
maxSettlementFee: parse6decimal('1000'),
maxSyncFee: parse6decimal('500'),
maxAsyncFee: parse6decimal('500'),
maxOracleFee: parse6decimal('0.5'),
})

Expand Down
3 changes: 2 additions & 1 deletion packages/oracle/test/integration/pyth/PythOracleFactory.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,8 @@ testOracles.forEach(testOracle => {
await oracleFactory.initialize()
await oracleFactory.connect(owner).updateParameter({
maxGranularity: 10000,
maxSettlementFee: parse6decimal('1000'),
maxSyncFee: parse6decimal('500'),
maxAsyncFee: parse6decimal('500'),
maxOracleFee: parse6decimal('0.5'),
})

Expand Down
3 changes: 2 additions & 1 deletion packages/oracle/test/integrationSepolia/chainlink/ChainlinkOracleFactory.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,8 @@ testOracles.forEach(testOracle => {
await oracleFactory.initialize()
await oracleFactory.connect(owner).updateParameter({
maxGranularity: 10000,
maxSettlementFee: parse6decimal('1000'),
maxSyncFee: parse6decimal('500'),
maxAsyncFee: parse6decimal('500'),
maxOracleFee: parse6decimal('0.5'),
})

Expand Down
34 changes: 28 additions & 6 deletions packages/oracle/test/unit/types/OracleParameter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ const { ethers } = HRE

const DEFAULT_ORACLE_PARAMETER: OracleParameterStruct = {
maxGranularity: 1,
maxSettlementFee: 0,
maxSyncFee: 0,
maxAsyncFee: 0,
maxOracleFee: 0,
}

Expand Down Expand Up @@ -65,22 +66,43 @@ describe('OracleParameter', () => {
})
})

context('.maxSettlementFee', async () => {
context('.maxSyncFee', async () => {
const STORAGE_SIZE = 48
it('saves if in range', async () => {
await oracleParameter.store({
...DEFAULT_ORACLE_PARAMETER,
maxSettlementFee: BigNumber.from(2).pow(STORAGE_SIZE).sub(1),
maxSyncFee: BigNumber.from(2).pow(STORAGE_SIZE).sub(1),
})
const value = await oracleParameter.read()
expect(value.maxSettlementFee).to.equal(BigNumber.from(2).pow(STORAGE_SIZE).sub(1))
expect(value.maxSyncFee).to.equal(BigNumber.from(2).pow(STORAGE_SIZE).sub(1))
})

it('reverts if maxSettlementFee out of range', async () => {
it('reverts if maxSyncFee out of range', async () => {
await expect(
oracleParameter.store({
...DEFAULT_ORACLE_PARAMETER,
maxSettlementFee: BigNumber.from(2).pow(STORAGE_SIZE),
maxSyncFee: BigNumber.from(2).pow(STORAGE_SIZE),
}),
).to.be.revertedWithCustomError(oracleParameter, 'OracleParameterStorageInvalidError')
})
})

context('.maxAsyncFee', async () => {
const STORAGE_SIZE = 48
it('saves if in range', async () => {
await oracleParameter.store({
...DEFAULT_ORACLE_PARAMETER,
maxAsyncFee: BigNumber.from(2).pow(STORAGE_SIZE).sub(1),
})
const value = await oracleParameter.read()
expect(value.maxAsyncFee).to.equal(BigNumber.from(2).pow(STORAGE_SIZE).sub(1))
})

it('reverts if maxAsyncFee out of range', async () => {
await expect(
oracleParameter.store({
...DEFAULT_ORACLE_PARAMETER,
maxAsyncFee: BigNumber.from(2).pow(STORAGE_SIZE),
}),
).to.be.revertedWithCustomError(oracleParameter, 'OracleParameterStorageInvalidError')
})
Expand Down
92 changes: 0 additions & 92 deletions packages/oracle/test/unit/types/PriceResponse.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,96 +298,4 @@ describe('PriceResponse', () => {
expect(value).to.equal(parse6decimal('0.5'))
})
})

describe('#applyFeeMaximum', () => {
it('calculates correct fee w/ non-zero sync, zero async', async () => {
await priceResponse.store({
...DEFAULT_PRICE_RESPONSE,
syncFee: parse6decimal('1'),
asyncFee: parse6decimal('0.2'),
})

await priceResponse.applyFeeMaximum(parse6decimal('0.5'), 0)

const value = await priceResponse.read()

expect(value.syncFee).to.equal(parse6decimal('0.5'))
expect(value.asyncFee).to.equal(parse6decimal('0.1'))
})

it('calculates correct fee w/ non-zero sync, single async', async () => {
await priceResponse.store({
...DEFAULT_PRICE_RESPONSE,
syncFee: parse6decimal('1'),
asyncFee: parse6decimal('0.2'),
})

await priceResponse.applyFeeMaximum(parse6decimal('0.6'), 1)

const value = await priceResponse.read()

expect(value.syncFee).to.equal(parse6decimal('0.5'))
expect(value.asyncFee).to.equal(parse6decimal('0.1'))
})

it('calculates correct fee w/ non-zero sync, multiple async', async () => {
await priceResponse.store({
...DEFAULT_PRICE_RESPONSE,
syncFee: parse6decimal('1'),
asyncFee: parse6decimal('0.2'),
})

await priceResponse.applyFeeMaximum(parse6decimal('1.0'), 5)

const value = await priceResponse.read()

expect(value.syncFee).to.equal(parse6decimal('0.5'))
expect(value.asyncFee).to.equal(parse6decimal('0.1'))
})

it('calculates correct fee w/ zero sync, zero async', async () => {
await priceResponse.store({
...DEFAULT_PRICE_RESPONSE,
syncFee: parse6decimal('0'),
asyncFee: parse6decimal('0.2'),
})

await priceResponse.applyFeeMaximum(parse6decimal('0.0'), 0)

const value = await priceResponse.read()

expect(value.syncFee).to.equal(parse6decimal('0'))
expect(value.asyncFee).to.equal(parse6decimal('0.2'))
})

it('calculates correct fee w/ zero sync, single async', async () => {
await priceResponse.store({
...DEFAULT_PRICE_RESPONSE,
syncFee: parse6decimal('0'),
asyncFee: parse6decimal('0.2'),
})

await priceResponse.applyFeeMaximum(parse6decimal('0.1'), 1)

const value = await priceResponse.read()

expect(value.syncFee).to.equal(parse6decimal('0.0'))
expect(value.asyncFee).to.equal(parse6decimal('0.1'))
})

it('calculates correct fee w/ zero sync, multiple async', async () => {
await priceResponse.store({
...DEFAULT_PRICE_RESPONSE,
syncFee: parse6decimal('0'),
asyncFee: parse6decimal('0.2'),
})

await priceResponse.applyFeeMaximum(parse6decimal('0.5'), 5)

const value = await priceResponse.read()

expect(value.syncFee).to.equal(parse6decimal('0.0'))
expect(value.asyncFee).to.equal(parse6decimal('0.1'))
})
})
})
3 changes: 2 additions & 1 deletion packages/periphery/test/integration/MultiInvoker/Pyth.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ export function RunPythOracleTests(

await oracleFactory.updateParameter({
maxGranularity: 1,
maxSettlementFee: parse6decimal('1.5'),
maxSyncFee: parse6decimal('1'),
maxAsyncFee: parse6decimal('1'),
maxOracleFee: parse6decimal('0.5'),
})
;[pythOracleFactory, keeperOracle] = await getKeeperOracle()
Expand Down
Loading