New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Full Multi-query support onchain #321

Draft

daveroga wants to merge 92 commits into master from PID-2709-full-multi-query-support-on-chain

Contributor

daveroga commented Dec 3, 2024 •

edited

Loading

Implement multi-query support similar to existing requests now in Universal Verifier.

Manage multi-query (Query) independently and in the same way we are managing Requests in ZKPVerifierBase now (setQuery, getQuery, …). Avoid ZKP and generalize methods in Requests. setRequest, getRequest, submitResponse, …
Change _proofs mapping from address user to uint256 userID to keep identifier of the user.
Create 2 mappings for managing link between userAddress and userID . In this first version 1 userID will have only 1 address? Review best approach or if we have to keep an array of addresses.

mapping(address userAddress => uint256 userID) _user_address_to_id;
mapping(unit256 userID => address userAddress) _id_to_user_address; // check address[] ?

Manage Auth in specific type of requests. Auth requests.

requestId. 32 bytes (in Big Endian): 31-0x00(not used), 30-0x01(requestType), 29..0 hash calculated Id,

For requestType:
   - 0x00 - regular request
   - 0x01 - auth request

Define challenge based on the ethereum address in this first version
Figure out linkID between the Requests and Auth of the same Query.
Consider that more than one type of auth may be available there for specific multiRequest. And each of the multiRequests should define it’s own set of valid auth along with requests.
RequestId change from uint64 to uint256.

Link to Tech Spec for changes: https://www.notion.so/privado-id/Multi-query-Tech-Spec-13d4f86a875180e68fc8e3fa5362805e

daveroga and others added 22 commits

November 26, 2024 11:18


          new universal verifier multi-query

bf71699


          Discussion results

74b24a1


          Discussion results 2

16a8b27


          update universal verifier multi query

f05104d


          remove ZKP

779513f


          add auth validators

8da12c7


          Broader discussion results

ba75a5d


          Add agreed universal verifier solution

ae9cec1


          update universal verifier multi query with agreed design

790a0e3


          query status and submit response

1858dce


          get request type from 30 byte of the requestId


          add EthIdentityValidator

bb82ff3


          updates from review

e66a160


          Discussion result

d416b9a


          updates from discussion

a26861c


          check response field values from linked response fields

0c2e792


          fix some errors in compilation

16f8b5a


          test universal verifier multi-query

4afb814


          different validators for sig and authv2

8f55467


          check specific storage values

657fa6c


          overrides solidity compiler optimizations for specific contract

46d17ab


          remove some methods

1e7b877

coveralls commented Dec 3, 2024 •

edited

Loading

Pull Request Test Coverage Report for Build 12953945580

Details

386 of 442 (87.33%) changed or added relevant lines in 23 files are covered.
3 unchanged lines in 1 file lost coverage.
Overall coverage increased (+1.3%) to 85.362%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
contracts/validators/request/CredentialAtomicQueryV3Validator.sol	16	17	94.12%
contracts/validators/request/LinkedMultiQueryValidator.sol	47	48	97.92%
contracts/verifiers/ValidatorWhitelist.sol	7	9	77.78%
contracts/verifiers/Verifier.sol	215	219	98.17%
contracts/state/State.sol	7	15	46.67%
contracts/validators/auth/AuthV2Validator_forAuth.sol	30	38	78.95%
contracts/validators/auth/EthIdentityValidator.sol	0	13	0.0%
contracts/validators/request/AuthV2Validator.sol	0	19	0.0%

Files with Coverage Reduction	New Missed Lines	%
contracts/state/State.sol	3	75.71%

Totals
Change from base Build 12891717959:	1.3%
Covered Lines:	1238
Relevant Lines:	1361

💛 - Coveralls

daveroga added 4 commits

December 3, 2024 12:16


          fix solhint

2942cdf


          update from discussion

a91c1e7


          set group of requests and check linkID

849e790


          fix solhint

a02592c

daveroga force-pushed the PID-2709-full-multi-query-support-on-chain branch from b70f050 to a02592c Compare

December 5, 2024 11:33

AndriianChestnykh requested changes

View reviewed changes

contracts/verifiers/UniversalVerifierMultiQuery.sol Outdated Show resolved Hide resolved

