@coti-io/coti-contracts 0.1.0 → 1.0.2

package/.github/workflows/npm-publish.yml

@@ -43,8 +43,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           registry-url: https://registry.npmjs.org/
+          scope: '@coti-io'
       - run: npm ci
       - run: npm publish --access=public
         env:

package/CONTRIBUTING.md

@@ -1,7 +1,7 @@
 
-# Contributing to COTI SDK TypeScript Examples
+# Contributing to COTI Contracts
 
-Thank you for your interest in contributing to the COTI SDK TypeScript Examples project! We welcome contributions from the community and appreciate your efforts to improve our project.
+Thank you for your interest in contributing to the COTI Contracts project! We welcome contributions from the community and appreciate your efforts to improve our project.
 
 ## Table of Contents
 

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2024 COTI
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -1,48 +1,31 @@
-# COTI Contracts
-
-A library for smart contract development on the COTI network.
-
-> [!NOTE]
-> This repository is meant to replace the now-deprecated [confidentiality-contracts](https://github.com/coti-io/confidentiality-contracts) repository.
-
-#### Important Links
-
-[Docs](https://docs.coti.io) | [Discord](https://discord.gg/cuCykh8P4m) | [Faucet](https://faucet.coti.io)
-
-#### Network-Specific Links
+[![image](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://telegram.coti.io)
+[![image](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.coti.io)
+[![image](https://img.shields.io/badge/X-000000?style=for-the-badge&logo=x&logoColor=white)](https://twitter.coti.io)
+[![image](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://youtube.coti.io)
 
-[Devnet Explorer](https://explorer-devnet.coti.io) | [Testnet Explorer](https://testnet.cotiscan.io)
+# COTI Contracts
 
-## Overview
+[![image](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)](https://www.npmjs.com/package/@coti-io/coti-contracts)
+[![image](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)](https://nodejs.org/download/release/v18.20.5/)
 
-> [!NOTE]  
-> Due to the nature of ongoing development, future versions might break existing functionality
+Welcome to COTI Contracts, a library of smart contracts for COTI's GC technology, including MPC contract for secure computations, private ERC20 and ERC721 contracts, and test mocks for validation. These components enable privacy-focused and decentralized DeFi solutions.
 
-The following contracts are included in the library:
-- [DataPrivacyFramework](/contracts/access/DataPrivacyFramework/)
-- [AccountOnboard](/contracts/onboard/)
-- [PrivateERC20](/contracts/token/PrivateERC20/)
-- [PrivateERC721](/contracts/token/PrivateERC721/)
-- [MpcCore](/contracts/utils/mpc/)
+## Documentation
 
-### Installation
+Full API documentation is available in the [COTI docs](https://docs.coti.io/coti-v2-documentation/build-on-coti/tools/ethers.js)
 
-#### Hardhat (npm)
+## Build and Install
 
 ```bash
-npm install @coti-io/coti-contracts
+npm install
 ```
 
-### Usage
-
-Once installed, you can use the contracts in the library by importing them:
+## Testing
 
-```solidity
-pragma solidity ^0.8.20;
+```bash
+npx hardhat test
+```
 
-import {PrivateERC20} from "@coti-io/coti-contracts/token/PrivateERC20/PrivateERC20.sol";
+---
 
-contract MyToken is PrivateERC20 {
-    constructor() ERC721("MyToken", "MTOK") {}
-}
-```
+To report an issue, please see the [issues](https://github.com/coti-io/coti-contracts/issues/new) tab.

package/contracts/access/DataPrivacyFramework/extensions/DataPrivacyFrameworkMpc.sol

@@ -48,7 +48,7 @@ abstract contract DataPrivacyFrameworkMpc is DataPrivacyFramework {
     )
         internal
         onlyAllowedUserOperation("op_mul", uintParameter, addressParameter, stringParameter)
-        returns (gtUint16)
+        returns (gtUint8)
     {
         return MpcCore.mul(a, b);
     }
@@ -123,34 +123,6 @@ abstract contract DataPrivacyFrameworkMpc is DataPrivacyFramework {
         return MpcCore.xor(a, b);
     }
 
-    function shl(
-        gtUint8 a,
-        gtUint8 b,
-        uint256 uintParameter,
-        address addressParameter,
-        string calldata stringParameter
-    )
-        internal
-        onlyAllowedUserOperation("op_shl", uintParameter, addressParameter, stringParameter)
-        returns (gtUint8)
-    {
-        return MpcCore.shl(a, b);
-    }
-
-    function shr(
-        gtUint8 a,
-        gtUint8 b,
-        uint256 uintParameter,
-        address addressParameter,
-        string calldata stringParameter
-    )
-        internal
-        onlyAllowedUserOperation("op_shr", uintParameter, addressParameter, stringParameter)
-        returns (gtUint8)
-    {
-        return MpcCore.shr(a, b);
-    }
-
     function eq(
         gtUint8 a,
         gtUint8 b,
@@ -330,7 +302,7 @@ abstract contract DataPrivacyFrameworkMpc is DataPrivacyFramework {
     )
         internal
         onlyAllowedUserOperation("op_mul", uintParameter, addressParameter, stringParameter)
-        returns (gtUint32)
+        returns (gtUint16)
     {
         return MpcCore.mul(a, b);
     }
@@ -405,34 +377,6 @@ abstract contract DataPrivacyFrameworkMpc is DataPrivacyFramework {
         return MpcCore.xor(a, b);
     }
 
-    function shl(
-        gtUint16 a,
-        gtUint16 b,
-        uint256 uintParameter,
-        address addressParameter,
-        string calldata stringParameter
-    )
-        internal
-        onlyAllowedUserOperation("op_shl", uintParameter, addressParameter, stringParameter)
-        returns (gtUint16)
-    {
-        return MpcCore.shl(a, b);
-    }
-
-    function shr(
-        gtUint16 a,
-        gtUint16 b,
-        uint256 uintParameter,
-        address addressParameter,
-        string calldata stringParameter
-    )
-        internal
-        onlyAllowedUserOperation("op_shr", uintParameter, addressParameter, stringParameter)
-        returns (gtUint16)
-    {
-        return MpcCore.shr(a, b);
-    }
-
     function eq(
         gtUint16 a,
         gtUint16 b,
@@ -612,7 +556,7 @@ abstract contract DataPrivacyFrameworkMpc is DataPrivacyFramework {
     )
         internal
         onlyAllowedUserOperation("op_mul", uintParameter, addressParameter, stringParameter)
-        returns (gtUint64)
+        returns (gtUint32)
     {
         return MpcCore.mul(a, b);
     }
@@ -687,34 +631,6 @@ abstract contract DataPrivacyFrameworkMpc is DataPrivacyFramework {
         return MpcCore.xor(a, b);
     }
 
-    function shl(
-        gtUint32 a,
-        gtUint32 b,
-        uint256 uintParameter,
-        address addressParameter,
-        string calldata stringParameter
-    )
-        internal
-        onlyAllowedUserOperation("op_shl", uintParameter, addressParameter, stringParameter)
-        returns (gtUint32)
-    {
-        return MpcCore.shl(a, b);
-    }
-
-    function shr(
-        gtUint32 a,
-        gtUint32 b,
-        uint256 uintParameter,
-        address addressParameter,
-        string calldata stringParameter
-    )
-        internal
-        onlyAllowedUserOperation("op_shr", uintParameter, addressParameter, stringParameter)
-        returns (gtUint32)
-    {
-        return MpcCore.shr(a, b);
-    }
-
     function eq(
         gtUint32 a,
         gtUint32 b,
@@ -969,34 +885,6 @@ abstract contract DataPrivacyFrameworkMpc is DataPrivacyFramework {
         return MpcCore.xor(a, b);
     }
 
-    function shl(
-        gtUint64 a,
-        gtUint64 b,
-        uint256 uintParameter,
-        address addressParameter,
-        string calldata stringParameter
-    )
-        internal
-        onlyAllowedUserOperation("op_shl", uintParameter, addressParameter, stringParameter)
-        returns (gtUint64)
-    {
-        return MpcCore.shl(a, b);
-    }
-
-    function shr(
-        gtUint64 a,
-        gtUint64 b,
-        uint256 uintParameter,
-        address addressParameter,
-        string calldata stringParameter
-    )
-        internal
-        onlyAllowedUserOperation("op_shr", uintParameter, addressParameter, stringParameter)
-        returns (gtUint64)
-    {
-        return MpcCore.shr(a, b);
-    }
-
     function eq(
         gtUint64 a,
         gtUint64 b,

package/contracts/mocks/README.md

@@ -1,5 +1,5 @@
 ## Disclaimer
 
-The Solidity contracts in **the mocks folder** are provided **for testing purposes only**. They are not intended for use in production environments and should not be deployed without thorough review and auditing.
+The Solidity contracts in **the mocks folder** are provided **for testing purposes only**, however they may provide useful examples of calling functions from the MPC Core. They are not intended for use in production environments and should not be deployed without thorough review and auditing.
 
 For additional examples, please refer to the [coti-contracts-examples repository](https://github.com/coti-io/coti-contracts-examples).