@lfdecentralizedtrust/zeto-contracts 0.2.2 → 0.5.0

package/contracts/lib/zeto_base.sol

@@ -1,293 +0,0 @@
-// Copyright © 2024 Kaleido, Inc.
-//
-// SPDX-License-Identifier: Apache-2.0
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-pragma solidity ^0.8.27;
-
-import {IZeto} from "./interfaces/izeto.sol";
-import {IZetoLockable} from "./interfaces/izeto_lockable.sol";
-import {Commonlib} from "./common.sol";
-import {ZetoCommon} from "./zeto_common.sol";
-
-/// @title A sample base implementation of a Zeto based token contract
-///        without using nullifiers. Each UTXO's spending status is explicitly tracked.
-/// @author Kaleido, Inc.
-/// @dev Implements common functionalities of Zeto based tokens without nullifiers
-abstract contract ZetoBase is IZeto, IZetoLockable, ZetoCommon {
-    enum UTXOStatus {
-        UNKNOWN, // default value for the empty UTXO slots
-        UNSPENT,
-        SPENT
-    }
-
-    // tracks all the regular (unlocked) UTXOs
-    mapping(uint256 => UTXOStatus) internal _utxos;
-    // used for tracking locked UTXOs. multi-step transaction flows that require counterparties
-    // to upload proofs. To protect the party that uploads their proof first,
-    // and prevent any other party from utilizing the uploaded proof to execute
-    // a transaction, the input UTXOs or nullifiers can be locked and only usable
-    // by the same party that did the locking.
-    mapping(uint256 => UTXOStatus) internal _lockedUtxos;
-    mapping(uint256 => address) internal delegates;
-
-    function __ZetoBase_init(
-        string memory name_,
-        string memory symbol_,
-        address initialOwner
-    ) internal onlyInitializing {
-        __ZetoCommon_init(name_, symbol_, initialOwner);
-    }
-
-    /// @dev query whether a UTXO is currently spent
-    /// @return bool whether the UTXO is spent
-    function spent(uint256 txo) public view returns (bool) {
-        return
-            _utxos[txo] == UTXOStatus.SPENT ||
-            _lockedUtxos[txo] == UTXOStatus.SPENT;
-    }
-
-    function validateTransactionProposal(
-        uint256[] memory inputs,
-        uint256[] memory outputs,
-        uint256[] memory lockedOutputs,
-        bool inputsLocked
-    ) internal view returns (bool) {
-        uint256[] memory allOutputs = new uint256[](
-            outputs.length + lockedOutputs.length
-        );
-        for (uint256 i = 0; i < outputs.length; i++) {
-            allOutputs[i] = outputs[i];
-        }
-        for (uint256 i = 0; i < lockedOutputs.length; i++) {
-            allOutputs[outputs.length + i] = lockedOutputs[i];
-        }
-        validateInputs(inputs, inputsLocked);
-        validateOutputs(allOutputs);
-
-        return true;
-    }
-
-    function validateInputs(
-        uint256[] memory inputs,
-        bool inputsLocked
-    ) internal view {
-        // sort the inputs to detect duplicates
-        uint256[] memory sortedInputs = sortCommitments(inputs);
-        // Check the inputs are all unspent
-        for (uint256 i = 0; i < sortedInputs.length; ++i) {
-            if (sortedInputs[i] == 0) {
-                // skip the zero inputs
-                continue;
-            }
-            if (i > 0 && sortedInputs[i] == sortedInputs[i - 1]) {
-                revert UTXODuplicate(sortedInputs[i]);
-            }
-            if (
-                _lockedUtxos[sortedInputs[i]] == UTXOStatus.UNKNOWN &&
-                _utxos[sortedInputs[i]] == UTXOStatus.UNKNOWN
-            ) {
-                revert UTXONotMinted(sortedInputs[i]);
-            }
-            if (
-                _lockedUtxos[sortedInputs[i]] == UTXOStatus.SPENT ||
-                _utxos[sortedInputs[i]] == UTXOStatus.SPENT
-            ) {
-                revert UTXOAlreadySpent(sortedInputs[i]);
-            }
-            if (
-                !inputsLocked &&
-                _lockedUtxos[sortedInputs[i]] == UTXOStatus.UNSPENT
-            ) {
-                revert UTXOAlreadyLocked(sortedInputs[i]);
-            }
-            if (
-                inputsLocked &&
-                delegates[sortedInputs[i]] != msg.sender &&
-                delegates[sortedInputs[i]] != address(0)
-            ) {
-                revert NotLockDelegate(
-                    sortedInputs[i],
-                    delegates[sortedInputs[i]],
-                    msg.sender
-                );
-            }
-        }
-    }
-
-    function validateOutputs(uint256[] memory outputs) internal view {
-        // sort the outputs to detect duplicates
-        uint256[] memory sortedOutputs = sortCommitments(outputs);
-
-        // Check for duplicate outputs
-        for (uint256 i = 0; i < sortedOutputs.length; ++i) {
-            if (sortedOutputs[i] == 0) {
-                // skip the zero outputs
-                continue;
-            }
-            if (i > 0 && sortedOutputs[i] == sortedOutputs[i - 1]) {
-                revert UTXODuplicate(sortedOutputs[i]);
-            }
-        }
-
-        // check the outputs are all new - looking in the locked and unlocked UTXOs
-        for (uint256 i = 0; i < outputs.length; ++i) {
-            if (
-                _utxos[outputs[i]] == UTXOStatus.SPENT ||
-                _lockedUtxos[outputs[i]] == UTXOStatus.SPENT
-            ) {
-                revert UTXOAlreadySpent(outputs[i]);
-            } else if (
-                _utxos[outputs[i]] == UTXOStatus.UNSPENT ||
-                _lockedUtxos[outputs[i]] == UTXOStatus.UNSPENT
-            ) {
-                revert UTXOAlreadyOwned(outputs[i]);
-            }
-        }
-    }
-
-    function processInputsAndOutputs(
-        uint256[] memory inputs,
-        uint256[] memory outputs,
-        uint256[] memory lockedOutputs,
-        bool inputsLocked
-    ) internal {
-        processInputs(inputs, inputsLocked);
-        processOutputs(outputs);
-        processLockedOutputs(lockedOutputs);
-    }
-
-    function processInputs(
-        uint256[] memory inputs,
-        bool inputsLocked
-    ) internal {
-        mapping(uint256 => UTXOStatus) storage utxos = inputsLocked
-            ? _lockedUtxos
-            : _utxos;
-        // consume the input UTXOs
-        for (uint256 i = 0; i < inputs.length; ++i) {
-            if (inputs[i] != 0) {
-                utxos[inputs[i]] = UTXOStatus.SPENT;
-            }
-        }
-    }
-
-    function processOutputs(uint256[] memory outputs) internal {
-        for (uint256 i = 0; i < outputs.length; ++i) {
-            if (outputs[i] != 0) {
-                _utxos[outputs[i]] = UTXOStatus.UNSPENT;
-            }
-        }
-    }
-
-    function processLockedOutputs(uint256[] memory lockedOutputs) internal {
-        for (uint256 i = 0; i < lockedOutputs.length; ++i) {
-            if (lockedOutputs[i] != 0) {
-                _lockedUtxos[lockedOutputs[i]] = UTXOStatus.UNSPENT;
-            }
-        }
-    }
-
-    // This function is used to mint new UTXOs, as an example implementation,
-    // which is only callable by the owner.
-    function _mint(
-        uint256[] memory utxos,
-        bytes calldata data
-    ) internal virtual {
-        validateOutputs(utxos);
-        processOutputs(utxos);
-        emit UTXOMint(utxos, msg.sender, data);
-    }
-
-    // The caller function must perform the proof verification
-    function _burn(
-        uint256[] memory inputs,
-        uint256 output,
-        bytes calldata data
-    ) internal virtual {
-        validateInputs(inputs, false);
-        uint256[] memory outputStates = new uint256[](1);
-        outputStates[0] = output;
-        validateOutputs(outputStates);
-        processInputs(inputs, false);
-        processOutputs(outputStates);
-        emit UTXOBurn(inputs, output, msg.sender, data);
-    }
-
-    // Locks the UTXOs so that they can only be spent by submitting the appropriate
-    // proof from the Eth account designated as the "delegate". This function
-    // should be called by a participant, to designate an escrow contract as the delegate,
-    // which can use uploaded proofs to execute transactions.
-    function _lock(
-        uint256[] memory inputs,
-        uint256[] memory outputs,
-        uint256[] memory lockedOutputs,
-        address delegate,
-        bytes calldata data
-    ) internal {
-        for (uint256 i = 0; i < lockedOutputs.length; ++i) {
-            if (lockedOutputs[i] == 0) {
-                continue;
-            }
-            if (
-                delegates[lockedOutputs[i]] != address(0) &&
-                delegates[lockedOutputs[i]] != msg.sender
-            ) {
-                revert NotLockDelegate(
-                    lockedOutputs[i],
-                    delegates[lockedOutputs[i]],
-                    msg.sender
-                );
-            }
-            delegates[lockedOutputs[i]] = delegate;
-        }
-
-        emit UTXOsLocked(
-            inputs,
-            outputs,
-            lockedOutputs,
-            delegate,
-            msg.sender,
-            data
-        );
-    }
-
-    // move the ability to spend the locked UTXOs to the delegate account.
-    // The sender must be the current delegate.
-    //
-    // Setting the delegate to address(0) will unlock the UTXOs.
-    function delegateLock(
-        uint256[] memory utxos,
-        address delegate,
-        bytes calldata data
-    ) public {
-        for (uint256 i = 0; i < utxos.length; ++i) {
-            if (utxos[i] == 0) {
-                continue;
-            }
-            if (delegates[utxos[i]] != msg.sender) {
-                revert NotLockDelegate(utxos[i], delegate, msg.sender);
-            }
-            delegates[utxos[i]] = delegate;
-        }
-
-        emit LockDelegateChanged(utxos, msg.sender, delegate, data);
-    }
-
-    function locked(uint256 utxo) public view returns (bool, address) {
-        if (_lockedUtxos[utxo] == UTXOStatus.UNSPENT) {
-            return (true, delegates[utxo]);
-        }
-        return (false, address(0));
-    }
-}

