KlimaDAO contracts

Local Development

Install foundry:

https://book.getfoundry.sh/getting-started/installation

For Linux and MacOS users:

curl -L https://foundry.paradigm.xyz | bash

This will download foundryup. Then install Foundry by running:

foundryup

Deploy

These examples use a localhost fork running on the anvil command

Base Protocol Contracts

• Deploy the Klima tokens (KLIMA, sKLIMA, wsKLIMA).

  forge script script/deployProtocolTokens.s.sol:DeployKlimaProtocolTokens --fork-url http://localhost:8545 --broadcast --ffi
  

• Update .env with the KLIMA and sKLIMA addresses from the previous step and deploy the Klima treasury.

  forge script script/deployProtocolTreasury.s.sol:DeployKlimaTreasury --fork-url http://localhost:8545 --broadcast --ffi
  

• Update .env with the treasury address from the previous step. Also, configure the desired parameters for the first epoch number, block, and epoch length in the deploy script below.

  forge script script/deployProtocolStaking.s.sol:DeployKlimaStaking --fork-url http://localhost:8545 --broadcast --ffi
  

Infinity Diamond Deployment

• Deploy the base Diamond, facet implementations, and perform the diamon cut with the following script.

  forge script script/deployInfinity.s.sol:DeployInfinityScript --fork-url http://localhost:8545 --broadcast --ffi
  

Deprecated Contracts

Note that the AlphaKlimaRedeemUpgradeable will fail to get built by default, and therefore has been marked deprecated.

In order to compile this contract, you will need to manually update the @openzeppelin/contracts-upgradeable contracts that are downloaded in your node_modules by changing _trustedForwarder in metatx/ERC2771ContextUpgradeable.sol from a private to a public address.

There is another issue related to the _trustedForwarder in that contract that has not yet been resolved.

Since aKLIMA was a prelaunch coupon and the existing deployed versino of the redemption contract works as expected, this contract is no longer needed.

Documentation

This repo is configured with Foundry to generate documentation for the solidity source files with the forge doc command.

Foundry forge doc generates and builds an mdbook from the natspec comments contained within the Solidity source files.The book.toml file located in the root folder contains the config settings and the preprocess_summary.py script allows you to customize the book after it is generated.

The preprocess_summary.py script is necessary to customize the book after Foundry has generated the book from the natspec comments. This script can also be used to insert additional pages into the book automatically. If you were to modify the book without this script, each time someone ran the build command it will overwrite these changes.

If you have not installed Foundry, follow the guide above before proceeding.

Please follow these rules:

• Annonate your code with proper NatSpec comments
• Before committing code, run the forge doc --build in order to build the doc/book
• A new mdbook should be manually deployed to the public documentation from the main branch each time contracts are verified to block explorers like Polygonscan.

You can run a local version of the documentation by running forge doc --serve

Vercel is configured to deploy previews of the mdbook from docs/book.

Additional information

Automating the building and deployment of the solidity documentation mdbook can also be achieved in a number of ways, each with their own trade offs.

1. Configure github actions to checkout foundry toolchain, build the book, and deploy to github pages. This requires a higher tier github org for multiple pages.
2. Configure github actions to checkout foundry toolchain, build the book, and deploy it to Vercel via Vercel CLI. This requires Vercel secrets stored in the repo.
3. Configure github actions to checkout foundry toolchain, build the book, and then commit it to the repo and configure Vercel to deploy. This requires Github actions to add commits after each commit.

Note: Vercel lacks a system level dependency required to install foundry to build the book before deploying

Ultimately, it was simpler to document the build process and deploy the public documentation manually as new smart contracts are not deployed frequently enough to warrant automated deployment. These notes were documented in case automatic deployment were to be revisited in the future.

Contents

• facets
• init
• interfaces
• libraries
• mocks
• Account
• Storage
• AppStorage
• C
• Diamond
• ReentrancyGuard

Contents

• Bridges
• Retire
• DiamondCutFacet
• DiamondLoupeFacet
• DustFacet
• ERC1155ReceiverFacet
• ERC721ReceiverFacet
• MetaTransactionsFacet
• OwnershipFacet
• RetirementQuoter
• TokenFacet

Contents

• C3
• ICR
• Toucan

Contents

• RedeemC3PoolFacet
• RetireC3C3TFacet

RedeemC3PoolFacet

Git Source

Inherits: ReentrancyGuard

Functions

c3RedeemPoolDefault

Redeems default underlying carbon tokens from a C3 Pool

function c3RedeemPoolDefault(
    address sourceToken,
    address poolToken,
    uint256 amount,
    uint256 maxAmountIn,
    LibTransfer.From fromMode,
    LibTransfer.To toMode
) external nonReentrant returns (address[] memory projectTokens, uint256[] memory amounts);

Parameters

Returns

c3RedeemPoolSpecific

Redeems default underlying carbon tokens from a C3 Pool

function c3RedeemPoolSpecific(
    address sourceToken,
    address poolToken,
    uint256 maxAmountIn,
    address[] memory projectTokens,
    uint256[] memory amounts,
    LibTransfer.From fromMode,
    LibTransfer.To toMode
) external nonReentrant returns (uint256[] memory redeemedAmounts);

Parameters

Returns

RetireC3C3TFacet

Git Source

Inherits: ReentrancyGuard

Functions

c3RetireExactC3T

This contract assumes that the token being provided is a raw TCO2 token.

The transactions will revert otherwise.

Redeems C3T directly

function c3RetireExactC3T(
    address carbonToken,
    uint256 amount,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    LibTransfer.From fromMode
) external nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

c3RetireExactC3TWithEntity

Redeems C3T directly

function c3RetireExactC3TWithEntity(
    address carbonToken,
    uint256 amount,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    LibTransfer.From fromMode
) external nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address carbonToken,
    uint256 retiredAmount
);

Contents

• RetireICRFacet

RetireICRFacet

Git Source

Inherits: ReentrancyGuard

Functions

icrRetireExactCarbon

This contract assumes that the token being provided is a raw ICR project token.

The transactions will revert otherwise.

Redeems ICR credit directly

function icrRetireExactCarbon(
    address projectToken,
    uint256 tokenId,
    uint256 amount,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    LibTransfer.From fromMode
) external nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address carbonToken,
    uint256 tokenId,
    uint256 retiredAmount
);

Contents

• RedeemToucanPoolFacet
• RetireToucanTCO2Facet

RedeemToucanPoolFacet

Git Source

Inherits: ReentrancyGuard

Functions

toucanRedeemExactCarbonPoolDefault

Redeems default underlying carbon tokens from a Toucan Pool

function toucanRedeemExactCarbonPoolDefault(
    address sourceToken,
    address poolToken,
    uint256 amount,
    uint256 maxAmountIn,
    LibTransfer.From fromMode,
    LibTransfer.To toMode
) external nonReentrant returns (address[] memory projectTokens, uint256[] memory amounts);

Parameters

Returns

toucanRedeemExactCarbonPoolSpecific

Redeems specific underlying carbon tokens from a Toucan Pool

function toucanRedeemExactCarbonPoolSpecific(
    address sourceToken,
    address poolToken,
    uint256 maxAmountIn,
    address[] memory projectTokens,
    uint256[] memory amounts,
    LibTransfer.From fromMode,
    LibTransfer.To toMode
) external nonReentrant returns (uint256[] memory redeemedAmounts);

Parameters

Returns

RetireToucanTCO2Facet

Git Source

Inherits: ReentrancyGuard

Functions

toucanRetireExactTCO2

This contract assumes that the token being provided is a raw TCO2 token.

The transactions will revert otherwise

Redeems TCO2 directly

function toucanRetireExactTCO2(
    address carbonToken,
    uint256 amount,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    LibTransfer.From fromMode
) external nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

toucanRetireExactTCO2WithEntity

Redeems TCO2 directly

function toucanRetireExactTCO2WithEntity(
    address carbonToken,
    uint256 amount,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    LibTransfer.From fromMode
) external nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

toucanRetireExactPuroTCO2

Retires Puro TCO2 directly

function toucanRetireExactPuroTCO2(
    address projectToken,
    uint256 tokenId,
    uint256 amount,
    LibRetire.RetireDetails memory details,
    LibTransfer.From fromMode
) external nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address carbonToken,
    uint256 retiredAmount
);

Contents

• RetireCarbonFacet
• RetireCarbonmarkFacet
• RetireInfoFacet
• RetireSourceFacet

RetireCarbonFacet

Git Source

Inherits: ReentrancyGuard

Functions

retireExactCarbonDefault

Retires an exact amount of carbon using default redemption

function retireExactCarbonDefault(
    address sourceToken,
    address poolToken,
    uint256 maxAmountIn,
    uint256 retireAmount,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    LibTransfer.From fromMode
) external payable nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

retireExactCarbonSpecific

Retires an exact amount of carbon using specific redemption

function retireExactCarbonSpecific(
    address sourceToken,
    address poolToken,
    address projectToken,
    uint256 maxAmountIn,
    uint256 retireAmount,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    LibTransfer.From fromMode
) external payable nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address poolToken,
    uint256 retiredAmount
);

RetireCarbonmarkFacet

Git Source

Inherits: ReentrancyGuard

Functions

retireCarbonmarkListing

Retires an exact amount of carbon using default redemption

function retireCarbonmarkListing(
    ICarbonmark.CreditListing memory listing,
    uint256 maxAmountIn,
    uint256 retireAmount,
    LibRetire.RetireDetails memory details,
    LibTransfer.From fromMode
) external payable nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address poolToken,
    uint256 retiredAmount
);

RetireInfoFacet

Git Source

Functions

getTotalRetirements

function getTotalRetirements(address account) external view returns (uint256 totalRetirements);

getTotalCarbonRetired

function getTotalCarbonRetired(address account) external view returns (uint256 totalCarbonRetired);

getTotalPoolRetired

function getTotalPoolRetired(address account, address poolToken) external view returns (uint256 totalPoolRetired);

getTotalProjectRetired

function getTotalProjectRetired(address account, address projectToken) external view returns (uint256);

getTotalRewardsClaimed

function getTotalRewardsClaimed(address account) external view returns (uint256 totalClaimed);

getRetirementDetails

function getRetirementDetails(address account, uint256 retirementIndex)
    external
    view
    returns (
        address poolTokenAddress,
        address projectTokenAddress,
        address beneficiaryAddress,
        string memory beneficiary,
        string memory retirementMessage,
        uint256 amount
    );

RetireSourceFacet

Git Source

Inherits: ReentrancyGuard

Functions

retireExactSourceDefault

Retires an exact amount of a source token using default redemption

function retireExactSourceDefault(
    address sourceToken,
    address poolToken,
    uint256 maxAmountIn,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    LibTransfer.From fromMode
) external payable nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

retireExactSourceSpecific

Retires an exact amount of a source token using specific redemption

Initial value set assuming source == pool.

function retireExactSourceSpecific(
    address sourceToken,
    address poolToken,
    address projectToken,
    uint256 maxAmountIn,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    LibTransfer.From fromMode
) external payable nonReentrant returns (uint256 retirementIndex);

Parameters

Returns

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address poolToken,
    uint256 retiredAmount
);

DiamondCutFacet

Git Source

Inherits: IDiamondCut

