Quickstart
Last updated
Was this helpful?
Last updated
Was this helpful?
This guide will help you explore the basics of interacting with the COTI network and executing transactions with encrypted inputs. To get started, choose your path (, or ) and follow the steps listed below.
Clone the repository
Navigate to the newly cloned repository directory
Install dependencies
Compile contracts
Run the PrivateToken test script
Running this test will automatically create an account and a key/value pair with name: SIGNING_KEYS
(visible in the .env file). The script will output something like this:
It is normal to encounter exception of:
Error: Created new random account [...] Please use faucet to fund it.
on the first run, This will be resolved once the account is funded.
To fund the account, head to the faucet at to get Testnet funds.
(use to join COTI's Discord server)
Send the following message to the faucet along with your newly created account, visible in the last part of the error above.
format:
testnet <account address>
for example:
testnet
0x17EDB982c3569D29EbaF407F72aDD05722d5f179
The bot will reply with the message:
<username> faucet transferred 10 COTI (testnet)
Run the PrivateToken
test suite once more.
The script output will look like this:
Running the test suite does the following:
Deploys the PrivateToken
contract: Sets up the token with specific details (name, symbol, initial supply).
Tests the deployment: Verifies the contract address, initial balance, and token details (name, symbol, decimals, total supply).
Tests transfers: Both clear and confidential transfers, including transferFrom
functionality with and without prior allowance.
Tests approvals and allowances: Ensures that the contract correctly handles approvals and allowances, both clear and confidential.
You may also run specific tests:
or
or
or
or
Install dependencies
Run the PrivateToken
example
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:
It is normal to receive the exception Error: Please use faucet to fund account
on the first run. This will be resolved once the account is funded.
Run the PrivateToken
script once more
You may also run other scripts:
or
or
Install dependencies
Set the python path as following
Run the native_transfer.py
script
Running the script will automatically create an account and a key/value pair with name: ACCOUNT_PRIVATE_KEY
(visible in the .env
file). The script will output something like this:
It is normal to receive the exception Not enough balance!
on the first run. This will be resolved once the account is funded.
Run the native_transfer.py
script once more
The script will output as following:
Run the onboard_account.py
script
You may also run other scripts:
or
Clone the repository
Navigate to the examples subdirectory in the newly cloned repository directory
To fund the account, head to the faucet at to get Testnet funds. (use to join COTI's Discord server)
Send the following message to the faucet along with your newly created account, visible in the last part of the error above.
format:
testnet <account address>
for example:
testnet 0x87c13D0f5903a68bE8288E52b23A220CeC6b1aB6
The bot will reply with the message
<username> faucet transferred 10 COTI (testnet)
Clone the repository
Navigate to the examples subdirectory in the newly cloned repository directory
To fund the account, head to the faucet at to get Testnet funds. (use to join COTI's Discord server)
Send the following message to the faucet along with your newly created account, visible in the last part of the error above.
format:
testnet <account address>
for example:
testnet 0x87c13D0f5903a68bE8288E52b23A220CeC6b1aB6
The bot will reply with the message
<username> faucet transferred 10 COTI (testnet)