Developers

Search…
Developers
Source code for all retirement based contracts can be found here: https://github.com/KlimaDAO/klimadao-solidity/tree/main/contracts/retirement​
KlimaRetirementAggregator
State Variables
Addresses common across the product are stored in the master contract:
​KLIMA​
​sKLIMA​
​wsKLIMA​
​USDC​
​Staking​
​Staking Helper​
​Treasury​
​Klima Retirement Storage​
Mappings used to flag and track different tokens and addresses:
isPoolToken: address => bool returning whether a pool token address has been added to the master contract.
poolBridge: address => uint returning which index number related to the bridge that a pool uses.
bridgeHelper: uint => address returning the address of the specific helper contract for the given bridge index.
Events
AddressUpdated(uint, address, address)
uint addressIndex (found in setAddress)
address oldAddress
address newAddress
PoolAdded(address,uint)
address poolToken
uint bridge
PoolRemoved(address)
address poolToken
BridgeHelperUpdated(uint, address)
uint bridgeID
address helper
Functions
Common parameters for retireCarbon functions:
Name
Type
Description
_sourceToken
address
The contract address of the source token being used to retire.
_poolToken
address
The contract address of the pool token being used to retire.
_amount
uint256
Either the amount of pool tokens to retire or the amount of source tokens to use. See _amountInCarbon. Expected values are in the number of decimals for the used token.
_amountInCarbon
bool
This flags whether the amount being passed is in carbon to retire (true) or total source tokens to spend (false). 
_beneficiaryAddress
address
The address of the account receiving the benefit of retirement.
_beneficiaryString
string
A string representation of the beneficiary. Useful for specifying a company or protocol name in a readable format.
_retirementMessage
string
Represents a specific message related to this retirement transaction. Example being "Retirement for 2022 Q1 travel."
retireCarbon
Transfers and uses tokens from caller's wallet to swap to the pool if needed and then retire the pool tokens.
1
function retireCarbon(
2
        address _sourceToken,
3
        address _poolToken,
4
        uint256 _amount,
5
        bool _amountInCarbon,
6
        address _beneficiaryAddress,
7
        string memory _beneficiaryString,
8
        string memory _retirementMessage
9
    ) publicid
Copied!
retireCarbonFrom
Same function as retireCarbon, but does not initiate the transfer of the source tokens to the aggregator. Source tokens must be transferred prior to calling retireCarbonFrom. 
Additional parameter: 
address _initiator: Address where any trade dust should be returned.
1
function retireCarbonFrom(
2
        address _initiator,
3
        address _sourceToken,
4
        address _poolToken,
5
        uint256 _amount,
6
        bool _amountInCarbon,
7
        address _beneficiaryAddress,
8
        string memory _beneficiaryString,
9
        string memory _retirementMessage
10
    ) public
Copied!
retireCarbonSpecific
Allows a user to specify the underlying offset they choose to retire. This action is subject to any fees imposed by a bridge for the selective redemption of a pool token.
Additional parameter:
address[] _carbonList: Array of addresses used to redeem pool tokens in order.
1
function retireCarbonSpecific(
2
        address _sourceToken,
3
        address _poolToken,
4
        uint256 _amount,
5
        bool _amountInCarbon,
6
        address _beneficiaryAddress,
7
        string memory _beneficiaryString,
8
        string memory _retirementMessage,
9
        address[] memory _carbonList
10
    ) public
Copied!
retireCarbonSpecificFrom
Similar to retireCarbonFrom, this operates the same way and allows a caller to transfer the needed source tokens to the aggregator prior to calling for specific retirement.
Additional parameters:
address[] _carbonList: Array of addresses used to redeem pool tokens in order.
address _initiator: Address where any trade dust should be returned.
1
function retireCarbonSpecificFrom(
2
        address _initiator,
3
        address _sourceToken,
4
        address _poolToken,
5
        uint256 _amount,
6
        bool _amountInCarbon,
7
        address _beneficiaryAddress,
8
        string memory _beneficiaryString,
9
        string memory _retirementMessage,
10
        address[] memory _carbonList
11
    ) public
Copied!
getSourceAmount
This function calls the specific bridge helper for the supplied pool token and returns both the source and carbon amounts. Parameters are the same as if you were going to use a retireCarbon function call.
1
function getSourceAmount(
2
        address _sourceToken,
3
        address _poolToken,
4
        uint256 _amount,
5
        bool _amountInCarbon
6
    ) public view returns (uint256, uint256)i
Copied!
Return Values:
uint256 sourceAmount: The total amount of source tokens needed.
uint256 carbonAmount: The total amount of carbon tokens needed or used.
getSourceAmountSpecific
This function does the same thing as getSourceAmount, but also factors in any pool redemption fees incurred by performing a selective retirement.
1
function getSourceAmountSpecific(
2
        address _sourceToken,
3
        address _poolToken,
4
        uint256 _amount,
5
        bool _amountInCarbon
6
    ) public view returns (uint256, uint256)
Copied!
Return Values:
uint256 sourceAmount: The total amount of source tokens needed.
uint256 carbonAmount: The total amount of carbon tokens needed or used.
Retirement
Staking
Last modified 2mo ago
Export as PDF
Copy link
Contents
KlimaRetirementAggregator
retireCarbonSpecificFrom
getSourceAmount
getSourceAmountSpecific