package/contracts/lib/zeto_fungible_withdraw.sol

@@ -1,132 +0,0 @@
-// Copyright © 2024 Kaleido, Inc.
-//
-// SPDX-License-Identifier: Apache-2.0
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-pragma solidity ^0.8.27;
-
-import {Groth16Verifier_Deposit} from "../verifiers/verifier_deposit.sol";
-import {Groth16Verifier_Withdraw} from "../verifiers/verifier_withdraw.sol";
-import {Groth16Verifier_WithdrawBatch} from "../verifiers/verifier_withdraw_batch.sol";
-import {ZetoFungible} from "./zeto_fungible.sol";
-import {Commonlib} from "./common.sol";
-
-uint256 constant WITHDRAW_INPUT_SIZE = 4;
-uint256 constant BATCH_WITHDRAW_INPUT_SIZE = 12;
-
-/// @title A sample implementation of a base Zeto fungible token contract
-/// @author Kaleido, Inc.
-/// @dev Defines the verifier library for checking UTXOs against a claimed value.
-abstract contract ZetoFungibleWithdraw is ZetoFungible {
-    // nullifierVerifier library for checking nullifiers against a claimed value.
-    // this can be used in the optional withdraw calls to verify that the nullifiers
-    // match the withdrawn value
-    Groth16Verifier_Withdraw internal _withdrawVerifier;
-    Groth16Verifier_WithdrawBatch internal _batchWithdrawVerifier;
-
-    function __ZetoFungibleWithdraw_init(
-        Groth16Verifier_Deposit depositVerifier,
-        Groth16Verifier_Withdraw withdrawVerifier,
-        Groth16Verifier_WithdrawBatch batchWithdrawVerifier
-    ) public onlyInitializing {
-        __ZetoFungible_init(depositVerifier);
-        _withdrawVerifier = withdrawVerifier;
-        _batchWithdrawVerifier = batchWithdrawVerifier;
-    }
-
-    function constructPublicInputs(
-        uint256 amount,
-        uint256[] memory inputs,
-        uint256 output,
-        uint256 size
-    ) internal pure returns (uint256[] memory publicInputs) {
-        publicInputs = new uint256[](size);
-        uint256 piIndex = 0;
-
-        // copy output amount
-        publicInputs[piIndex++] = amount;
-
-        // copy input commitments
-        for (uint256 i = 0; i < inputs.length; i++) {
-            publicInputs[piIndex++] = inputs[i];
-        }
-
-        // copy output commitment
-        publicInputs[piIndex++] = output;
-
-        return publicInputs;
-    }
-
-    function _withdraw(
-        uint256 amount,
-        uint256[] memory inputs,
-        uint256 output,
-        Commonlib.Proof calldata proof
-    ) public virtual {
-        // Check the proof
-        if (inputs.length > 2) {
-            // Check if inputs or outputs exceed batchMax and revert with custom error if necessary
-            if (inputs.length > BATCH_WITHDRAW_INPUT_SIZE) {
-                revert WithdrawArrayTooLarge(BATCH_WITHDRAW_INPUT_SIZE);
-            }
-            uint256[] memory publicInputs = constructPublicInputs(
-                amount,
-                inputs,
-                output,
-                BATCH_WITHDRAW_INPUT_SIZE
-            );
-            // construct the public inputs for verifier
-            uint256[BATCH_WITHDRAW_INPUT_SIZE] memory fixedSizeInputs;
-            for (uint256 i = 0; i < fixedSizeInputs.length; i++) {
-                fixedSizeInputs[i] = publicInputs[i];
-            }
-            // Check the proof
-            require(
-                _batchWithdrawVerifier.verifyProof(
-                    proof.pA,
-                    proof.pB,
-                    proof.pC,
-                    fixedSizeInputs
-                ),
-                "Invalid proof"
-            );
-        } else {
-            uint256[] memory publicInputs = constructPublicInputs(
-                amount,
-                inputs,
-                output,
-                WITHDRAW_INPUT_SIZE
-            );
-            // construct the public inputs for verifier
-            uint256[WITHDRAW_INPUT_SIZE] memory fixedSizeInputs;
-            for (uint256 i = 0; i < fixedSizeInputs.length; i++) {
-                fixedSizeInputs[i] = publicInputs[i];
-            }
-            // Check the proof
-            require(
-                _withdrawVerifier.verifyProof(
-                    proof.pA,
-                    proof.pB,
-                    proof.pC,
-                    fixedSizeInputs
-                ),
-                "Invalid proof"
-            );
-        }
-
-        require(
-            _erc20.transfer(msg.sender, amount),
-            "Failed to transfer ERC20 tokens"
-        );
-    }
-}

