Skip to main content

Voting

Voting#

Handles receiving and resolving price requests via a commit-reveal voting scheme.

Functions#

constructor(uint256 _phaseLength, struct FixedPoint.Unsigned _gatPercentage, struct FixedPoint.Unsigned _inflationRate, uint256 _rewardsExpirationTimeout, address _votingToken, address _finder, address _timerAddress) (public)

Construct the Voting contract.

Parameters:#

  • _phaseLength: length of the commit and reveal phases in seconds.
  • _gatPercentage: of the total token supply that must be used in a vote to create a valid price resolution.
  • _inflationRate: percentage inflation per round used to increase token supply of correct voters.
  • _rewardsExpirationTimeout: timeout, in seconds, within which rewards must be claimed.
  • _votingToken: address of the UMA token contract used to commit votes.
  • _finder: keeps track of all contracts within the system based on their interfaceName.
  • _timerAddress: Contract that stores the current time in a testing environment. Must be set to 0x0 for production environments that use live time.
requestPrice(bytes32 identifier, uint256 time, bytes ancillaryData) (public)

Enqueues a request (if a request isn't already present) for the given identifier, time pair.

Time must be in the past and the identifier must be supported. The length of the ancillary data is limited such that this method abides by the EVM transaction gas limit.

Parameters:#

  • identifier: uniquely identifies the price requested. eg BTC/USD (encoded as bytes32) could be requested.
  • time: unix timestamp for the price request.
  • ancillaryData: arbitrary data appended to a price request to give the voters more info from the caller.
requestPrice(bytes32 identifier, uint256 time) (public)
hasPrice(bytes32 identifier, uint256 time, bytes ancillaryData) → bool (public)

Whether the price for identifier and time is available.

Time must be in the past and the identifier must be supported.

Parameters:#

  • identifier: uniquely identifies the price requested. eg BTC/USD (encoded as bytes32) could be requested.
  • time: unix timestamp of for the price request.
  • ancillaryData: arbitrary data appended to a price request to give the voters more info from the caller.
hasPrice(bytes32 identifier, uint256 time) → bool (public)
getPrice(bytes32 identifier, uint256 time, bytes ancillaryData) → int256 (public)

Gets the price for identifier and time if it has already been requested and resolved.

If the price is not available, the method reverts.

Parameters:#

  • identifier: uniquely identifies the price requested. eg BTC/USD (encoded as bytes32) could be requested.
  • time: unix timestamp of for the price request.
  • ancillaryData: arbitrary data appended to a price request to give the voters more info from the caller.
getPrice(bytes32 identifier, uint256 time) → int256 (public)
getPriceRequestStatuses(struct VotingAncillaryInterface.PendingRequestAncillary[] requests) → struct Voting.RequestState[] (public)

Gets the status of a list of price requests, identified by their identifier and time.

If the status for a particular request is NotRequested, the lastVotingRound will always be 0.

Parameters:#

  • requests: array of type PendingRequest which includes an identifier and timestamp for each request.
getPriceRequestStatuses(struct VotingInterface.PendingRequest[] requests) → struct Voting.RequestState[] (public)
commitVote(bytes32 identifier, uint256 time, bytes ancillaryData, bytes32 hash) (public)

/** Commit a vote for a price request for identifier at time.

identifier, time must correspond to a price request that's currently in the commit phase. Commits can be changed. Since transaction data is public, the salt will be revealed with the vote. While this is the system’s expected behavior, voters should never reuse salts. If someone else is able to guess the voted price and knows that a salt will be reused, then they can determine the vote pre-reveal.

Parameters:#

  • identifier: uniquely identifies the committed vote. EG BTC/USD price pair.
  • time: unix timestamp of the price being voted on.
  • ancillaryData: arbitrary data appended to a price request to give the voters more info from the caller.
  • hash: keccak256 hash of the price, salt, voter address, time, current roundId, and identifier. /
commitVote(bytes32 identifier, uint256 time, bytes32 hash) (public)
snapshotCurrentRound(bytes signature) (external)

Snapshot the current round's token balances and lock in the inflation rate and GAT.

This function can be called multiple times, but only the first call per round into this function or revealVote will create the round snapshot. Any later calls will be a no-op. Will revert unless called during reveal period.

Parameters:#

  • signature: signature required to prove caller is an EOA to prevent flash loans from being included in the snapshot. /
revealVote(bytes32 identifier, uint256 time, int256 price, bytes ancillaryData, int256 salt) (public)

Reveal a previously committed vote for identifier at time.

The revealed price, salt, address, time, roundId, and identifier, must hash to the latest hash that commitVote() was called with. Only the committer can reveal their vote.

Parameters:#

  • identifier: voted on in the commit phase. EG BTC/USD price pair.
  • time: specifies the unix timestamp of the price being voted on.
  • price: voted on during the commit phase.
  • ancillaryData: arbitrary data appended to a price request to give the voters more info from the caller.
  • salt: value used to hide the commitment price during the commit phase. /
revealVote(bytes32 identifier, uint256 time, int256 price, int256 salt) (public)
commitAndEmitEncryptedVote(bytes32 identifier, uint256 time, bytes ancillaryData, bytes32 hash, bytes encryptedVote) (public)

commits a vote and logs an event with a data blob, typically an encrypted version of the vote

An encrypted version of the vote is emitted in an event EncryptedVote to allow off-chain infrastructure to retrieve the commit. The contents of encryptedVote are never used on chain: it is purely for convenience.

Parameters:#

  • identifier: unique price pair identifier. Eg: BTC/USD price pair.
  • time: unix timestamp of for the price request.
  • ancillaryData: arbitrary data appended to a price request to give the voters more info from the caller.
  • hash: keccak256 hash of the price you want to vote for and a int256 salt.
  • encryptedVote: offchain encrypted blob containing the voters amount, time and salt. /
commitAndEmitEncryptedVote(bytes32 identifier, uint256 time, bytes32 hash, bytes encryptedVote) (public)
batchCommit(struct VotingAncillaryInterface.CommitmentAncillary[] commits) (public)

Submit a batch of commits in a single transaction.

Using encryptedVote is optional. If included then commitment is emitted in an event. Look at project-root/common/Constants.js for the tested maximum number of commitments that can fit in one transaction.

Parameters:#

  • commits: struct to encapsulate an identifier, time, hash and optional encryptedVote. /
batchCommit(struct VotingInterface.Commitment[] commits) (public)
batchReveal(struct VotingAncillaryInterface.RevealAncillary[] reveals) (public)

Reveal multiple votes in a single transaction. Look at project-root/common/Constants.js for the tested maximum number of reveals. that can fit in one transaction.

For more info on reveals, review the comment for revealVote.

Parameters:#

  • reveals: array of the Reveal struct which contains an identifier, time, price and salt. /
batchReveal(struct VotingInterface.Reveal[] reveals) (public)
retrieveRewards(address voterAddress, uint256 roundId, struct VotingAncillaryInterface.PendingRequestAncillary[] toRetrieve) → struct FixedPoint.Unsigned totalRewardToIssue (public)

Retrieves rewards owed for a set of resolved price requests.

Can only retrieve rewards if calling for a valid round and if the call is done within the timeout threshold (not expired). Note that a named return value is used here to avoid a stack to deep error.

Parameters:#

  • voterAddress: voter for which rewards will be retrieved. Does not have to be the caller.
  • roundId: the round from which voting rewards will be retrieved from.
  • toRetrieve: array of PendingRequests which rewards are retrieved from.
retrieveRewards(address voterAddress, uint256 roundId, struct VotingInterface.PendingRequest[] toRetrieve) → struct FixedPoint.Unsigned (public)
getPendingRequests() → struct VotingAncillaryInterface.PendingRequestAncillary[] (external)

Gets the queries that are being voted on this round.

getVotePhase() → enum VotingAncillaryInterface.Phase (external)

Returns the current voting phase, as a function of the current time.

getCurrentRoundId() → uint256 (external)

Returns the current round ID, as a function of the current time.

setMigrated(address newVotingAddress) (external)

Disables this Voting contract in favor of the migrated one.

Can only be called by the contract owner.

Parameters:#

  • newVotingAddress: the newly migrated contract address. /
setInflationRate(struct FixedPoint.Unsigned newInflationRate) (public)

Resets the inflation rate. Note: this change only applies to rounds that have not yet begun.

This method is public because calldata structs are not currently supported by solidity.

Parameters:#

  • newInflationRate: sets the next round's inflation rate. /
setGatPercentage(struct FixedPoint.Unsigned newGatPercentage) (public)

Resets the Gat percentage. Note: this change only applies to rounds that have not yet begun.

This method is public because calldata structs are not currently supported by solidity.

Parameters:#

  • newGatPercentage: sets the next round's Gat percentage. /
setRewardsExpirationTimeout(uint256 NewRewardsExpirationTimeout) (public)

Resets the rewards expiration timeout.

This change only applies to rounds that have not yet begun.

Parameters:#

  • NewRewardsExpirationTimeout: how long a caller can wait before choosing to withdraw their rewards. /
owner() → address (public)

Returns the address of the current owner.

renounceOwnership() (public)

Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

transferOwnership(address newOwner) (public)

Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

_transferOwnership(address newOwner) (internal)

Transfers ownership of the contract to a new account (newOwner). Internal function without access restriction.

_msgSender() → address (internal)
_msgData() → bytes (internal)
setCurrentTime(uint256 time) (external)

Sets the current time.

Will revert if not running in test mode.

Parameters:#

  • time: timestamp to set current Testable time to.
getCurrentTime() → uint256 (public)

Gets the current time. Will return the last time set in setCurrentTime if running in test mode. Otherwise, it will return the block timestamp.

Events#

VoteCommitted(address voter, uint256 roundId, bytes32 identifier, uint256 time, bytes ancillaryData)
EncryptedVote(address voter, uint256 roundId, bytes32 identifier, uint256 time, bytes ancillaryData, bytes encryptedVote)
VoteRevealed(address voter, uint256 roundId, bytes32 identifier, uint256 time, int256 price, bytes ancillaryData, uint256 numTokens)
RewardsRetrieved(address voter, uint256 roundId, bytes32 identifier, uint256 time, bytes ancillaryData, uint256 numTokens)
PriceRequestAdded(uint256 roundId, bytes32 identifier, uint256 time)
PriceResolved(uint256 roundId, bytes32 identifier, uint256 time, int256 price, bytes ancillaryData)
OwnershipTransferred(address previousOwner, address newOwner)

Modifiers#

onlyRegisteredContract()
onlyIfNotMigrated()
onlyOwner()

Throws if called by any account other than the owner.

onlyIfTest()

Reverts if not running in test mode.