all files / contracts/ Unirep.sol

96.8% Statements 121/125
87.14% Branches 61/70
96.15% Functions 25/26
96.76% Lines 179/185
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576                                                                                                        25× 24× 24× 24× 24× 24× 24× 24× 24×   24× 24×     24×     24× 24×   24× 24× 24×   24× 24× 120×   24×                                                   120× 119× 119× 106×   119× 630× 629× 628×   628× 523×   628×               117×     117×                     425×     425× 424×   423×   421×                       538× 538× 536× 536×   536× 535×   535× 535×   533×           533×           533×       533× 533×                   982× 982× 980×     980×     980×     980×           980×           980×   910×                     953×                           31× 29×                       109× 108×   106×   105×   104×       104× 104×             104×       104× 79× 79× 79×   25×   24× 24×   103×             103×           103× 103× 618×   103× 103×   103×   103× 64× 64×   39×     102×                     83× 81×   81× 81× 80×     80× 79×     79×   79× 235×                 78×     76×           76×             76×       76×                   538× 538×           750× 750× 745× 745×       104× 87×       87×     87×       87×   87×   87×   87×     104×   104×   104×           427× 427× 427×           426× 426× 426×   426×         426×           83× 83×           82× 82× 82× 82×   82× 246×     82×       82×                           820× 820× 820× 814×           10× 10× 10×                         30× 30×           23× 23×           13× 13×           18× 18×                                
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
 
import {VerifySignature} from './libraries/VerifySignature.sol';
 
import {IUnirep} from './interfaces/IUnirep.sol';
import {IVerifier} from './interfaces/IVerifier.sol';
 
import {IncrementalBinaryTree, IncrementalTreeData} from '@zk-kit/incremental-merkle-tree.sol/IncrementalBinaryTree.sol';
import {ReusableMerkleTree, ReusableTreeData} from './libraries/ReusableMerkleTree.sol';
import {LazyMerkleTree, LazyTreeData} from './libraries/LazyMerkleTree.sol';
 
import 'poseidon-solidity/PoseidonT3.sol';
 
/**
 * @title Unirep
 * @dev Unirep is a reputation which uses ZKP to preserve users' privacy.
 * Attester can give attestations to users, and users can optionally prove that how much reputation they have.
 */
