Skip to content

Commit

Permalink
Merge pull request #27 from ToucanProtocol/johnx25bd-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
0xmichalis committed Dec 28, 2023
2 parents 7405d40 + 7f86b2c commit 1fd6f14
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Offset Helper

This contract has the purpose to simplify the carbon offsetting process.
This contract simplifies the carbon offsetting process on Toucan.

What it does in more exact terms is it abstracts the process of retiring TCO2, which normally looks like so:
More specifically, the Offset Helper abstracts the process of using a stablecoin to acquire and retire TCO2. This process normally looks like:

- user exchanges USDC for BCT/NCT tokens at one of the DEXs (Uniswap, Sushiswap, etc. depending on network)
- user interacts with the BCT/NCT token contract to redeem the tokens for TCO2
- user exchanges USDC (a stablecoin) for carbon reference tokens like BCT or NCT using a DEX like Uniswap, Sushiswap, etc. (depending on network)
- user interacts with the BCT/NCT pool token contract to redeem TCO2 tokens from within the pool
- user interacts with the TCO2 token contract to retire the TCO2

You can see this process explained in more depth in our [docs](https://docs.toucan.earth/toucan/introduction/overview).

With the OffsetHelper contract, the user only needs to interact with the OffsetHelper contract, which will take care of the rest in a single transaction.

## Deployments
Expand All @@ -22,14 +24,14 @@ See [./docs/OffsetHelper.md](./docs/OffsetHelper.md) for detailed documentation.

### Development

## Preqrequisites
## Prerequisites

1. Install the required packages:
```
yarn
```
2. Copy `.env.example` to `.env` and modify values of the required environment variables:
1. `POLYGON_URL`/`MUMBAI_URL` to specify custom RPC endpoints for Polygon Mainnet, respectively, the Mumbai Testnet.
1. `POLYGON_URL`/`MUMBAI_URL` to specify your preferred RPC endpoints for Polygon Mainnet and the Mumbai Testnet.
2. `PRIVATE_KEY` and `POLYGONSCAN_KEY` in order to deploy contract and publish source code on [polygonscan](https://polygonscan.com).

## Commands
Expand Down

0 comments on commit 1fd6f14

Please sign in to comment.