# Checkpoint module for issuing ERC20 dividends (ERC20DividendCheckpoint.sol)

View Source: [contracts/modules/Checkpoint/Dividend/ERC20/ERC20DividendCheckpoint.sol](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/contracts/modules/Checkpoint/Dividend/ERC20/ERC20DividendCheckpoint.sol)

**↗ Extends:** [**ERC20DividendCheckpointStorage**](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ERC20DividendCheckpointStorage.md)**,** [**DividendCheckpoint**](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/DividendCheckpoint.md)

**ERC20DividendCheckpoint**

**Events**

```javascript
event ERC20DividendDeposited(address indexed _depositor, uint256  _checkpointId, uint256  _maturity, uint256  _expiry, address indexed _token, uint256  _amount, uint256  _totalSupply, uint256  _dividendIndex, bytes32 indexed _name);
event ERC20DividendClaimed(address indexed _payee, uint256 indexed _dividendIndex, address indexed _token, uint256  _amount, uint256  _withheld);
event ERC20DividendReclaimed(address indexed _claimer, uint256 indexed _dividendIndex, address indexed _token, uint256  _claimedAmount);
event ERC20DividendWithholdingWithdrawn(address indexed _claimer, uint256 indexed _dividendIndex, address indexed _token, uint256  _withheldAmount);
```

## Functions