package/contracts/lib/zeto_fungible_withdraw_nullifier.sol

@@ -1,144 +0,0 @@
-// Copyright © 2024 Kaleido, Inc.
-//
-// SPDX-License-Identifier: Apache-2.0
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-pragma solidity ^0.8.27;
-
-import {Groth16Verifier_Deposit} from "../verifiers/verifier_deposit.sol";
-import {Groth16Verifier_WithdrawNullifier} from "../verifiers/verifier_withdraw_nullifier.sol";
-import {Groth16Verifier_WithdrawNullifierBatch} from "../verifiers/verifier_withdraw_nullifier_batch.sol";
-import {ZetoFungible} from "./zeto_fungible.sol";
-import {Commonlib} from "./common.sol";
-
-uint256 constant WITHDRAW_INPUT_SIZE = 7;
-uint256 constant BATCH_WITHDRAW_INPUT_SIZE = 23;
-
-/// @title A sample implementation of a base Zeto fungible token contract
-/// @author Kaleido, Inc.
-/// @dev Defines the verifier library for checking UTXOs against a claimed value.
-abstract contract ZetoFungibleWithdrawWithNullifiers is ZetoFungible {
-    // nullifierVerifier library for checking nullifiers against a claimed value.
-    // this can be used in the optional withdraw calls to verify that the nullifiers
-    // match the withdrawn value
-    Groth16Verifier_WithdrawNullifier internal _withdrawVerifier;
-    Groth16Verifier_WithdrawNullifierBatch internal _batchWithdrawVerifier;
-
-    function __ZetoFungibleWithdrawWithNullifiers_init(
-        Groth16Verifier_Deposit depositVerifier,
-        Groth16Verifier_WithdrawNullifier withdrawVerifier,
-        Groth16Verifier_WithdrawNullifierBatch batchWithdrawVerifier
-    ) internal onlyInitializing {
-        __ZetoFungible_init(depositVerifier);
-        _withdrawVerifier = withdrawVerifier;
-        _batchWithdrawVerifier = batchWithdrawVerifier;
-    }
-
-    function constructPublicInputs(
-        uint256 amount,
-        uint256[] memory nullifiers,
-        uint256 output,
-        uint256 root,
-        uint256 size
-    ) internal pure returns (uint256[] memory publicInputs) {
-        publicInputs = new uint256[](size);
-        uint256 piIndex = 0;
-
-        // copy output amount
-        publicInputs[piIndex++] = amount;
-
-        // copy input commitments
-        for (uint256 i = 0; i < nullifiers.length; i++) {
-            publicInputs[piIndex++] = nullifiers[i];
-        }
-
-        // copy root
-        publicInputs[piIndex++] = root;
-
-        // populate enables
-        for (uint256 i = 0; i < nullifiers.length; i++) {
-            publicInputs[piIndex++] = (nullifiers[i] == 0) ? 0 : 1;
-        }
-
-        // copy output commitment
-        publicInputs[piIndex++] = output;
-
-        return publicInputs;
-    }
-
-    function _withdrawWithNullifiers(
-        uint256 amount,
-        uint256[] memory nullifiers,
-        uint256 output,
-        uint256 root,
-        Commonlib.Proof calldata proof
-    ) public virtual {
-        // Check the proof
-        if (nullifiers.length > 2) {
-            // Check if inputs or outputs exceed batchMax and revert with custom error if necessary
-            if (nullifiers.length > BATCH_WITHDRAW_INPUT_SIZE) {
-                revert WithdrawArrayTooLarge(BATCH_WITHDRAW_INPUT_SIZE);
-            }
-            uint256[] memory publicInputs = constructPublicInputs(
-                amount,
-                nullifiers,
-                output,
-                root,
-                BATCH_WITHDRAW_INPUT_SIZE
-            );
-            // construct the public inputs for verifier
-            uint256[BATCH_WITHDRAW_INPUT_SIZE] memory fixedSizeInputs;
-            for (uint256 i = 0; i < fixedSizeInputs.length; i++) {
-                fixedSizeInputs[i] = publicInputs[i];
-            }
-            // Check the proof
-            require(
-                _batchWithdrawVerifier.verifyProof(
-                    proof.pA,
-                    proof.pB,
-                    proof.pC,
-                    fixedSizeInputs
-                ),
-                "Invalid proof"
-            );
-        } else {
-            uint256[] memory publicInputs = constructPublicInputs(
-                amount,
-                nullifiers,
-                output,
-                root,
-                WITHDRAW_INPUT_SIZE
-            );
-            // construct the public inputs for verifier
-            uint256[WITHDRAW_INPUT_SIZE] memory fixedSizeInputs;
-            for (uint256 i = 0; i < fixedSizeInputs.length; i++) {
-                fixedSizeInputs[i] = publicInputs[i];
-            }
-            // Check the proof
-            require(
-                _withdrawVerifier.verifyProof(
-                    proof.pA,
-                    proof.pB,
-                    proof.pC,
-                    fixedSizeInputs
-                ),
-                "Invalid proof"
-            );
-        }
-
-        require(
-            _erc20.transfer(msg.sender, amount),
-            "Failed to transfer ERC20 tokens"
-        );
-    }
-}