# ShareDebtToken

> ShareDebtToken

ERC20 compatible token represennting debt position in Silo

*It implements reversed approvals (ERC20R) and checks solvency of receiver on transfer. It is assumed that there is no vector attack on taking somone else's debt becasue we don't see economical reason why one would do such thing. For that reason anyone can transfer owner's token to any receiver as long as receiving wallet approves the transfer. In other words, anyone can take someone else's debt without asking.*

## Methods

### allowance

```solidity
function allowance(address owner, address spender) external view returns (uint256)
```

*See {IERC20-allowance}.*

#### Parameters

| Name    | Type    | Description |
| ------- | ------- | ----------- |
| owner   | address | undefined   |
| spender | address | undefined   |

#### Returns

| Name | Type    | Description |
| ---- | ------- | ----------- |
| \_0  | uint256 | undefined   |

### approve

```solidity
function approve(address spender, uint256 amount) external nonpayable returns (bool)
```

*See {IERC20-approve}. Requirements: - `spender` cannot be the zero address.*

#### Parameters

| Name    | Type    | Description |
| ------- | ------- | ----------- |
| spender | address | undefined   |
| amount  | uint256 | undefined   |

#### Returns

| Name | Type | Description |
| ---- | ---- | ----------- |
| \_0  | bool | undefined   |

### asset

```solidity
function asset() external view returns (address)
```

asset for which this tokens was deployed

#### Returns

| Name | Type    | Description |
| ---- | ------- | ----------- |
| \_0  | address | undefined   |

### balanceOf

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

*See {IERC20-balanceOf}.*

#### Parameters

| Name    | Type    | Description |
| ------- | ------- | ----------- |
| account | address | undefined   |

#### Returns

| Name | Type    | Description |
| ---- | ------- | ----------- |
| \_0  | uint256 | undefined   |

### burn

```solidity
function burn(address _account, uint256 _amount) external nonpayable
```

Burn method for Silo to close debt positon

#### Parameters

| Name      | Type    | Description                    |
| --------- | ------- | ------------------------------ |
| \_account | address | wallet for which to burn token |
| \_amount  | uint256 | amount of token to be burned   |

### decimals

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

*Returns the number of decimals used to get its user representation. For example, if `decimals` equals `2`, a balance of `505` tokens should be displayed to a user as `5.05` (`505 / 10 ** 2`). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.*

#### Returns

| Name | Type  | Description |
| ---- | ----- | ----------- |
| \_0  | uint8 | undefined   |

### decreaseAllowance

```solidity
function decreaseAllowance(address spender, uint256 subtractedValue) external nonpayable returns (bool)
```

*Atomically decreases the allowance granted to `spender` by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - `spender` cannot be the zero address. - `spender` must have allowance for the caller of at least `subtractedValue`.*

#### Parameters

| Name            | Type    | Description |
| --------------- | ------- | ----------- |
| spender         | address | undefined   |
| subtractedValue | uint256 | undefined   |

#### Returns

| Name | Type | Description |
| ---- | ---- | ----------- |
| \_0  | bool | undefined   |

### decreaseReceiveAllowance

```solidity
function decreaseReceiveAllowance(address _owner, uint256 _subtractedValue) external nonpayable returns (bool)
```