* [(address \_securityToken, address \_polyToken)](/polymath/api/erc20dividendcheckpoint.md)
* [createDividend(uint256 \_maturity, uint256 \_expiry, address \_token, uint256 \_amount, bytes32 \_name)](/polymath/api/erc20dividendcheckpoint.md#createdividend)
* [createDividendWithCheckpoint(uint256 \_maturity, uint256 \_expiry, address \_token, uint256 \_amount, uint256 \_checkpointId, bytes32 \_name)](/polymath/api/erc20dividendcheckpoint.md#createdividendwithcheckpoint)
* [createDividendWithExclusions(uint256 \_maturity, uint256 \_expiry, address \_token, uint256 \_amount, address\[\] \_excluded, bytes32 \_name)](/polymath/api/erc20dividendcheckpoint.md#createdividendwithexclusions)
* [createDividendWithCheckpointAndExclusions(uint256 \_maturity, uint256 \_expiry, address \_token, uint256 \_amount, uint256 \_checkpointId, address\[\] \_excluded, bytes32 \_name)](/polymath/api/erc20dividendcheckpoint.md#createdividendwithcheckpointandexclusions)
* [\_createDividendWithCheckpointAndExclusions(uint256 \_maturity, uint256 \_expiry, address \_token, uint256 \_amount, uint256 \_checkpointId, address\[\] \_excluded, bytes32 \_name)](/polymath/api/erc20dividendcheckpoint.md#_createdividendwithcheckpointandexclusions)
* [\_emitERC20DividendDepositedEvent(uint256 \_checkpointId, uint256 \_maturity, uint256 \_expiry, address \_token, uint256 \_amount, uint256 currentSupply, uint256 dividendIndex, bytes32 \_name)](/polymath/api/erc20dividendcheckpoint.md#_emiterc20dividenddepositedevent)
* [\_payDividend(address payable \_payee, struct DividendCheckpointStorage.Dividend \_dividend, uint256 \_dividendIndex)](/polymath/api/erc20dividendcheckpoint.md#_paydividend)
* [reclaimDividend(uint256 \_dividendIndex)](/polymath/api/erc20dividendcheckpoint.md#reclaimdividend)
* [withdrawWithholding(uint256 \_dividendIndex)](/polymath/api/erc20dividendcheckpoint.md#withdrawwithholding)

Constructor

```javascript
function (address _securityToken, address _polyToken) public nonpayable Module
```

**Arguments**

| Name            | Type    | Description                   |
| --------------- | ------- | ----------------------------- |
| \_securityToken | address | Address of the security token |
| \_polyToken     | address |                               |

### createDividend

Creates a dividend and checkpoint for the dividend

```javascript
function createDividend(uint256 _maturity, uint256 _expiry, address _token, uint256 _amount, bytes32 _name) external nonpayable withPerm
```

**Arguments**

| Name       | Type    | Description                                                               |
| ---------- | ------- | ------------------------------------------------------------------------- |
| \_maturity | uint256 | Time from which dividend can be paid                                      |
| \_expiry   | uint256 | Time until dividend can no longer be paid, and can be reclaimed by issuer |
| \_token    | address | Address of ERC20 token in which dividend is to be denominated             |
| \_amount   | uint256 | Amount of specified token for dividend                                    |
| \_name     | bytes32 | Name/Title for identification                                             |

### createDividendWithCheckpoint

Creates a dividend with a provided checkpoint

```javascript
function createDividendWithCheckpoint(uint256 _maturity, uint256 _expiry, address _token, uint256 _amount, uint256 _checkpointId, bytes32 _name) external nonpayable withPerm
```

**Arguments**

| Name           | Type    | Description                                                               |
| -------------- | ------- | ------------------------------------------------------------------------- |
| \_maturity     | uint256 | Time from which dividend can be paid                                      |
| \_expiry       | uint256 | Time until dividend can no longer be paid, and can be reclaimed by issuer |
| \_token        | address | Address of ERC20 token in which dividend is to be denominated             |
| \_amount       | uint256 | Amount of specified token for dividend                                    |
| \_checkpointId | uint256 | Checkpoint id from which to create dividends                              |
| \_name         | bytes32 | Name/Title for identification                                             |

### createDividendWithExclusions

Creates a dividend and checkpoint for the dividend

```javascript
function createDividendWithExclusions(uint256 _maturity, uint256 _expiry, address _token, uint256 _amount, address[] _excluded, bytes32 _name) public nonpayable withPerm
```

**Arguments**

| Name       | Type       | Description                                                               |
| ---------- | ---------- | ------------------------------------------------------------------------- |
| \_maturity | uint256    | Time from which dividend can be paid                                      |
| \_expiry   | uint256    | Time until dividend can no longer be paid, and can be reclaimed by issuer |
| \_token    | address    | Address of ERC20 token in which dividend is to be denominated             |
| \_amount   | uint256    | Amount of specified token for dividend                                    |
| \_excluded | address\[] | List of addresses to exclude                                              |
| \_name     | bytes32    | Name/Title for identification                                             |

### createDividendWithCheckpointAndExclusions

Creates a dividend with a provided checkpoint

```javascript
function createDividendWithCheckpointAndExclusions(uint256 _maturity, uint256 _expiry, address _token, uint256 _amount, uint256 _checkpointId, address[] _excluded, bytes32 _name) public nonpayable withPerm
```

**Arguments**

| Name           | Type       | Description                                                               |
| -------------- | ---------- | ------------------------------------------------------------------------- |
| \_maturity     | uint256    | Time from which dividend can be paid                                      |
| \_expiry       | uint256    | Time until dividend can no longer be paid, and can be reclaimed by issuer |
| \_token        | address    | Address of ERC20 token in which dividend is to be denominated             |
| \_amount       | uint256    | Amount of specified token for dividend                                    |
| \_checkpointId | uint256    | Checkpoint id from which to create dividends                              |
| \_excluded     | address\[] | List of addresses to exclude                                              |
| \_name         | bytes32    | Name/Title for identification                                             |

### \_createDividendWithCheckpointAndExclusions

Creates a dividend with a provided checkpoint

```javascript
function _createDividendWithCheckpointAndExclusions(uint256 _maturity, uint256 _expiry, address _token, uint256 _amount, uint256 _checkpointId, address[] _excluded, bytes32 _name) internal nonpayable
```

**Arguments**

| Name           | Type       | Description                                                               |
| -------------- | ---------- | ------------------------------------------------------------------------- |
| \_maturity     | uint256    | Time from which dividend can be paid                                      |
| \_expiry       | uint256    | Time until dividend can no longer be paid, and can be reclaimed by issuer |
| \_token        | address    | Address of ERC20 token in which dividend is to be denominated             |
| \_amount       | uint256    | Amount of specified token for dividend                                    |
| \_checkpointId | uint256    | Checkpoint id from which to create dividends                              |
| \_excluded     | address\[] | List of addresses to exclude                                              |
| \_name         | bytes32    | Name/Title for identification                                             |

### \_emitERC20DividendDepositedEvent

Emits the ERC20DividendDeposited event. Seperated into a different function as a workaround for stack too deep error

```javascript
function _emitERC20DividendDepositedEvent(uint256 _checkpointId, uint256 _maturity, uint256 _expiry, address _token, uint256 _amount, uint256 currentSupply, uint256 dividendIndex, bytes32 _name) internal nonpayable
```

**Arguments**

| Name           | Type    | Description |
| -------------- | ------- | ----------- |
| \_checkpointId | uint256 |             |
| \_maturity     | uint256 |             |
| \_expiry       | uint256 |             |
| \_token        | address |             |
| \_amount       | uint256 |             |
| currentSupply  | uint256 |             |
| dividendIndex  | uint256 |             |
| \_name         | bytes32 |             |

### \_payDividend

⤾ overrides [DividendCheckpoint.\_payDividend](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/DividendCheckpoint.md#_paydividend)

Internal function for paying dividends

```javascript
function _payDividend(address payable _payee, struct DividendCheckpointStorage.Dividend _dividend, uint256 _dividendIndex) internal nonpayable
```

**Arguments**

| Name            | Type                                      | Description                              |
| --------------- | ----------------------------------------- | ---------------------------------------- |
| \_payee         | address payable                           | Address of investor                      |
| \_dividend      | struct DividendCheckpointStorage.Dividend | Storage with previously issued dividends |
| \_dividendIndex | uint256                                   | Dividend to pay                          |

### reclaimDividend

⤾ overrides [DividendCheckpoint.reclaimDividend](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/DividendCheckpoint.md#reclaimdividend)

Issuer can reclaim remaining unclaimed dividend amounts, for expired dividends

```javascript
function reclaimDividend(uint256 _dividendIndex) external nonpayable withPerm
```

**Arguments**

| Name            | Type    | Description         |
| --------------- | ------- | ------------------- |
| \_dividendIndex | uint256 | Dividend to reclaim |

### withdrawWithholding

⤾ overrides [DividendCheckpoint.withdrawWithholding](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/DividendCheckpoint.md#withdrawwithholding)

Allows issuer to withdraw withheld tax

```javascript
function withdrawWithholding(uint256 _dividendIndex) external nonpayable withPerm
```

**Arguments**

| Name            | Type    | Description               |
| --------------- | ------- | ------------------------- |
| \_dividendIndex | uint256 | Dividend to withdraw from |


---

# 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://developers.polymath.network/polymath/api/erc20dividendcheckpoint.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.