CarbonRetirementBondDepository

Git Source

Inherits: Ownable2Step

Author: Cujo

A smart contract that handles the distribution of carbon in exchange for KLIMA tokens. Bond depositors can only use this to retire carbon by providing KLIMA tokens.

State Variables

KLIMA

Address of the KLIMA token contract.

address public constant KLIMA = 0x4e78011Ce80ee02d2c3e649Fb657E45898257815;

DAO

Address of the DAO multi-sig.

address public constant DAO = 0x65A5076C0BA74e5f3e069995dc3DAB9D197d995c;

TREASURY

Address of the Treasury contract.

address public constant TREASURY = 0x7Dd4f0B986F032A44F913BF92c9e8b7c17D77aD7;

INFINITY

address of the Klima Infinity contract.

address public constant INFINITY = 0x8cE54d9625371fb2a068986d32C85De8E6e995f8;

FEE_DIVISOR

Divisor used for calculating percentages.

uint256 public constant FEE_DIVISOR = 10_000;

allocatorContract

Allocator contract used by policy to fund and close markets.

address public allocatorContract;

poolReference

Mapping that stores the KLIMA/X LP used for quoting price references.

mapping(address => address) public poolReference;

referenceKlimaPosition

Mapping that stores whether the KLIMA is token 0 or token 1 in the LP contract.

mapping(address => uint8) public referenceKlimaPosition;

daoFee

Mapping that stores the DAO fee charged for a specific pool token.

mapping(address => uint256) public daoFee;

maxSlippage

Mapping that stores the maximum slippage tolerated for a specific pool token.

mapping(address => uint256) public maxSlippage;

Functions

onlyAllocator

Modifier to ensure that the calling function is being called by the allocator contract.

modifier onlyAllocator();

swapToExact

Swaps the specified amount of pool tokens for KLIMA tokens.

Only callable by the Infinity contract.

function swapToExact(address poolToken, uint256 poolAmount) external;

Parameters

retireCarbonDefault

Retires the specified amount of carbon for the given pool token using KI.

Requires KLIMA spend approval for the amount returned by getKlimaAmount()

function retireCarbonDefault(
    address poolToken,
    uint256 retireAmount,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) external returns (uint256 retirementIndex);

Parameters

Returns

retireCarbonSpecific

Retires the specified amount of carbon for the given pool token using KI. Uses the provided project token for the underlying credit to retire.

Requires KLIMA spend approval for the amount returned by getKlimaAmount()

function retireCarbonSpecific(
    address poolToken,
    address projectToken,
    uint256 retireAmount,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) external returns (uint256 retirementIndex);

Parameters

Returns

openMarket

Emits event on market allocation.

Only the allocator contract can call this function.

function openMarket(address poolToken) external onlyAllocator;

Parameters

closeMarket

Closes the market for a specified pool token by transferring all remaining pool tokens to the treasury address.

Only the allocator contract can call this function.

function closeMarket(address poolToken) external onlyAllocator;

Parameters

updateMaxSlippage

Updates the maximum slippage percentage for a specified pool token.

function updateMaxSlippage(address poolToken, uint256 _maxSlippage) external onlyOwner;

Parameters

updateDaoFee

Updates the DAO fee for a specified pool token.

function updateDaoFee(address poolToken, uint256 _daoFee) external onlyOwner;

Parameters

setPoolReference

Sets the reference token for a given pool token. The reference token is used to determine the current price of the pool token in terms of KLIMA. The position of KLIMA in the Uniswap pair for the reference token is also determined.

function setPoolReference(address poolToken, address referenceToken) external onlyOwner;

Parameters

setAllocator

Sets the address of the allocator contract. Only the contract owner can call this function.

function setAllocator(address allocator) external onlyOwner;

Parameters

getKlimaAmount

Calculates the amount of KLIMA tokens needed to retire a specified amount of pool tokens for a pool. The required amount of KLIMA tokens is calculated based on the current market price of the pool token and the amount of pool tokens to be retired. If the raw amount needed from the dex exceeds slippage, than the limited amount is returned.

function getKlimaAmount(uint256 poolAmount, address poolToken) public view returns (uint256 klimaNeeded);

Parameters

Returns

_transferAndBurnKlima

Transfers and burns a specified amount of KLIMA tokens. A fee is also transferred to the DAO address based on the fee divisor and the configured fee for the pool token.

On extremely small quote amounts this can result in zero

function _transferAndBurnKlima(uint256 totalKlima, address poolToken) private;

Parameters

getMarketQuote

Returns the current market price of the pool token in terms of KLIMA tokens.

Currently all KLIMA LP contracts safely interact with the IUniswapV2Pair abi.

function getMarketQuote(address poolToken, uint256 amountOut) internal view returns (uint256 currentPrice);

Parameters

Returns

Events

AllocatorChanged

event AllocatorChanged(address oldAllocator, address newAllocator);

PoolReferenceChanged

event PoolReferenceChanged(address pool, address oldLp, address newLp);

ReferenceKlimaPositionChanged

event ReferenceKlimaPositionChanged(address lp, uint8 oldPosition, uint8 newPosition);

DaoFeeChanged

event DaoFeeChanged(address pool, uint256 oldFee, uint256 newFee);

PoolSlippageChanged

event PoolSlippageChanged(address pool, uint256 oldSlippage, uint256 newSlippage);

MarketOpened

event MarketOpened(address pool, uint256 amount);

MarketClosed

event MarketClosed(address pool, uint256 amount);

CarbonBonded

event CarbonBonded(address pool, uint256 poolAmount);

KlimaBonded

event KlimaBonded(uint256 daoFee, uint256 klimaBurned);