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

Jump to bottom

Simplify fault design #67

Merged
merged 7 commits into from
Nov 21, 2024
Merged

Simplify fault design #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7aac663
Delayed review response
ZenGround0 Oct 23, 2024
d358c3a
Redesign faults
ZenGround0 Nov 18, 2024
7738ff8
Fixup
ZenGround0 Nov 18, 2024
7a41348
Add the bulk of tests
ZenGround0 Nov 18, 2024
89f4d2c
Found bug
ZenGround0 Nov 20, 2024
e0b6c83
Added test
ZenGround0 Nov 20, 2024
f3e854f
Double call to NPP reverts
ZenGround0 Nov 20, 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
1 change: 0 additions & 1 deletion src/PDPVerifier.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,6 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {
removeRoots(setId, removalsToProcess);
// Bring added roots into proving set
challengeRange[setId] = proofSetLeafCount[setId];

nextChallengeEpoch[setId] = block.number + challengeFinality;

// Clear next challenge epoch if the set is now empty.
Expand Down
61 changes: 32 additions & 29 deletions src/SimplePDPService.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,20 +67,12 @@ contract PDPRecordKeeper {
}
}

// SimplePDPServiceApplication is a default implementation of a PDP Application.
// SimplePDPServiceApplication is a default implementation of a PDP Listener
// It maintains a record of all events that have occurred in the PDP service,
// and provides a way to query these events.
// This contract only supports one PDP service caller, set in the constructor.
contract SimplePDPService is PDPListener, PDPRecordKeeper, Initializable, UUPSUpgradeable, OwnableUpgradeable {

enum FaultType {
NONE,
LATE,
SKIPPED
}

event Debug(string message, uint256 value);
event FaultRecord(FaultType faultType, uint256 periodsFaulted);
event FaultRecord(uint256 periodsFaulted);

// The address of the PDP verifier contract that is allowed to call this contract
address public pdpVerifierAddress;
Expand Down Expand Up @@ -142,37 +134,48 @@ contract SimplePDPService is PDPListener, PDPRecordKeeper, Initializable, UUPSUp
// it also checks that proofs are not late and emits a fault record if so
function posessionProven(uint256 proofSetId, uint256 challengedLeafCount, uint256 seed, uint256 challengeCount) external onlyPDPVerifier {
receiveProofSetEvent(proofSetId, OperationType.PROVE_POSSESSION, abi.encode(challengedLeafCount, seed, challengeCount));
emit Debug("Here we go", 0);
if (provenThisPeriod[proofSetId]) {
// return immediately, we've already witnessed a proof for this proof set this period
return;
revert("Only one proof of possession allowed per proving period. Open a new proving period.");
}

if (challengeCount < getChallengesPerProof()) {
revert("Invalid challenge count < 5");
}
emit Debug("deadline", provingDeadlines[proofSetId]);
emit Debug("block number", block.number);
// check for late proof
// check for proof outside of proving period
if (provingDeadlines[proofSetId] < block.number) {
uint256 periodsLate = 1 + ((block.number - provingDeadlines[proofSetId]) / getMaxProvingPeriod());
emit Debug("we're late", periodsLate);
emit FaultRecord(FaultType.LATE, periodsLate);
revert("Current proving period passed. Open a new proving period.");
}
if (provingDeadlines[proofSetId] - getMaxProvingPeriod() >= block.number) {
revert("Too early. Wait for proving period to open");
}
provenThisPeriod[proofSetId] = true;
}

// nextProvingPeriod checks for unsubmitted proof and emits a fault record if so
// nextProvingPeriod checks for unsubmitted proof and emits a fault if so
function nextProvingPeriod(uint256 proofSetId, uint256 leafCount) external onlyPDPVerifier {
receiveProofSetEvent(proofSetId, OperationType.NEXT_PROVING_PERIOD, abi.encode(leafCount));
// check for unsubmitted proof
if (!provenThisPeriod[proofSetId]) {
uint256 periodsSkipped = 1;
if (provingDeadlines[proofSetId] < block.number) {
periodsSkipped = 1 + ((block.number - provingDeadlines[proofSetId]) / getMaxProvingPeriod());
}
emit FaultRecord(FaultType.SKIPPED, periodsSkipped);
// Noop when proving period not yet open
// Can only get here if calling nextProvingPeriod multiple times within the same proving period
uint256 prevDeadline = provingDeadlines[proofSetId] - getMaxProvingPeriod();
if (block.number <= prevDeadline) {
revert("One call to nextProvingPeriod allowed per proving period");
}

uint256 periodsSkipped;
// Proving period is open 0 skipped periods
if (block.number <= provingDeadlines[proofSetId]) {
periodsSkipped = 0;
} else { // Proving period has closed possible some skipped periods
periodsSkipped = (block.number - (provingDeadlines[proofSetId] + 1)) / getMaxProvingPeriod();
}
uint256 faultPeriods = periodsSkipped;
if (!provenThisPeriod[proofSetId]) {
// include previous unproven period
faultPeriods += 1;
}
if (faultPeriods > 0) {
emit FaultRecord(faultPeriods);
}
provingDeadlines[proofSetId] = provingDeadlines[proofSetId] + getMaxProvingPeriod()*(periodsSkipped+1);
provenThisPeriod[proofSetId] = false;
}
}
}
35 changes: 10 additions & 25 deletions test/PDPVerifier.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {PDPFees} from "../src/Fees.sol";
import {SimplePDPService, PDPRecordKeeper} from "../src/SimplePDPService.sol";

contract PDPVerifierProofSetCreateDeleteTest is Test {
SimplePDPService listener;
TestingRecordKeeperService listener;
ListenerHelper listenerAssert;
PDPVerifier pdpVerifier;

Expand All @@ -23,10 +23,7 @@ contract PDPVerifierProofSetCreateDeleteTest is Test {
);
MyERC1967Proxy proxy = new MyERC1967Proxy(address(pdpVerifierImpl), initializeData);
pdpVerifier = PDPVerifier(address(proxy));
SimplePDPService listenerImpl = new SimplePDPService();
initializeData = abi.encodeWithSelector(SimplePDPService.initialize.selector, address(pdpVerifier));
MyERC1967Proxy listenerProxy = new MyERC1967Proxy(address(listenerImpl), initializeData);
listener = SimplePDPService(address(listenerProxy));
listener = new TestingRecordKeeperService();
Copy link
Collaborator

Choose a reason for hiding this comment

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

❤️

listenerAssert = new ListenerHelper(address(listener));
}
function tearDown() public view {
Expand Down Expand Up @@ -147,7 +144,7 @@ contract PDPVerifierProofSetCreateDeleteTest is Test {

contract PDPVerifierOwnershipTest is Test {
PDPVerifier pdpVerifier;
SimplePDPService listener;
TestingRecordKeeperService listener;
address public owner;
address public nextOwner;
address public nonOwner;
Expand All @@ -160,10 +157,7 @@ contract PDPVerifierOwnershipTest is Test {
);
MyERC1967Proxy proxy = new MyERC1967Proxy(address(pdpVerifierImpl), initializeData);
pdpVerifier = PDPVerifier(address(proxy));
SimplePDPService listenerImpl = new SimplePDPService();
initializeData = abi.encodeWithSelector(SimplePDPService.initialize.selector, address(pdpVerifier));
MyERC1967Proxy listenerProxy = new MyERC1967Proxy(address(listenerImpl), initializeData);
listener = SimplePDPService(address(listenerProxy));
listener = new TestingRecordKeeperService();

owner = address(this);
nextOwner = address(0x1234);
Expand Down Expand Up @@ -231,7 +225,7 @@ contract PDPVerifierProofSetMutateTest is Test {
uint256 constant challengeFinalityDelay = 2;

PDPVerifier pdpVerifier;
SimplePDPService listener;
TestingRecordKeeperService listener;
ListenerHelper listenerAssert;

function setUp() public {
Expand All @@ -242,10 +236,7 @@ contract PDPVerifierProofSetMutateTest is Test {
);
MyERC1967Proxy proxy = new MyERC1967Proxy(address(pdpVerifierImpl), initializeData);
pdpVerifier = PDPVerifier(address(proxy));
SimplePDPService listenerImpl = new SimplePDPService();
initializeData = abi.encodeWithSelector(SimplePDPService.initialize.selector, address(pdpVerifier));
MyERC1967Proxy listenerProxy = new MyERC1967Proxy(address(listenerImpl), initializeData);
listener = SimplePDPService(address(listenerProxy));
listener = new TestingRecordKeeperService();
listenerAssert = new ListenerHelper(address(listener));
}

Expand Down Expand Up @@ -896,7 +887,7 @@ import "../src/PDPVerifier.sol";

contract SumTreeAddTest is Test {
SumTreeInternalTestPDPVerifier pdpVerifier;
SimplePDPService listener;
TestingRecordKeeperService listener;
uint256 testSetId;

function setUp() public {
Expand All @@ -907,10 +898,7 @@ contract SumTreeAddTest is Test {
);
MyERC1967Proxy proxy = new MyERC1967Proxy(address(pdpVerifierImpl), initializeData);
pdpVerifier = SumTreeInternalTestPDPVerifier(address(proxy));
SimplePDPService listenerImpl = new SimplePDPService();
initializeData = abi.encodeWithSelector(SimplePDPService.initialize.selector, address(pdpVerifier));
MyERC1967Proxy listenerProxy = new MyERC1967Proxy(address(listenerImpl), initializeData);
listener = SimplePDPService(address(listenerProxy));
listener = new TestingRecordKeeperService();
testSetId = pdpVerifier.createProofSet{value: PDPFees.sybilFee()}(address(listener));
}

Expand Down Expand Up @@ -1272,7 +1260,7 @@ contract PDPListenerIntegrationTest is Test {

contract PDPVerifierE2ETest is Test, ProofBuilderHelper {
PDPVerifier pdpVerifier;
SimplePDPService listener;
TestingRecordKeeperService listener;
uint256 constant challengeFinalityDelay = 2;

function setUp() public {
Expand All @@ -1283,10 +1271,7 @@ contract PDPVerifierE2ETest is Test, ProofBuilderHelper {
);
MyERC1967Proxy proxy = new MyERC1967Proxy(address(pdpVerifierImpl), initializeData);
pdpVerifier = PDPVerifier(address(proxy));
SimplePDPService listenerImpl = new SimplePDPService();
initializeData = abi.encodeWithSelector(SimplePDPService.initialize.selector, address(pdpVerifier));
MyERC1967Proxy listenerProxy = new MyERC1967Proxy(address(listenerImpl), initializeData);
listener = SimplePDPService(address(listenerProxy));
listener = new TestingRecordKeeperService();
}

function testCompleteProvingPeriodE2E() public {
Expand Down
Loading