Skip to content

Commit ed806d1

Browse files
authored
Merge pull request ToucanProtocol#103 from pheuberger/fix-import-in-docs
Fix a few mistakes in the README file
2 parents c0cc677 + 3aa916b commit ed806d1

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -310,16 +310,14 @@ If you do, that's also quite easy to pull off. You just replace the usage of the
310310
```typescript
311311
const retirementReceipt = await toucan.retireAndMintCertificate(
312312
"Alice",
313-
signer.address,
313+
bobsAddress,
314314
"Bob",
315315
"Just helping the planet",
316316
parseEther("3.0"),
317317
tco2s[len - 1].address
318318
);
319319
```
320320

321-
Why do you see my name twice you ask? 🤔
322-
323-
Well, the first "Alice" represents the entity that is doing the retirement/offset. The second one represents the party that 'benefits' from it, in this case "Bob". We will also add Bob's address so now the relation of the certificate is set to that address instead of the retiring party.
321+
"Alice" represents the entity that is doing the retirement/offset. The second name represents the party that 'benefits' from it, in this case "Bob". We will also add Bob's address so now the relation of the certificate is set to that address instead of the retiring party.
324322

325323
This useful in case you happen to be an entity that retires on behalf of someone else.

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ yarn add toucan-sdk
2929
Instantiate the ToucanClient and set a `signer` & `provider` to interact with our infrastructure.
3030

3131
```typescript
32-
import { ToucanClient } from "toucan-sdk";
32+
import ToucanClient from "toucan-sdk";
3333

3434
const toucan = new ToucanClient("alfajores", provider, signer);
3535
```
3636

3737
You could also set the signer/provider later if you prefer that. They are optional. But you will need to set them if you want to interact with contracts. The provider is read-only, while the signer allows both writing to and reading from the blockchain.
3838

3939
```typescript
40-
import { ToucanClient } from "toucan-sdk";
40+
import ToucanClient from "toucan-sdk";
4141

4242
const toucan = new ToucanClient("alfajores");
4343
toucan.setProvider(provider);
@@ -140,7 +140,7 @@ Now you have quite some info on the project, including its address.
140140
Toucan SDK offers a lot of pre-defined queries. Try them out!
141141

142142
```typescript
143-
import { ToucanClient } from "toucan-sdk";
143+
import ToucanClient from "toucan-sdk";
144144

145145
// here we don't need to set the signer or provider
146146
const toucan = new ToucanClient("alfajores");
@@ -186,7 +186,7 @@ This allows you to fetch with your own queries and can be very powerful if you k
186186

187187
```typescript
188188
import { gql } from "@urql/core";
189-
import { ToucanClient } from "toucan-sdk";
189+
import ToucanClient from "toucan-sdk";
190190

191191
const toucan = new ToucanClient("alfajores");
192192

0 commit comments

Comments
 (0)