> For the complete documentation index, see [llms.txt](https://docs.caviar.sh/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caviar.sh/technical-reference/custom-pools/smart-contract-api/privatepoolmetadata.md).

# PrivatePoolMetadata

[Git Source](https://github.com/outdoteth/caviar-private-pools/blob/4214d102e516c8e0735261ce0b0adad9ffef842f/src/PrivatePoolMetadata.sol)

**Author:** out.eth (@outdoteth)

This contract is used to generate NFT metadata for private pools.

## Functions

### tokenURI

Returns the tokenURI for a pool with it's metadata.

```solidity
function tokenURI(uint256 tokenId) public view returns (string memory);
```

**Parameters**

| Name      | Type      | Description                  |
| --------- | --------- | ---------------------------- |
| `tokenId` | `uint256` | The private pool's token ID. |

### attributes

Returns the attributes for a pool encoded as json.

```solidity
function attributes(uint256 tokenId) public view returns (string memory);
```

**Parameters**

| Name      | Type      | Description                  |
| --------- | --------- | ---------------------------- |
| `tokenId` | `uint256` | The private pool's token ID. |

### svg

Returns an svg image for a pool.

```solidity
function svg(uint256 tokenId) public view returns (bytes memory);
```

**Parameters**

| Name      | Type      | Description                  |
| --------- | --------- | ---------------------------- |
| `tokenId` | `uint256` | The private pool's token ID. |

### trait

```solidity
function trait(string memory traitType, string memory value) internal pure returns (string memory);
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.caviar.sh/technical-reference/custom-pools/smart-contract-api/privatepoolmetadata.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.