Skip to content

Commit 7ef8682

Browse files
committed
docs: remove extended description of offsethelper from readme
This description is in the contract's natspec and not be duplicated
1 parent 96711ee commit 7ef8682

File tree

1 file changed

+2
-14
lines changed

1 file changed

+2
-14
lines changed

README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,9 @@ A collection of Solidity contract examples that implement, integrate with or dem
1010

1111
## OffsetHelper
1212

13-
The `OffsetHelper` contract implements helper functions that simplify the carbon offsetting (retirement) process. Retiring carbon tokens normally requires multiple steps and interactions with Toucan Protocol's main contracts:
14-
1. Obtain a Toucan pool token such as BCT or NCT (by performing a token swap).
15-
2. Redeem the pool token for a TCO2 token.
16-
3. Retire the TCO2 token.
13+
The `OffsetHelper` contract implements helper functions that simplify the carbon offsetting (retirement) process.
1714

18-
These steps are combined in each of the following "auto offset" methods implemented in `OffsetHelper` to allow a retirement within one transaction:
19-
- `autoOffsetUsingPoolToken()` if the user has already owns a Toucan pool token such as BCT or NCT,
20-
- `autoOffsetUsingETH()` if the user would like to perform a retirement using MATIC,
21-
- `autoOffsetUsingToken()` if the user would like to perform a retirement using an ERC20 token: USDC, WETH or WMATIC.
22-
23-
In these methods, "auto" refers to the fact that these methods use `autoRedeem` in order to automatically choose a TCO2 token corresponding to the oldest tokenized carbon project in the specfified token pool. There are no fees incurred by the user when using `autoRedeem`.
24-
25-
There are two read helper functions `calculateNeededETHAmount()` and `calculateNeededTokenAmount()` that can be used before calling `autoOffsetUsingETH()` and `autoOffsetUsingToken()`, to determine how MATIC, respectively how much of the ERC20 token must be sent to the `OffsetHelper` contract in order to retire the specified amount of carbon.
26-
27-
See [./docs/OffsetHelper.md](./docs/OffsetHelper.md) for detailed documentation of these and other methods from the contract.
15+
See [./docs/OffsetHelper.md](./docs/OffsetHelper.md) for detailed documentation.
2816

2917
### Development
3018

0 commit comments

Comments
 (0)