Retire Carbon Credits on Celo using ToucanSDK 🌱
Learn how to make your dApp climate positive with a few lines of code. 👩💻
Climate change is real, and thinking of our carbon footprint when building software should be part of the planning process as much as thinking about the architecture. One blockchain that is leading in this regard is Celo blockchain. They are even offsetting more carbon than they are producing. So, if your choice of network for your application is Celo, you already made a step in the right direction. But other actions can increase your or your users carbon footprint and, in this tutorial, you will learn how to account for that in a few lines of code and create a climate positive app. If you are new to carbon credit retirements and what kind of infrastructure tools Toucan provides, make sure to read up on it in their blog.
To start building, you'll need a basic understanding of web development, Node (v12), yarn, and Git.
- Node
- Yarn
- Git
- Celo-Composer
- Toucan SDK
Okay. What will learn in this tutorial in detail? We will learn how to retire carbon credits on Celo. To do that we will have to first aquire some carbon pool token fomr a DEX, redeem these e.g,Nature Carbon Tonnes (NCTs) for tokenized carbon credits (TCO2s) and retire those. We will also learn how to get all data related to tokens and retirements through querying the subgraph. As a little cherie on the top, we will do a quick preview of the OffsetHelper that will simplify all of this even more!!
By the end of this tutorial, you will know
- how to redeem carbon reference tokens, like NCT for TCO2
- how to retire TCO2
- how to query the subgraph to get details on tokens, retirements and certificates
And now lets start building 🏗
Clone this repository and open the project in our favorite IDE (e.g., VS Code).
git clone [email protected]:GigaHierz/co-operate-workshop.git
First navigate into the react-app.
cd packages/react-app/
Here install all dependencies with
npm i
or
yarn
And finally, let's start the App and see if everything is running.
npm run dev
or
yarn run dev
With the newest update, every dApp that relies on WalletConnect now needs to obtain a projectId from WalletConnect Cloud. This is absolutely free and only takes a few minutes.
Provide the projectId to getDefaultWallets and individual RainbowKit wallet connectors like the following:
Rename the env.exampleto .env
Add you token ID as vaule for NEXT_PUBLIC_WC_PROJECT_ID.
Next, we are going to retire carbon credits on Celo using the Toucan SDK. The Toucan SDK provides you with tools to simply implement carbon retirements into your app with just a few lines of code. It also provides some pre-defined subgraph queries but offers you the freedom to create any query your heart desires to get all the info about all retirements and tokens.
Add the Toucan SDK.
npm i toucan-sdk
or
yarn add toucan-sdk
In case it shows an error message with Module not found: Can't resolve 'toucan-sdk', just delete the noe_moudles and run yarnor npm i again.
We want to first instantiate the ToucanClient and set a signer & provider to interact with our infrastructure. We can use the signer & provider from the wagmi library. For interacting with The Graph, no provider or signer is needed though. But we will talk about that later.
So in the index.ts file we will add the imports to the top:
import ToucanClient from "toucan-sdk";
import { useProvider, useSigner } from "wagmi";And this part into our function body. You can set the signer and provider directly or at a later point. Here we want to first check if the signer is set, meaning if the user is connected to the application with their wallet.
const provider = useProvider();
const { data: signer, isError, isLoading } = useSigner();
const toucan = new ToucanClient("alfajores", provider);
signer && toucan.setSigner(signer);In the end our code should look like this:
import ToucanClient from "toucan-sdk";
import { useProvider, useSigner } from "wagmi";
export default function Home() {
const provider = useProvider();
const { data: signer, isError, isLoading } = useSigner();
const toucan = new ToucanClient("alfajores", provider);
signer && toucan.setSigner(signer);
return (
<div>
<div className="h1">
There we go... a canvas for your next Celo project!
</div>
</div>
);
}To retire Carbon Credits, we need pool tokens (e.g., NCTs) or carbon reference tokens like TCO2s. We can get them from the Toucan Faucet. In this example we will get NCT, as theses are the tokens, you can buy in an exchange like Ubeswap.
What is the difference between NCTs and TCO2s? Simply put, TCO2s are tokenized carbon credits. While NCT are the first carbon reference tokens created on Toucans infrastructure and are stripped of most attributes. As a user you will only have TCO2 tokens, if you tokenized carbon credits yourself or if you have already redeemed NCTs for TCO2s. So, this example will start with NCTs.
🍃 Get some Nature Carbon Tonnes (NCT) form the Toucan Faucet before you continue. Make sure you have CELO to pay the gas fee for the withdrawal, you can get some from the Celo Faucet. 🍃
Now, using the ToucanSDK we will auto-redeem the Pool tokens with toucan.redeemAuto2, where they are exchanged for the lowest ranking TCO2s. The function also returns the addresses of the redeemed TCO2s, which we need for the next step. As arguments for the function, we will need the pool symbol, that we want to retire, like "NCT". We will also need to input the amount of tokens we wish to retire, use parseEther("1") from the "ethers.js" for that.
If we prefer to choose the TCO2s that we want to retire, we can get a list of all TCO2s with getScoredTCO2s and then select the ones we prefer. Currently scored TCO2 means, that the tokens are sorted by year with scoredTokens[0] being the lowest. Using the Toucan SDK, you can get more info on each of the tokens though querying the subgraph (as described in the next part), and decide your own criteria, based on the newly released Core Carbon Principals. When choosing the TCO2 you want to retire, make sure that the balance of the token is not 0.
After having chosen TCO2s we want to retire, (we can choose several) we can redeem them with toucan.redeemMany. For this Toucan Protocol takes fees. We can calculate the fee beforehand with toucan.toucan.calculateRedeemFees.
But today we stay simple with toucan.redeemAuto2.
await toucan.redeemAuto2("NCT", parseEther("1"));Now let's put that code in a function and add a button to trigger it, so we can see it in action!! We also want to store the return value, the TCO2 address in a variable, as we will want to use it in the next step.
import ToucanClient from "toucan-sdk";
import { useProvider, useSigner } from "wagmi";
import { parseEther } from "ethers/lib/utils";
import { useState } from "react";
export default function Home() {
const provider = useProvider();
const { data: signer, isError, isLoading } = useSigner();
const toucan = new ToucanClient("alfajores", provider);
signer && toucan.setSigner(signer);
// we will store our return value here
const [tco2address, setTco2address] = useState("");
const redeemPoolToken = async (): Promise<void> => {
const redeemedTokenAddress = await toucan.redeemAuto2(
"NCT",
parseEther("1")
);
redeemedTokenAddress && setTco2address(redeemedTokenAddress[0].address);
};
return (
<div>
<button
className="inline-flex w-full justify-center rounded-full border px-5 my-5 py-2 text-md font-medium border-wood bg-prosperity text-black hover:bg-snow"
onClick={() => redeemPoolToken()}
>
{"Redeem Tokens"}
</button>
</div>
);
}Okayyyy, let's connect our wallet Wallet Connect button and redeem the token. And 👓 Check the transaction on Celoscan 👓
After having redeemed our pool tokens for TCO2s, we will be able to retire them. We can only retire TCO2 tokens. We can either choose to simply toucan.retire or if we would like to retire for a third party use the toucan.retireFrom function. Lastly, we can also already get a certificate created with toucan.retireAndMintCertificate.
The first thing we will have to do, will be to get the address of our TCO2 token. We will have saved that as return value form toucan.redeemAuto2. And now we can retire our token.
await toucan.retire(parseEther("1.0"), tco2Address);Let's create a second function called retirePoolToken as well as a button for the retirement process.
import { parseEther } from "ethers/lib/utils.js";
import { useState } from "react";
import ToucanClient from "toucan-sdk";
import { useProvider, useSigner } from "wagmi";
export default function Home() {
const provider = useProvider();
const { data: signer, isError, isLoading } = useSigner();
const toucan = new ToucanClient("alfajores", provider);
signer && toucan.setSigner(signer);
const [tco2address, setTco2address] = useState("");
const redeemPoolToken = async (): Promise<void> => {
const redeemedTokenAddress = await toucan.redeemAuto2(
"NCT",
parseEther("1")
);
redeemedTokenAddress && setTco2address(redeemedTokenAddress[0].address);
};
const retirePoolToken = async (): Promise<void> => {
tco2address.length && (await toucan.retire(parseEther("1"), tco2address));
};
return (
<div>
<button
className="inline-flex w-full justify-center rounded-full border px-5 my-5 py-2 text-md font-medium border-wood bg-prosperity text-black hover:bg-snow"
onClick={() => redeemPoolToken()}
>
{"Redeem Tokens"}
</button>
<button
className="inline-flex w-full justify-center rounded-full border px-5 my-5 py-2 text-md font-medium border-wood bg-prosperity text-black hover:bg-snow"
onClick={() => retirePoolToken()}
>
{"Retire Tokens"}
</button>
</div>
);
}You now have the foundation to implement retirement with endless possibilities like in one function and trigger retirements based on an input. image of the app with buttons to redeem and retire
In the last step, we are creating a list showing our retirements. First, we will create a new list.tsx page.
Here we need the Toucan Client again. This time, we won't need a provider or signer as we are only querying the subgraph.
const toucan = new ToucanClient("alfajores");The Toucan SDK has several pre-defined queries to get data from the subgraph, but we can also create our customized query with toucan.fetchCustomQuery(). We can check all schemes, create and test our query in the playground of the Toucan Subgraph.
For now, we will use one of the predefined queries, to get a list of our retirements. We will need the user address here so we will use the useAccount Hook from wagmi. Remember that an address (user, token) always needs to be lower case for querying.
const { address } = useAccount();
await toucan.fetchUserRetirements(address?.toLowerCase());Now let's add save the return value in a state, add typing for our retirement data, fetch the user retirements when the component is loading and add some code to display our retirements in a table.
import { useEffect, useState } from "react";
import ToucanClient, { UserRetirementsResponse } from "toucan-sdk";
import { useAccount } from "wagmi";
export default function List() {
const toucan = new ToucanClient("alfajores");
const { address } = useAccount();
const [retirements, setRetirements] = useState<UserRetirementsResponse[]>([]);
const getUserRetirements = async () => {
const result =
address && (await toucan.fetchUserRetirements(address?.toLowerCase()));
result && setRetirements(result);
};
useEffect(() => {
getUserRetirements();
});
return (
<div>
<div className="mt-8 flow-root">
<div className="-mx-4 -my-2 overflow-x-auto sm:-mx-6 lg:-mx-8">
<div className="inline-block min-w-full py-2 align-middle sm:px-6 lg:px-8">
{retirements?.length && (
<div className="overflow-hidden ring-1 ring-black">
<table className="min-w-full divide-y divide-black">
<thead className="bg-prosperity">
<tr>
<th
scope="col"
className="py-3.5 pl-4 pr-3 text-left text-sm font-semibold text-gray-900 sm:pl-6"
>
Token Name
</th>
<th
scope="col"
className="px-3 py-3.5 text-left text-sm font-semibold text-gray-900"
>
Token Symbol
</th>
<th
scope="col"
className="px-3 py-3.5 text-left text-sm font-semibold text-gray-900"
>
Certificate ID
</th>
<th
scope="col"
className="px-3 py-3.5 text-left text-sm font-semibold text-gray-900"
>
Creation Tx
</th>
</tr>
</thead>
<tbody className="divide-y divide-black bg-white">
{retirements.map((item) => {
return (
<tr key={item.id}>
<td className="whitespace-nowrap py-4 pl-4 pr-3 text-sm font-medium text-gray-900 sm:pl-6">
{item.token.name}
</td>
<td className="whitespace-nowrap px-3 py-4 text-sm text-gray-500">
{item.token.symbol}
</td>
<td className="whitespace-nowrap px-3 py-4 text-sm text-gray-500">
{item.certificate?.id}
</td>
<td className="relative whitespace-nowrap py-4 pl-3 pr-4 text-right text-sm font-medium sm:pr-6">
<a
target="\_blank"
rel="noopener noreferrer"
href={`https://alfajores.celoscan.io/tx/${item.creationTx}`}
className="text-forest hover:text-forest"
>
...
{item.creationTx.substring(
item.creationTx.length - 15
)}
</a>
</td>
</tr>
);
})}
</tbody>
</table>
</div>
)}
</div>
</div>
</div>
</div>
);
}Add the list page into the header.tsx file and your "Retirement List Page" and you are done!
So far the OffsetHelper has only been deployed on Polygon. But now it's almost ready on Celo. This contract will make it even easier to retire carbon credits.
What does it do in detail:
- user exchanges cUSD for NCT tokens at one of the DEXs (Ubeswap, Uniswap soon)
- user interacts with the NCT token contract to redeem the tokens for TCO2
- user interacts with the TCO2 token contract to retire the TCO2
very cool!! lets try it out!!!
first let's create a new page called autoOffset.tsx. Let's use the usePrepareContractWrite and useContractWrite from the wagmi library to call the autoOffsetPoolToken function.
You will need to look up the address of the poolToken you want to retire/offset. You can find all addresses of Toucans deployed contracts on their page.
The token should already be in your wallet. If you need some for testing, head over to our faucet. Otherwise head over to Ubeswap (soon Uniswap) to buy some. There are other functions in the OffsetHelper, that already overtake the swapping part. So, check it out. On Celo you can use only the token functions like autoOffsetExactInToken and autoOffsetExactOutTokenand don't need the functions for native tokens like autoOffsetExactInETH and autoOffsetExactOutETH.
We will do the Offsetting directly on Celo (not using the testnet).
autoOffsetPoolToken(poolToken: string, amount: BigNumber);import { parseEther } from "ethers/lib/utils.js";
import { useContractWrite, usePrepareContractWrite } from "wagmi";
export default function autoOffset() {
const poolAddress = "0x02De4766C272abc10Bc88c220D214A26960a7e92";
const amount = parseEther("1");
const { config } = usePrepareContractWrite({
address: "0xAB62E8a5A43453339f745EaFcbEE0302A31c3d5E",
abi: [
{
inputs: [
{
internalType: "address",
name: "_poolToken",
type: "address",
},
{
internalType: "uint256",
name: "_amountToOffset",
type: "uint256",
},
],
stateMutability: "nonpayable",
type: "function",
},
],
functionName: "autoOffsetPoolToken",
args: [
poolAddress,
amount,
{
gasLimit: 2500000,
},
],
});
const { data, isLoading, isSuccess, write } = useContractWrite(config);
return <div></div>;
}okay. you might get an error. and for a reason. First we will have the user approve the amount that the OffsetHelper will retire. Here the Toucan SDK comes in handy again. We can get the poolcontract by just looking for the symbol like "NCT".
import ToucanClient from "toucan-sdk";
import { useProvider, useSigner } from "wagmi";
const provider = useProvider();
const { data: signer, isError } = useSigner();
const toucan = new ToucanClient("celo", provider);
signer && toucan.setSigner(signer);
const poolToken = toucan.getPoolContract("NCT");
const offsetHelperAddress = "0xAB62E8a5A43453339f745EaFcbEE0302A31c3d5E";
const approve = async () => {
return await poolToken.approve(offsetHelperAddress, amount);
};Let's call the function and add a button.
const offset = async () => {
const tx = await approve();
await tx.wait();
write && write();
};
return (
<div>
<button
className="inline-flex w-full justify-center rounded-full border px-5 my-5 py-2 text-md font-medium border-wood bg-prosperity text-black hover:bg-snow"
onClick={() => offset?.()}
>
offset
</button>
{isLoading && <div>Check Wallet</div>}
{isSuccess && (
<div>
<a
href={`https://celoscan.io/tx/${JSON.stringify(data.hash)}`}
target="_blank"
rel="noopener noreferrer"
>
{" "}
Transaction: {JSON.stringify(data.hash)}
</a>{" "}
</div>
)}{" "}
</div>
);If you followed the guide your code should now look like this:
import { usePrepareContractWrite, useContractWrite, useChainId } from "wagmi";
import ToucanClient from "toucan-sdk";
import { useProvider, useSigner } from "wagmi";
import { parseEther } from "ethers/lib/utils";
export default function AutoOffsetPoolToken() {
const provider = useProvider();
const amount = parseEther("1");
const { data: signer, isError } = useSigner();
const toucan = new ToucanClient("celo", provider);
signer && toucan.setSigner(signer);
const poolToken = toucan.getPoolContract("NCT");
const poolAddress = "0xfb60a08855389F3c0A66b29aB9eFa911ed5cbCB5";
const offsetHelperAddress = "0xAB62E8a5A43453339f745EaFcbEE0302A31c3d5E";
const approve = async () => {
return await poolToken.approve(offsetHelperAddress, amount);
};
const { config } = usePrepareContractWrite({
address: offsetHelperAddress,
abi: [
{
inputs: [
{
internalType: "address",
name: "_poolToken",
type: "address",
},
{
internalType: "uint256",
name: "_amountToOffset",
type: "uint256",
},
],
name: "autoOffsetPoolToken",
outputs: [
{
internalType: "address[]",
name: "tco2s",
type: "address[]",
},
{
internalType: "uint256[]",
name: "amounts",
type: "uint256[]",
},
],
stateMutability: "nonpayable",
type: "function",
},
],
functionName: "autoOffsetPoolToken",
args: [
poolAddress,
amount,
{
gasLimit: 2500000,
},
],
});
const { data, isLoading, isSuccess, write } = useContractWrite(config);
const offset = async () => {
const tx = await approve();
await tx.wait();
write && write();
};
return (
<div>
<button
className="inline-flex w-full justify-center rounded-full border px-5 my-5 py-2 text-md font-medium border-wood bg-prosperity text-black hover:bg-snow"
onClick={() => offset?.()}
>
offset
</button>
{isLoading && <div>Check Wallet</div>}
{isSuccess && (
<div>
<a
href={`https://celoscan.io/tx/${JSON.stringify(data.hash)}`}
target="_blank"
rel="noopener noreferrer"
>
{" "}
Transaction: {JSON.stringify(data.hash)}
</a>{" "}
</div>
)}{" "}
</div>
);
}Congratulations! You've build your first climate positive app. Now go explore more ways to build on Toucan in
- Toucan's documentation
- Toucan's SDK
- Toucan's blog