# WLSETHV1

*Alluvial Finance Inc.*

> Wrapped LsETH (v1)

This contract wraps the LsETH token into a rebase token, more suitable for some DeFi use-cases like stable swaps.

## Methods

### allowance

```solidity
function allowance(address _owner, address _spender) external view returns (uint256)
```

Retrieves the token allowance given from one address to another

#### Parameters

| Name      | Type    | Description                         |
| --------- | ------- | ----------------------------------- |
| \_owner   | address | Owner that gave the allowance       |
| \_spender | address | Spender that received the allowance |

#### Returns

| Name | Type    | Description                               |
| ---- | ------- | ----------------------------------------- |
| \_0  | uint256 | The allowance of the owner to the spender |

### approve

```solidity
function approve(address _spender, uint256 _value) external nonpayable returns (bool)
```

Approves another account to transfer tokens

#### Parameters

| Name      | Type    | Description                         |
| --------- | ------- | ----------------------------------- |
| \_spender | address | Spender that receives the allowance |
| \_value   | uint256 | Amount to allow                     |

#### Returns

| Name | Type | Description     |
| ---- | ---- | --------------- |
| \_0  | bool | True if success |

### balanceOf

```solidity
function balanceOf(address _owner) external view returns (uint256)
```

Retrieves the token balance of the specified user

#### Parameters

| Name    | Type    | Description                |
| ------- | ------- | -------------------------- |
| \_owner | address | Owner to check the balance |

#### Returns

| Name | Type    | Description              |
| ---- | ------- | ------------------------ |
| \_0  | uint256 | The balance of the owner |

### burn

```solidity
function burn(address _recipient, uint256 _shares) external nonpayable
```

Burn tokens and retrieve underlying LsETH tokens

*The message sender burns shares from its balance for the LsETH equivalent valueThe message sender doesn't need to approve the contract to burn the sharesThe freed LsETH is sent to the specified recipient*

#### Parameters

| Name        | Type    | Description                                                               |
| ----------- | ------- | ------------------------------------------------------------------------- |
| \_recipient | address | The account receiving the underlying LsETH tokens after shares are burned |
| \_shares    | uint256 | Amount of LsETH to free by burning wrapped LsETH                          |

### decimals

```solidity
function decimals() external pure returns (uint8)
```

Retrieves the token decimal count

#### Returns

| Name | Type  | Description       |
| ---- | ----- | ----------------- |
| \_0  | uint8 | The decimal count |

### decreaseAllowance

```solidity
function decreaseAllowance(address _spender, uint256 _subtractableValue) external nonpayable returns (bool)
```

Decrease allowance to another account

#### Parameters

| Name                | Type    | Description                         |
| ------------------- | ------- | ----------------------------------- |
| \_spender           | address | Spender that receives the allowance |
| \_subtractableValue | uint256 | Amount to subtract                  |

#### Returns

| Name | Type | Description     |
| ---- | ---- | --------------- |
| \_0  | bool | True if success |

### increaseAllowance

```solidity
function increaseAllowance(address _spender, uint256 _additionalValue) external nonpayable returns (bool)
```

Increase allowance to another account

#### Parameters

| Name              | Type    | Description                         |
| ----------------- | ------- | ----------------------------------- |
| \_spender         | address | Spender that receives the allowance |
| \_additionalValue | uint256 | Amount to add                       |

#### Returns

| Name | Type | Description     |
| ---- | ---- | --------------- |
| \_0  | bool | True if success |

### initWLSETHV1

```solidity
function initWLSETHV1(address _river) external nonpayable
```

Initializes the wrapped token contract

#### Parameters

| Name    | Type    | Description                   |
| ------- | ------- | ----------------------------- |
| \_river | address | Address of the River contract |

### mint

```solidity
function mint(address _recipient, uint256 _shares) external nonpayable
```

Mint tokens by providing LsETH tokens

*The message sender locks LsETH tokens and received wrapped LsETH tokens in exchangeThe message sender needs to approve the contract to mint the wrapped tokensThe minted wrapped LsETH is sent to the specified recipient*

#### Parameters

| Name        | Type    | Description                                        |
| ----------- | ------- | -------------------------------------------------- |
| \_recipient | address | The account receiving the new minted wrapped LsETH |
| \_shares    | uint256 | The amount of LsETH to wrap                        |

### name

```solidity
function name() external pure returns (string)
```

Retrieves the token full name

#### Returns

| Name | Type   | Description           |
| ---- | ------ | --------------------- |
| \_0  | string | The name of the token |

### sharesOf

```solidity
function sharesOf(address _owner) external view returns (uint256)
```

Retrieves the raw shares count of the user

#### Parameters

| Name    | Type    | Description                       |
| ------- | ------- | --------------------------------- |
| \_owner | address | Owner to check the shares balance |

#### Returns

| Name | Type    | Description             |
| ---- | ------- | ----------------------- |
| \_0  | uint256 | The shares of the owner |

### symbol

```solidity
function symbol() external pure returns (string)
```

Retrieves the token symbol

#### Returns

| Name | Type   | Description             |
| ---- | ------ | ----------------------- |
| \_0  | string | The symbol of the token |

### totalSupply

```solidity
function totalSupply() external view returns (uint256)
```

Retrieves the token total supply

#### Returns

| Name | Type    | Description      |
| ---- | ------- | ---------------- |
| \_0  | uint256 | The total supply |

### transfer

```solidity
function transfer(address _to, uint256 _value) external nonpayable returns (bool)
```

Transfers tokens between the message sender and a recipient

#### Parameters

| Name    | Type    | Description               |
| ------- | ------- | ------------------------- |
| \_to    | address | Recipient of the transfer |
| \_value | uint256 | Amount to transfer        |

#### Returns

| Name | Type | Description     |
| ---- | ---- | --------------- |
| \_0  | bool | True if success |

### transferFrom

```solidity
function transferFrom(address _from, address _to, uint256 _value) external nonpayable returns (bool)
```

Transfers tokens between two accounts

*It is expected that \_from has given at least \_value allowance to msg.sender*

#### Parameters

| Name    | Type    | Description               |
| ------- | ------- | ------------------------- |
| \_from  | address | Sender account            |
| \_to    | address | Recipient of the transfer |
| \_value | uint256 | Amount to transfer        |

#### Returns

| Name | Type | Description     |
| ---- | ---- | --------------- |
| \_0  | bool | True if success |

## Events

### Approval

```solidity
event Approval(address indexed owner, address indexed spender, uint256 value)
```

An approval has been made

#### Parameters

| Name              | Type    | Description                      |
| ----------------- | ------- | -------------------------------- |
| owner `indexed`   | address | The token owner                  |
| spender `indexed` | address | The account allowed by the owner |
| value             | uint256 | The amount allowed               |

### Burn

```solidity
event Burn(address indexed recipient, uint256 shares)
```

Tokens have been burned

#### Parameters

| Name                | Type    | Description                                   |
| ------------------- | ------- | --------------------------------------------- |
| recipient `indexed` | address | The account that receive the underlying LsETH |
| shares              | uint256 | The amount of LsETH that got sent back        |

### Initialized

```solidity
event Initialized(uint8 version)
```

*Triggered when the contract has been initialized or reinitialized.*

#### Parameters

| Name    | Type  | Description |
| ------- | ----- | ----------- |
| version | uint8 | undefined   |

### Mint

```solidity
event Mint(address indexed recipient, uint256 shares)
```

Tokens have been minted

#### Parameters

| Name                | Type    | Description                          |
| ------------------- | ------- | ------------------------------------ |
| recipient `indexed` | address | The account receiving the new tokens |
| shares              | uint256 | The amount of LsETH provided         |

### SetRiver

```solidity
event SetRiver(address indexed river)
```

The stored value of river has been changed

#### Parameters

| Name            | Type    | Description              |
| --------------- | ------- | ------------------------ |
| river `indexed` | address | The new address of river |

### Transfer

```solidity
event Transfer(address indexed from, address indexed to, uint256 value)
```

A transfer has been made

#### Parameters

| Name           | Type    | Description            |
| -------------- | ------- | ---------------------- |
| from `indexed` | address | The transfer sender    |
| to `indexed`   | address | The transfer recipient |
| value          | uint256 | The amount transferred |

## Errors

### AllowanceTooLow

```solidity
error AllowanceTooLow(address _from, address _operator, uint256 _allowance, uint256 _value)
```

Allowance too low to perform operation

#### Parameters

| Name        | Type    | Description                       |
| ----------- | ------- | --------------------------------- |
| \_from      | address | Account where funds are sent from |
| \_operator  | address | Account attempting the transfer   |
| \_allowance | uint256 | Current allowance                 |
| \_value     | uint256 | Requested transfer value          |

### BalanceTooLow

```solidity
error BalanceTooLow()
```

Balance too low to perform operation

### InvalidZeroAddress

```solidity
error InvalidZeroAddress()
```

The address is zero

### NullTransfer

```solidity
error NullTransfer()
```

Invalid empty transfer

### TokenTransferError

```solidity
error TokenTransferError()
```

The token transfer failed during the minting or burning process

### UnauthorizedTransfer

```solidity
error UnauthorizedTransfer(address _from, address _to)
```

Invalid transfer recipients

#### Parameters

| Name   | Type    | Description                                         |
| ------ | ------- | --------------------------------------------------- |
| \_from | address | Account sending the funds in the invalid transfer   |
| \_to   | address | Account receiving the funds in the invalid transfer |


---

# Agent Instructions: 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:

```
GET https://docs.liquidcollective.io/eth/technical-reference/smart-contracts/wlsethv1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.