contracts/verifiers/UniversalVerifierMultiQuery.sol Outdated Show resolved Hide resolved

contracts/verifiers/UniversalVerifierMultiQuery.sol Outdated Show resolved Hide resolved

contracts/verifiers/UniversalVerifierMultiQuery.sol Outdated Show resolved Hide resolved

contracts/verifiers/UniversalVerifierMultiQuery.sol Outdated Show resolved Hide resolved

contracts/verifiers/UniversalVerifierMultiQuery.sol Outdated Show resolved Hide resolved


          updates from review

6b82ff0

daveroga added 2 commits

January 17, 2025 11:22


          fix requestId calculation

d7c7281


          remove specific multi-request test that now is included in verifier test

822c81c

daveroga force-pushed the PID-2709-full-multi-query-support-on-chain branch from 5237dec to 822c81c Compare

January 17, 2025 12:03

daveroga added 2 commits

January 17, 2025 19:59


          add test wrappers and tests for RequestDisableable, RequestOwnership …

39d67f5

…and validatorWhitelist


          increase coverage

e2109e6

daveroga force-pushed the PID-2709-full-multi-query-support-on-chain branch from 7819a0b to e2109e6 Compare

January 17, 2025 19:36

AndriianChestnykh requested changes

View reviewed changes

contracts/interfaces/IVerifier.sol Outdated

               /**
-               * @dev IVerifier. Interface for verification of groth16 proofs.
+               * @dev IVerifier. Interface for verification of groth16 proofs for validators circuits.

Collaborator

AndriianChestnykh Jan 18, 2025

The description is wrong in speaking about groth16

contracts/interfaces/IVerifier.sol Outdated

+                      IRequestValidator validator;
+                      bytes params;
+                      address creator;
+                      uint256 verifierId;

Collaborator

AndriianChestnykh Jan 18, 2025

Considering latest discussions, it doesn't seem we'll use the verifierId field anytime soon

Contributor Author

daveroga Jan 20, 2025

Removed from RequestData and RequestInfo

contracts/interfaces/IVerifier.sol Outdated

+                   * @param proof proof to verify.
+                   */
+                  struct AuthResponse {
+                      string authType; //zkp-auth-v2, zkp-auth-v3, etc. will deside later

Collaborator

AndriianChestnykh Jan 18, 2025

Can you please remove "will deside later" ? :)

contracts/interfaces/IVerifier.sol

Comment on lines +94 to +98

+                  struct AuthType {
+                      string authType;
+                      IAuthValidator validator;
+                      bytes params;
+                  }

Collaborator

AndriianChestnykh Jan 18, 2025

NatSpec is missing

contracts/interfaces/IVerifier.sol Outdated

Comment on lines 152 to 156

+                  /**
+                   * @dev Get the group of requests.
+                   * @return Group of requests.
+                   */
+                  function getGroupedRequests(uint256 groupID) external view returns (uint256[] memory);

Collaborator

AndriianChestnykh Jan 18, 2025

That may be more practical to return RequestInfo[] rather than uint256[]

Contributor Author

daveroga Jan 20, 2025

Yes, sure

contracts/validators/AuthV2Validator.sol Outdated

    
                      IVerifier verifier = getVerifierByCircuitId(CIRCUIT_ID);

                      require(verifier != IVerifier(address(0)), "Verifier address should not be zero");

                      IGroth16Verifier verifier = getVerifierByCircuitId(CIRCUIT_ID);

                      require(verifier != IGroth16Verifier(address(0)), "Verifier address should not be zero");

Collaborator

AndriianChestnykh Jan 18, 2025

better something like g16verifier as a var name

Contributor Author

daveroga Jan 20, 2025 •

edited

Loading

Changed also other contracts var names following the same rule.

contracts/validators/EthIdentityValidator.sol Outdated

