{
    "Function": "slitherConstructorConstantVariables",
    "File": "contracts/interfaces/UMAprotocol/OptimisticOracleInterface.sol",
    "Parent Contracts": [],
    "High-Level Calls": [],
    "Internal Calls": [],
    "Library Calls": [],
    "Low-Level Calls": [],
    "Code": "abstract contract OptimisticOracleInterface {\n  // Struct representing the state of a price request.\n  enum State {\n    Invalid, // Never requested.\n    Requested, // Requested, no other actions taken.\n    Proposed, // Proposed, but not expired or disputed yet.\n    Expired, // Proposed, not disputed, past liveness.\n    Disputed, // Disputed, but no DVM price returned yet.\n    Resolved, // Disputed and DVM price is available.\n    Settled // Final price has been set in the contract (can get here from Expired or Resolved).\n  }\n\n  // Struct representing a price request.\n  struct Request {\n    address proposer; // Address of the proposer.\n    address disputer; // Address of the disputer.\n    IERC20 currency; // ERC20 token used to pay rewards and fees.\n    bool settled; // True if the request is settled.\n    bool refundOnDispute; // True if the requester should be refunded their reward on dispute.\n    int256 proposedPrice; // Price that the proposer submitted.\n    int256 resolvedPrice; // Price resolved once the request is settled.\n    uint256 expirationTime; // Time at which the request auto-settles without a dispute.\n    uint256 reward; // Amount of the currency to pay to the proposer on settlement.\n    uint256 finalFee; // Final fee to pay to the Store upon request to the DVM.\n    uint256 bond; // Bond that the proposer and disputer must pay on top of the final fee.\n    uint256 customLiveness; // Custom liveness value set by the requester.\n  }\n\n  // This value must be <= the Voting contract's `ancillaryBytesLimit` value otherwise it is possible\n  // that a price can be requested to this contract successfully, but cannot be disputed because the DVM refuses\n  // to accept a price request made with ancillary data length over a certain size.\n  uint256 public constant ancillaryBytesLimit = 8192;\n\n  /**\n   * @notice Requests a new price.\n   * @param identifier price identifier being requested.\n   * @param timestamp timestamp of the price being requested.\n   * @param ancillaryData ancillary data representing additional args being passed with the price request.\n   * @param currency ERC20 token used for payment of rewards and fees. Must be approved for use with the DVM.\n   * @param reward reward offered to a successful proposer. Will be pulled from the caller. Note: this can be 0,\n   *               which could make sense if the contract requests and proposes the value in the same call or\n   *               provides its own reward system.\n   * @return totalBond default bond (final fee) + final fee that the proposer and disputer will be required to pay.\n   * This can be changed with a subsequent call to setBond().\n   */\n  function requestPrice(\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData,\n    IERC20 currency,\n    uint256 reward\n  ) external virtual returns (uint256 totalBond);\n\n  /**\n   * @notice Set the proposal bond associated with a price request.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @param bond custom bond amount to set.\n   * @return totalBond new bond + final fee that the proposer and disputer will be required to pay. This can be\n   * changed again with a subsequent call to setBond().\n   */\n  function setBond(\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData,\n    uint256 bond\n  ) external virtual returns (uint256 totalBond);\n\n  /**\n   * @notice Sets the request to refund the reward if the proposal is disputed. This can help to \"hedge\" the caller\n   * in the event of a dispute-caused delay. Note: in the event of a dispute, the winner still receives the other's\n   * bond, so there is still profit to be made even if the reward is refunded.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   */\n  function setRefundOnDispute(\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData\n  ) external virtual;\n\n  /**\n   * @notice Sets a custom liveness value for the request. Liveness is the amount of time a proposal must wait before\n   * being auto-resolved.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @param customLiveness new custom liveness.\n   */\n  function setCustomLiveness(\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData,\n    uint256 customLiveness\n  ) external virtual;\n\n  /**\n   * @notice Proposes a price value on another address' behalf. Note: this address will receive any rewards that come\n   * from this proposal. However, any bonds are pulled from the caller.\n   * @param proposer address to set as the proposer.\n   * @param requester sender of the initial price request.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @param proposedPrice price being proposed.\n   * @return totalBond the amount that's pulled from the caller's wallet as a bond. The bond will be returned to\n   * the proposer once settled if the proposal is correct.\n   */\n  function proposePriceFor(\n    address proposer,\n    address requester,\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData,\n    int256 proposedPrice\n  ) public virtual returns (uint256 totalBond);\n\n  /**\n   * @notice Proposes a price value for an existing price request.\n   * @param requester sender of the initial price request.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @param proposedPrice price being proposed.\n   * @return totalBond the amount that's pulled from the proposer's wallet as a bond. The bond will be returned to\n   * the proposer once settled if the proposal is correct.\n   */\n  function proposePrice(\n    address requester,\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData,\n    int256 proposedPrice\n  ) external virtual returns (uint256 totalBond);\n\n  /**\n   * @notice Disputes a price request with an active proposal on another address' behalf. Note: this address will\n   * receive any rewards that come from this dispute. However, any bonds are pulled from the caller.\n   * @param disputer address to set as the disputer.\n   * @param requester sender of the initial price request.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @return totalBond the amount that's pulled from the caller's wallet as a bond. The bond will be returned to\n   * the disputer once settled if the dispute was value (the proposal was incorrect).\n   */\n  function disputePriceFor(\n    address disputer,\n    address requester,\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData\n  ) public virtual returns (uint256 totalBond);\n\n  /**\n   * @notice Disputes a price value for an existing price request with an active proposal.\n   * @param requester sender of the initial price request.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @return totalBond the amount that's pulled from the disputer's wallet as a bond. The bond will be returned to\n   * the disputer once settled if the dispute was valid (the proposal was incorrect).\n   */\n  function disputePrice(\n    address requester,\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData\n  ) external virtual returns (uint256 totalBond);\n\n  /**\n   * @notice Retrieves a price that was previously requested by a caller. Reverts if the request is not settled\n   * or settleable. Note: this method is not view so that this call may actually settle the price request if it\n   * hasn't been settled.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @return resolved price.\n   */\n  function settleAndGetPrice(\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData\n  ) external virtual returns (int256);\n\n  /**\n   * @notice Attempts to settle an outstanding price request. Will revert if it isn't settleable.\n   * @param requester sender of the initial price request.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @return payout the amount that the \"winner\" (proposer or disputer) receives on settlement. This amount includes\n   * the returned bonds as well as additional rewards.\n   */\n  function settle(\n    address requester,\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData\n  ) external virtual returns (uint256 payout);\n\n  /**\n   * @notice Gets the current data structure containing all information about a price request.\n   * @param requester sender of the initial price request.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @return the Request data structure.\n   */\n  function getRequest(\n    address requester,\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData\n  ) public view virtual returns (Request memory);\n\n  /**\n   * @notice Returns the state of a price request.\n   * @param requester sender of the initial price request.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @return the State enum value.\n   */\n  function getState(\n    address requester,\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData\n  ) public view virtual returns (State);\n\n  /**\n   * @notice Checks if a given request has resolved or been settled (i.e the optimistic oracle has a price).\n   * @param requester sender of the initial price request.\n   * @param identifier price identifier to identify the existing request.\n   * @param timestamp timestamp to identify the existing request.\n   * @param ancillaryData ancillary data of the price being requested.\n   * @return true if price has resolved or settled, false otherwise.\n   */\n  function hasPrice(\n    address requester,\n    bytes32 identifier,\n    uint256 timestamp,\n    bytes memory ancillaryData\n  ) public view virtual returns (bool);\n\n  function stampAncillaryData(bytes memory ancillaryData, address requester)\n    public\n    view\n    virtual\n    returns (bytes memory);\n}"
}