All repositories specified below contain smart contracts that implement confidentiality features using the COTI V2 protocol. The contracts provide examples for various use cases, such as Non-Fungible Tokens (NFTs), ERC20 tokens, Auction, and Identity management.
These contracts demonstrate how to leverage the confidentiality features of the COTI V2 protocol to enhance privacy and security in decentralized applications. The contracts are of Solidity and can be compiled and deployed using popular development tools like Hardhat and Foundry (Work in progress).
Docs | Devnet Explorer | Discord | Faucet
Interact with the network using any of the following:
The following contracts are available in each of the packages:
Contract | python sdk | hardhat sdk | typescript sdk | Contract Description | |
---|---|---|---|---|---|
AccountOnboard |
deployment | ✅ * | ✅ | ❌ | Onboard a EOA account - During onboard network creates AES unique for that EOA which is used for decrypting values sent back from the network |
AccountOnboard |
execution | ✅ | ✅ | ✅ | " |
ERC20Example |
deployment | ✅ | ✅ | ❌ | Confidential ERC20 - deploy and transfer encrypted amount of funds |
ERC20Example |
execution | ✅ | ✅ | ✅ | " |
NFTExample |
deployment | ❌ | ✅ | ❌ | Confidential NFT example - saving encrypted data |
NFTExample |
execution | ❌ | ✅ | ❌ | " |
ConfidentialAuction |
deployment | ❌ | ✅ | ❌ | Confidential auction - encrypted bid amount |
ConfidentialAuction |
execution | ❌ | ✅ | ❌ | " |
ConfidentialIdentityRegistry |
deployment | ❌ | ✅ | ❌ | Confidential Identity Registry - Encrypted identity data |
ConfidentialIdentityRegistry |
execution | ❌ | ✅ | ❌ | " |
DataOnChain |
deployment | ✅ | ❌ | ❌ | Basic encryption and decryption - Good place to start explorining network capabilties |
DataOnChain |
execution | ✅ | ❌ | ✅ | " |
Precompile |
deployment | ✅ | ✅ | ❌ | Thorough examples of the precompile functionality |
Precompile |
execution | ✅ | ✅ | ❌ | " |
(*) no deployment needed (system contract)
Note
Due to the nature of ongoing development, future version might break existing functionality
🤖 To request devnet/testnet funds use our faucet
Examples that described above resides in [coti-sdk-typescript/src/examples], the solidity contracts are in the confidentiality-contracts repo that is imported as a git submodule.
The following examples are available for execution:
Contract | Contract Description |
---|---|
AccountOnboard | Onboard a EOA account - During onboard network creates AES unique for that EOA which is used for decrypting values sent back from the network |
ERC20Example | Confidential ERC20 - deploy and transfer encrypted amount of funds |
DataOnChain | Basic encryption and decryption - Good place to start explorining network capabilties |
The following process will help you run the erc20.ts
example from the COTI Typescript SDK Examples project. The script includes functions for transferring tokens, approving allowances, and handling confidential transactions. The script uses various utilities from the SDK to manage confidential accounts, decrypt values, and ensure correct balances and allowances during transactions. It will also:
- Create a EOA (Externally Owned Account)
- Validate minimum balance
Note
Ensure your environment meets all the pre-requisites. Visit the pre-requisites section of the readme.
-
Clone the Typescript examples repo along with its submodules into your desired location
git clone --recurse-submodules [email protected]:coti-io/coti-sdk-typescript-examples.git
-
Change directory to the newly create one
cd coti-sdk-typescript-examples
-
Install dependencies
yarn
-
Run
erc20.ts
scriptyarn erc20
Running this test will automatically create an account and a key/value pair with name:SIGNING_KEY
(visible in the .env file). The script will output something like this:\yarn run v1.22.22 $ ts-node src/main.ts erc20 ************* Created new account 0x87c13D0f5903a68bE8288E52b23A220CeC6b1aB6 and saved into .env file ************* /Users/user/projects/coti-sdk-typescript-examples/src/util/onboard.ts:13 throw new Error(`Please use faucet to fund account ${wallet.address}`) ^ Error: Please use faucet to fund account 0x87c13D0f5903a68bE8288E52b23A220CeC6b1aB6
It is normal to receive the exceptionError: Please use faucet to fund account
on the first run. This will be resolved once the account is funded. -
Head to the faucet at https://faucet.coti.io to get devnet funds.
Send the following message to the BOT using your newly created account, visible in the fourth line of the responseCreated new account 0x87c13D0f5903a68bE8288E52b23A220CeC6b1aB6 [...]
devnet <account address>
The bot will reply with the message:
<username> faucet transferred 5 COTIv2 (devnet)
-
Run
erc20.ts
script once moreyarn erc20
- Extending examples such as confidential ERC20 minting, confidential NFT (deployment and actions) and more.