toucan-sdk/docs/modules.md

A JavaScript SDK for Toucan Protocol. Works in the web browser and Node.js.

[toucan-sdk](README.md) / Exports

# toucan-sdk

## Table of contents

### Classes

- [default](classes/default.md)

### Type Aliases

- [BalanceResponse](modules.md#balanceresponse)
- [BridgedBatchTokensResponse](modules.md#bridgedbatchtokensresponse)
- [PoolContentsResponse](modules.md#poolcontentsresponse)
- [ProjectResponse](modules.md#projectresponse)
- [RedeemsResponse](modules.md#redeemsresponse)
- [TCO2TokenResponse](modules.md#tco2tokenresponse)
- [UserBatchesResponse](modules.md#userbatchesresponse)
- [UserRetirementsResponse](modules.md#userretirementsresponse)

## Type Aliases

### BalanceResponse

Ƭ **BalanceResponse**: `Pick`<`TCO2BalanceSchema`, ``"balance"``\> & { `token`: `Pick`<`TCO2TokenSchema`, ``"symbol"``\>  }

#### Defined in

[types/responses.ts:147](https://github.com/GigaHierz/toucan-sdk/blob/b837065/src/types/responses.ts#L147)

___

### BridgedBatchTokensResponse

Ƭ **BridgedBatchTokensResponse**: `Pick`<`BatchTokenSchema`, ``"id"`` \| ``"serialNumber"`` \| ``"quantity"`` \| ``"timestamp"`` \| ``"tx"``\> & { `creator`: `Pick`<`UserSchema`, ``"id"``\>  }

#### Defined in

[types/responses.ts:75](https://github.com/GigaHierz/toucan-sdk/blob/b837065/src/types/responses.ts#L75)

___

### PoolContentsResponse

Ƭ **PoolContentsResponse**: `Pick`<`PooledTCO2TokenSchema`, ``"amount"``\> & { `token`: `Pick`<`TCO2TokenSchema`, ``"name"``\> & { `projectVintage`: `Pick`<`ProjectVintageSchema`, ``"id"``\> & { `project`: `Pick`<`ProjectSchema`, ``"methodology"`` \| ``"standard"``\>  }  }  }

#### Defined in

[types/responses.ts:126](https://github.com/GigaHierz/toucan-sdk/blob/b837065/src/types/responses.ts#L126)

___

### ProjectResponse

Ƭ **ProjectResponse**: `Pick`<`ProjectSchema`, ``"projectId"`` \| ``"region"`` \| ``"standard"`` \| ``"methodology"``\> & { `vintages`: `Pick`<`ProjectVintageSchema`, ``"id"``\>  }

#### Defined in

[types/responses.ts:138](https://github.com/GigaHierz/toucan-sdk/blob/b837065/src/types/responses.ts#L138)

___

### RedeemsResponse

Ƭ **RedeemsResponse**: `Pick`<`RedeemSchema`, ``"id"`` \| ``"amount"`` \| ``"timestamp"``\> & { `creator`: `Pick`<`UserSchema`, ``"id"``\> ; `token`: `Pick`<`TCO2TokenSchema`, ``"symbol"`` \| ``"name"`` \| ``"address"``\> & { `projectVintage`: `Pick`<`ProjectVintageSchema`, ``"name"``\> & { `project`: `Pick`<`ProjectSchema`, ``"projectId"``\>  }  }  }

#### Defined in

[types/responses.ts:110](https://github.com/GigaHierz/toucan-sdk/blob/b837065/src/types/responses.ts#L110)

___

### TCO2TokenResponse

Ƭ **TCO2TokenResponse**: `Pick`<`TCO2TokenSchema`, ``"id"`` \| ``"name"`` \| ``"symbol"`` \| ``"address"``\> & { `projectVintage`: `Pick`<`ProjectVintageSchema`, ``"name"``\> & { `project`: `Pick`<`ProjectSchema`, ``"projectId"``\>  }  }

#### Defined in

[types/responses.ts:62](https://github.com/GigaHierz/toucan-sdk/blob/b837065/src/types/responses.ts#L62)

___

### UserBatchesResponse

Ƭ **UserBatchesResponse**: `Pick`<`BatchTokenSchema`, ``"id"`` \| ``"tx"`` \| ``"serialNumber"`` \| ``"quantity"`` \| ``"confirmationStatus"``\> & { `comments`: `Pick`<`BatchCommentSchema`, ``"id"`` \| ``"comment"``\> & { `sender`: `Pick`<`UserSchema`, ``"id"``\>  }[] ; `creator`: `Pick`<`UserSchema`, ``"id"``\>  }[]

I have decided to separated the types for the subgraph methods here as using Pick to separate
the needed properties from the schemas can become verbose as you will see below.

See types/schemas.ts for more information on why I decided to use Pick in the first place.

#### Defined in

[types/responses.ts:44](https://github.com/GigaHierz/toucan-sdk/blob/b837065/src/types/responses.ts#L44)

___

### UserRetirementsResponse

Ƭ **UserRetirementsResponse**: `Pick`<`RetirementSchema`, ``"id"`` \| ``"creationTx"`` \| ``"amount"`` \| ``"timestamp"``\> & { `certificate`: `Pick`<`RetirementCertificateSchema`, ``"id"`` \| ``"retiringEntityString"`` \| ``"beneficiaryString"`` \| ``"retirementMessage"`` \| ``"createdAt"``\> & { `beneficiary`: `Pick`<`UserSchema`, ``"id"``\> ; `retiringEntity`: `Pick`<`UserSchema`, ``"id"``\>  } ; `token`: `Pick`<`TCO2TokenSchema`, ``"symbol"`` \| ``"name"`` \| ``"address"``\> & { `projectVintage`: `Pick`<`ProjectVintageSchema`, ``"name"``\> & { `project`: `Pick`<`ProjectSchema`, ``"projectId"``\>  }  }  }

#### Defined in

[types/responses.ts:84](https://github.com/GigaHierz/toucan-sdk/blob/b837065/src/types/responses.ts#L84)