tropykus Protocol

tropykus is an algorithmic distributed protocol deployed on the RSK network. As such, it's main motivation is to allow users to lend crypto currencies as collateral and to borrow crypto assets based on interest rates set by real-time supply and demand smart contracts. The tropykus Protocol is developed using RSK smart contracts for supplying or borrowing assets. Through the cToken contracts, accounts on the blockchain supply capital (rBTC or ERC-20 tokens) to receive cTokens or borrow assets from the protocol (holding other assets as collateral). The tropykus cToken contracts track these balances and algorithmically set interest rates for borrowers.

You can read the protocol documentation at tropykus.app

Contracts

We detail a few of the core contracts in the tropykus protocol.

CToken, CErc20 and CRBTC

The tropykus cTokens, which are self-contained borrowing and lending contracts. CToken contains the core logic and CErc20 and CRBTC add public interfaces for Erc20 tokens and rBTC, respectively. Each CToken is assigned an interest rate and risk model (see InterestRateModel and Comptroller sections), and allows accounts to *mint* (supply capital), *redeem* (withdraw capital), *borrow* and *repay a borrow*. Each CToken is an ERC-20 compliant token where balances represent ownership of the market.

Price Oracle Proxy

This contract controlls the adapters that link the protocol with price oracles.

Comptroller

The risk model contract, which validates permissible user actions and disallows actions if they do not fit certain risk parameters. For instance, the Comptroller enforces that each borrowing user must maintain a sufficient collateral balance across all cTokens.

TROP

The tropykus Governance Token (TROP). Holders of this token have the ability to govern the protocol via the governor contract.

Governor Alpha

The administrator of the tropykus timelock contract. Holders of TROP token may create and vote on proposals which will be queued into the tropykus timelock and then have effects on tropykus cToken and Copmtroller contracts. This contract may be replaced in the future with a beta version.

InterestRateModel

Contracts which define interest rate models. These models algorithmically determine interest rates based on the current utilization of a given market (that is, how much of the supplied assets are liquid versus borrowed).

Careful Math

Library for safe math operations.

ErrorReporter

Library for tracking error codes and failure conditions.

Exponential

Library for handling fixed-point decimal numbers.

SafeToken

Library for safely handling Erc20 interaction.

Deployed Networks

Contract	Mainnet	Testnet
Unitroller (Comptroller Proxy)	0x57f3edae1d2a109f0d5e4e6269aca2f532cdbaaa	0x3a983c7597b3ac4fbc3e0cf484d7631d70d04c05
cRIF	0xb7ff2c56c897562c0aa6747d2679d35f5e937492	0x4664d4cbd5104a0e974354724cbc8e0d9bd1aca3
cRBTC	0x872664a885a1995d754e3666a23fad5c801401c4	0xc19f0882bf318c9f8767c7d520018888e878417b
crUSDT	0xd256c121a507cadd2687599e27fa45e31b7c3199	0xfd09f3349fdab173d162cd0e4669b591ed5a78fb

Installation

To run tropykus, pull the repository from GitHub and install its dependencies. You will need yarn or npm installed.

git clone https://github.com/TruStartUp/tropykus-protocol
cd tropykus-protocol
yarn install --lock-file # or `npm install`

REPL

The tropykus Protocol has a simple scenario evaluation tool to test and evaluate scenarios which could occur on the blockchain. We inherited this feature from the original source code and this is primarily used for constructing high-level integration tests. The tool also has a REPL to interact with local the tropykus Protocol (similar to truffle console).

yarn repl -n development
yarn repl -n rinkeby

> Read CToken cBAT Address
Command: Read CToken cBAT Address
AddressV<val=0xAD53863b864AE703D31b819d29c14cDA93D7c6a6>

You can read more about the scenario runner in the Scenario Docs on steps for using the repl.

Testing

Jest contract tests are defined under the tests directory. To run the tests run:

yarn test

Integration Specs

There are additional tests under the spec/scenario folder. These are high-level integration tests based on the scenario runner depicted above. The aim of these tests is to be highly literate and have high coverage in the interaction of contracts.

Code Coverage

To run code coverage, run:

yarn coverage

Linting

To lint the code, run:

yarn lint

Note for Developers: Prerequisites 📋

tropykus initially developed and tested on:

• Operating system: macOS, debian 10 (buster), ubuntu LTS.

• RSK-node

• Node.js(LTS 12)

• npm (optional)

• yarn

• make, g++

• ganache-cli (optional)

• ganache

• solc

• sol-select(optional)

• node-gyp(optional)

• [direnv] (https://direnv.net/)

g++

#ubuntu/debian
sudo apt install g++

make

#ubuntu/debian
sudo apt-get install make

Recomend 🤓

Recomend for GNU SO. Install build-essential package and node-gyp.

#ubuntu/debian
sudo apt-get install build-essential
npm install -g node-gyp

Also recommend seting git pull to default rebase mode.

#ubuntu/debian
git config --global pull.rebase true

Deployment

To deploy the contracts we use buidler.

Copy the .envrc.example and rename it to .envrc, change the mnemonic, then usedirenv allow on this dirally rectory. Finally run yarn deploy [networkName] to deploy to the selected network

Debugging 🔩

Debug in local ganache-cli with VS Code

#run ganache-cli in a terminal
ganache-cli --gasLimit 20000000 --gasPrice 20000 --defaultBalanceEther 1000000000 --allowUnlimitedContractSize true -v -k "istanbul"

Configure launch.json (VS Code).

In .buil/launch.json (create if is necesary) add the follow:

{
"version": "0.2.0",
"configurations": [
    {
        "name": "dev",
        "request": "launch",
        "type": "node",
        "runtimeExecutable": "/usr/bin/npx",
        "program": "saddle",
        "args": [
          "test",
        ],
    },
]
}

Security and Liability

All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE