> For the complete documentation index, see [llms.txt](https://docs.rigoblock.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rigoblock.com/api/protocol/interfaces/v4/pool/ismartpoolactions.md).

# ISmartPoolActions

## Overview

#### License: Apache 2.0-or-later

```solidity
interface ISmartPoolActions
```

Author: Gabriele Rigo - <gab@rigoblock.com>

## Functions info

### mint (0x156e29f6)

```solidity
function mint(
    address recipient,
    uint256 amountIn,
    uint256 amountOutMin
) external payable returns (uint256 recipientAmount)
```

Allows a user to mint pool tokens on behalf of an address.

Parameters:

| Name         | Type    | Description                                                         |
| ------------ | ------- | ------------------------------------------------------------------- |
| recipient    | address | Address receiving the tokens.                                       |
| amountIn     | uint256 | Amount of base tokens.                                              |
| amountOutMin | uint256 | Minimum amount to be received, prevents pool operator frontrunning. |

Return values:

| Name            | Type    | Description                           |
| --------------- | ------- | ------------------------------------- |
| recipientAmount | uint256 | Number of tokens minted to recipient. |

### mintWithToken (0xf7b94b33)

```solidity
function mintWithToken(
    address recipient,
    uint256 amountIn,
    uint256 amountOutMin,
    address tokenIn
) external payable returns (uint256 recipientAmount)
```

Allows a user to mint pool tokens on behalf of an address using a desired token.

The token must be vault-owned, i.e. in the active token list, after operator action.

Parameters:

| Name         | Type    | Description                                                         |
| ------------ | ------- | ------------------------------------------------------------------- |
| recipient    | address | Address receiving the tokens.                                       |
| amountIn     | uint256 | Amount of base tokens.                                              |
| amountOutMin | uint256 | Minimum amount to be received, prevents pool operator frontrunning. |

Return values:

| Name            | Type    | Description                           |
| --------------- | ------- | ------------------------------------- |
| recipientAmount | uint256 | Number of tokens minted to recipient. |

### burn (0xb390c0ab)

```solidity
function burn(
    uint256 amountIn,
    uint256 amountOutMin
) external returns (uint256 netRevenue)
```

Allows a pool holder to burn pool tokens.

Parameters:

| Name         | Type    | Description                                                         |
| ------------ | ------- | ------------------------------------------------------------------- |
| amountIn     | uint256 | Number of tokens to burn.                                           |
| amountOutMin | uint256 | Minimum amount to be received, prevents pool operator frontrunning. |

Return values:

| Name       | Type    | Description                      |
| ---------- | ------- | -------------------------------- |
| netRevenue | uint256 | Net amount of burnt pool tokens. |

### burnForToken (0x78b3dea4)

```solidity
function burnForToken(
    uint256 amountIn,
    uint256 amountOutMin,
    address tokenOut
) external returns (uint256 netRevenue)
```

Allows a pool holder to burn pool tokens and receive a token other than base token.

The method is a fallback for when the vault does not hold enough base token, reverts otherwise.

Parameters:

| Name         | Type    | Description                                                         |
| ------------ | ------- | ------------------------------------------------------------------- |
| amountIn     | uint256 | Number of tokens to burn.                                           |
| amountOutMin | uint256 | Minimum amount to be received, prevents pool operator frontrunning. |
| tokenOut     | address | The token to be received in exchange for pool tokens.               |

Return values:

| Name       | Type    | Description                      |
| ---------- | ------- | -------------------------------- |
| netRevenue | uint256 | Net amount of burnt pool tokens. |

### updateUnitaryValue (0xe7d8724e)

```solidity
function updateUnitaryValue()
    external
    returns (NetAssetsValue memory navParams)
```

Allows anyone to store an up-to-date pool price.

Return values:

| Name      | Type                  | Description                                                     |
| --------- | --------------------- | --------------------------------------------------------------- |
| navParams | struct NetAssetsValue | Tuple of unitary value, net total value, net total liabilities. |

### setOperator (0x558a7297)

```solidity
function setOperator(address operator, bool approved) external returns (bool)
```

Sets or removes an operator for the caller.

Parameters:

| Name     | Type    | Description                  |
| -------- | ------- | ---------------------------- |
| operator | address | The address of the operator. |
| approved | bool    | The approval status.         |

Return values:

| Name | Type | Description        |
| ---- | ---- | ------------------ |
| \[0] | bool | bool True, always. |
