MessageProcessor
MessageProcessor is used to process messages published by signup users. It will process message by batch due to large size of messages. After it finishes processing, the sbCommitment will be used for Tally and Subsidy contracts.
NoMoreMessages
error NoMoreMessages()
custom errors
StateNotMerged
error StateNotMerged()
InvalidProcessMessageProof
error InvalidProcessMessageProof()
NumSignUpsTooLarge
error NumSignUpsTooLarge()
CurrentMessageBatchIndexTooLarge
error CurrentMessageBatchIndexTooLarge()
BatchEndIndexTooLarge
error BatchEndIndexTooLarge()
processingComplete
bool processingComplete
Get the result of whether there are unprocessed messages left
Return Values
| Name | Type | Description |
|---|
numBatchesProcessed
uint256 numBatchesProcessed
The number of batches processed
currentBatchIndex
uint256 currentBatchIndex
The current message batch index
sbCommitment
uint256 sbCommitment
Get the commitment to the state and ballot roots
Return Values
| Name | Type | Description |
|---|
poll
contract IPoll poll
verifier
contract IVerifier verifier
vkRegistry
contract IVkRegistry vkRegistry
mode
enum DomainObjs.Mode mode
constructor
constructor(address _verifier, address _vkRegistry, address _poll, enum DomainObjs.Mode _mode) public payable
Create a new instance
Parameters
| Name | Type | Description |
|---|---|---|
| _verifier | address | The Verifier contract address |
| _vkRegistry | address | The VkRegistry contract address |
| _poll | address | The Poll contract address |
| _mode | enum DomainObjs.Mode | Voting mode |
processMessages
function processMessages(uint256 _newSbCommitment, uint256[8] _proof) external
Update the Poll's currentSbCommitment if the proof is valid.
Parameters
| Name | Type | Description |
|---|---|---|
| _newSbCommitment | uint256 | The new state root and ballot root commitment after all messages are processed |
| _proof | uint256[8] | The zk-SNARK proof |
getPublicCircuitInputs
function getPublicCircuitInputs(uint256 _currentMessageBatchIndex, uint256 _newSbCommitment, uint256 _outputBatchHash) public view returns (uint256[] publicInputs)
Get public circuit inputs.
Parameters
| Name | Type | Description |
|---|---|---|
| _currentMessageBatchIndex | uint256 | The current processed batch index |
| _newSbCommitment | uint256 | The new state root and ballot root commitment after all messages are processed |
| _outputBatchHash | uint256 | The output batch hash |
Return Values
| Name | Type | Description |
|---|---|---|
| publicInputs | uint256[] | publicInputs public circuit inputs |
verifyProcessProof
function verifyProcessProof(uint256 _currentBatchIndex, uint256 _outputBatchHash, uint256 _newSbCommitment, uint8 _messageBatchSize, uint8 _voteOptionTreeDepth, uint256[8] _proof) internal view returns (bool isValid)
Verify the proof for processMessage
used to update the sbCommitment
Parameters
| Name | Type | Description |
|---|---|---|
| _currentBatchIndex | uint256 | The batch index of current message batch |
| _outputBatchHash | uint256 | The output batch hash |
| _newSbCommitment | uint256 | The new sbCommitment after we update this message batch |
| _messageBatchSize | uint8 | The message batch size |
| _voteOptionTreeDepth | uint8 | The vote option tree depth |
| _proof | uint256[8] | The zk-SNARK proof |
Return Values
| Name | Type | Description |
|---|---|---|
| isValid | bool | Whether the proof is valid |
updateMessageProcessingData
function updateMessageProcessingData(uint256 _newSbCommitment, bool _processingComplete) internal
update message processing state variables
Parameters
| Name | Type | Description |
|---|---|---|
| _newSbCommitment | uint256 | sbCommitment to be updated |
| _processingComplete | bool | update flag that indicate processing is finished or not |