Skip to content

scribe: Adds deprecated Chainlink::latestAnswer() function #24

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

Merged
pmerkleplant merged 2 commits into from
Sep 29, 2023
Merged

scribe: Adds deprecated Chainlink::latestAnswer() function #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
946f79f
scribe: Adds deprecated Chainlink::latestAnswer() function
pmerkleplant Sep 28, 2023
ca89ecb
chaincheck: Adds latestAnswer invariant check
pmerkleplant Sep 29, 2023
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
116 changes: 59 additions & 57 deletions .gas-snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,66 +10,68 @@ ScribeInvariantTest:invariant_pubKeys_AtIndexZeroIsZeroPoint() (runs: 256, calls
ScribeInvariantTest:invariant_pubKeys_LengthIsStrictlyMonotonicallyIncreasing() (runs: 256, calls: 3840, reverts: 0)
ScribeInvariantTest:invariant_pubKeys_NonZeroPubKeyExistsAtMostOnce() (runs: 256, calls: 3840, reverts: 0)
ScribeInvariantTest:invariant_pubKeys_ZeroPointIsNeverAddedAsPubKey() (runs: 256, calls: 3840, reverts: 0)
ScribeOptimisticTest:test_Deployment() (gas: 56925)
ScribeOptimisticTest:test_afterAuthedAction_1_drop() (gas: 248716)
ScribeOptimisticTest:test_afterAuthedAction_1_setBar() (gas: 295527)
ScribeOptimisticTest:test_afterAuthedAction_1_setChallengePeriod() (gas: 294070)
ScribeOptimisticTest:test_afterAuthedAction_2_drop() (gas: 325609)
ScribeOptimisticTest:test_afterAuthedAction_2_setBar() (gas: 384647)
ScribeOptimisticTest:test_afterAuthedAction_2_setChallengePeriod() (gas: 384247)
ScribeOptimisticTest:test_afterAuthedAction_3_drop() (gas: 251331)
ScribeOptimisticTest:test_afterAuthedAction_3_setBar() (gas: 298667)
ScribeOptimisticTest:test_afterAuthedAction_3_setChallengePeriod() (gas: 298140)
ScribeOptimisticTest:test_afterAuthedAction_4_drop() (gas: 327074)
ScribeOptimisticTest:test_afterAuthedAction_4_setBar() (gas: 385846)
ScribeOptimisticTest:test_afterAuthedAction_4_setChallengePeriod() (gas: 384610)
ScribeOptimisticTest:test_Deployment() (gas: 59359)
ScribeOptimisticTest:test_afterAuthedAction_1_drop() (gas: 248804)
ScribeOptimisticTest:test_afterAuthedAction_1_setBar() (gas: 295659)
ScribeOptimisticTest:test_afterAuthedAction_1_setChallengePeriod() (gas: 294180)
ScribeOptimisticTest:test_afterAuthedAction_2_drop() (gas: 325741)
ScribeOptimisticTest:test_afterAuthedAction_2_setBar() (gas: 384823)
ScribeOptimisticTest:test_afterAuthedAction_2_setChallengePeriod() (gas: 384423)
ScribeOptimisticTest:test_afterAuthedAction_3_drop() (gas: 251454)
ScribeOptimisticTest:test_afterAuthedAction_3_setBar() (gas: 298843)
ScribeOptimisticTest:test_afterAuthedAction_3_setChallengePeriod() (gas: 298316)
ScribeOptimisticTest:test_afterAuthedAction_4_drop() (gas: 327250)
ScribeOptimisticTest:test_afterAuthedAction_4_setBar() (gas: 386044)
ScribeOptimisticTest:test_afterAuthedAction_4_setChallengePeriod() (gas: 384786)
ScribeOptimisticTest:test_drop_IndexZero() (gas: 44243)
ScribeOptimisticTest:test_drop_Multiple_IsAuthProtected() (gas: 14726)
ScribeOptimisticTest:test_drop_Single_IsAuthProtected() (gas: 12760)
ScribeOptimisticTest:test_latestRoundData_isTollProtected() (gas: 13986)
ScribeOptimisticTest:test_lift_Multiple_FailsIf_ECDSADataInvalid() (gas: 106951)
ScribeOptimisticTest:test_lift_Multiple_FailsIf_MaxFeedsReached() (gas: 20286905)
ScribeOptimisticTest:test_lift_Multiple_IsAuthProtected() (gas: 16446)
ScribeOptimisticTest:test_lift_Single_FailsIf_ECDSADataInvalid() (gas: 22113)
ScribeOptimisticTest:test_lift_Single_FailsIf_MaxFeedsReached() (gas: 19731467)
ScribeOptimisticTest:test_drop_Multiple_IsAuthProtected() (gas: 14770)
ScribeOptimisticTest:test_drop_Single_IsAuthProtected() (gas: 12782)
ScribeOptimisticTest:test_latestAnswer_isTollProtected() (gas: 12505)
ScribeOptimisticTest:test_latestRoundData_isTollProtected() (gas: 14030)
ScribeOptimisticTest:test_lift_Multiple_FailsIf_ECDSADataInvalid() (gas: 106973)
ScribeOptimisticTest:test_lift_Multiple_FailsIf_MaxFeedsReached() (gas: 20286949)
ScribeOptimisticTest:test_lift_Multiple_IsAuthProtected() (gas: 16490)
ScribeOptimisticTest:test_lift_Single_FailsIf_ECDSADataInvalid() (gas: 22135)
ScribeOptimisticTest:test_lift_Single_FailsIf_MaxFeedsReached() (gas: 19731489)
ScribeOptimisticTest:test_lift_Single_IsAuthProtected() (gas: 12905)
ScribeOptimisticTest:test_opChallenge_FailsIf_CalledSubsequently() (gas: 311597)
ScribeOptimisticTest:test_opChallenge_FailsIf_InvalidSchnorrDataGiven() (gas: 283188)
ScribeOptimisticTest:test_opChallenge_FailsIf_NoOpPokeToChallenge() (gas: 14853)
ScribeOptimisticTest:test_peek_isTollProtected() (gas: 12826)
ScribeOptimisticTest:test_peep_isTollProtected() (gas: 13178)
ScribeOptimisticTest:test_poke_Initial_FailsIf_AgeIsZero() (gas: 242731)
ScribeOptimisticTest:test_opChallenge_FailsIf_CalledSubsequently() (gas: 311729)
ScribeOptimisticTest:test_opChallenge_FailsIf_InvalidSchnorrDataGiven() (gas: 283298)
ScribeOptimisticTest:test_opChallenge_FailsIf_NoOpPokeToChallenge() (gas: 14897)
ScribeOptimisticTest:test_peek_isTollProtected() (gas: 12870)
ScribeOptimisticTest:test_peep_isTollProtected() (gas: 13200)
ScribeOptimisticTest:test_poke_Initial_FailsIf_AgeIsZero() (gas: 242775)
ScribeOptimisticTest:test_readWithAge_isTollProtected() (gas: 12357)
ScribeOptimisticTest:test_read_isTollProtected() (gas: 11801)
ScribeOptimisticTest:test_setBar_FailsIf_BarIsZero() (gas: 11771)
ScribeOptimisticTest:test_setBar_IsAuthProtected() (gas: 13686)
ScribeOptimisticTest:test_setMaxChallengeReward_IsAuthProtected() (gas: 13686)
ScribeOptimisticTest:test_setOpChallengePeriod_DropsFinalizedOpPoke_If_NonFinalizedAfterUpdate() (gas: 299610)
ScribeOptimisticTest:test_setOpChallengePeriod_FailsIf_OpChallengePeriodIsZero() (gas: 11545)
ScribeOptimisticTest:test_setOpChallengePeriod_IsAuthProtected() (gas: 12310)
ScribeOptimisticTest:test_toll_diss_IsAuthProtected() (gas: 13216)
ScribeOptimisticTest:test_toll_kiss_IsAuthProtected() (gas: 12397)
ScribeOptimisticTest:test_tryReadWithAge_isTollProtected() (gas: 13702)
ScribeOptimisticTest:test_tryRead_isTollProtected() (gas: 12964)
ScribeTest:test_Deployment() (gas: 40852)
ScribeOptimisticTest:test_read_isTollProtected() (gas: 11823)
ScribeOptimisticTest:test_setBar_FailsIf_BarIsZero() (gas: 11793)
ScribeOptimisticTest:test_setBar_IsAuthProtected() (gas: 13730)
ScribeOptimisticTest:test_setMaxChallengeReward_IsAuthProtected() (gas: 13730)
ScribeOptimisticTest:test_setOpChallengePeriod_DropsFinalizedOpPoke_If_NonFinalizedAfterUpdate() (gas: 299764)
ScribeOptimisticTest:test_setOpChallengePeriod_FailsIf_OpChallengePeriodIsZero() (gas: 11567)
ScribeOptimisticTest:test_setOpChallengePeriod_IsAuthProtected() (gas: 12332)
ScribeOptimisticTest:test_toll_diss_IsAuthProtected() (gas: 13260)
ScribeOptimisticTest:test_toll_kiss_IsAuthProtected() (gas: 12419)
ScribeOptimisticTest:test_tryReadWithAge_isTollProtected() (gas: 13746)
ScribeOptimisticTest:test_tryRead_isTollProtected() (gas: 12986)
ScribeTest:test_Deployment() (gas: 42326)
ScribeTest:test_drop_IndexZero() (gas: 16904)
ScribeTest:test_drop_Multiple_IsAuthProtected() (gas: 13750)
ScribeTest:test_drop_Single_IsAuthProtected() (gas: 12126)
ScribeTest:test_latestRoundData_isTollProtected() (gas: 13088)
ScribeTest:test_lift_Multiple_FailsIf_ECDSADataInvalid() (gas: 106604)
ScribeTest:test_lift_Multiple_FailsIf_MaxFeedsReached() (gas: 20286231)
ScribeTest:test_lift_Multiple_IsAuthProtected() (gas: 15561)
ScribeTest:test_lift_Single_FailsIf_ECDSADataInvalid() (gas: 21415)
ScribeTest:test_lift_Single_FailsIf_MaxFeedsReached() (gas: 19732296)
ScribeTest:test_drop_Multiple_IsAuthProtected() (gas: 13794)
ScribeTest:test_drop_Single_IsAuthProtected() (gas: 12148)
ScribeTest:test_latestAnswer_isTollProtected() (gas: 12092)
ScribeTest:test_latestRoundData_isTollProtected() (gas: 13132)
ScribeTest:test_lift_Multiple_FailsIf_ECDSADataInvalid() (gas: 106626)
ScribeTest:test_lift_Multiple_FailsIf_MaxFeedsReached() (gas: 20286275)
ScribeTest:test_lift_Multiple_IsAuthProtected() (gas: 15605)
ScribeTest:test_lift_Single_FailsIf_ECDSADataInvalid() (gas: 21437)
ScribeTest:test_lift_Single_FailsIf_MaxFeedsReached() (gas: 19732318)
ScribeTest:test_lift_Single_IsAuthProtected() (gas: 12535)
ScribeTest:test_peek_isTollProtected() (gas: 12329)
ScribeTest:test_peep_isTollProtected() (gas: 12439)
ScribeTest:test_poke_Initial_FailsIf_AgeIsZero() (gas: 239291)
ScribeTest:test_peek_isTollProtected() (gas: 12373)
ScribeTest:test_peep_isTollProtected() (gas: 12461)
ScribeTest:test_poke_Initial_FailsIf_AgeIsZero() (gas: 239335)
ScribeTest:test_readWithAge_isTollProtected() (gas: 11969)
ScribeTest:test_read_isTollProtected() (gas: 11673)
ScribeTest:test_setBar_FailsIf_BarIsZero() (gas: 11370)
ScribeTest:test_setBar_IsAuthProtected() (gas: 12779)
ScribeTest:test_toll_diss_IsAuthProtected() (gas: 12489)
ScribeTest:test_toll_kiss_IsAuthProtected() (gas: 12066)
ScribeTest:test_tryReadWithAge_isTollProtected() (gas: 12827)
ScribeTest:test_tryRead_isTollProtected() (gas: 12265)
ScribeTest:test_read_isTollProtected() (gas: 11695)
ScribeTest:test_setBar_FailsIf_BarIsZero() (gas: 11392)
ScribeTest:test_setBar_IsAuthProtected() (gas: 12823)
ScribeTest:test_toll_diss_IsAuthProtected() (gas: 12533)
ScribeTest:test_toll_kiss_IsAuthProtected() (gas: 12088)
ScribeTest:test_tryReadWithAge_isTollProtected() (gas: 12871)
ScribeTest:test_tryRead_isTollProtected() (gas: 12287)
10 changes: 10 additions & 0 deletions script/chaincheck/IScribeChaincheck.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,16 @@ contract IScribeChaincheck is Chaincheck {
logs.push(log);
}

// Note that latestAnswer()(int) was added in v1.2.0 and may not be
// supported by every deployed Scribe(Optimistic) instance.
try self.latestAnswer() returns (int val) {
if (uint(val) != valWant) {
logs.push(log);
}
} catch {
// Scribe instance has version <v1.2.0.
}

// - MakerDAO Compatibility Functions

(valGot, isValidGot) = self.peek();
Expand Down
7 changes: 7 additions & 0 deletions src/IScribe.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,13 @@ interface IScribe is IChronicle {
uint80 answeredInRound
);

/// @notice Returns the oracle's latest value.
/// @dev Provides partial compatibility with Chainlink's
/// IAggregatorV3Interface.
/// @custom:deprecated See https://docs.chain.link/data-feeds/api-reference/#latestanswer.
/// @return answer The oracle's latest value.
function latestAnswer() external view returns (int);

/// @notice Pokes the oracle.
/// @dev Expects `pokeData`'s age to be greater than the timestamp of the
/// last successful poke.
Expand Down
7 changes: 7 additions & 0 deletions src/Scribe.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,13 @@ contract Scribe is IScribe, Auth, Toll {
answeredInRound = roundId;
}

/// @inheritdoc IScribe
/// @dev Only callable by toll'ed address.
function latestAnswer() external view virtual toll returns (int) {
uint val = _pokeData.val;
return int(val);
}

// -- Public Read Functionality --

/// @inheritdoc IScribe
Expand Down
14 changes: 14 additions & 0 deletions src/ScribeOptimistic.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,20 @@ contract ScribeOptimistic is IScribeOptimistic, Scribe {
answeredInRound = roundId;
}

/// @inheritdoc IScribe
/// @dev Only callable by toll'ed address.
function latestAnswer()
external
view
virtual
override(IScribe, Scribe)
toll
returns (int)
{
uint val = _currentPokeData().val;
return int(val);
}

function _currentPokeData() internal view returns (PokeData memory) {
// Load pokeData slots from storage.
PokeData memory pokeData = _pokeData;
Expand Down
14 changes: 14 additions & 0 deletions test/IScribeTest.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,9 @@ abstract contract IScribeTest is Test {
assertEq(startedAt, 0);
assertEq(updatedAt, wantAge);
assertEq(uint(answeredInRound), 1);

answer = scribe.latestAnswer();
assertEq(uint(answer), wantVal);
}

// -- Test: Deployment --
Expand Down Expand Up @@ -191,6 +194,9 @@ abstract contract IScribeTest is Test {
assertEq(startedAt, 0);
assertEq(updatedAt, 0);
assertEq(answeredInRound, 1);

// latestAnswer()(int) returns zero.
assertEq(scribe.latestAnswer(), int(0));
}

// -- Test: Schnorr Verification --
Expand Down Expand Up @@ -940,4 +946,12 @@ abstract contract IScribeTest is Test {
);
scribe.latestRoundData();
}

function test_latestAnswer_isTollProtected() public {
vm.prank(address(0xbeef));
vm.expectRevert(
abi.encodeWithSelector(IToll.NotTolled.selector, address(0xbeef))
);
scribe.latestAnswer();
}
}