contract Unirep is IUnirep, VerifySignature {
    // All verifier contracts
    IVerifier public immutable signupVerifier;
    IVerifier public immutable userStateTransitionVerifier;
 
    uint256 public constant SNARK_SCALAR_FIELD =
        21888242871839275222246405745257275088548364400416034343698204186575808495617;
 
    // Attester id == address
    mapping(uint160 => AttesterData) attesters;
 
    // Mapping of used nullifiers
    mapping(uint256 => bool) public usedNullifiers;
 
    uint8 public immutable stateTreeDepth;
    uint8 public immutable epochTreeDepth;
    uint8 public immutable historyTreeDepth;
    uint8 public immutable fieldCount;
    uint8 public immutable sumFieldCount;
    uint8 public immutable numEpochKeyNoncePerEpoch;
    uint8 public immutable replNonceBits;
    uint8 public immutable replFieldBits;
    uint48 public immutable chainid;
    uint256 public immutable defaultDataHash;
 
    uint48 public attestationCount = 1;
 
    constructor(
        Config memory _config,
        IVerifier _signupVerifier,
        IVerifier _userStateTransitionVerifier
    ) {
        // see IUnirep.sol EpochKeyData.data
        require(_config.fieldCount < 128, 'datasize');
        stateTreeDepth = _config.stateTreeDepth;
        epochTreeDepth = _config.epochTreeDepth;
        historyTreeDepth = _config.historyTreeDepth;
        fieldCount = _config.fieldCount;
        sumFieldCount = _config.sumFieldCount;
        numEpochKeyNoncePerEpoch = _config.numEpochKeyNoncePerEpoch;
        replNonceBits = _config.replNonceBits;
        replFieldBits = _config.replFieldBits;
 
        uint256 id;
        assembly {
            id := chainid()
        }
        chainid = uint48(id);
 
        // Set the verifier contracts
        signupVerifier = _signupVerifier;
        userStateTransitionVerifier = _userStateTransitionVerifier;
 
        emit AttesterSignedUp(0, type(uint48).max, uint48(block.timestamp));
        attesters[uint160(0)].epochLength = type(uint48).max;
        attesters[uint160(0)].startTimestamp = uint48(block.timestamp);
 
        uint256 zeroDataHash = 0;
        for (uint256 i = 1; i < fieldCount; i++) {
            zeroDataHash = PoseidonT3.hash([zeroDataHash, 0]);
        }
        defaultDataHash = zeroDataHash;
    }
 
    function config() public view returns (Config memory) {
        return
            Config({
                stateTreeDepth: stateTreeDepth,
                epochTreeDepth: epochTreeDepth,
                historyTreeDepth: historyTreeDepth,
                fieldCount: fieldCount,
                sumFieldCount: sumFieldCount,
                numEpochKeyNoncePerEpoch: numEpochKeyNoncePerEpoch,
                replNonceBits: replNonceBits,
                replFieldBits: replFieldBits
            });
    }
 
    /**
     * Use this if your application has custom signup proof logic.
     * e.g. to insert a non-zero data field in the state tree leaf
     **/
    function manualUserSignUp(
        uint48 epoch,
        uint256 identityCommitment,
        uint256 leafIdentityHash,
        uint256[] calldata initialData
    ) public {
        if (initialData.length > fieldCount) revert OutOfRange();
        uint256 initialDataHash = defaultDataHash;
        if (initialData.length != 0) {
            initialDataHash = initialData[0];
        }
        for (uint8 x = 0; x < initialData.length; x++) {
            if (initialData[x] >= SNARK_SCALAR_FIELD) revert InvalidField();
            if (x >= sumFieldCount && initialData[x] >= 2 ** replFieldBits)
                revert OutOfRange();
            uint256 data = initialData[x] <<
                (x >= sumFieldCount ? replNonceBits : 0);
            if (x != 0) {
                initialDataHash = PoseidonT3.hash([initialDataHash, data]);
            }
            emit Attestation(
                type(uint48).max,
                identityCommitment,
                uint160(msg.sender),
                x,
                data
            );
        }
        uint256 stateTreeLeaf = PoseidonT3.hash(
            [leafIdentityHash, initialDataHash]
        );
        _userSignUp(epoch, identityCommitment, stateTreeLeaf);
    }
 
    /**
     * @dev User signs up by provding a zk proof outputting identity commitment and new gst leaf.
     * msg.sender must be attester
     */
    function userSignUp(
        uint256[] calldata publicSignals,
        uint256[8] calldata proof
    ) public {
        SignupSignals memory signals = decodeSignupSignals(publicSignals);
        // Verify the proof
        // only allow attester to sign up users
        if (uint160(msg.sender) != signals.attesterId)
            revert AttesterIdNotMatch(uint160(msg.sender));
        if (signals.chainId != chainid) revert ChainIdNotMatch(signals.chainId);
        // Verify the proof
        if (!signupVerifier.verifyProof(publicSignals, proof))
            revert InvalidProof();
 
        _userSignUp(
            signals.epoch,
            signals.identityCommitment,
            signals.stateTreeLeaf
        );
    }
 
    function _userSignUp(
        uint48 epoch,
        uint256 identityCommitment,
        uint256 stateTreeLeaf
    ) internal {
        uint160 attesterId = uint160(msg.sender);
        _updateEpochIfNeeded(attesterId);
        AttesterData storage attester = attesters[attesterId];
        Iif (attester.startTimestamp == 0) revert AttesterNotSignUp(attesterId);
 
        if (attester.identityCommitments[identityCommitment])
            revert UserAlreadySignedUp(identityCommitment);
        attester.identityCommitments[identityCommitment] = true;
 
        uint48 currentEpoch = attester.currentEpoch;
        if (currentEpoch != epoch) revert EpochNotMatch();
 
        emit UserSignedUp(
            currentEpoch,
            identityCommitment,
            attesterId,
            attester.stateTree.numberOfLeaves
        );
        emit StateTreeLeaf(
            attester.currentEpoch,
            attesterId,
            attester.stateTree.numberOfLeaves,
            stateTreeLeaf
        );
        uint256 root = ReusableMerkleTree.insert(
            attester.stateTree,
            stateTreeLeaf
        );
        attester.stateTreeRoots[currentEpoch][root] = true;
        IncrementalBinaryTree.insert(
            attester.semaphoreGroup,
            identityCommitment
        );
    }
 
    /**
     * @dev Allow an attester to signup and specify their epoch length
     */
    function _attesterSignUp(address attesterId, uint48 epochLength) private {
        AttesterData storage attester = attesters[uint160(attesterId)];
        if (attester.startTimestamp != 0)
            revert AttesterAlreadySignUp(uint160(attesterId));
        attester.startTimestamp = uint48(block.timestamp);
 
        // initialize the state tree
        ReusableMerkleTree.init(attester.stateTree, stateTreeDepth);
 
        // initialize the epoch tree
        LazyMerkleTree.init(attester.epochTree, epochTreeDepth);
 
        // initialize the semaphore group tree
        IncrementalBinaryTree.initWithDefaultZeroes(
            attester.semaphoreGroup,
            stateTreeDepth // TODO: increase this
        );
 
        // initialize history tree
        IncrementalBinaryTree.initWithDefaultZeroes(
            attester.historyTree,
            historyTreeDepth
        );
 
        // set the epoch length
        attester.epochLength = epochLength;
 
        emit AttesterSignedUp(
            uint160(attesterId),
            epochLength,
            attester.startTimestamp
        );
    }
 
    /**
     * @dev Sign up an attester using the address who sends the transaction
     */
    function attesterSignUp(uint48 epochLength) public {
        _attesterSignUp(msg.sender, epochLength);
    }
 
    /**
     * @dev Sign up an attester using the claimed address and the signature
     * @param attester The address of the attester who wants to sign up
     * @param signature The signature of the attester
     */
    function attesterSignUpViaRelayer(
        address attester,
        uint48 epochLength,
        bytes calldata signature
    ) public {
        // TODO: verify epoch length in signature
        if (!isValidSignature(attester, epochLength, signature))
            revert InvalidSignature();
        _attesterSignUp(attester, epochLength);
    }
 
    /**
     * @dev Attest to a change in data for a user that controls `epochKey`
     */
    function attest(
        uint256 epochKey,
        uint48 epoch,
        uint fieldIndex,
        uint change
    ) public {
        uint48 currentEpoch = updateEpochIfNeeded(uint160(msg.sender));
        if (epoch != currentEpoch) revert EpochNotMatch();
 
        if (epochKey >= SNARK_SCALAR_FIELD) revert InvalidEpochKey();
 
        if (fieldIndex >= fieldCount) revert InvalidField();
 
        EpochKeyData storage epkData = attesters[uint160(msg.sender)].epkData[
            epochKey
        ];
 
        uint256 epkEpoch = epkData.epoch;
        Iif (epkEpoch != 0 && epkEpoch != currentEpoch) {
            revert InvalidEpoch(epkEpoch);
        }
        // only allow an epoch key to be used in a single epoch
        // this is to prevent frontrunning DOS in UST
        // e.g. insert a tx attesting to the epk revealed by the UST
        // then the UST can never succeed
        Iif (epkEpoch != currentEpoch) {
            epkData.epoch = currentEpoch;
        }
 
        if (fieldIndex < sumFieldCount) {
            uint256 oldVal = epkData.data[fieldIndex];
            uint256 newVal = addmod(oldVal, change, SNARK_SCALAR_FIELD);
            epkData.data[fieldIndex] = newVal;
        } else {
            if (change >= 2 ** replFieldBits) {
                revert OutOfRange();
            }
            change = (change << uint(replNonceBits)) + uint(attestationCount);
            epkData.data[fieldIndex] = change;
        }
        emit Attestation(
            epoch,
            epochKey,
            uint160(msg.sender),
            fieldIndex,
            change
        );
        attestationCount++;
 
        // now construct the leaf
        // TODO: only rebuild the hashchain as needed
        // e.g. if data[4] if attested to, don't hash 0,1,2,3
 
        uint256 leaf = epochKey;
        for (uint8 x = 0; x < fieldCount; x++) {
            leaf = PoseidonT3.hash([leaf, epkData.data[x]]);
        }
        bool newLeaf = epkData.leaf == 0;
        epkData.leaf = leaf;
 
        LazyTreeData storage epochTree = attesters[uint160(msg.sender)]
            .epochTree;
        if (newLeaf) {
            epkData.leafIndex = epochTree.numberOfLeaves;
            LazyMerkleTree.insert(epochTree, leaf);
        } else {
            LazyMerkleTree.update(epochTree, leaf, epkData.leafIndex);
        }
 
        emit EpochTreeLeaf(epoch, uint160(msg.sender), epkData.leafIndex, leaf);
    }
 
    /**
     * @dev Allow a user to epoch transition for an attester. Accepts a zk proof outputting the new gst leaf
     **/
    function userStateTransition(
        uint256[] calldata publicSignals,
        uint256[8] calldata proof
    ) public {
        // Verify the proof
        if (!userStateTransitionVerifier.verifyProof(publicSignals, proof))
            revert InvalidProof();
        UserStateTransitionSignals
            memory signals = decodeUserStateTransitionSignals(publicSignals);
        Iif (signals.attesterId >= type(uint160).max) revert AttesterInvalid();
        updateEpochIfNeeded(signals.attesterId);
        AttesterData storage attester = attesters[signals.attesterId];
        // verify that the transition nullifier hasn't been used
        // just use the first outputted EPK as the nullifier
        if (usedNullifiers[signals.epochKeys[0]])
            revert NullifierAlreadyUsed(signals.epochKeys[0]);
        usedNullifiers[signals.epochKeys[0]] = true;
 
        // verify that we're transition to the current epoch
        Iif (attester.currentEpoch != signals.toEpoch) revert EpochNotMatch();
 
        for (uint8 x = 0; x < numEpochKeyNoncePerEpoch; x++) {
            if (
                attester.epkData[signals.epochKeys[x]].epoch <
                signals.toEpoch &&
                attester.epkData[signals.epochKeys[x]].leaf != 0
            ) {
                revert EpochKeyNotProcessed();
            }
        }
 
        // make sure from state tree root is valid
        if (!attester.historyTreeRoots[signals.historyTreeRoot])
            revert InvalidHistoryTreeRoot(signals.historyTreeRoot);
 
        // update the current state tree
        emit StateTreeLeaf(
            attester.currentEpoch,
            signals.attesterId,
            attester.stateTree.numberOfLeaves,
            signals.stateTreeLeaf
        );
        emit UserStateTransitioned(
            attester.currentEpoch,
            signals.attesterId,
            attester.stateTree.numberOfLeaves,
            signals.stateTreeLeaf,
            signals.epochKeys[0]
        );
        uint256 root = ReusableMerkleTree.insert(
            attester.stateTree,
            signals.stateTreeLeaf
        );
        attester.stateTreeRoots[attester.currentEpoch][root] = true;
    }
 
    /**
     * @dev Update the currentEpoch for an attester, if needed
     * https://github.com/ethereum/solidity/issues/13813
     */
    function _updateEpochIfNeeded(
        uint256 attesterId
    ) public returns (uint epoch) {
        Iif (attesterId >= type(uint160).max) revert AttesterInvalid();
        return updateEpochIfNeeded(uint160(attesterId));
    }
 
    function updateEpochIfNeeded(
        uint160 attesterId
    ) public returns (uint48 epoch) {
        AttesterData storage attester = attesters[attesterId];
        epoch = attesterCurrentEpoch(attesterId);
        uint48 fromEpoch = attester.currentEpoch;
        if (epoch == fromEpoch) return epoch;
 
        // otherwise reset the trees for the new epoch
 
        if (attester.stateTree.numberOfLeaves > 0) {
            uint256 epochTreeRoot = LazyMerkleTree.root(
                attester.epochTree,
                epochTreeDepth
            );
            uint256 historyTreeLeaf = PoseidonT3.hash(
                [attester.stateTree.root, epochTreeRoot]
            );
            uint256 root = IncrementalBinaryTree.insert(
                attester.historyTree,
                historyTreeLeaf
            );
            attester.historyTreeRoots[root] = true;
 
            ReusableMerkleTree.reset(attester.stateTree);
 
            attester.epochTreeRoots[fromEpoch] = epochTreeRoot;
 
            emit HistoryTreeLeaf(attesterId, historyTreeLeaf);
        }
 
        LazyMerkleTree.reset(attester.epochTree);
 
        emit EpochEnded(epoch - 1, attesterId);
 
        attester.currentEpoch = epoch;
    }
 
    function decodeSignupControl(
        uint256 control
    ) public pure returns (uint160 attesterId, uint48 epoch, uint48 chainId) {
        chainId = uint48((control >> (208)) & ((1 << 36) - 1));
        epoch = uint48((control >> 160) & ((1 << 48) - 1));
        attesterId = uint160(control & ((1 << 160) - 1));
    }
 
    function decodeSignupSignals(
        uint256[] calldata publicSignals
    ) public pure returns (SignupSignals memory) {
        SignupSignals memory signals;
        signals.identityCommitment = publicSignals[0];
        signals.stateTreeLeaf = publicSignals[1];
        // now decode the control values
        (
            signals.attesterId,
            signals.epoch,
            signals.chainId
        ) = decodeSignupControl(publicSignals[2]);
        return signals;
    }
 
    function decodeUserStateTransitionControl(
        uint256 control
    ) public pure returns (uint160 attesterId, uint48 toEpoch) {
        toEpoch = uint48((control >> 160) & ((1 << 48) - 1));
        attesterId = uint160(control & ((1 << 160) - 1));
    }
 
    function decodeUserStateTransitionSignals(
        uint256[] calldata publicSignals
    ) public view returns (UserStateTransitionSignals memory) {
        UserStateTransitionSignals memory signals;
        signals.historyTreeRoot = publicSignals[0];
        signals.stateTreeLeaf = publicSignals[1];
        signals.epochKeys = new uint[](numEpochKeyNoncePerEpoch);
 
        for (uint8 i = 0; i < numEpochKeyNoncePerEpoch; i++) {
            signals.epochKeys[i] = publicSignals[2 + i];
        }
        // now decode the control values
        (
            signals.attesterId,
            signals.toEpoch
        ) = decodeUserStateTransitionControl(publicSignals[5]);
        return signals;
    }
 
    function attesterStartTimestamp(
        uint160 attesterId
    ) public view returns (uint256) {
        AttesterData storage attester = attesters[attesterId];
        require(attester.startTimestamp != 0); // indicates the attester is signed up
        return attester.startTimestamp;
    }
 
    function attesterCurrentEpoch(
        uint160 attesterId
    ) public view returns (uint48) {
        uint48 timestamp = attesters[attesterId].startTimestamp;
        uint48 epochLength = attesters[attesterId].epochLength;
        if (timestamp == 0) revert AttesterNotSignUp(attesterId);
        return (uint48(block.timestamp) - timestamp) / epochLength;
    }
 
    function attesterEpochRemainingTime(
        uint160 attesterId
    ) public view returns (uint48) {
        uint48 timestamp = attesters[attesterId].startTimestamp;
        uint48 epochLength = attesters[attesterId].epochLength;
        if (timestamp == 0) revert AttesterNotSignUp(attesterId);
        uint48 blockTimestamp = uint48(block.timestamp);
        uint48 _currentEpoch = (blockTimestamp - timestamp) / epochLength;
        return timestamp + (_currentEpoch + 1) * epochLength - blockTimestamp;
    }
 
    function attesterEpochLength(
        uint160 attesterId
    ) public view returns (uint48) {
        AttesterData storage attester = attesters[attesterId];
        return attester.epochLength;
    }
 
    function attesterStateTreeRootExists(
        uint160 attesterId,
        uint48 epoch,
        uint256 root
    ) public view returns (bool) {
        AttesterData storage attester = attesters[attesterId];
        return attester.stateTreeRoots[epoch][root];
    }
 
    function attesterStateTreeRoot(
        uint160 attesterId
    ) public view returns (uint256) {
        AttesterData storage attester = attesters[attesterId];
        return attester.stateTree.root;
    }
 
    function attesterStateTreeLeafCount(
        uint160 attesterId
    ) public view returns (uint256) {
        AttesterData storage attester = attesters[attesterId];
        return attester.stateTree.numberOfLeaves;
    }
 
    function attesterSemaphoreGroupRoot(
        uint160 attesterId
    ) public view returns (uint256) {
        AttesterData storage attester = attesters[attesterId];
        return attester.semaphoreGroup.root;
    }
 
    function attesterMemberCount(
        uint160 attesterId
    ) public view returns (uint256) {
        AttesterData storage attester = attesters[attesterId];
        return attester.semaphoreGroup.numberOfLeaves;
    }
 
    function attesterEpochRoot(
        uint160 attesterId,
        uint48 epoch
    ) public view returns (uint256) {
        AttesterData storage attester = attesters[attesterId];
        Eif (epoch == attesterCurrentEpoch(attesterId)) {
            return LazyMerkleTree.root(attester.epochTree, epochTreeDepth);
        }
        return attester.epochTreeRoots[epoch];
    }
}