Author: Nick Mudge nick@perfectabstractions.com (https://twitter.com/mudgen) EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535 /*****************************************************************************

Functions

diamondCut

Add/replace/remove any number of functions and optionally execute a function with delegatecall

function diamondCut(FacetCut[] calldata _diamondCut, address _init, bytes calldata _calldata) external override;

Parameters

DiamondLoupeFacet

Git Source

Inherits: IDiamondLoupe, IERC165

Author: Nick Mudge nick@perfectabstractions.com (https://twitter.com/mudgen) EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535 /*****************************************************************************

Functions

facets

These functions are expected to be called frequently by tools.

Gets all facets and their selectors.

function facets() external view override returns (Facet[] memory facets_);

Returns

facetFunctionSelectors

Gets all the function selectors provided by a facet.

function facetFunctionSelectors(address _facet)
    external
    view
    override
    returns (bytes4[] memory facetFunctionSelectors_);

Parameters

Returns

facetAddresses

Get all the facet addresses used by a diamond.

function facetAddresses() external view override returns (address[] memory facetAddresses_);

Returns

facetAddress

Gets the facet that supports the given selector.

If facet is not found return address(0).

function facetAddress(bytes4 _functionSelector) external view override returns (address facetAddress_);

Parameters

Returns

supportsInterface

function supportsInterface(bytes4 _interfaceId) external view override returns (bool);

DustFacet

Git Source

Inherits: ReentrancyGuard

Author: Cujo

Functions

sendDust

function sendDust() external payable;

ERC1155ReceiverFacet

Git Source

Inherits: ReentrancyGuard, IERC1155Receiver

Functions

onERC1155Received

function onERC1155Received(address operator, address from, uint256 id, uint256 value, bytes calldata data)
    external
    virtual
    override
    returns (bytes4);

onERC1155BatchReceived

function onERC1155BatchReceived(
    address operator,
    address from,
    uint256[] calldata ids,
    uint256[] calldata values,
    bytes calldata data
) external virtual override returns (bytes4);

ERC721ReceiverFacet

Git Source

Inherits: ReentrancyGuard, IERC721Receiver

Functions

onERC721Received

function onERC721Received(address, address, uint256 tokenId, bytes memory) external virtual override returns (bytes4);

MetaTransactionsFacet

Git Source

Inherits: ReentrancyGuard

State Variables

META_TRANSACTION_TYPEHASH

bytes32 private constant META_TRANSACTION_TYPEHASH =
    keccak256(bytes("MetaTransaction(uint256 nonce,address from,bytes functionSignature)"));

Functions

convertBytesToBytes4

function convertBytesToBytes4(bytes memory inBytes) internal pure returns (bytes4 outBytes4);

getDomainSeparator

function getDomainSeparator() private view returns (bytes32);

toTypedMessageHash

Accept message hash and returns hash message in EIP712 compatible form So that it can be used to recover signer from signature signed using EIP712 formatted data https://eips.ethereum.org/EIPS/eip-712 "\x19" makes the encoding deterministic "\x01" is the version byte to make it compatible to EIP-191

function toTypedMessageHash(bytes32 messageHash) internal view returns (bytes32);

hashMetaTransaction

function hashMetaTransaction(MetaTransaction memory metaTx) internal pure returns (bytes32);

getNonce

Query the latest nonce of an address

function getNonce(address user) external view returns (uint256 nonce_);

Parameters

Returns

verify

function verify(address user, MetaTransaction memory metaTx, bytes32 sigR, bytes32 sigS, uint8 sigV)
    internal
    view
    returns (bool);

executeMetaTransaction

function executeMetaTransaction(
    address userAddress,
    bytes memory functionSignature,
    bytes32 sigR,
    bytes32 sigS,
    uint8 sigV
) public payable returns (bytes memory);

Events

MetaTransactionExecuted

event MetaTransactionExecuted(address userAddress, address payable relayerAddress, bytes functionSignature);

Structs

MetaTransaction

struct MetaTransaction {
    uint256 nonce;
    address from;
    bytes functionSignature;
}

OwnershipFacet

Git Source

Inherits: IERC173

Functions

transferOwnership

function transferOwnership(address _newOwner) external override;

owner

function owner() external view override returns (address owner_);

RetirementQuoter

Git Source

Author: Cujo

State Variables

s

AppStorage internal s;

Functions

getSourceAmountSwapOnly

function getSourceAmountSwapOnly(address sourceToken, address carbonToken, uint256 amountOut)
    public
    view
    returns (uint256 amountIn);

getSourceAmountDefaultRetirement

function getSourceAmountDefaultRetirement(address sourceToken, address carbonToken, uint256 retireAmount)
    public
    view
    returns (uint256 amountIn);

getSourceAmountSpecificRetirement

function getSourceAmountSpecificRetirement(address sourceToken, address carbonToken, uint256 retireAmount)
    public
    view
    returns (uint256 amountIn);

getSourceAmountDefaultRedeem

function getSourceAmountDefaultRedeem(address sourceToken, address carbonToken, uint256 redeemAmount)
    public
    view
    returns (uint256 amountIn);

getSourceAmountSpecificRedeem

function getSourceAmountSpecificRedeem(address sourceToken, address carbonToken, uint256[] memory redeemAmounts)
    public
    view
    returns (uint256 amountIn);

getRetireAmountSourceDefault

function getRetireAmountSourceDefault(address sourceToken, address carbonToken, uint256 amount)
    public
    view
    returns (uint256 amountOut);

getRetireAmountSourceSpecific

function getRetireAmountSourceSpecific(address sourceToken, address carbonToken, uint256 amount)
    public
    view
    returns (uint256 amountOut);

TokenFacet

Git Source

Author: Publius

SPDX-License-Identifier: MIT

Functions

transferToken

Transfer

function transferToken(
    IERC20 token,
    address recipient,
    uint256 amount,
    LibTransfer.From fromMode,
    LibTransfer.To toMode
) external payable;

wrapMatic

Weth

function wrapMatic(uint256 amount, LibTransfer.To mode) external payable;

unwrapMatic

function unwrapMatic(uint256 amount, LibTransfer.From mode) external payable;

getInternalBalance

Getters

function getInternalBalance(address account, IERC20 token) public view returns (uint256 balance);

getInternalBalances

function getInternalBalances(address account, IERC20[] memory tokens)
    external
    view
    returns (uint256[] memory balances);

getExternalBalance

function getExternalBalance(address account, IERC20 token) public view returns (uint256 balance);

getExternalBalances

function getExternalBalances(address account, IERC20[] memory tokens)
    external
    view
    returns (uint256[] memory balances);

getBalance

function getBalance(address account, IERC20 token) public view returns (uint256 balance);

getBalances

function getBalances(address account, IERC20[] memory tokens) external view returns (uint256[] memory balances);

getAllBalance

function getAllBalance(address account, IERC20 token) public view returns (Balance memory b);

getAllBalances

function getAllBalances(address account, IERC20[] memory tokens) external view returns (Balance[] memory balances);

Events

InternalBalanceChanged

event InternalBalanceChanged(address indexed user, IERC20 indexed token, int256 delta);

Structs

Balance

struct Balance {
    uint256 internalBalance;
    uint256 externalBalance;
    uint256 totalBalance;
}

Contents

• C3SushiInit
• DiamondInit
• DiamondInitCoorest
• InitProjectTotals
• _EmptyInit

C3SushiInit

Git Source

State Variables

s

AppStorage internal s;

Functions

init

function init() external;

DiamondInit

Git Source

Author: Nick Mudge nick@perfectabstractions.com (https://twitter.com/mudgen) EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535 Implementation of a diamond. /*****************************************************************************

State Variables

s

AppStorage internal s;

MAX_INT

uint256 private constant MAX_INT = 2 ** 256 - 1;

Functions

init

function init() external;

DiamondInitCoorest

Git Source

State Variables

s

AppStorage internal s;

Functions

init

function init() external;

InitProjectTotals

Git Source

State Variables

s

AppStorage internal s;

Functions

init

function init() external;

_EmptyInit

Git Source

Functions

init

function init() external;

Contents

• IC3Pool
• IC3ProjectToken
• IC3ProjectFactory
• ICarbonChain
• ICarbonmark
• ICCO2
• ICoorest
• IDiamond
• IDiamondCut
• IDiamondLoupe
• IERC1155Receiver
• IERC165
• IERC173
• IERC721Receiver
• ICarbonContractRegistry
• IProject
• IStaking
• IStakingHelper
• IwsKLIMA
• IKlimaRetirementBond
• IKlimaCarbonRetirements
• IKlimaInfinity
• IToucanPool
• IToucanCarbonOffsets
• IToucanContractRegistry
• IToucanPuroCarbonOffsets
• IBentoBoxMinimal
• ITridentRouter
• ITridentPool
• IUniswapV2Pair
• IUniswapV2Router01
• IUniswapV2Router02
• IWMATIC

IC3Pool

Git Source

Functions

freeRedeem

function freeRedeem(uint256 amount) external;

taxedRedeem

function taxedRedeem(address[] memory erc20Addresses, uint256[] memory amount) external;

getFreeRedeemAddresses

function getFreeRedeemAddresses() external view returns (address[] memory);

getERC20Tokens

function getERC20Tokens() external view returns (address[] memory);

feeRedeem

function feeRedeem() external view returns (uint256);

IC3ProjectToken

Git Source

Functions

offsetFor

function offsetFor(uint256 amount, address beneficiary, string memory transferee, string memory reason) external;

IC3ProjectFactory

Git Source

Functions

isTokenExists

function isTokenExists(address _address) external returns (bool);

ICarbonChain

Git Source

Functions

offsetCarbon

function offsetCarbon(uint256 _carbonTon, string calldata _transactionInfo, string calldata _onBehalfOf) external;

ICarbonmark

Git Source

Functions

createListing

This function creates a new listing and returns the resulting listing ID

function createListing(address token, uint256 amount, uint256 unitPrice, uint256 minFillAmount, uint256 deadline)
    external
    returns (bytes32 id);

Parameters

Returns

fillListing

This function fills an existing listing

function fillListing(
    bytes32 id,
    address listingAccount,
    address listingToken,
    uint256 listingUnitPrice,
    uint256 amount,
    uint256 maxCost
) external;

Parameters

getListingOwner

function getListingOwner(bytes32 id) external view returns (address);

getUnitPrice

function getUnitPrice(bytes32 id) external view returns (uint256);

getRemainingAmount

function getRemainingAmount(bytes32 id) external view returns (uint256);

getListingDeadline

function getListingDeadline(bytes32 id) external view returns (uint256);

Structs

CreditListing

Struct containing all of the detail information needed to fill a listing

struct CreditListing {
    bytes32 id;
    address account;
    address token;
    uint256 tokenId;
    uint256 remainingAmount;
    uint256 unitPrice;
}

Properties

ICCO2

Git Source

Functions

burningPercentage

function burningPercentage() external view returns (uint256);

decimalRatio

function decimalRatio() external view returns (uint256);

ICoorest

Git Source

Functions

mintPOCC

function mintPOCC(uint256 _amountCO2, string memory _reason, string memory _owner) external payable returns (uint256);

IDiamond

Git Source

Author: Nick Mudge nick@perfectabstractions.com (https://twitter.com/mudgen) EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535 /*****************************************************************************

Events

DiamondCut

event DiamondCut(FacetCut[] _diamondCut, address _init, bytes _calldata);

Structs

FacetCut

struct FacetCut {
    address facetAddress;
    FacetCutAction action;
    bytes4[] functionSelectors;
}

Enums

FacetCutAction

enum FacetCutAction {
    Add,
    Replace,
    Remove
}

IDiamondCut

Git Source

Author: Nick Mudge nick@perfectabstractions.com (https://twitter.com/mudgen) EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535 /*****************************************************************************

Functions

diamondCut

Add/replace/remove any number of functions and optionally execute a function with delegatecall

function diamondCut(FacetCut[] calldata _diamondCut, address _init, bytes calldata _calldata) external;

Parameters

Events

DiamondCut

event DiamondCut(FacetCut[] _diamondCut, address _init, bytes _calldata);

Structs

FacetCut

struct FacetCut {
    address facetAddress;
    FacetCutAction action;
    bytes4[] functionSelectors;
}

Enums

FacetCutAction

enum FacetCutAction {
    Add,
    Replace,
    Remove
}

IDiamondLoupe

Git Source

Author: Nick Mudge nick@perfectabstractions.com (https://twitter.com/mudgen) EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535 /*****************************************************************************

Functions

facets

Gets all facet addresses and their four byte function selectors.

function facets() external view returns (Facet[] memory facets_);

Returns

facetFunctionSelectors

Gets all the function selectors supported by a specific facet.

function facetFunctionSelectors(address _facet) external view returns (bytes4[] memory facetFunctionSelectors_);

Parameters

Returns

facetAddresses

Get all the facet addresses used by a diamond.

function facetAddresses() external view returns (address[] memory facetAddresses_);

Returns

facetAddress

Gets the facet that supports the given selector.

If facet is not found return address(0).

function facetAddress(bytes4 _functionSelector) external view returns (address facetAddress_);

Parameters

Returns

Structs

Facet

These functions are expected to be called frequently by tools.

struct Facet {
    address facetAddress;
    bytes4[] functionSelectors;
}

IERC1155Receiver

Git Source

Functions

onERC1155Received

Handles the receipt of a single ERC1155 token type. This function is called at the end of a safeTransferFrom after the balance has been updated. NOTE: To accept the transfer, this must return bytes4(keccak256("onERC1155Received(address,address,uint256,uint256,bytes)")) (i.e. 0xf23a6e61, or its own function selector).

function onERC1155Received(address operator, address from, uint256 id, uint256 value, bytes calldata data)
    external
    returns (bytes4);

Parameters

Returns

onERC1155BatchReceived

Handles the receipt of a multiple ERC1155 token types. This function is called at the end of a safeBatchTransferFrom after the balances have been updated. NOTE: To accept the transfer(s), this must return bytes4(keccak256("onERC1155BatchReceived(address,address,uint256[],uint256[],bytes)")) (i.e. 0xbc197c81, or its own function selector).

function onERC1155BatchReceived(
    address operator,
    address from,
    uint256[] calldata ids,
    uint256[] calldata values,
    bytes calldata data
) external returns (bytes4);

Parameters

Returns

IERC165

Git Source

Functions

supportsInterface

Query if a contract implements an interface

Interface identification is specified in ERC-165. This function uses less than 30,000 gas.

function supportsInterface(bytes4 interfaceId) external view returns (bool);

Parameters

Returns

IERC173

Git Source

Functions

owner

Get the address of the owner

function owner() external view returns (address owner_);

Returns

transferOwnership

Set the address of the new owner of the contract

Set _newOwner to address(0) to renounce any ownership.

function transferOwnership(address _newOwner) external;

Parameters

Events

OwnershipTransferred

This emits when ownership of a contract changes.

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);

IERC721Receiver

Git Source

Interface for any contract that wants to support safeTransfers from ERC721 asset contracts.

Functions

onERC721Received

Whenever an {IERC721} tokenId token is transferred to this contract via {IERC721-safeTransferFrom} by operator from from, this function is called. It must return its Solidity selector to confirm the token transfer. If any other value is returned or the interface is not implemented by the recipient, the transfer will be reverted. The selector can be obtained in Solidity with IERC721Receiver.onERC721Received.selector.

function onERC721Received(address operator, address from, uint256 tokenId, bytes calldata data)
    external
    returns (bytes4);

ICarbonContractRegistry

Git Source

Functions

getTokenVaultBeaconAddress

function getTokenVaultBeaconAddress() external view returns (address);

getVerifiedVaultAddress

function getVerifiedVaultAddress(uint256 id) external view returns (address);

getSerializationAddress

function getSerializationAddress(string calldata serialization) external view returns (address);

getProjectAddressFromId

function getProjectAddressFromId(uint256 projectId) external view returns (address);

getProjectIdFromAddress

function getProjectIdFromAddress(address projectAddress) external view returns (uint256);

getBeaconAddress

function getBeaconAddress() external view returns (address);

IProject

Git Source

Functions

retire

function retire(
    uint256 tokenId,
    uint256 amount,
    address beneficiary,
    string memory retireeName,
    string memory customUri,
    string memory comment,
    bytes memory data
) external returns (uint256 nftTokenId);

IStaking

Git Source

Functions

unstake

function unstake(uint256 _amount, bool _trigger) external;

IStakingHelper

Git Source

Functions

stake

function stake(uint256 _amount) external;

IwsKLIMA

Git Source

Functions

wrap

function wrap(uint256 _amount) external returns (uint256);

unwrap

function unwrap(uint256 _amount) external returns (uint256);

wKLIMATosKLIMA

function wKLIMATosKLIMA(uint256 _amount) external view returns (uint256);

sKLIMATowKLIMA

function sKLIMATowKLIMA(uint256 _amount) external view returns (uint256);

IKlimaRetirementBond

Git Source

Functions

swapToExact

function swapToExact(address poolToken, uint256 amount) external;

getKlimaAmount

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

owner

function owner() external returns (address);

IKlimaCarbonRetirements

Git Source

Functions

carbonRetired

function carbonRetired(
    address _retiree,
    address _pool,
    uint256 _amount,
    string calldata _beneficiaryString,
    string calldata _retirementMessage
) external;

getUnclaimedTotal

function getUnclaimedTotal(address _minter) external view returns (uint256);

offsetClaimed

function offsetClaimed(address _minter, uint256 _amount) external returns (bool);

getRetirementIndexInfo

function getRetirementIndexInfo(address _retiree, uint256 _index)
    external
    view
    returns (address, uint256, string memory, string memory);

getRetirementPoolInfo

function getRetirementPoolInfo(address _retiree, address _pool) external view returns (uint256);

getRetirementTotals

function getRetirementTotals(address _retiree) external view returns (uint256, uint256, uint256);

IKlimaInfinity

Git Source

Functions

toucan_retireExactCarbonPoolDefault

function toucan_retireExactCarbonPoolDefault(
    address sourceToken,
    address carbonToken,
    uint256 amount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

toucan_retireExactCarbonPoolWithEntityDefault

function toucan_retireExactCarbonPoolWithEntityDefault(
    address sourceToken,
    address carbonToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

toucan_retireExactSourcePoolDefault

function toucan_retireExactSourcePoolDefault(
    address sourceToken,
    address carbonToken,
    uint256 amount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

toucan_retireExactSourcePoolWithEntityDefault

function toucan_retireExactSourcePoolWithEntityDefault(
    address sourceToken,
    address carbonToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

toucan_retireExactCarbonPoolSpecific

function toucan_retireExactCarbonPoolSpecific(
    address sourceToken,
    address carbonToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

toucan_retireExactCarbonPoolWithEntitySpecific

function toucan_retireExactCarbonPoolWithEntitySpecific(
    address sourceToken,
    address poolToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

toucan_retireExactSourcePoolWithEntitySpecific

function toucan_retireExactSourcePoolWithEntitySpecific(
    address sourceToken,
    address poolToken,
    address projectToken,
    uint256 sourceAmount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

toucan_retireExactSourcePoolSpecific

function toucan_retireExactSourcePoolSpecific(
    address sourceToken,
    address poolToken,
    address projectToken,
    uint256 sourceAmount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

moss_retireExactCarbonPoolDefault

function moss_retireExactCarbonPoolDefault(
    address sourceToken,
    address carbonToken,
    uint256 amount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

moss_retireExactCarbonPoolWithEntityDefault

function moss_retireExactCarbonPoolWithEntityDefault(
    address sourceToken,
    address carbonToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

moss_retireExactSourcePoolDefault

function moss_retireExactSourcePoolDefault(
    address sourceToken,
    address carbonToken,
    uint256 sourceAmount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

moss_retireExactSourcePoolWithEntityDefault

function moss_retireExactSourcePoolWithEntityDefault(
    address sourceToken,
    address carbonToken,
    uint256 sourceAmount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

c3_retireExactCarbonPoolDefault

function c3_retireExactCarbonPoolDefault(
    address sourceToken,
    address carbonToken,
    uint256 amount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

c3_retireExactCarbonPoolWithEntityDefault

function c3_retireExactCarbonPoolWithEntityDefault(
    address sourceToken,
    address carbonToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

c3_retireExactSourcePoolDefault

function c3_retireExactSourcePoolDefault(
    address sourceToken,
    address carbonToken,
    uint256 sourceAmount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

c3_retireExactSourcePoolWithEntityDefault

function c3_retireExactSourcePoolWithEntityDefault(
    address sourceToken,
    address carbonToken,
    uint256 sourceAmount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

c3_retireExactCarbonPoolSpecific

function c3_retireExactCarbonPoolSpecific(
    address sourceToken,
    address carbonToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

c3_retireExactCarbonPoolWithEntitySpecific

function c3_retireExactCarbonPoolWithEntitySpecific(
    address sourceToken,
    address poolToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

c3_retireExactSourcePoolWithEntitySpecific

function c3_retireExactSourcePoolWithEntitySpecific(
    address sourceToken,
    address poolToken,
    address projectToken,
    uint256 sourceAmount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

c3_retireExactSourcePoolSpecific

function c3_retireExactSourcePoolSpecific(
    address sourceToken,
    address poolToken,
    address projectToken,
    uint256 sourceAmount,
    address retiringAddress,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage,
    uint8 fromMode
) external returns (uint256 retirementIndex);

IToucanPool

Git Source

Functions

redeemAuto2

function redeemAuto2(uint256 amount) external returns (address[] memory tco2s, uint256[] memory amounts);

redeemMany

function redeemMany(address[] calldata erc20s, uint256[] calldata amounts) external;

feeRedeemPercentageInBase

function feeRedeemPercentageInBase() external pure returns (uint256);

feeRedeemDivider

function feeRedeemDivider() external pure returns (uint256);

redeemFeeExemptedAddresses

function redeemFeeExemptedAddresses(address) external view returns (bool);

getScoredTCO2s

function getScoredTCO2s() external view returns (address[] memory);

IToucanCarbonOffsets

Git Source

Functions

retire

function retire(uint256 amount) external;

retireAndMintCertificate

function retireAndMintCertificate(
    string calldata retiringEntityString,
    address beneficiary,
    string calldata beneficiaryString,
    string calldata retirementMessage,
    uint256 amount
) external;

mintCertificateLegacy

function mintCertificateLegacy(
    string calldata retiringEntityString,
    address beneficiary,
    string calldata beneficiaryString,
    string calldata retirementMessage,
    uint256 amount
) external;

standardRegistry

function standardRegistry() external returns (string memory registry);

IToucanContractRegistry

Git Source

Functions

isValidERC20

function isValidERC20(address erc20) external returns (bool);

IToucanPuroCarbonOffsets

Git Source

Functions

requestRetirement

function requestRetirement(CreateRetirementRequestParams calldata params) external returns (uint256 requestId);

Structs

CreateRetirementRequestParams

struct CreateRetirementRequestParams {
    uint256[] tokenIds;
    uint256 amount;
    string retiringEntityString;
    address beneficiary;
    string beneficiaryString;
    string retirementMessage;
    string beneficiaryLocation;
    string consumptionCountryCode;
    uint256 consumptionPeriodStart;
    uint256 consumptionPeriodEnd;
}

IBentoBoxMinimal

Git Source

Functions

setMasterContractApproval

Approves users' BentoBox assets to a "master" contract.

function setMasterContractApproval(address user, address masterContract, bool approved, uint8 v, bytes32 r, bytes32 s)
    external;

toAmount

function toAmount(IERC20 token, uint256 share, bool roundUp) external view returns (uint256 amount);

ITridentRouter

Git Source

Trident pool router interface.

Functions

exactInputSingleWithNativeToken

function exactInputSingleWithNativeToken(ExactInputSingleParams calldata params)
    external
    payable
    returns (uint256 amountOut);

Structs

ExactInputSingleParams

struct ExactInputSingleParams {
    uint256 amountIn;
    uint256 amountOutMinimum;
    address pool;
    address tokenIn;
    bytes data;
}

ITridentPool

Git Source

Trident pool interface.

Functions

getAmountOut

Simulates a trade and returns the expected output.

The pool does not need to include a trade simulator directly in itself - it can use a library.

function getAmountOut(bytes calldata data) external view returns (uint256 finalAmountOut);

Parameters

Returns

getAmountIn

Simulates a trade and returns the expected output.

The pool does not need to include a trade simulator directly in itself - it can use a library.

function getAmountIn(bytes calldata data) external view returns (uint256 finalAmountIn);

Parameters

Returns

IUniswapV2Pair

Git Source

Functions

name

function name() external pure returns (string memory);

symbol

function symbol() external pure returns (string memory);

decimals

function decimals() external pure returns (uint8);

totalSupply

function totalSupply() external view returns (uint256);

balanceOf

function balanceOf(address owner) external view returns (uint256);

allowance

function allowance(address owner, address spender) external view returns (uint256);

approve

function approve(address spender, uint256 value) external returns (bool);

transfer

function transfer(address to, uint256 value) external returns (bool);

transferFrom

function transferFrom(address from, address to, uint256 value) external returns (bool);

DOMAIN_SEPARATOR

function DOMAIN_SEPARATOR() external view returns (bytes32);

PERMIT_TYPEHASH

function PERMIT_TYPEHASH() external pure returns (bytes32);

nonces

function nonces(address owner) external view returns (uint256);

permit

function permit(address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s)
    external;

MINIMUM_LIQUIDITY

function MINIMUM_LIQUIDITY() external pure returns (uint256);

factory

function factory() external view returns (address);

token0

function token0() external view returns (address);

token1

function token1() external view returns (address);

getReserves

function getReserves() external view returns (uint112 reserve0, uint112 reserve1, uint32 blockTimestampLast);

price0CumulativeLast

function price0CumulativeLast() external view returns (uint256);

price1CumulativeLast

function price1CumulativeLast() external view returns (uint256);

kLast

function kLast() external view returns (uint256);

mint

function mint(address to) external returns (uint256 liquidity);

burn

function burn(address to) external returns (uint256 amount0, uint256 amount1);

swap

function swap(uint256 amount0Out, uint256 amount1Out, address to, bytes calldata data) external;

skim

function skim(address to) external;

sync

function sync() external;

initialize

function initialize(address, address) external;

Events

Approval

event Approval(address indexed owner, address indexed spender, uint256 value);

Transfer

event Transfer(address indexed from, address indexed to, uint256 value);

Mint

event Mint(address indexed sender, uint256 amount0, uint256 amount1);

Burn

event Burn(address indexed sender, uint256 amount0, uint256 amount1, address indexed to);

Swap

event Swap(
    address indexed sender,
    uint256 amount0In,
    uint256 amount1In,
    uint256 amount0Out,
    uint256 amount1Out,
    address indexed to
);

Sync

event Sync(uint112 reserve0, uint112 reserve1);

IUniswapV2Router01

Git Source

Functions

factory

function factory() external pure returns (address);

WETH

function WETH() external pure returns (address);

addLiquidity

function addLiquidity(
    address tokenA,
    address tokenB,
    uint256 amountADesired,
    uint256 amountBDesired,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
) external returns (uint256 amountA, uint256 amountB, uint256 liquidity);

addLiquidityETH

function addLiquidityETH(
    address token,
    uint256 amountTokenDesired,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) external payable returns (uint256 amountToken, uint256 amountETH, uint256 liquidity);

removeLiquidity

function removeLiquidity(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
) external returns (uint256 amountA, uint256 amountB);

removeLiquidityETH

function removeLiquidityETH(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) external returns (uint256 amountToken, uint256 amountETH);

removeLiquidityWithPermit

function removeLiquidityWithPermit(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 amountA, uint256 amountB);

removeLiquidityETHWithPermit

function removeLiquidityETHWithPermit(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 amountToken, uint256 amountETH);

swapExactTokensForTokens

function swapExactTokensForTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapTokensForExactTokens

function swapTokensForExactTokens(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapExactETHForTokens

function swapExactETHForTokens(uint256 amountOutMin, address[] calldata path, address to, uint256 deadline)
    external
    payable
    returns (uint256[] memory amounts);

swapTokensForExactETH

function swapTokensForExactETH(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapExactTokensForETH

function swapExactTokensForETH(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapETHForExactTokens

function swapETHForExactTokens(uint256 amountOut, address[] calldata path, address to, uint256 deadline)
    external
    payable
    returns (uint256[] memory amounts);

quote

function quote(uint256 amountA, uint256 reserveA, uint256 reserveB) external pure returns (uint256 amountB);

getAmountOut

function getAmountOut(uint256 amountIn, uint256 reserveIn, uint256 reserveOut)
    external
    pure
    returns (uint256 amountOut);

getAmountIn

function getAmountIn(uint256 amountOut, uint256 reserveIn, uint256 reserveOut)
    external
    pure
    returns (uint256 amountIn);

getAmountsOut

function getAmountsOut(uint256 amountIn, address[] calldata path) external view returns (uint256[] memory amounts);

getAmountsIn

function getAmountsIn(uint256 amountOut, address[] calldata path) external view returns (uint256[] memory amounts);

IUniswapV2Router02

Git Source

Inherits: IUniswapV2Router01

Functions

removeLiquidityETHSupportingFeeOnTransferTokens

function removeLiquidityETHSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) external returns (uint256 amountETH);

removeLiquidityETHWithPermitSupportingFeeOnTransferTokens

function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 amountETH);

swapExactTokensForTokensSupportingFeeOnTransferTokens

function swapExactTokensForTokensSupportingFeeOnTransferTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external;

swapExactETHForTokensSupportingFeeOnTransferTokens

function swapExactETHForTokensSupportingFeeOnTransferTokens(
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external payable;

swapExactTokensForETHSupportingFeeOnTransferTokens

function swapExactTokensForETHSupportingFeeOnTransferTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external;

IWMATIC

Git Source

Inherits: IERC20

Author: Cujo

Functions

deposit

function deposit() external payable;

withdraw

function withdraw(uint256) external;

Contents

• Bridges
• Token
• TokenSwap
• LibAppStorage
• LibDiamond
• LibKlima
• LibMeta
• LibRetire

Contents

• LibC3Carbon
• LibCoorestCarbon
• LibICRCarbon
• LibMossCarbon
• LibToucanCarbon

LibC3Carbon

Git Source

Author: Cujo

Functions

freeRedeemAndRetire

Calls freeRedeem on a C3 pool and retires the underlying C3T

function freeRedeemAndRetire(
    address poolToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal;

Parameters

redeemSpecificAndRetire

Calls taxedRedeem on a C3 pool and retires the underlying C3T

function redeemSpecificAndRetire(
    address poolToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal;

Parameters

retireC3T

Retire a C3T token

function retireC3T(
    address poolToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal;

Parameters

getExactCarbonSpecificRedeemFee

Return the additional fee needed to redeem specific number of project tokens.

function getExactCarbonSpecificRedeemFee(address poolToken, uint256 amount)
    internal
    view
    returns (uint256 poolFeeAmount);

Parameters

Returns

getExactSourceSpecificRetireAmount

Return the amount that can be specifically redeemed from a C3 given x number of tokens.

function getExactSourceSpecificRetireAmount(address poolToken, uint256 amount)
    internal
    view
    returns (uint256 retireAmount);

Parameters

Returns

redeemPoolAuto

Receives and redeems a number of pool tokens and sends the C3T to a destination..

function redeemPoolAuto(address poolToken, uint256 amount, LibTransfer.To toMode)
    internal
    returns (address[] memory allProjectTokens, uint256[] memory amounts);

Parameters

Returns

redeemPoolSpecific

Receives and redeems a number of pool tokens and sends the C3T to a destination.

function redeemPoolSpecific(
    address poolToken,
    address[] memory projectTokens,
    uint256[] memory amounts,
    LibTransfer.To toMode
) internal returns (uint256[] memory);

Parameters

Returns

isValid

function isValid(address token) internal returns (bool);

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address carbonToken,
    uint256 retiredAmount
);

LibCoorestCarbon

Git Source

Author: must-be-carbon

Handles interaction with the Coorest Pool and child tokens ( CCO2, POCC )

Functions

retireCarbonToken

Retires CCO2

Use this function to retire CCO2.

This function assumes that checks to carbonToken are make higher up in call stack.

It's important to know that Coorest transfers fee portion to it's account & rest amount is burned

function retireCarbonToken(
    address carbonToken,
    uint256 retireAmount,
    uint256 retireAmountWithFee,
    LibRetire.RetireDetails memory details
) internal returns (uint256 poccId);

Parameters

Returns

getSpecificRetirementFee

Calculates the Coorest fee that needs to be added to desired retire amount

Use this function to compute the Coorest fee.

This function assumes that checks to carbonToken are make higher up in call stack

function getSpecificRetirementFee(address carbonToken, uint256 amount) internal view returns (uint256 feeAmount);

Parameters

Returns

getFeePercent

This function fetches fee percent & divider from CCO2 token contract.

function getFeePercent(address carbonToken) private view returns (FeeParams memory feeParams);

Parameters

Returns

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address carbonToken,
    uint256 retiredAmount
);

Errors

FeePercentageGreaterThanDivider

error FeePercentageGreaterThanDivider();

FeeRetireDividerIsZero

error FeeRetireDividerIsZero();

RetireAmountIsZero

error RetireAmountIsZero();

Structs

FeeParams

struct FeeParams {
    uint256 feeRetireBp;
    uint256 feeRetireDivider;
}

LibICRCarbon

Git Source

Author: Cujo

Functions

retireICC

function retireICC(
    address poolToken,
    address projectToken,
    uint256 tokenId,
    uint256 amount,
    LibRetire.RetireDetails memory details
) internal returns (uint256 retiredAmount);

isValid

function isValid(address token) internal view returns (bool);

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address carbonToken,
    uint256 tokenId,
    uint256 retiredAmount
);

LibMossCarbon

Git Source

Author: Cujo

Functions

offsetCarbon

Retires Moss MCO2 tokens on Polygon

function offsetCarbon(
    address poolToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal;

Parameters

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address carbonToken,
    uint256 retiredAmount
);

LibToucanCarbon

Git Source

Author: Cujo

Functions

redeemAutoAndRetire

Redeems Toucan pool tokens using default redemtion and retires the TCO2

function redeemAutoAndRetire(
    address poolToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal;

Parameters

redeemSpecificAndRetire

Redeems Toucan pool tokens using specific redemtion and retires the TCO2

function redeemSpecificAndRetire(
    address poolToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal returns (uint256 retiredAmount);

Parameters

Returns

retireTCO2

Redeems Toucan TCO2s

function retireTCO2(
    address poolToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal;

Parameters

retirePuroTCO2

Creates a Retirement Request for Toucan Puro TCO2s

function retirePuroTCO2(uint256 tokenId, address projectToken, uint256 amount, LibRetire.RetireDetails memory details)
    internal;

Parameters

sendRetireCert

Send the ERC-721 retirement certificate received to a beneficiary

function sendRetireCert(address _beneficiary) internal;

Parameters

getSpecificRedeemFee

Calculates the additional pool tokens needed to specifically redeem x TCO2s

function getSpecificRedeemFee(address poolToken, uint256 amount) internal view returns (uint256 poolFeeAmount);

Parameters

Returns

getSpecificRetireAmount

Returns the number of TCO2s retired when selectively redeeming x pool tokens

function getSpecificRetireAmount(address poolToken, uint256 amount) internal view returns (uint256 retireAmount);

Parameters

Returns

redeemPoolAuto

Simple wrapper to use redeem Toucan pools using the default list

function redeemPoolAuto(address poolToken, uint256 amount, LibTransfer.To toMode)
    internal
    returns (address[] memory projectTokens, uint256[] memory amounts);

Parameters

Returns

redeemPoolSpecific

Simple wrapper to use redeem Toucan pools using the specific list

function redeemPoolSpecific(
    address poolToken,
    address[] memory projectTokens,
    uint256[] memory amounts,
    LibTransfer.To toMode
) internal returns (uint256[] memory);

Parameters

Returns

isValid

function isValid(address token) internal returns (bool);

isPuro

function isPuro(address token) internal returns (bool);

Events

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address carbonToken,
    uint256 retiredAmount
);

CarbonRetired

event CarbonRetired(
    LibRetire.CarbonBridge carbonBridge,
    address indexed retiringAddress,
    string retiringEntityString,
    address indexed beneficiaryAddress,
    string beneficiaryString,
    string retirementMessage,
    address indexed carbonPool,
    address carbonToken,
    uint256 tokenId,
    uint256 retiredAmount
);

Contents

• LibApprove
• LibBalance
• LibMatic
• LibTransfer
• LibWmatic

LibApprove

Git Source

Author: publius

Functions

approveToken

function approveToken(IERC20 token, address spender, uint256 amount) internal;

LibBalance

Git Source

Author: LeoFib, Publius

Functions

getBalance

function getBalance(address account, IERC20 token) internal view returns (uint256 combined_balance);

increaseInternalBalance

Increases account's Internal Balance for token by amount.

function increaseInternalBalance(address account, IERC20 token, uint256 amount) internal;

decreaseInternalBalance

Decreases account's Internal Balance for token by amount. If allowPartial is true, this function doesn't revert if account doesn't have enough balance, and sets it to zero and returns the deducted amount instead.

function decreaseInternalBalance(address account, IERC20 token, uint256 amount, bool allowPartial)
    internal
    returns (uint256 deducted);

setInternalBalance

Sets account's Internal Balance for token to newBalance. Emits an InternalBalanceChanged event. This event includes delta, which is the amount the balance increased (if positive) or decreased (if negative). To avoid reading the current balance in order to compute the delta, this function relies on the caller providing it directly.

function setInternalBalance(address account, IERC20 token, uint256 newBalance, int256 delta) private;

getInternalBalance

Returns account's Internal Balance for token.

function getInternalBalance(address account, IERC20 token) internal view returns (uint256);

Events

InternalBalanceChanged

Emitted when a account's Internal Balance changes, through interacting using Internal Balance.

event InternalBalanceChanged(address indexed account, IERC20 indexed token, int256 delta);

LibMatic

Git Source

Author: Cujo

Functions

refundMatic

function refundMatic() internal;

LibTransfer

Git Source

Author: publius

Functions

transferToken

function transferToken(IERC20 token, address recipient, uint256 amount, From fromMode, To toMode)
    internal
    returns (uint256 transferredAmount);

receiveToken

function receiveToken(IERC20 token, uint256 amount, address sender, From mode)
    internal
    returns (uint256 receivedAmount);

receive1155Token

function receive1155Token(IERC1155 token, uint256 tokenId, uint256 amount, address sender, From mode)
    internal
    returns (uint256 receivedAmount);

sendToken

function sendToken(IERC20 token, uint256 amount, address recipient, To mode) internal;

Enums

From

enum From {
    EXTERNAL,
    INTERNAL,
    EXTERNAL_INTERNAL,
    INTERNAL_TOLERANT
}

To

enum To {
    EXTERNAL,
    INTERNAL
}

LibWmatic

Git Source

Author: Cujo

State Variables

WMATIC

address constant WMATIC = 0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270;

Functions

wrap

function wrap(uint256 amount, LibTransfer.To mode) internal;

unwrap

function unwrap(uint256 amount, LibTransfer.From mode) internal;

deposit

function deposit(uint256 amount) private;

withdraw

function withdraw(uint256 amount) private;

Contents

• LibSwap
• LibTreasurySwap
• LibTridentSwap
• LibUniswapV2Swap

LibSwap

Git Source

Author: Cujo

Functions

swapToExactCarbonDefault

Swaps to an exact number of carbon tokens

function swapToExactCarbonDefault(address sourceToken, address carbonToken, uint256 sourceAmount, uint256 carbonAmount)
    internal
    returns (uint256 carbonReceived);

Parameters

Returns

swapExactSourceToCarbonDefault

Swaps to an exact number of source tokens

function swapExactSourceToCarbonDefault(address sourceToken, address carbonToken, uint256 amount)
    internal
    returns (uint256 carbonReceived);

Parameters

Returns

returnTradeDust

Return any dust/slippaged amounts still held by the contract

function returnTradeDust(address sourceToken, address poolToken) internal;

Parameters

swapToKlimaFromUsdc

Swaps a given amount of USDC for KLIMA using Sushiswap

function swapToKlimaFromUsdc(uint256 sourceAmount, uint256 klimaAmount) internal returns (uint256 klimaReceived);

Parameters

Returns

swapToKlimaFromOther

Swaps from arbitrary token routed through USDC for KLIMA

function swapToKlimaFromOther(address sourceToken, uint256 sourceAmount, uint256 klimaAmount)
    internal
    returns (uint256 klimaReceived);

Parameters

Returns

swapWithRetirementBonds

Performs a swap with Retirement Bonds for carbon to retire.

function swapWithRetirementBonds(address sourceToken, address carbonToken, uint256 sourceAmount, uint256 carbonAmount)
    internal
    returns (uint256 carbonRecieved);

Parameters

Returns

getSourceAmount

Get the source amount needed when swapping within a single DEX

function getSourceAmount(address sourceToken, address carbonToken, uint256 amount)
    internal
    view
    returns (uint256 sourceNeeded);

Parameters

Returns

getMultipleSourceAmount

Get the source amount needed when swapping between multiple DEXs

function getMultipleSourceAmount(address sourceToken, address carbonToken, uint256 amount)
    internal
    view
    returns (uint256[] memory);

Parameters

Returns

getSourceAmountFromRetirementBond

Fetches the amount of KLIMA needed for a retirement bond, then calculates the source amount needed if a DEX swap is required.

function getSourceAmountFromRetirementBond(address sourceToken, address carbonToken, uint256 amount)
    internal
    view
    returns (uint256 sourceNeeded);

Parameters

Returns

getDefaultAmountOut

Get the source amount needed when swapping between multiple DEXs

function getDefaultAmountOut(address sourceToken, address carbonToken, uint256 amount)
    internal
    view
    returns (uint256 amountOut);

Parameters

Returns

_performToExactSwap

Perform a toExact swap depending on the dex provided

function _performToExactSwap(uint8 dex, address router, address[] memory path, uint256 maxAmountIn, uint256 amount)
    private
    returns (uint256 amountOut);

Parameters

Returns

_performExactSourceSwap

Perform a swap using all source tokens

function _performExactSourceSwap(uint8 dex, address router, address[] memory path, uint256 amount)
    private
    returns (uint256 amountOut);

Parameters

Returns

_getAmountIn

Return the amountIn needed for an exact swap

function _getAmountIn(uint8 dex, address router, address[] memory path, uint256 amount)
    private
    view
    returns (uint256 amountIn);

Parameters

Returns

_getAmountOut

Return the amountIn needed for an exact swap

function _getAmountOut(uint8 dex, address router, address[] memory path, uint256 amount)
    private
    view
    returns (uint256 amountOut);

Parameters

Returns

LibTreasurySwap

Git Source

Author: Cujo

Functions

getAmountIn

function getAmountIn(address tokenIn, uint256 amountOut) internal view returns (uint256 amountIn);

swapToExact

function swapToExact(address carbonToken, uint256 amountIn, uint256 amountOut) internal;

LibTridentSwap

Git Source

Author: Cujo

Functions

swapExactTokensForTokens

function swapExactTokensForTokens(address router, address pool, address tokenIn, uint256 amountIn, uint256 minAmountOut)
    internal
    returns (uint256 amountOut);

getAmountIn

function getAmountIn(address pool, address tokenIn, address tokenOut, uint256 amountOut)
    internal
    view
    returns (uint256 amountIn);

getAmountOut

function getAmountOut(address pool, address tokenIn, address tokenOut, uint256 amountIn)
    internal
    view
    returns (uint256 amountOut);

getTridentPool

function getTridentPool(address tokenOne, address tokenTwo) internal view returns (address tridentPool);

LibUniswapV2Swap

Git Source

Author: Cujo

Functions

swapTokensForExactTokens

function swapTokensForExactTokens(address router, address[] memory path, uint256 amountIn, uint256 amountOut)
    internal
    returns (uint256);

swapExactTokensForTokens

function swapExactTokensForTokens(address router, address[] memory path, uint256 amount) internal returns (uint256);

getAmountIn

function getAmountIn(address router, address[] memory path, uint256 amount) internal view returns (uint256);

getAmountOut

function getAmountOut(address router, address[] memory path, uint256 amount) internal view returns (uint256);

LibAppStorage

Git Source

Author: Publius

Functions

diamondStorage

function diamondStorage() internal pure returns (AppStorage storage ds);

LibDiamond

Git Source

Author: Nick Mudge nick@perfectabstractions.com (https://twitter.com/mudgen) EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535 /*****************************************************************************

State Variables

DIAMOND_STORAGE_POSITION

bytes32 constant DIAMOND_STORAGE_POSITION = keccak256("diamond.standard.diamond.storage");

Functions

diamondStorage

function diamondStorage() internal pure returns (DiamondStorage storage ds);

setContractOwner

function setContractOwner(address _newOwner) internal;

contractOwner

function contractOwner() internal view returns (address contractOwner_);

enforceIsContractOwner

function enforceIsContractOwner() internal view;

diamondCut

function diamondCut(IDiamondCut.FacetCut[] memory _diamondCut, address _init, bytes memory _calldata) internal;

addFunctions

function addFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal;

replaceFunctions

function replaceFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal;

removeFunctions

function removeFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal;

addFacet

function addFacet(DiamondStorage storage ds, address _facetAddress) internal;

addFunction

function addFunction(DiamondStorage storage ds, bytes4 _selector, uint96 _selectorPosition, address _facetAddress)
    internal;

removeFunction

function removeFunction(DiamondStorage storage ds, address _facetAddress, bytes4 _selector) internal;

initializeDiamondCut

function initializeDiamondCut(address _init, bytes memory _calldata) internal;

enforceHasContractCode

function enforceHasContractCode(address _contract, string memory _errorMessage) internal view;

Events

OwnershipTransferred

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);

DiamondCut

event DiamondCut(IDiamondCut.FacetCut[] _diamondCut, address _init, bytes _calldata);

Structs

FacetAddressAndPosition

struct FacetAddressAndPosition {
    address facetAddress;
    uint96 functionSelectorPosition;
}

FacetFunctionSelectors

struct FacetFunctionSelectors {
    bytes4[] functionSelectors;
    uint256 facetAddressPosition;
}

DiamondStorage

struct DiamondStorage {
    mapping(bytes4 => FacetAddressAndPosition) selectorToFacetAndPosition;
    mapping(address => FacetFunctionSelectors) facetFunctionSelectors;
    address[] facetAddresses;
    mapping(bytes4 => bool) supportedInterfaces;
    address contractOwner;
}

LibKlima

Git Source

Author: Cujo

Functions

toWrappedAmount

Returns wsKLIMA amount for provided sKLIMA amount

function toWrappedAmount(uint256 amount) internal view returns (uint256 wrappedAmount);

Parameters

Returns

toUnwrappedAmount

Returns sKLIMA amount for provided wsKLIMA amount

function toUnwrappedAmount(uint256 amount) internal view returns (uint256 unwrappedAmount);

Parameters

Returns

unwrapKlima

Unwraps and unstakes provided wsKLIMA amount

function unwrapKlima(uint256 amount) internal returns (uint256 unwrappedAmount);

Parameters

Returns

unstakeKlima

Unstakes provided sKLIMA amount

function unstakeKlima(uint256 amount) internal;

Parameters

wrapKlima

Stakes and wraps provided KLIMA amount

function wrapKlima(uint256 amount) internal returns (uint256 wrappedAmount);

Parameters

Returns

stakeKlima

Stakes provided KLIMA amount

function stakeKlima(uint256 amount) internal;

Parameters

LibMeta

Git Source

State Variables

EIP712_DOMAIN_TYPEHASH

bytes32 internal constant EIP712_DOMAIN_TYPEHASH =
    keccak256(bytes("EIP712Domain(string name,string version,uint256 salt,address verifyingContract)"));

Functions

domainSeparator

function domainSeparator(string memory name, string memory version) internal view returns (bytes32 domainSeparator_);

getChainID

function getChainID() internal view returns (uint256 id);

msgSender

function msgSender() internal view returns (address sender_);

addressToString

Converts an address to a string representation.

function addressToString(address _address) internal pure returns (string memory);

Parameters

Returns

LibRetire

Git Source

Author: Cujo

Functions

retireReceivedCarbon

Retire received carbon based on the bridge of the provided pool tokens using default redemption

function retireReceivedCarbon(
    address poolToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal;

Parameters

retireReceivedExactCarbonSpecific

Retire received carbon based on the bridge of the provided pool tokens using specific redemption

function retireReceivedExactCarbonSpecific(
    address poolToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal returns (uint256 redeemedAmount);

Parameters

retireReceivedCreditToken

Retire received carbon based on the bridge of the provided pool tokens using default redemption

function retireReceivedCreditToken(
    address creditToken,
    uint256 tokenId,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal;

Parameters

retireReceivedCreditToken

Retire received carbon based on the bridge of the provided pool tokens using default redemption

function retireReceivedCreditToken(address creditToken, uint256 tokenId, uint256 amount, RetireDetails memory details)
    internal;

Parameters

retireReceivedCarbonSpecificFromSource

Additional function to handle the differences in wanting to fully retire x pool tokens specifically

function retireReceivedCarbonSpecificFromSource(
    address poolToken,
    address projectToken,
    uint256 amount,
    address retiringAddress,
    string memory retiringEntityString,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal returns (uint256 redeemedAmount);

Parameters

Returns

getTotalCarbon

Returns the total carbon needed fee included

function getTotalCarbon(uint256 retireAmount) internal view returns (uint256 totalCarbon);

Parameters

Returns

getTotalCarbonSpecific

Returns the total carbon needed fee included

function getTotalCarbonSpecific(address poolToken, uint256 retireAmount) internal view returns (uint256 totalCarbon);

Parameters

Returns

getFee

Returns the total fee needed to retire x number of tokens

function getFee(uint256 carbonAmount) internal view returns (uint256 fee);

Parameters

Returns

saveRetirementDetails

Saves the details of the retirement over to KlimaCarbonRetirements and project details within AppStorage

function saveRetirementDetails(
    address poolToken,
    address projectToken,
    uint256 amount,
    address beneficiaryAddress,
    string memory beneficiaryString,
    string memory retirementMessage
) internal;

Parameters

getTotalRetirements

function getTotalRetirements(address account) internal view returns (uint256 totalRetirements);

getTotalCarbonRetired

function getTotalCarbonRetired(address account) internal view returns (uint256 totalCarbonRetired);

getTotalPoolRetired

function getTotalPoolRetired(address account, address poolToken) internal view returns (uint256 totalPoolRetired);

getTotalProjectRetired

function getTotalProjectRetired(address account, address projectToken) internal view returns (uint256);

getTotalRewardsClaimed

function getTotalRewardsClaimed(address account) internal view returns (uint256 totalClaimed);

getRetirementDetails

function getRetirementDetails(address account, uint256 retirementIndex)
    internal
    view
    returns (
        address poolTokenAddress,
        address projectTokenAddress,
        address beneficiaryAddress,
        string memory beneficiary,
        string memory retirementMessage,
        uint256 amount
    );

Structs

RetireDetails

struct RetireDetails {
    address retiringAddress;
    string retiringEntityString;
    address beneficiaryAddress;
    string beneficiaryString;
    string retirementMessage;
    string beneficiaryLocation;
    string consumptionCountryCode;
    uint256 consumptionPeriodStart;
    uint256 consumptionPeriodEnd;
}

Enums

CarbonBridge

enum CarbonBridge {
    TOUCAN,
    MOSS,
    C3,
    ICR,
    COOREST
}

Contents

• ConstantsGetter
• CoorestLibraryMock

ConstantsGetter

Git Source

Author: Cujo

Functions

toucanCert

function toucanCert() external pure returns (address);

mossCarbonChain

function mossCarbonChain() external pure returns (address);

staking

function staking() external pure returns (address);

stakingHelper

function stakingHelper() external pure returns (address);

treasury

function treasury() external pure returns (address);

klima

function klima() external pure returns (address);

sKlima

function sKlima() external pure returns (address);

wsKlima

function wsKlima() external pure returns (address);

usdc_bridged

function usdc_bridged() external pure returns (address);

usdc

function usdc() external pure returns (address);

bct

function bct() external pure returns (address);

nct

function nct() external pure returns (address);

mco2

function mco2() external pure returns (address);

ubo

function ubo() external pure returns (address);

nbo

function nbo() external pure returns (address);

sushiRouter

function sushiRouter() external pure returns (address);

quickswapRouter

function quickswapRouter() external pure returns (address);

sushiTridentRouter

function sushiTridentRouter() external pure returns (address);

sushiBento

function sushiBento() external pure returns (address);

klimaCarbonRetirements

function klimaCarbonRetirements() external pure returns (address);

klimaRetirementBond

function klimaRetirementBond() external pure returns (address);

carbonmark

function carbonmark() external pure returns (address);

coorestPool

function coorestPool() external pure returns (address);

coorestPoCCToken

function coorestPoCCToken() external pure returns (address);

coorestCCO2Token

function coorestCCO2Token() external pure returns (address);

CoorestLibraryMock

Git Source

Functions

getSpecificRetirementFee

function getSpecificRetirementFee(address carbonToken, uint256 amount) public returns (uint256);

Account

Git Source

Author: Cujo

Structs

Retirement

struct Retirement {
    address poolTokenAddress;
    address projectTokenAddress;
    address beneficiaryAddress;
    string beneficiary;
    string retirementMessage;
    uint256 amount;
    uint256 pledgeID;
}

State

struct State {
    mapping(uint256 => Retirement) retirements;
    mapping(address => uint256) totalPoolRetired;
    mapping(address => uint256) totalProjectRetired;
    uint256 totalRetirements;
    uint256 totalCarbonRetired;
    uint256 totalRewardsClaimed;
}

Storage

Git Source

Structs

CarbonBridge

struct CarbonBridge {
    string name;
    address defaultRouter;
    uint8 routerType;
}

DefaultSwap

struct DefaultSwap {
    uint8[] swapDexes;
    address[] ammRouters;
    mapping(uint8 => address[]) swapPaths;
}

Token1155Settings

Stores the transient details of 1155 tokens received.

struct Token1155Settings {
    uint256 tokenId;
    uint256 value;
    uint256[] ids;
    uint256[] values;
}

Properties

AppStorage

Git Source

struct AppStorage {
    mapping(uint256 => Storage.CarbonBridge) bridges;
    mapping(address => bool) isPoolToken;
    mapping(address => LibRetire.CarbonBridge) poolBridge;
    mapping(address => mapping(address => Storage.DefaultSwap)) swap;
    mapping(address => Account.State) a;
    uint256 lastERC721Received;
    uint256 fee;
    uint256 reentrantStatus;
    mapping(address => mapping(IERC20 => uint256)) internalTokenBalance;
    mapping(address => uint256) metaNonces;
    bytes32 domainSeparator;
    mapping(address => mapping(address => address)) tridentPool;
    Storage.Token1155Settings lastERC1155Received;
}

C

Git Source

Author: Cujo

State Variables

CHAIN_ID

uint256 private constant CHAIN_ID = 137;

KLIMA

address private constant KLIMA = 0x4e78011Ce80ee02d2c3e649Fb657E45898257815;

SKLIMA

address private constant SKLIMA = 0xb0C22d8D350C67420f06F48936654f567C73E8C8;

WSKLIMA

address private constant WSKLIMA = 0x6f370dba99E32A3cAD959b341120DB3C9E280bA6;

STAKING

address private constant STAKING = 0x25d28a24Ceb6F81015bB0b2007D795ACAc411b4d;

STAKING_HELPER

address private constant STAKING_HELPER = 0x4D70a031Fc76DA6a9bC0C922101A05FA95c3A227;

TREASURY

address private constant TREASURY = 0x7Dd4f0B986F032A44F913BF92c9e8b7c17D77aD7;

USDC_BRIDGED

address private constant USDC_BRIDGED = 0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174;

USDC

address private constant USDC = 0x3c499c542cEF5E3811e1192ce70d8cC03d5c3359;

SUSHI_POLYGON

address private constant SUSHI_POLYGON = 0x1b02dA8Cb0d097eB8D57A175b88c7D8b47997506;

QUICKSWAP_POLYGON

address private constant QUICKSWAP_POLYGON = 0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff;

SUSHI_BENTO

address private constant SUSHI_BENTO = 0x0319000133d3AdA02600f0875d2cf03D442C3367;

SUSHI_TRIDENT_POLYGON

address private constant SUSHI_TRIDENT_POLYGON = 0xc5017BE80b4446988e8686168396289a9A62668E;

CARBONMARK

address private constant CARBONMARK = 0x7B51dBc2A8fD98Fe0924416E628D5755f57eB821;

BCT

address private constant BCT = 0x2F800Db0fdb5223b3C3f354886d907A671414A7F;

NCT

address private constant NCT = 0xD838290e877E0188a4A44700463419ED96c16107;

MCO2

address private constant MCO2 = 0xAa7DbD1598251f856C12f63557A4C4397c253Cea;

UBO

address private constant UBO = 0x2B3eCb0991AF0498ECE9135bcD04013d7993110c;

NBO

address private constant NBO = 0x6BCa3B77C1909Ce1a4Ba1A20d1103bDe8d222E48;

TOUCAN_RETIRE_CERT

address private constant TOUCAN_RETIRE_CERT = 0x5e377f16E4ec6001652befD737341a28889Af002;

MOSS_CARBON_CHAIN

address private constant MOSS_CARBON_CHAIN = 0xeDAEFCf60e12Bd331c092341D5b3d8901C1c05A8;

KLIMA_CARBON_RETIREMENTS

address private constant KLIMA_CARBON_RETIREMENTS = 0xac298CD34559B9AcfaedeA8344a977eceff1C0Fd;

KLIMA_RETIREMENT_BOND

address private constant KLIMA_RETIREMENT_BOND = 0xa595f0d598DaF144e5a7ca91E6D9A5bAA09dDeD0;

TOUCAN_REGISTRY

address constant TOUCAN_REGISTRY = 0x263fA1c180889b3a3f46330F32a4a23287E99FC9;

C3_PROJECT_FACTORY

address constant C3_PROJECT_FACTORY = 0xa4c951B30952f5E2feFC8a92F4d3c7551925A63B;

ICR_PROJECT_REGISTRY

address constant ICR_PROJECT_REGISTRY = 0x9f87988FF45E9b58ae30fA1685088460125a7d8A;

COOREST_POOL

address constant COOREST_POOL = 0x363ae9B7Dbf55c0956A74C3be4ed0996d277A8BE;

COOREST_POCC_TOKEN

address constant COOREST_POCC_TOKEN = 0x51cF819352FC536aD8A84214922615C160BB497D;

COOREST_CCO2_TOKEN

address constant COOREST_CCO2_TOKEN = 0x82B37070e43C1BA0EA9e2283285b674eF7f1D4E2;

Functions

toucanCert

function toucanCert() internal pure returns (address);

mossCarbonChain

function mossCarbonChain() internal pure returns (address);

staking

function staking() internal pure returns (address);

stakingHelper

function stakingHelper() internal pure returns (address);

treasury

function treasury() internal pure returns (address);

klima

function klima() internal pure returns (address);

sKlima

function sKlima() internal pure returns (address);

wsKlima

function wsKlima() internal pure returns (address);

usdc_bridged

function usdc_bridged() internal pure returns (address);

usdc

function usdc() internal pure returns (address);

bct

function bct() internal pure returns (address);

nct

function nct() internal pure returns (address);

mco2

function mco2() internal pure returns (address);

ubo

function ubo() internal pure returns (address);

nbo

function nbo() internal pure returns (address);

sushiRouter

function sushiRouter() internal pure returns (address);

quickswapRouter

function quickswapRouter() internal pure returns (address);

sushiTridentRouter

function sushiTridentRouter() internal pure returns (address);

sushiBento

function sushiBento() internal pure returns (address);

klimaCarbonRetirements

function klimaCarbonRetirements() internal pure returns (address);

klimaRetirementBond

function klimaRetirementBond() internal pure returns (address);

toucanRegistry

function toucanRegistry() internal pure returns (address);

c3ProjectFactory

function c3ProjectFactory() internal pure returns (address);

carbonmark

function carbonmark() internal pure returns (address);

icrProjectRegistry

function icrProjectRegistry() internal pure returns (address);

coorestPool

function coorestPool() internal pure returns (address);

coorestPoCCToken

function coorestPoCCToken() internal pure returns (address);

coorestCCO2Token

function coorestCCO2Token() internal pure returns (address);

Diamond

Git Source

Author: Nick Mudge nick@perfectabstractions.com (https://twitter.com/mudgen) EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535 Implementation of a diamond. /*****************************************************************************

State Variables

s

AppStorage internal s;

Functions

constructor

constructor(address _contractOwner, address _diamondCutFacet) payable;

fallback

fallback() external payable;

receive

receive() external payable;

ReentrancyGuard

Git Source

Author: Beanstalk Farms

State Variables

_NOT_ENTERED

uint256 private constant _NOT_ENTERED = 1;

_ENTERED

uint256 private constant _ENTERED = 2;

s

AppStorage internal s;

Functions

nonReentrant

modifier nonReentrant();

Contents

• sushixklima

Contents

• interfaces
• keepers
• IOwnable
• Ownable
• IUniswapV2Pair
• SafeMathUniswap
• UniswapV2Library
• TransferHelper
• IUniswapV2Router01
• IUniswapV2Router02
• IUniswapV2Factory
• IERC20Uniswap
• IWETH
• UniswapV2Router02
• SushiswapGreenSwapWrapper
• IKlimaRetirementAggregator
• IWrappedAsset
• SwapRetirementHolder
• testETHSender

Contents

• IUniswapV2Router01
• IUniswapV2Router02

IUniswapV2Router01

Git Source

Functions

factory

function factory() external pure returns (address);

WETH

function WETH() external pure returns (address);

addLiquidity

function addLiquidity(
    address tokenA,
    address tokenB,
    uint256 amountADesired,
    uint256 amountBDesired,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
) external returns (uint256 amountA, uint256 amountB, uint256 liquidity);

addLiquidityETH

function addLiquidityETH(
    address token,
    uint256 amountTokenDesired,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) external payable returns (uint256 amountToken, uint256 amountETH, uint256 liquidity);

removeLiquidity

function removeLiquidity(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
) external returns (uint256 amountA, uint256 amountB);

removeLiquidityETH

function removeLiquidityETH(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) external returns (uint256 amountToken, uint256 amountETH);

removeLiquidityWithPermit

function removeLiquidityWithPermit(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 amountA, uint256 amountB);

removeLiquidityETHWithPermit

function removeLiquidityETHWithPermit(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 amountToken, uint256 amountETH);

swapExactTokensForTokens

function swapExactTokensForTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapTokensForExactTokens

function swapTokensForExactTokens(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapExactETHForTokens

function swapExactETHForTokens(uint256 amountOutMin, address[] calldata path, address to, uint256 deadline)
    external
    payable
    returns (uint256[] memory amounts);

swapTokensForExactETH

function swapTokensForExactETH(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapExactTokensForETH

function swapExactTokensForETH(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapETHForExactTokens

function swapETHForExactTokens(uint256 amountOut, address[] calldata path, address to, uint256 deadline)
    external
    payable
    returns (uint256[] memory amounts);

quote

function quote(uint256 amountA, uint256 reserveA, uint256 reserveB) external pure returns (uint256 amountB);

getAmountOut

function getAmountOut(uint256 amountIn, uint256 reserveIn, uint256 reserveOut)
    external
    pure
    returns (uint256 amountOut);

getAmountIn

function getAmountIn(uint256 amountOut, uint256 reserveIn, uint256 reserveOut)
    external
    pure
    returns (uint256 amountIn);

getAmountsOut

function getAmountsOut(uint256 amountIn, address[] calldata path) external view returns (uint256[] memory amounts);

getAmountsIn

function getAmountsIn(uint256 amountOut, address[] calldata path) external view returns (uint256[] memory amounts);

IUniswapV2Router02

Git Source

Inherits: IUniswapV2Router01

Functions

removeLiquidityETHSupportingFeeOnTransferTokens

function removeLiquidityETHSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) external returns (uint256 amountETH);

removeLiquidityETHWithPermitSupportingFeeOnTransferTokens

function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 amountETH);

swapExactTokensForTokensSupportingFeeOnTransferTokens

function swapExactTokensForTokensSupportingFeeOnTransferTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external;

swapExactETHForTokensSupportingFeeOnTransferTokens

function swapExactETHForTokensSupportingFeeOnTransferTokens(
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external payable;

swapExactTokensForETHSupportingFeeOnTransferTokens

function swapExactTokensForETHSupportingFeeOnTransferTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external;

Contents

• KeeperBase
• KeeperCompatible
• KeeperCompatibleInterface

KeeperBase

Git Source

Functions

preventExecution

method that allows it to be simulated via eth_call by checking that the sender is the zero address.

function preventExecution() internal view;

cannotExecute

modifier that allows it to be simulated via eth_call by checking that the sender is the zero address.

modifier cannotExecute();

Errors

OnlySimulatedBackend

error OnlySimulatedBackend();

KeeperCompatible

Git Source

Inherits: KeeperBase, KeeperCompatibleInterface

KeeperCompatibleInterface

Git Source

Functions

checkUpkeep

method that is simulated by the keepers to see if any work actually needs to be performed. This method does does not actually need to be executable, and since it is only ever simulated it can consume lots of gas.

To ensure that it is never called, you may want to add the cannotExecute modifier from KeeperBase to your implementation of this method.

function checkUpkeep(bytes calldata checkData) external returns (bool upkeepNeeded, bytes memory performData);

Parameters

Returns

performUpkeep

method that is actually executed by the keepers, via the registry. The data returned by the checkUpkeep simulation will be passed into this method to actually be executed.

The input to this method should not be trusted, and the caller of the method should not even be restricted to any single registry. Anyone should be able call it, and the input should be validated, there is no guarantee that the data passed in is the performData returned from checkUpkeep. This could happen due to malicious keepers, racing keepers, or simply a state change while the performUpkeep transaction is waiting for confirmation. Always validate the data passed in.

function performUpkeep(bytes calldata performData) external;

Parameters

IOwnable

Git Source

Functions

manager

function manager() external view returns (address);

renounceManagement

function renounceManagement() external;

pushManagement

function pushManagement(address newOwner_) external;

pullManagement

function pullManagement() external;

Ownable

Git Source

Inherits: IOwnable

State Variables

_owner

address internal _owner;

_newOwner

address internal _newOwner;

Functions

constructor

constructor();

manager

function manager() public view override returns (address);

onlyManager

modifier onlyManager();

renounceManagement

function renounceManagement() public virtual override onlyManager;

pushManagement

function pushManagement(address newOwner_) public virtual override onlyManager;

pullManagement

function pullManagement() public virtual override;

Events

OwnershipPushed

event OwnershipPushed(address indexed previousOwner, address indexed newOwner);

OwnershipPulled

event OwnershipPulled(address indexed previousOwner, address indexed newOwner);

IUniswapV2Pair

Git Source

Submitted for verification at polygonscan.com on 2021-06-09

Functions

name

function name() external pure returns (string memory);

symbol

function symbol() external pure returns (string memory);

decimals

function decimals() external pure returns (uint8);

totalSupply

function totalSupply() external view returns (uint256);

balanceOf

function balanceOf(address owner) external view returns (uint256);

allowance

function allowance(address owner, address spender) external view returns (uint256);

approve

function approve(address spender, uint256 value) external returns (bool);

transfer

function transfer(address to, uint256 value) external returns (bool);

transferFrom

function transferFrom(address from, address to, uint256 value) external returns (bool);

DOMAIN_SEPARATOR

function DOMAIN_SEPARATOR() external view returns (bytes32);

PERMIT_TYPEHASH

function PERMIT_TYPEHASH() external pure returns (bytes32);

nonces

function nonces(address owner) external view returns (uint256);

permit

function permit(address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s)
    external;

MINIMUM_LIQUIDITY

function MINIMUM_LIQUIDITY() external pure returns (uint256);

factory

function factory() external view returns (address);

token0

function token0() external view returns (address);

token1

function token1() external view returns (address);

getReserves

function getReserves() external view returns (uint112 reserve0, uint112 reserve1, uint32 blockTimestampLast);

price0CumulativeLast

function price0CumulativeLast() external view returns (uint256);

price1CumulativeLast

function price1CumulativeLast() external view returns (uint256);

kLast

function kLast() external view returns (uint256);

mint

function mint(address to) external returns (uint256 liquidity);

burn

function burn(address to) external returns (uint256 amount0, uint256 amount1);

swap

function swap(uint256 amount0Out, uint256 amount1Out, address to, bytes calldata data) external;

skim

function skim(address to) external;

sync

function sync() external;

initialize

function initialize(address, address) external;

Events

Approval

event Approval(address indexed owner, address indexed spender, uint256 value);

Transfer

event Transfer(address indexed from, address indexed to, uint256 value);

Mint

event Mint(address indexed sender, uint256 amount0, uint256 amount1);

Burn

event Burn(address indexed sender, uint256 amount0, uint256 amount1, address indexed to);

Swap

event Swap(
    address indexed sender,
    uint256 amount0In,
    uint256 amount1In,
    uint256 amount0Out,
    uint256 amount1Out,
    address indexed to
);

Sync

event Sync(uint112 reserve0, uint112 reserve1);

SafeMathUniswap

Git Source

Functions

add

function add(uint256 x, uint256 y) internal pure returns (uint256 z);

sub

function sub(uint256 x, uint256 y) internal pure returns (uint256 z);

mul

function mul(uint256 x, uint256 y) internal pure returns (uint256 z);

UniswapV2Library

Git Source

Functions

sortTokens

function sortTokens(address tokenA, address tokenB) internal pure returns (address token0, address token1);

pairFor

function pairFor(address factory, address tokenA, address tokenB) internal pure returns (address pair);

getReserves

function getReserves(address factory, address tokenA, address tokenB)
    internal
    view
    returns (uint256 reserveA, uint256 reserveB);

quote

function quote(uint256 amountA, uint256 reserveA, uint256 reserveB) internal pure returns (uint256 amountB);

getAmountOut

function getAmountOut(uint256 amountIn, uint256 reserveIn, uint256 reserveOut)
    internal
    pure
    returns (uint256 amountOut);

getAmountIn

function getAmountIn(uint256 amountOut, uint256 reserveIn, uint256 reserveOut)
    internal
    pure
    returns (uint256 amountIn);

getAmountsOut

function getAmountsOut(address factory, uint256 amountIn, address[] memory path)
    internal
    view
    returns (uint256[] memory amounts);

getAmountsIn

function getAmountsIn(address factory, uint256 amountOut, address[] memory path)
    internal
    view
    returns (uint256[] memory amounts);

TransferHelper

Git Source

Functions

safeApprove

function safeApprove(address token, address to, uint256 value) internal;

safeTransfer

function safeTransfer(address token, address to, uint256 value) internal;

safeTransferFrom

function safeTransferFrom(address token, address from, address to, uint256 value) internal;

safeTransferETH

function safeTransferETH(address to, uint256 value) internal;

IUniswapV2Router01

Git Source

Functions

factory

function factory() external pure returns (address);

WETH

function WETH() external pure returns (address);

addLiquidity

function addLiquidity(
    address tokenA,
    address tokenB,
    uint256 amountADesired,
    uint256 amountBDesired,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
) external returns (uint256 amountA, uint256 amountB, uint256 liquidity);

addLiquidityETH

function addLiquidityETH(
    address token,
    uint256 amountTokenDesired,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) external payable returns (uint256 amountToken, uint256 amountETH, uint256 liquidity);

removeLiquidity

function removeLiquidity(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
) external returns (uint256 amountA, uint256 amountB);

removeLiquidityETH

function removeLiquidityETH(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) external returns (uint256 amountToken, uint256 amountETH);

removeLiquidityWithPermit

function removeLiquidityWithPermit(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 amountA, uint256 amountB);

removeLiquidityETHWithPermit

function removeLiquidityETHWithPermit(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 amountToken, uint256 amountETH);

swapExactTokensForTokens

function swapExactTokensForTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapTokensForExactTokens

function swapTokensForExactTokens(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapExactETHForTokens

function swapExactETHForTokens(uint256 amountOutMin, address[] calldata path, address to, uint256 deadline)
    external
    payable
    returns (uint256[] memory amounts);

swapTokensForExactETH

function swapTokensForExactETH(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapExactTokensForETH

function swapExactTokensForETH(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external returns (uint256[] memory amounts);

swapETHForExactTokens

function swapETHForExactTokens(uint256 amountOut, address[] calldata path, address to, uint256 deadline)
    external
    payable
    returns (uint256[] memory amounts);

quote

function quote(uint256 amountA, uint256 reserveA, uint256 reserveB) external pure returns (uint256 amountB);

getAmountOut

function getAmountOut(uint256 amountIn, uint256 reserveIn, uint256 reserveOut)
    external
    pure
    returns (uint256 amountOut);

getAmountIn

function getAmountIn(uint256 amountOut, uint256 reserveIn, uint256 reserveOut)
    external
    pure
    returns (uint256 amountIn);

getAmountsOut

function getAmountsOut(uint256 amountIn, address[] calldata path) external view returns (uint256[] memory amounts);

getAmountsIn

function getAmountsIn(uint256 amountOut, address[] calldata path) external view returns (uint256[] memory amounts);

IUniswapV2Router02

Git Source

Inherits: IUniswapV2Router01

Functions

removeLiquidityETHSupportingFeeOnTransferTokens

function removeLiquidityETHSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) external returns (uint256 amountETH);

removeLiquidityETHWithPermitSupportingFeeOnTransferTokens

function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 amountETH);

swapExactTokensForTokensSupportingFeeOnTransferTokens

function swapExactTokensForTokensSupportingFeeOnTransferTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external;

swapExactETHForTokensSupportingFeeOnTransferTokens

function swapExactETHForTokensSupportingFeeOnTransferTokens(
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external payable;

swapExactTokensForETHSupportingFeeOnTransferTokens

function swapExactTokensForETHSupportingFeeOnTransferTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external;

IUniswapV2Factory

Git Source

Functions

feeTo

function feeTo() external view returns (address);

feeToSetter

function feeToSetter() external view returns (address);

migrator

function migrator() external view returns (address);

getPair

function getPair(address tokenA, address tokenB) external view returns (address pair);

allPairs

function allPairs(uint256) external view returns (address pair);

allPairsLength

function allPairsLength() external view returns (uint256);

createPair

function createPair(address tokenA, address tokenB) external returns (address pair);

setFeeTo

function setFeeTo(address) external;

setFeeToSetter

function setFeeToSetter(address) external;

setMigrator

function setMigrator(address) external;

Events

PairCreated

event PairCreated(address indexed token0, address indexed token1, address pair, uint256);

IERC20Uniswap

Git Source

Functions

name

function name() external view returns (string memory);

symbol

function symbol() external view returns (string memory);

decimals

function decimals() external view returns (uint8);

totalSupply

function totalSupply() external view returns (uint256);

balanceOf

function balanceOf(address owner) external view returns (uint256);

allowance

function allowance(address owner, address spender) external view returns (uint256);

approve

function approve(address spender, uint256 value) external returns (bool);

transfer

function transfer(address to, uint256 value) external returns (bool);

transferFrom

function transferFrom(address from, address to, uint256 value) external returns (bool);

Events

Approval

event Approval(address indexed owner, address indexed spender, uint256 value);

Transfer

event Transfer(address indexed from, address indexed to, uint256 value);

IWETH

Git Source

Functions

deposit

function deposit() external payable;

transfer

function transfer(address to, uint256 value) external returns (bool);

withdraw

function withdraw(uint256) external;

UniswapV2Router02

Git Source

Inherits: IUniswapV2Router02

State Variables

factory

address public immutable override factory;

WETH

address public immutable override WETH;

Functions

ensure

modifier ensure(uint256 deadline);

constructor

constructor(address _factory, address _WETH) public;

receive

receive() external payable;

_addLiquidity

function _addLiquidity(
    address tokenA,
    address tokenB,
    uint256 amountADesired,
    uint256 amountBDesired,
    uint256 amountAMin,
    uint256 amountBMin
) internal virtual returns (uint256 amountA, uint256 amountB);

addLiquidity

function addLiquidity(
    address tokenA,
    address tokenB,
    uint256 amountADesired,
    uint256 amountBDesired,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
) external virtual override ensure(deadline) returns (uint256 amountA, uint256 amountB, uint256 liquidity);

addLiquidityETH

function addLiquidityETH(
    address token,
    uint256 amountTokenDesired,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
)
    external
    payable
    virtual
    override
    ensure(deadline)
    returns (uint256 amountToken, uint256 amountETH, uint256 liquidity);

removeLiquidity

function removeLiquidity(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline
) public virtual override ensure(deadline) returns (uint256 amountA, uint256 amountB);

removeLiquidityETH

function removeLiquidityETH(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) public virtual override ensure(deadline) returns (uint256 amountToken, uint256 amountETH);

removeLiquidityWithPermit

function removeLiquidityWithPermit(
    address tokenA,
    address tokenB,
    uint256 liquidity,
    uint256 amountAMin,
    uint256 amountBMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external virtual override returns (uint256 amountA, uint256 amountB);

removeLiquidityETHWithPermit

function removeLiquidityETHWithPermit(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external virtual override returns (uint256 amountToken, uint256 amountETH);

removeLiquidityETHSupportingFeeOnTransferTokens

function removeLiquidityETHSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline
) public virtual override ensure(deadline) returns (uint256 amountETH);

removeLiquidityETHWithPermitSupportingFeeOnTransferTokens

function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
    address token,
    uint256 liquidity,
    uint256 amountTokenMin,
    uint256 amountETHMin,
    address to,
    uint256 deadline,
    bool approveMax,
    uint8 v,
    bytes32 r,
    bytes32 s
) external virtual override returns (uint256 amountETH);

_swap

function _swap(uint256[] memory amounts, address[] memory path, address _to) internal virtual;

swapExactTokensForTokens

function swapExactTokensForTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external virtual override ensure(deadline) returns (uint256[] memory amounts);

swapTokensForExactTokens

function swapTokensForExactTokens(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
) external virtual override ensure(deadline) returns (uint256[] memory amounts);

swapExactETHForTokens

function swapExactETHForTokens(uint256 amountOutMin, address[] calldata path, address to, uint256 deadline)
    external
    payable
    virtual
    override
    ensure(deadline)
    returns (uint256[] memory amounts);

swapTokensForExactETH

function swapTokensForExactETH(
    uint256 amountOut,
    uint256 amountInMax,
    address[] calldata path,
    address to,
    uint256 deadline
) external virtual override ensure(deadline) returns (uint256[] memory amounts);

swapExactTokensForETH

function swapExactTokensForETH(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external virtual override ensure(deadline) returns (uint256[] memory amounts);

swapETHForExactTokens

function swapETHForExactTokens(uint256 amountOut, address[] calldata path, address to, uint256 deadline)
    external
    payable
    virtual
    override
    ensure(deadline)
    returns (uint256[] memory amounts);

_swapSupportingFeeOnTransferTokens

function _swapSupportingFeeOnTransferTokens(address[] memory path, address _to) internal virtual;

swapExactTokensForTokensSupportingFeeOnTransferTokens

function swapExactTokensForTokensSupportingFeeOnTransferTokens(
    uint256 amountIn,
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external virtual override ensure(deadline);

swapExactETHForTokensSupportingFeeOnTransferTokens

function swapExactETHForTokensSupportingFeeOnTransferTokens(
    uint256 amountOutMin,
    address[] calldata path,
    address to,
    uint256 deadline
) external payable virtual override ensure(deadline);