Tropykus finance 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 kTokens. Accounts may also do the reverse, and borrow assets from the protocol, using other assets as collateral.
The Tropykus cToken contracts (CRBTC, CERC20Immutable and CRDOC) track these balances, and algorithmically set interest rates for borrowers. This process is described in greater detail, in the Tropykus Whitepaper.
@tropykus-finance/tropykus npm package enables developers to interact with a deployed instance of Tropykus smart contracts by simply importing it as a dependency.
$ npm init
$ npm install @babel/runtime
$ npm install @tropykus-finance/tropykusconst Tropykus = require('@tropykus-finance/tropykus');
const tropykus = new Tropykus('https://public-node.testnet.rsk.co', 400000);
tropykus.setComptroller('0xd8f5366b7bbe1275336fc3b929646104379e1d7d');
tropykus.comptroller.allMarkets()
.then(console.log)
.catch(console.error);To add an account to the Tropykus protocol in order to use it as a signer account for the transactions simply use the setAccount function:
const mnemonic = ${your_account_mnemonic};
const derivationPath = `m/44'/60'/0'/0/0`;
tropykus.setAccount(mnemonic, derivationPath);Note: For more information about derivation paths check Derivation Paths, How HD wallets derive keys.
In this case we are using m/44'/60'/0'/0/0 derivation path for BIP 44 schema and Ethereum Network
For Account Based RSK Addresses use:
RSK Mainnet: m/44'/137'/0'/0/N RSK Testnet: m/44'/37310'/0'/0/N
The correct account assignation can be validated with the tropykus.account.address property
console.log(tropykus.account.address);In order to deposit cryptos into tropykus markets is necesary to have the instance of the specific market, for that use the tropykus.addMarket().
tropykus.addMarket(artifact, deployed, marketAddress, erc20TokenAddress, args);- artifact: string specifying the artifact to use for the contract instance
- deployed: boolean flag to indicate if the contract is already deployed
- marketAddress: on chain deployed market address.
- erc20TokenAddress: on chain deployed erc20 token address.
- args: additional args to initialize market
By default
deployed = true,
marketAddress = null,
erc20TokenAddress = null,
args = {
comptrollerAddress: '',
interestRateModelAddress: '',
initialExchangeRate: 0.02,
name: '',
symbol: '',
decimals: 0,
}
For cRBTC:
const crbtc = await tropykus.addMarket('CRBTC', true, crbtcMarketAddress);For cTokens (cDOC, cRIF, cUSDT):
const cdoc = await tropykus.addMarket('CErc20Immutable', true, cdocAddress, docAddress);For cRDOC:
const crdoc = await tropykus.addMarket('CRDOC', true, rcdocAddress, rdocAddress);Then mint function can be called using the assigned tropykus account to sign the transaction
const tx = await crbtc.mint(account, value);- account: Object signer to sign the transaction, it could be the value get from
tropykus.account - value: numeric value to be minted into the market
Wait for mint result:
Once the mint function is excecuted a promise with the transaction is ruturned. Then it is posible wait for the transaction result using the wait() method, e.g.
tx.wait();To request for the account balance the function market.balanceofUnderlying() can be used.
const balance = await crbtc.balanceOfUnderlying(tropykus.account);In order to ask for a borrow in a market first there has to be a deposit so there is collateral. Once there is a deposit the borrow() function can be used:
await crbtc.borrow(account, value);- account: Object signer to sign the transaction, it could be the value get from
tropykus.account - value: numeric value to be borrowed from the market
Note: The borrow function does not change between markets like the mint does. Borrow can be used from any market just like the example from crbtc.
To request for the account borrowed balance the function market.borrowBalanceCurrent() can be used.
const borrowedBalance = await crbtc.borrowBalanceCurrent(tropykus.account);In order to redeem from a market after having deposited in the first place the redeem() function is used:
await crbtc.redeem(account, value);- account: Object signer to sign the transaction, it could be the value get from
tropykus.account - value: numeric value to be redeemed from the market
Note: Similarly to the borrow function, redeem() can be used equally from any market
const cdoc = await tropykus.addMarket('CDOC', true, rcdocAddress, rdocAddress);
// It's necesary have founds in the market to be able to redeem
await cdoc.mint(tropykus.account, depositValue);
// Then it is possible to redeem a different value
await cdoc.redeem(tropykus.account, redeemValue);
To redeem all founds deposited in the market the function can be called as follows:
await cdoc.redeem(tropykus.account, 0, true);The third paramether is a flag that indicated to the method if all founds must be redeemed
In order to repay in a market after having borrowed in the first place the repayBorrow() function is used:
const crif = await tropykus.addMarket('CErc20Immutable', true, cRifAddress, rifAddress);
await crif.repayBorrow(account, repayValue);
- account: Object signer to sign the transaction, it could be the value get from
tropykus.account - repayValue: numeric value to be paid in the market
To repay all debt in the market the function can be called as follows:
await crif.repayBorrow(tropykus.account, 0, true);
const borrowBalance = await crif.borrowBalanceCurrent(tropykus.account);
console.log('borrowBalance', borrowBalance) // 0;The third parameter is a flag that indicates the method that must pay all the debt.
| Artifact | Address | |
|---|---|---|
| Price Oracle | PriceOracleProxy | 0x1bdf453f72a8466ba3709b091b7658edfc550c23 |
| tRIF Token | StandardToken | 0xc370cd19517b5a8a9f6df0958679e8cd4874c048 |
| tDOC Token | StandardToken | 0x494154243ac77c6ab90dfa0d4d42dd411e1df5f3 |
| trDOC Token | StandardToken | 0xc486ac998afbf1b477533dda94d950bd2190ceb5 |
| tUSDT Token | StandardToken | 0xcf5137f039578cb10070b91bb30fd3d260bcddde |
| RIF Interest Rate Model | WhitePaperInterestRateModel | 0x41cbfa04ac7bad4e702fad9c92064cf503964f3a |
| DOC Interest Rate Model | JumpRateModelV2 | 0xe8cf23e02ffb01b7f7221025e7af0ec56fa6df88 |
| rDOC Interest Rate Model | JumpRateModelV2 | 0x385d059f3dd3dc36addd1918a75fb84d758c3f69 |
| USDT Interest Rate Model | JumpRateModelV2 | 0x01ffd800f0d5af18b7847e52d9bdcfed81bb8f28 |
| RBTC Interest Rate Model | WhitePaperInterestRateModel | 0x4c9e251ce7073ce1a62d696800ed07f67eace2d5 |
| RBTC micro(kSAT) Interest Rate Model | HurricaneInterestRateModel | 0xd22de9a3f9d87e6bf58783e44b5453b3deacb0fe |
| kRIF | CErc20Immutable | 0xd22de9a3f9d87e6bf58783e44b5453b3deacb0fe |
| kDOC | CErc20Immutable | 0xe7b4770af8152fc1a0e13d08e70a8c9a70f4d9d9 |
| kRDOC | CRDOC | 0x0981eb51a91e6f89063c963438cadf16c2e44962 |
| kUSDT | CErc20Immutable | 0x495be6b6d8f35748bb8fe657f884f84342043733 |
| kRBTC | CRBTC | 0x636b2c156d09cee9516f9afec7a4605e1f43dec1 |
| kSAT | CRBTC | 0xf2250c3d8e81a562f55e4a207c218d50c62db087 |
| Comptroller | ComptrollerG6 | 0x7de1ade0c4482ceab96faff408cc9dcc9015b448 |