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

formatting of previous PR #99

Merged
merged 1 commit into from
Nov 28, 2023
Merged

formatting of previous PR #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
160 changes: 117 additions & 43 deletions contracts/AdjudicationFramework.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ To the normal Arbitrator contracts that does its arbitration jobs, it looks like
*/

contract AdjudicationFramework is BalanceHolder {

uint256 public constant ARB_DISPUTE_TIMEOUT = 86400;
uint256 public constant QUESTION_UNHANDLED_TIMEOUT = 86400;

Expand Down Expand Up @@ -59,14 +58,14 @@ contract AdjudicationFramework is BalanceHolder {
}

// Reality.eth questions for propositions we may be asked to rule on
struct ArbitratorProposition{
struct ArbitratorProposition {
PropositionType proposition_type;
address arbitrator;
bool isFrozen;
}
mapping(bytes32 => ArbitratorProposition) public propositions;

// Keep a count of active propositions that freeze an arbitrator.
// Keep a count of active propositions that freeze an arbitrator.
// When they're all cleared they can be unfrozen.
mapping(address => uint256) public countArbitratorFreezePropositions;

Expand Down Expand Up @@ -106,21 +105,31 @@ contract AdjudicationFramework is BalanceHolder {
// We'll identify ourselves in the template so we only need a single parameter for questions, the arbitrator in question.
// TODO: We may want to specify a document with the terms that guide this decision here, rather than just leaving it implicit.

string memory templatePrefixAdd = '{"title": "Should we add arbitrator %s to the framework ';
string memory templatePrefixRemove = '{"title": "Should we remove arbitrator %s from the framework ';
string memory templateSuffix = '?", "type": "bool", "category": "adjudication", "lang": "en"}';
string
memory templatePrefixAdd = '{"title": "Should we add arbitrator %s to the framework ';
string
memory templatePrefixRemove = '{"title": "Should we remove arbitrator %s from the framework ';
string
memory templateSuffix = '?", "type": "bool", "category": "adjudication", "lang": "en"}';

string memory thisContractStr = Strings.toHexString(address(this));
string memory addTemplate = string.concat(templatePrefixAdd, thisContractStr, templateSuffix);
string memory removeTemplate = string.concat(templatePrefixRemove, thisContractStr, templateSuffix);
string memory addTemplate = string.concat(
templatePrefixAdd,
thisContractStr,
templateSuffix
);
string memory removeTemplate = string.concat(
templatePrefixRemove,
thisContractStr,
templateSuffix
);

templateIdAddArbitrator = realityETH.createTemplate(addTemplate);
templateIdRemoveArbitrator = realityETH.createTemplate(removeTemplate);

for (uint256 i = 0; i < _initialArbitrators.length; i++) {
arbitrators[_initialArbitrators[i]] = true;
arbitrators[_initialArbitrators[i]] = true;
}

}

/// @notice Return the dispute fee for the specified question. 0 indicates that we won't arbitrate it.
Expand Down Expand Up @@ -303,10 +312,7 @@ contract AdjudicationFramework is BalanceHolder {

uint256 finalize_ts = question_arbitrations[question_id].finalize_ts;
require(finalize_ts > 0, "Submission must have been queued");
require(
finalize_ts < block.timestamp,
"Challenge deadline not passed"
);
require(finalize_ts < block.timestamp, "Challenge deadline not passed");

balanceOf[question_arbitrations[question_id].payer] =
balanceOf[question_arbitrations[question_id].payer] +
Expand All @@ -324,40 +330,83 @@ contract AdjudicationFramework is BalanceHolder {
// 2) Prove sufficient bond posted, freeze
// 3) Complete operation or Undo freeze

function beginAddArbitratorToAllowList(address arbitrator_to_add)
external returns (bytes32) {
function beginAddArbitratorToAllowList(
address arbitrator_to_add
) external returns (bytes32) {
string memory question = Strings.toHexString(arbitrator_to_add);
bytes32 question_id = realityETH.askQuestionWithMinBond(templateIdAddArbitrator, question, forkArbitrator, REALITY_ETH_TIMEOUT, uint32(block.timestamp), 0, REALITY_ETH_BOND_ARBITRATOR_ADD);
require(propositions[question_id].proposition_type == PropositionType.NONE, "Proposition already exists");
propositions[question_id] = ArbitratorProposition(PropositionType.ADD_ARBITRATOR, arbitrator_to_add, false);
bytes32 question_id = realityETH.askQuestionWithMinBond(
templateIdAddArbitrator,
question,
forkArbitrator,
REALITY_ETH_TIMEOUT,
uint32(block.timestamp),
0,
REALITY_ETH_BOND_ARBITRATOR_ADD
);
require(
propositions[question_id].proposition_type == PropositionType.NONE,
"Proposition already exists"
);
propositions[question_id] = ArbitratorProposition(
PropositionType.ADD_ARBITRATOR,
arbitrator_to_add,
false
);
return question_id;
}

function beginRemoveArbitratorFromAllowList(address arbitrator_to_remove)
external returns (bytes32) {
function beginRemoveArbitratorFromAllowList(
address arbitrator_to_remove
) external returns (bytes32) {
string memory question = Strings.toHexString(arbitrator_to_remove);
bytes32 question_id = realityETH.askQuestionWithMinBond(templateIdRemoveArbitrator, question, forkArbitrator, REALITY_ETH_TIMEOUT, uint32(block.timestamp), 0, REALITY_ETH_BOND_ARBITRATOR_REMOVE);
require(propositions[question_id].proposition_type == PropositionType.NONE, "Proposition already exists");
propositions[question_id] = ArbitratorProposition(PropositionType.REMOVE_ARBITRATOR, arbitrator_to_remove, false);
bytes32 question_id = realityETH.askQuestionWithMinBond(
templateIdRemoveArbitrator,
question,
forkArbitrator,
REALITY_ETH_TIMEOUT,
uint32(block.timestamp),
0,
REALITY_ETH_BOND_ARBITRATOR_REMOVE
);
require(
propositions[question_id].proposition_type == PropositionType.NONE,
"Proposition already exists"
);
propositions[question_id] = ArbitratorProposition(
PropositionType.REMOVE_ARBITRATOR,
arbitrator_to_remove,
false
);

return question_id;
}

function executeAddArbitratorToAllowList(bytes32 question_id) external {

require(propositions[question_id].proposition_type == PropositionType.ADD_ARBITRATOR, "Wrong Proposition type");
require(
propositions[question_id].proposition_type ==
PropositionType.ADD_ARBITRATOR,
"Wrong Proposition type"
);
address arbitrator = propositions[question_id].arbitrator;
require(!arbitrators[arbitrator], "Arbitrator already on allowlist");
require(realityETH.resultFor(question_id) == bytes32(uint256(1)), "Question did not return yes");
delete(propositions[question_id]);
require(
realityETH.resultFor(question_id) == bytes32(uint256(1)),
"Question did not return yes"
);
delete (propositions[question_id]);

// NB They may still be in a frozen state because of some other proposition
arbitrators[arbitrator] = true;
}

function executeRemoveArbitratorFromAllowList(bytes32 question_id) external {

require(propositions[question_id].proposition_type == PropositionType.REMOVE_ARBITRATOR, "Wrong Proposition type");
function executeRemoveArbitratorFromAllowList(
bytes32 question_id
) external {
require(
propositions[question_id].proposition_type ==
PropositionType.REMOVE_ARBITRATOR,
"Wrong Proposition type"
);

// NB This will run even if the arbitrator has already been removed by another proposition.
// This is needed so that the freeze can be cleared if the arbitrator is then reinstated.
Expand All @@ -367,26 +416,38 @@ contract AdjudicationFramework is BalanceHolder {
require(realityEthResult == bytes32(uint256(1)), "Result was not 1");

if (propositions[question_id].isFrozen) {
countArbitratorFreezePropositions[arbitrator] = countArbitratorFreezePropositions[arbitrator] - 1;
countArbitratorFreezePropositions[arbitrator] =
countArbitratorFreezePropositions[arbitrator] -
1;
}
delete(propositions[question_id]);
delete (propositions[question_id]);

arbitrators[arbitrator] = false;
}

// When an arbitrator is listed for removal, they can be frozen given a sufficient bond
function freezeArbitrator(
bytes32 question_id,
bytes32[] memory history_hashes, address[] memory addrs, uint256[] memory bonds, bytes32[] memory answers
bytes32[] memory history_hashes,
address[] memory addrs,
uint256[] memory bonds,
bytes32[] memory answers
) public {
require(propositions[question_id].proposition_type == PropositionType.REMOVE_ARBITRATOR, "Wrong Proposition type");
require(
propositions[question_id].proposition_type ==
PropositionType.REMOVE_ARBITRATOR,
"Wrong Proposition type"
);
address arbitrator = propositions[question_id].arbitrator;

require(
arbitrators[arbitrator],
"Arbitrator not allowlisted" // Not allowlisted in the first place
);
require(!propositions[question_id].isFrozen, "Arbitrator already frozen");
require(
!propositions[question_id].isFrozen,
"Arbitrator already frozen"
);

// Require a bond of at least the specified level
// This is only relevant if REALITY_ETH_BOND_ARBITRATOR_FREEZE is higher than REALITY_ETH_BOND_ARBITRATOR_REMOVE
Expand All @@ -399,30 +460,43 @@ contract AdjudicationFramework is BalanceHolder {
answer = realityETH.getBestAnswer(question_id);
bond = realityETH.getBond(question_id);
} else {
(answer, bond) = realityETH.getEarliestAnswerFromSuppliedHistoryOrRevert(question_id, history_hashes, addrs, bonds, answers);
(answer, bond) = realityETH
.getEarliestAnswerFromSuppliedHistoryOrRevert(
question_id,
history_hashes,
addrs,
bonds,
answers
);
}

require(answer == bytes32(uint256(1)), "Supplied answer is not yes");
require(bond >= REALITY_ETH_BOND_ARBITRATOR_FREEZE, "Bond too low to freeze");
require(
bond >= REALITY_ETH_BOND_ARBITRATOR_FREEZE,
"Bond too low to freeze"
);

// TODO: Ideally we would check the bond is for the "remove" answer.
// TODO: Ideally we would check the bond is for the "remove" answer.
// #92

propositions[question_id].isFrozen = true;
countArbitratorFreezePropositions[arbitrator] = countArbitratorFreezePropositions[arbitrator] + 1;
countArbitratorFreezePropositions[arbitrator] =
countArbitratorFreezePropositions[arbitrator] +
1;
}

function clearFailedProposition(bytes32 question_id) public {
address arbitrator = propositions[question_id].arbitrator;
require(arbitrator != address(0), "Proposition not found");
if (propositions[question_id].isFrozen) {
countArbitratorFreezePropositions[arbitrator] = countArbitratorFreezePropositions[arbitrator] - 1;
countArbitratorFreezePropositions[arbitrator] =
countArbitratorFreezePropositions[arbitrator] -
1;
}
delete(propositions[question_id]);
delete (propositions[question_id]);
}

function realitio() external view returns (address) {
return address(realityETH);
}

}
8 changes: 5 additions & 3 deletions contracts/ChainIdManager.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ contract ChainIdManager is Owned {
// Fee to use up a Chain ID
uint256 public immutable gasBurnAmount = 1000000;

constructor(uint64 _chainIdCounter) Owned() {chainIdCounter = _chainIdCounter;}
constructor(uint64 _chainIdCounter) Owned() {
chainIdCounter = _chainIdCounter;
}

/**
* @dev Adds a Chain ID to the deny list, this can be done if the chainId is used by another project
Expand All @@ -37,7 +39,7 @@ contract ChainIdManager is Owned {
* @return chainId The next usable Chain ID
*/
function getNextUsableChainId() public returns (uint64 chainId) {
// The burnGas function introduces a cost to use up chainIds.
// The burnGas function introduces a cost to use up chainIds.
// There are uint64(2**63=9.223372e+18) chainIds minus the publicly used chainIds available.
// Using all of the chainIds would cost 9.223372e+18 * gasBurnAmount = 9.223372e+24 gas = 6.1489147e+17 blocks = 237226647377 years
burnGas();
Expand All @@ -51,6 +53,6 @@ contract ChainIdManager is Owned {
function burnGas() public view {
uint256 counter = 0;
uint256 _lowestLimit = gasleft() - gasBurnAmount;
while(gasleft() > _lowestLimit) counter++;
while (gasleft() > _lowestLimit) counter++;
}
}
9 changes: 5 additions & 4 deletions contracts/ForkingManager.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ contract ForkingManager is IForkingManager, ForkableStructure {
}

function isForkingInitiated() external view returns (bool) {
return (executionTimeForProposal > 0);
}
return (executionTimeForProposal > 0);
}

function isForkingExecuted() external view returns (bool) {
return (children[0] != address(0) || children[1] != address(0));
Expand Down Expand Up @@ -177,7 +177,9 @@ contract ForkingManager is IForkingManager, ForkableStructure {
);
initializePackedParameters.chainID = ChainIdManager(chainIdManager)
.getNextUsableChainId();
initializePackedParameters.forkID = newImplementations.forkID > 0 ? newImplementations.forkID : IPolygonZkEVM(zkEVM).forkID();
initializePackedParameters.forkID = newImplementations.forkID > 0
? newImplementations.forkID
: IPolygonZkEVM(zkEVM).forkID();
IForkableZkEVM(newInstances.zkEVM.two).initialize(
newInstances.forkingManager.two,
zkEVM,
Expand Down Expand Up @@ -272,5 +274,4 @@ contract ForkingManager is IForkingManager, ForkableStructure {
newInstances.bridge.two
);
}

}
Loading
Loading