Skip to main content

cCFX Contract

The cCFX contract is the core of PHX v2, which allows users to stake CFX and earn rewards through PoS. It also functions as a standard ERC-20 contract. Its address is: 0xa11ad495c3bf53c19368313a894ba49bc26e7f92

It extends the following methods on the basis of ERC20 to realize the function of depositing CFX and participating in PoS to obtain income.

  1. deposit: deposit CFX
  2. redeem: initiate a redemption request for CFX.
  3. withdraw: withdraw CFX back(after redemption is completed)
  4. cfxRatio: exchange rate between CFX and cCFX
  5. userRedeemedAssets: CFX amount in user redemption
  6. userWithdrawableAssets: CFX amount that can be withdrawn after redemption is completed

The overall operation process is:: deposit -> redeem -> withdraw

Core Methods​

deposit​

function deposit() external;

By calling this method and setting the transaction's value to deposit CFX, CFX will be converted to cCFX proportionally and distributed to the user. cCFX represents the user's share in the entire PoS pool and is also the certificate for the user to redeem CFX. There are no restrictions on the amount of CFX that can be deposited.

redeem​

function redeem(uint256 shares) external;

To redeem CFX, you need to initiate a request using the redeem method. This method requires one parameter called shares, which specifies the number of cCFX to be redeemed. The method will destroy the user's cCFX and add their redemption request to the redemption queue.

userRedeemedAssets​

function userRedeemedAssets(address user) external view returns (uint256);

This method is used to query the amount of CFX in redemption for users, that is, the amount of CFX that has been requested for redemption but has not yet been redeemed by the user.

After the user initiates a redemption request, if the amount is small, it can be completed within a few minutes and can be withdrawn immediately after completion. In most cases (80%), the redemption time will be completed within 1 day. In extreme cases (when the redemption amount is relatively large), it may take several days.

userWithdrawableAssets​

function userWithdrawableAssets(address user) external view returns (uint256);

This method is used to query the amount of CFX that can be withdrawn by the user after completing the redemption.

withdraw​

function withdraw(uint256 amount) external;

Call this method to extract the redeemed CFX from the completion and transfer it to the personal account.

Complete Contract ABI​

Below is the complete ABI of the cCFX contract, can be used in ethers.js:

[
  "event Approval(address indexed,address indexed,uint256)",
  "event Deposit(address indexed,uint256,uint256)",
  "event Redeem(address indexed,uint256,uint256)",
  "event Transfer(address indexed,address indexed,uint256)",
  "event Withdraw(address indexed,uint256)",
  "function allowance(address,address) view returns (uint256)",
  "function approve(address,uint256) returns (bool)",
  "function balanceOf(address) view returns (uint256)",
  "function cfxRatio() view returns (uint256)",
  "function decimals() view returns (uint8)",
  "function decreaseAllowance(address,uint256) returns (bool)",
  "function deposit() payable",
  "function increaseAllowance(address,uint256) returns (bool)",
  "function name() view returns (string)",
  "function redeem(uint256)",
  "function supportsInterface(bytes4) view returns (bool)",
  "function symbol() view returns (string)",
  "function totalAssets() view returns (uint256)",
  "function totalRedeemedAssets() view returns (uint256)",
  "function totalSupply() view returns (uint256)",
  "function transfer(address,uint256) returns (bool)",
  "function transferFrom(address,address,uint256) returns (bool)",
  "function userRedeemedAssets(address) view returns (uint256)",
  "function userWithdrawableAssets(address) view returns (uint256)",
  "function withdraw(uint256)"
]

Complete contract interface also can be checked in Conflux Scan account page's contract tab

FAQs​

How to earn PoS rewards?​

By holding cCFX you can earn PoS rewards, because the cCFX/CFX exchange ratio is continually increase, at an estimated 12% APY. Which means if you hold 100 cCFX for one year, you can exchange 112 CFX back.

What the redeem complete period?​

Normally the redeem duration is couple minutes to one day.