+                  /// @dev Main storage structure for the contract
+                  /// @custom:storage-location iden3.storage.EthIdentityValidator
+                  struct EthIdentityValidatorBaseStorage {
+                      IState state;

Collaborator

AndriianChestnykh Jan 18, 2025

The IState state; can be removed as it is not used. So may be no storage at all

Contributor Author

daveroga Jan 20, 2025

We are using state in the internal function _verifyEthIdentity. So we can't removed it.

contracts/verifiers/UniversalVerifier.sol Outdated

Comment on lines 209 to 219

                   function _getRequestIfCanBeVerified(
-                      uint64 requestId
+                      uint256 requestId
                   )
                       internal
                       view
-                      override(RequestDisableable, ValidatorWhitelist, ZKPVerifierBase)
+                      override(RequestDisableable, ValidatorWhitelist, Verifier)
                       onlyEnabledRequest(requestId)
-                      returns (IZKPVerifier.ZKPRequest storage)
+                      returns (IVerifier.RequestData storage)
                   {
                       return super._getRequestIfCanBeVerified(requestId);
                   }

Collaborator

AndriianChestnykh Jan 18, 2025

If I'm not missing something, you don't need the onlyEnabledRequest(requestId) modifier at Universal Verifier level. You anyway have it at RequestDisableable level.

Contributor Author

daveroga Jan 20, 2025

Yes, I think so. Removed the onlyEnabledRequest(requestId) at UniversalVerifier.sol level.

contracts/verifiers/Verifier.sol Outdated

Comment on lines 46 to 54

+                  struct UserAddressToIdInfo {
+                      uint256 userID;
+                      uint256 timestamp;
+                  }
+                  struct UserIdToAddressInfo {
+                      address userAddress;
+                      uint256 timestamp;
+                  }

Collaborator

AndriianChestnykh Jan 18, 2025

These two structs are not used

Contributor Author

daveroga Jan 20, 2025

Removed

contracts/verifiers/Verifier.sol Outdated

Comment on lines 226 to 234

+                  function _setRequestWithChecks(
+                      Request calldata request
+                  )
+                      internal
+                      checkRequestExistence(request.requestId, false)
+                      checkRequestGroupExistence(request, false)
+                  {
+                      _setRequest(request);
+                  }

Collaborator

AndriianChestnykh Jan 18, 2025

checkRequestExistence looks like duplicated in one of the flows that use this method.
Besides checkRequestGroupExistence is used only here and _setRequestWithChecks is used in one place only. So maybe remove _setRequestWithChecks method at all and reorganise the code

Contributor Author

daveroga Jan 20, 2025

Yes, this was old code from previous versions. Reorganized.

daveroga added 6 commits

January 20, 2025 09:37


          updates from review

886193c


          reorganize universal verifier tests

adfac38


          test all the events from universal verifier

70e5a5c


          add embedded verifier test

001f603


          some fixes and increase coverage

a80a773


          increase coverage

d952287

daveroga force-pushed the PID-2709-full-multi-query-support-on-chain branch from fd814c2 to d952287 Compare

January 21, 2025 09:20

AndriianChestnykh and others added 7 commits

January 21, 2025 17:38


          Integration tests (#332)

43e6e8f

* LinkedMultiQuery small fixes

* Add more linked multi query tests

* Improve Linked Multi Query tests

* Scaffold verifier integration-test

* WIP

* Fix getValidatorVerification helpers method

* Fix lmk10 groth16 wrapper in constants

* Remove console from Verifier.sol


          Fix lmk tests

16de597


          update multi-request integration test

85ebc38


          check multi-request components exist

c75baa6


          small general updates

0e90b88


          fix solhint

45c5edc


          remove VerifierLib and move functionality to Verifier

b18c064

daveroga force-pushed the PID-2709-full-multi-query-support-on-chain branch from 539badf to b18c064 Compare

January 23, 2025 16:39


          fix solhint

109f3f8

daveroga force-pushed the PID-2709-full-multi-query-support-on-chain branch from c98bf44 to 109f3f8 Compare

January 24, 2025 07:47

daveroga added 2 commits

January 24, 2025 12:01


          update missing unified addresses for validators

1179c78


          add test to calculate create2 proxy addresses

a64341a

daveroga force-pushed the PID-2709-full-multi-query-support-on-chain branch from 5256217 to a64341a Compare

January 24, 2025 13:54


          update test script to check unified addresses for all the contracts

bc22c56

daveroga requested a review from AndriianChestnykh

January 24, 2025 16:25


          fix create2Calldata statelib

6ea8563

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet