Skip to content

Commit

Permalink
Merge pull request #78 from FilOzone/feat/passthrough-params
Browse files Browse the repository at this point in the history 
Update interface
  • Loading branch information
@ZenGround0
ZenGround0 authored Dec 3, 2024
2 parents c994801 + a7caf18 commit ef3976d
Show file tree
Hide file tree
Showing 4 changed files with 256 additions and 273 deletions.
37 changes: 22 additions & 15 deletions src/PDPVerifier.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ import "../lib/openzeppelin-contracts-upgradeable/contracts/access/OwnableUpgrad


interface PDPListener {
function proofSetCreated(uint256 proofSetId, address creator) external;
function proofSetDeleted(uint256 proofSetId, uint256 deletedLeafCount) external;
function rootsAdded(uint256 proofSetId, uint256 firstAdded, PDPVerifier.RootData[] memory rootData) external;
function rootsScheduledRemove(uint256 proofSetId, uint256[] memory rootIds) external;
function proofSetCreated(uint256 proofSetId, address creator, bytes calldata extraData) external;
function proofSetDeleted(uint256 proofSetId, uint256 deletedLeafCount, bytes calldata extraData) external;
function rootsAdded(uint256 proofSetId, uint256 firstAdded, PDPVerifier.RootData[] memory rootData, bytes calldata extraData) external;
function rootsScheduledRemove(uint256 proofSetId, uint256[] memory rootIds, bytes calldata extraData) external;
// Note: extraData not included as proving messages conceptually always originate from the SP
function posessionProven(uint256 proofSetId, uint256 challengedLeafCount, uint256 seed, uint256 challengeCount) external;
function nextProvingPeriod(uint256 proofSetId, uint256 challengeEpoch, uint256 leafCount) external;
function nextProvingPeriod(uint256 proofSetId, uint256 challengeEpoch, uint256 leafCount, bytes calldata extraData) external;
}

contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {
Expand All @@ -26,6 +27,7 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {
uint256 public constant MAX_ROOT_SIZE = 1 << 50;
uint256 public constant MAX_ENQUEUED_REMOVALS = 2000;
address public constant RANDOMNESS_PRECOMPILE = 0xfE00000000000000000000000000000000000006;
uint256 public constant EXTRA_DATA_MAX_SIZE = 2048;

// Events
event ProofSetCreated(uint256 indexed setId);
Expand Down Expand Up @@ -230,7 +232,8 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {
// A proof set is created empty, with no roots. Creation yields a proof set ID
// for referring to the proof set later.
// Sender of create message is proof set owner.
function createProofSet(address listenerAddr) public payable returns (uint256) {
function createProofSet(address listenerAddr, bytes calldata extraData) public payable returns (uint256) {
require(extraData.length <= EXTRA_DATA_MAX_SIZE, "Extra data too large");
uint256 sybilFee = PDPFees.sybilFee();
require(msg.value >= sybilFee, "sybil fee not met");
burnFee(sybilFee);
Expand All @@ -246,14 +249,15 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {
proofSetListener[setId] = listenerAddr;

if (listenerAddr != address(0)) {
PDPListener(listenerAddr).proofSetCreated(setId, msg.sender);
PDPListener(listenerAddr).proofSetCreated(setId, msg.sender, extraData);
}
emit ProofSetCreated(setId);
return setId;
}

// Removes a proof set. Must be called by the contract owner.
function deleteProofSet(uint256 setId) public {
function deleteProofSet(uint256 setId, bytes calldata extraData) public {
require(extraData.length <= EXTRA_DATA_MAX_SIZE, "Extra data too large");
if (setId >= nextProofSetId) {
revert("proof set id out of bounds");
}
Expand All @@ -266,7 +270,7 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {

address listenerAddr = proofSetListener[setId];
if (listenerAddr != address(0)) {
PDPListener(listenerAddr).proofSetDeleted(setId, deletedLeafCount);
PDPListener(listenerAddr).proofSetDeleted(setId, deletedLeafCount, extraData);
}
emit ProofSetDeleted(setId, deletedLeafCount);
}
Expand All @@ -279,7 +283,8 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {

// Appends new roots to the collection managed by a proof set.
// These roots won't be challenged until the next proving period.
function addRoots(uint256 setId, RootData[] calldata rootData) public returns (uint256) {
function addRoots(uint256 setId, RootData[] calldata rootData, bytes calldata extraData) public returns (uint256) {
require(extraData.length <= EXTRA_DATA_MAX_SIZE, "Extra data too large");
require(proofSetLive(setId), "Proof set not live");
require(rootData.length > 0, "Must add at least one root");
require(proofSetOwner[setId] == msg.sender, "Only the owner can add roots");
Expand All @@ -297,7 +302,7 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {

address listenerAddr = proofSetListener[setId];
if (listenerAddr != address(0)) {
PDPListener(listenerAddr).rootsAdded(setId, firstAdded, rootData);
PDPListener(listenerAddr).rootsAdded(setId, firstAdded, rootData, extraData);
}
emit RootsAdded(firstAdded);

Expand Down Expand Up @@ -328,7 +333,8 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {

// scheduleRemovals scheduels removal of a batch of roots from a proof set for the start of the next
// proving period. It must be called by the proof set owner.
function scheduleRemovals(uint256 setId, uint256[] calldata rootIds) public {
function scheduleRemovals(uint256 setId, uint256[] calldata rootIds, bytes calldata extraData) public {
require(extraData.length <= EXTRA_DATA_MAX_SIZE, "Extra data too large");
require(proofSetLive(setId), "Proof set not live");
require(proofSetOwner[setId] == msg.sender, "Only the owner can schedule removal of roots");
require(rootIds.length + scheduledRemovals[setId].length <= MAX_ENQUEUED_REMOVALS, "Too many removals wait for next proving period to schedule");
Expand All @@ -340,7 +346,7 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {

address listenerAddr = proofSetListener[setId];
if (listenerAddr != address(0)) {
PDPListener(listenerAddr).rootsScheduledRemove(setId, rootIds);
PDPListener(listenerAddr).rootsScheduledRemove(setId, rootIds, extraData);
}
}

Expand Down Expand Up @@ -416,7 +422,8 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {
//
// Note that this method can be called at any time but the pdpListener will likely consider it
// a "fault" or other penalizeable behavior to call this method before calling provePossesion.
function nextProvingPeriod(uint256 setId, uint256 challengeEpoch) public {
function nextProvingPeriod(uint256 setId, uint256 challengeEpoch, bytes calldata extraData) public {
require(extraData.length <= EXTRA_DATA_MAX_SIZE, "Extra data too large");
require(msg.sender == proofSetOwner[setId], "only the owner can move to next proving period");
// Take removed roots out of proving set
uint256[] storage removals = scheduledRemovals[setId];
Expand All @@ -443,7 +450,7 @@ contract PDPVerifier is Initializable, UUPSUpgradeable, OwnableUpgradeable {

address listenerAddr = proofSetListener[setId];
if (listenerAddr != address(0)) {
PDPListener(listenerAddr).nextProvingPeriod(setId, challengeEpoch,proofSetLeafCount[setId]);
PDPListener(listenerAddr).nextProvingPeriod(setId, challengeEpoch,proofSetLeafCount[setId], extraData);
}
}

Expand Down
15 changes: 8 additions & 7 deletions src/SimplePDPService.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ contract SimplePDPService is PDPListener, PDPRecordKeeper, Initializable, UUPSUp
return 2880;
}

// Number of epochs at the end of a proving period during which a
// Number of epochs at the end of a proving period during which a
// proof of possession can be submitted
function challengeWindow() public pure returns (uint256) {
return 60;
Expand Down Expand Up @@ -147,22 +147,23 @@ contract SimplePDPService is PDPListener, PDPRecordKeeper, Initializable, UUPSUp
}

// Listener interface methods
function proofSetCreated(uint256 proofSetId, address creator) external onlyPDPVerifier {
// Note we just drop the user defined extraData as this contract has no use for it
function proofSetCreated(uint256 proofSetId, address creator, bytes calldata) external onlyPDPVerifier {
receiveProofSetEvent(proofSetId, OperationType.CREATE, abi.encode(creator));
}

function proofSetDeleted(uint256 proofSetId, uint256 deletedLeafCount) external onlyPDPVerifier {
function proofSetDeleted(uint256 proofSetId, uint256 deletedLeafCount, bytes calldata) external onlyPDPVerifier {
receiveProofSetEvent(proofSetId, OperationType.DELETE, abi.encode(deletedLeafCount));
}

function rootsAdded(uint256 proofSetId, uint256 firstAdded, PDPVerifier.RootData[] memory rootData) external onlyPDPVerifier {
function rootsAdded(uint256 proofSetId, uint256 firstAdded, PDPVerifier.RootData[] memory rootData, bytes calldata) external onlyPDPVerifier {
if (firstAdded == 0) {
provingDeadlines[proofSetId] = block.number + getMaxProvingPeriod();
}
receiveProofSetEvent(proofSetId, OperationType.ADD, abi.encode(firstAdded, rootData));
}

function rootsScheduledRemove(uint256 proofSetId, uint256[] memory rootIds) external onlyPDPVerifier {
function rootsScheduledRemove(uint256 proofSetId, uint256[] memory rootIds, bytes calldata) external onlyPDPVerifier {
receiveProofSetEvent(proofSetId, OperationType.REMOVE_SCHEDULED, abi.encode(rootIds));
}

Expand All @@ -187,7 +188,7 @@ contract SimplePDPService is PDPListener, PDPRecordKeeper, Initializable, UUPSUp
}

// nextProvingPeriod checks for unsubmitted proof and emits a fault if so
function nextProvingPeriod(uint256 proofSetId, uint256 challengeEpoch, uint256 leafCount) external onlyPDPVerifier {
function nextProvingPeriod(uint256 proofSetId, uint256 challengeEpoch, uint256 leafCount, bytes calldata) external onlyPDPVerifier {
receiveProofSetEvent(proofSetId, OperationType.NEXT_PROVING_PERIOD, abi.encode(challengeEpoch, leafCount));
// Noop when proving period not yet open
// Can only get here if calling nextProvingPeriod multiple times within the same proving period
Expand Down Expand Up @@ -217,7 +218,7 @@ contract SimplePDPService is PDPListener, PDPRecordKeeper, Initializable, UUPSUp
if (faultPeriods > 0) {
emit FaultRecord(faultPeriods);
}
provingDeadlines[proofSetId] = nextDeadline;
provingDeadlines[proofSetId] = nextDeadline;
provenThisPeriod[proofSetId] = false;
}
}
Loading

0 comments on commit ef3976d

Please sign in to comment.