Module "cToken"

Index

Functions

Functions

borrow

borrow(asset: string, amount: any, options?: any): Promise<any>

- Defined in cToken.ts:224
Borrows an Ethereum asset from the Compound Protocol for the user. The user's address must first have supplied collateral and entered a corresponding market.
example
```
const compound = new Compound(window.ethereum);

(async function() {

  const daiScaledUp = '32000000000000000000';
  const trxOptions = { mantissa: true };

  console.log('Borrowing 32 Dai...');
  const trx = await compound.borrow(Compound.DAI, daiScaledUp, trxOptions);

  console.log('Ethers.js transaction object', trx);

})().catch(console.error);
```
Parameters
- asset: string
  
  A string of the asset to borrow (must be a supported underlying asset).
- amount: any
  
  A string, number, or BigNumber object of the amount of an asset to borrow. Use the mantissa boolean in the options parameter to indicate if this value is scaled up (so there are no decimals) or in its natural scale.
- Default value options: any = {}
Returns Promise<any>

Returns an Ethers.js transaction object of the borrow transaction.

redeem

redeem(asset: string, amount: any, options?: any): Promise<any>

- Defined in cToken.ts:144
Redeems the user's Ethereum asset from the Compound Protocol.
example
```
const compound = new Compound(window.ethereum);

(async function() {

  console.log('Redeeming ETH...');
  const trx = await compound.redeem(Compound.ETH, 1); // also accepts cToken args
  console.log('Ethers.js transaction object', trx);

})().catch(console.error);
```
Parameters
- asset: string
  
  A string of the asset to redeem, or its cToken name.
- amount: any
  
  A string, number, or BigNumber object of the amount of an asset to redeem. Use the mantissa boolean in the options parameter to indicate if this value is scaled up (so there are no decimals) or in its natural scale. This can be an amount of cTokens or underlying asset (use the asset parameter to specify).
- Default value options: any = {}
Returns Promise<any>

Returns an Ethers.js transaction object of the redeem transaction.

repayBorrow

repayBorrow(asset: string, amount: any, borrower: string, options?: any): Promise<any>

- Defined in cToken.ts:292
Repays a borrowed Ethereum asset for the user or on behalf of another Ethereum address.
example
```
const compound = new Compound(window.ethereum);

(async function() {

  console.log('Repaying Dai borrow...');
  const address = null; // set this to any address to repayBorrowBehalf
  const trx = await compound.repayBorrow(Compound.DAI, 32, address);

  console.log('Ethers.js transaction object', trx);

})().catch(console.error);
```
Parameters
- asset: string
  
  A string of the asset that was borrowed (must be a supported underlying asset).
- amount: any
  
  A string, number, or BigNumber object of the amount of an asset to borrow. Use the mantissa boolean in the options parameter to indicate if this value is scaled up (so there are no decimals) or in its natural scale.
- borrower: string
- Default value options: any = {}
Returns Promise<any>

Returns an Ethers.js transaction object of the repayBorrow or repayBorrowBehalf transaction.

supply

supply(asset: string, amount: any, noApprove?: boolean, options?: any): Promise<any>

- Defined in cToken.ts:46
Supplies the user's Ethereum asset to the Compound Protocol.
example
```
const compound = new Compound(window.ethereum);

// Ethers.js overrides are an optional 3rd parameter for `supply`
// const trxOptions = { gasLimit: 250000, mantissa: false };

(async function() {

  console.log('Supplying ETH to the Compound Protocol...');
  const trx = await compound.supply(Compound.ETH, 1);
  console.log('Ethers.js transaction object', trx);

})().catch(console.error);
```
Parameters
- asset: string
  
  A string of the asset to supply.
- amount: any
  
  A string, number, or BigNumber object of the amount of an asset to supply. Use the mantissa boolean in the options parameter to indicate if this value is scaled up (so there are no decimals) or in its natural scale.
- Default value noApprove: boolean = false
  
  Explicitly prevent this method from attempting an ERC-20 approve transaction prior to sending the mint transaction.
- Default value options: any = {}
Returns Promise<any>

Returns an Ethers.js transaction object of the supply transaction.