*Atomically decreases the receive allowance granted to `owner` by the caller. This is an alternative to {receive approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {ReceiveApproval} event indicating the updated receive allowance.*

#### Parameters

| Name              | Type    | Description                                                        |
| ----------------- | ------- | ------------------------------------------------------------------ |
| \_owner           | address | owner of debt token that is being allowed sending it to the caller |
| \_subtractedValue | uint256 | amount of token to decrease allowance                              |

#### Returns

| Name | Type | Description       |
| ---- | ---- | ----------------- |
| \_0  | bool | true if succeeded |

### increaseAllowance

```solidity
function increaseAllowance(address spender, uint256 addedValue) external nonpayable returns (bool)
```

*Atomically increases the allowance granted to `spender` by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - `spender` cannot be the zero address.*

#### Parameters

| Name       | Type    | Description |
| ---------- | ------- | ----------- |
| spender    | address | undefined   |
| addedValue | uint256 | undefined   |

#### Returns

| Name | Type | Description |
| ---- | ---- | ----------- |
| \_0  | bool | undefined   |

### increaseReceiveAllowance

```solidity
function increaseReceiveAllowance(address _owner, uint256 _addedValue) external nonpayable returns (bool)
```

*Atomically increases the receive allowance granted to `owner` by the caller. This is an alternative to {receive approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {ReceiveApproval} event indicating the updated receive allowance.*

#### Parameters

| Name         | Type    | Description                                                        |
| ------------ | ------- | ------------------------------------------------------------------ |
| \_owner      | address | owner of debt token that is being allowed sending it to the caller |
| \_addedValue | uint256 | amount of token to increase allowance                              |

#### Returns

| Name | Type | Description       |
| ---- | ---- | ----------------- |
| \_0  | bool | true if succeeded |

### mint

```solidity
function mint(address _account, uint256 _amount) external nonpayable
```

Mint method for Silo to create debt positon

#### Parameters

| Name      | Type    | Description                    |
| --------- | ------- | ------------------------------ |
| \_account | address | wallet for which to mint token |
| \_amount  | uint256 | amount of token to be minted   |

### name

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

*Returns the name of the token.*

#### Returns

| Name | Type   | Description |
| ---- | ------ | ----------- |
| \_0  | string | undefined   |

### receiveAllowance

```solidity
function receiveAllowance(address _owner, address _receiver) external view returns (uint256)
```

*Returns the remaining number of tokens that `_owner` is allowed to send to `_receiver` through {transferFrom}. This is zero by default.*

#### Parameters

| Name       | Type    | Description                          |
| ---------- | ------- | ------------------------------------ |
| \_owner    | address | owner of debt token                  |
| \_receiver | address | wallet that is receiving debt tokens |

#### Returns

| Name | Type    | Description             |
| ---- | ------- | ----------------------- |
| \_0  | uint256 | current token allowance |

### setReceiveApproval

```solidity
function setReceiveApproval(address owner, uint256 _amount) external nonpayable returns (bool)
```

*Sets `_amount` as the allowance of `spender` over the caller's tokens. Returns a boolean value indicating whether the operation succeeded. IMPORTANT: Beware that changing an allowance with this method brings the risk that someone may use both the old and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards: <https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729> OR use increase/decrease approval method instead. Emits an {ReceiveApproval} event.*

#### Parameters

| Name     | Type    | Description               |
| -------- | ------- | ------------------------- |
| owner    | address | undefined                 |
| \_amount | uint256 | amount of token allowance |

#### Returns

| Name | Type | Description       |
| ---- | ---- | ----------------- |
| \_0  | bool | true if succeeded |

### silo

```solidity
function silo() external view returns (contract ISilo)
```

Silo address for which tokens was deployed

#### Returns

| Name | Type           | Description |
| ---- | -------------- | ----------- |
| \_0  | contract ISilo | undefined   |

### symbol

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

Returns token symbol

#### Returns

| Name | Type   | Description  |
| ---- | ------ | ------------ |
| \_0  | string | token symbol |

### totalSupply

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

*See {IERC20-totalSupply}.*

#### Returns

| Name | Type    | Description |
| ---- | ------- | ----------- |
| \_0  | uint256 | undefined   |

### transfer

```solidity
function transfer(address recipient, uint256 amount) external nonpayable returns (bool)
```

*See {IERC20-transfer}. Requirements: - `recipient` cannot be the zero address. - the caller must have a balance of at least `amount`.*

#### Parameters

| Name      | Type    | Description |
| --------- | ------- | ----------- |
| recipient | address | undefined   |
| amount    | uint256 | undefined   |

#### Returns

| Name | Type | Description |
| ---- | ---- | ----------- |
| \_0  | bool | undefined   |

### transferFrom

```solidity
function transferFrom(address sender, address recipient, uint256 amount) external nonpayable returns (bool)
```

*See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - `sender` and `recipient` cannot be the zero address. - `sender` must have a balance of at least `amount`. - the caller must have allowance for `sender`'s tokens of at least `amount`.*

#### Parameters

| Name      | Type    | Description |
| --------- | ------- | ----------- |
| sender    | address | undefined   |
| recipient | address | undefined   |
| amount    | uint256 | undefined   |

#### Returns

| Name | Type | Description |
| ---- | ---- | ----------- |
| \_0  | bool | undefined   |

## Events

### Approval

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

#### Parameters

| Name              | Type    | Description |
| ----------------- | ------- | ----------- |
| owner `indexed`   | address | undefined   |
| spender `indexed` | address | undefined   |
| value             | uint256 | undefined   |

### NotificationSent

```solidity
event NotificationSent(contract INotificationReceiver notificationReceiver, bool success)
```

Emitted every time receiver is notified about token transfer

#### Parameters

| Name                 | Type                           | Description |
| -------------------- | ------------------------------ | ----------- |
| notificationReceiver | contract INotificationReceiver | undefined   |
| success              | bool                           | undefined   |

### ReceiveApproval

```solidity
event ReceiveApproval(address indexed _owner, address indexed _receiver, uint256 _value)
```

#### Parameters

| Name                 | Type    | Description |
| -------------------- | ------- | ----------- |
| \_owner `indexed`    | address | undefined   |
| \_receiver `indexed` | address | undefined   |
| \_value              | uint256 | undefined   |

### Transfer

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

#### Parameters

| Name           | Type    | Description |
| -------------- | ------- | ----------- |
| from `indexed` | address | undefined   |
| to `indexed`   | address | undefined   |
| value          | uint256 | undefined   |