_ballotStateOf

Contract: JBFundingCycleStore​

Step by step

A project's latest funding cycle configuration approval status.

Definition

function _ballotStateOf(
  uint256 _projectId,
  uint256 _configuration,
  uint256 _start,
  uint256 _ballotFundingCycleConfiguration
) private view returns (JBBallotState) { ... }

• Arguments:
  • _projectId is the ID of the project to which the funding cycle belongs.
  • _configuration is the funding cycle configuration to get the ballot state of.
  • _start is the start time of the funding cycle configuration to get the ballot state of.
  • _ballotFundingCycleConfiguration is the configuration of the funding cycle which is configured with the ballot that should be used.
• The view function is private to this contract.
• The view function does not alter state on the blockchain.
• The function returns the JBBallotState of the project.

Body

1. If there is no ballot configuration, the ballot state is implicitly approved.

   // If there is no ballot funding cycle, implicitly approve.
   if (_ballotFundingCycleConfiguration == 0) return JBBallotState.Approved;

   Enums used:

   • JBBallotState
     • .Approved

2. Get the funding cycle that has a reference of the ballot that should be used.

   // Get the ballot funding cycle.
   JBFundingCycle memory _ballotFundingCycle = _getStructFor(
     _projectId,
     _ballotFundingCycleConfiguration
   );

   Internal references:

   • _getStructFor

3. If there's no ballot, the funding cycle configuration is implicitly approved. Otherwise, return the state that the ballot for the provided configuration.

   // If there is no ballot, the ID is auto approved.
   if (_ballotFundingCycle.ballot == IJBFundingCycleBallot(address(0)))
     return JBBallotState.Approved;

// Return the ballot's state
return _ballotFundingCycle.ballot.stateOf(_projectId, _configuration, _start);
```

_Enums used:_

* [`JBBallotState`](/zh/dev/api/enums/jbballotstate)
  * `.Approved`

_External references:_

* [`stateOf`](/zh/dev/api/interfaces/ijbfundingcycleballot)

Code

/**
  @notice
  A project's latest funding cycle configuration approval status.

  @param _projectId The ID of the project to which the funding cycle belongs.
  @param _configuration The funding cycle configuration to get the ballot state of.
  @param _start The start time of the funding cycle configuration to get the ballot state of.
  @param _ballotFundingCycleConfiguration The configuration of the funding cycle which is configured with the ballot that should be used.

  @return The ballot state of the project.
*/
function _ballotStateOf(
  uint256 _projectId,
  uint256 _configuration,
  uint256 _start,
  uint256 _ballotFundingCycleConfiguration
) private view returns (JBBallotState) {
  // If there is no ballot funding cycle, implicitly approve.
  if (_ballotFundingCycleConfiguration == 0) return JBBallotState.Approved;

  // Get the ballot funding cycle.
  JBFundingCycle memory _ballotFundingCycle = _getStructFor(
    _projectId,
    _ballotFundingCycleConfiguration
  );

  // If there is no ballot, the ID is auto approved.
  if (_ballotFundingCycle.ballot == IJBFundingCycleBallot(address(0)))
    return JBBallotState.Approved;

  // Return the ballot's state
  return _ballotFundingCycle.ballot.stateOf(_projectId, _configuration, _start);
}

Bug bounty

Category	Description	Reward
Optimization	Help make this operation more efficient.	0.5ETH
Low severity	Identify a vulnerability in this operation that could lead to an inconvenience for a user of the protocol or for a protocol developer.	1ETH
High severity	Identify a vulnerability in this operation that could lead to data corruption or loss of funds.	5+ETH