Skip to main content

_getStructFor

Contract: JBFundingCycleStore​

Unpack a funding cycle's packed stored values into an easy-to-work-with funding cycle struct.

Definition​

function _getStructFor(uint256 _projectId, uint256 _configuration)
  private
  view
  returns (JBFundingCycle memory fundingCycle) { ... }
  • Arguments:
    • _projectId is the ID of the project to which the funding cycle belongs.
    • _configuration is the funding cycle configuration to get the full struct for.
  • The view function is private to this contract.
  • The view function does not alter state on the blockchain.
  • The function returns a JBFundingCycle struct.

Body​

  1. If the configuration provided is 0, return an empty funding cycle.

    // Return an empty funding cycle if the configuration specified is 0.
    if (_configuration == 0) return fundingCycle;

  2. Set the funding cycle's configuration to the provided value.

    fundingCycle.configuration = _configuration;

  3. Get the stored intrinsic properties of the funding cycle. Populate the struct values by unpacking the uint256.

    uint256 _packedIntrinsicProperties = _packedIntrinsicPropertiesOf[_projectId][_configuration];

    // weight in bits 0-87 bits.
    fundingCycle.weight = uint256(uint88(_packedIntrinsicProperties));
    // basedOn in bits 88-143 bits.
    fundingCycle.basedOn = uint256(uint56(_packedIntrinsicProperties >> 88));
    // start in bits 144-199 bits.
    fundingCycle.start = uint256(uint56(_packedIntrinsicProperties >> 144));
    // number in bits 200-255 bits.
    fundingCycle.number = uint256(uint56(_packedIntrinsicProperties >> 200));

    Internal references:

  4. Get the stored user properties of the funding cycle. Populate the struct values by unpacking the uint256.

    uint256 _packedUserProperties = _packedUserPropertiesOf[_projectId][_configuration];

    // ballot in bits 0-159 bits.
    fundingCycle.ballot = IJBFundingCycleBallot(address(uint160(_packedUserProperties)));
    // duration in bits 160-191 bits.
    fundingCycle.duration = uint256(uint32(_packedUserProperties >> 160));
    // discountRate in bits 192-223 bits.
    fundingCycle.discountRate = uint256(uint32(_packedUserProperties >> 192));

    Internal references:

  5. Populate the metadata property of the struct by reading from what's stored.

    fundingCycle.metadata = _metadataOf[_projectId][_configuration];

    Internal references: