> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymath/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymath/api/volumerestrictiontm.md).

# VolumeRestrictionTM.sol

View Source: [contracts/modules/TransferManager/VRTM/VolumeRestrictionTM.sol](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/contracts/modules/TransferManager/VRTM/VolumeRestrictionTM.sol)

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

**VolumeRestrictionTM**

**Events**

```javascript
event ChangedExemptWalletList(address indexed _wallet, bool  _exempted);
event AddIndividualRestriction(address indexed _holder, uint256  _allowedTokens, uint256  _startTime, uint256  _rollingPeriodInDays, uint256  _endTime, enum VolumeRestrictionTMStorage.RestrictionType  _typeOfRestriction);
event AddIndividualDailyRestriction(address indexed _holder, uint256  _allowedTokens, uint256  _startTime, uint256  _rollingPeriodInDays, uint256  _endTime, enum VolumeRestrictionTMStorage.RestrictionType  _typeOfRestriction);
event ModifyIndividualRestriction(address indexed _holder, uint256  _allowedTokens, uint256  _startTime, uint256  _rollingPeriodInDays, uint256  _endTime, enum VolumeRestrictionTMStorage.RestrictionType  _typeOfRestriction);
event ModifyIndividualDailyRestriction(address indexed _holder, uint256  _allowedTokens, uint256  _startTime, uint256  _rollingPeriodInDays, uint256  _endTime, enum VolumeRestrictionTMStorage.RestrictionType  _typeOfRestriction);
event AddDefaultRestriction(uint256  _allowedTokens, uint256  _startTime, uint256  _rollingPeriodInDays, uint256  _endTime, enum VolumeRestrictionTMStorage.RestrictionType  _typeOfRestriction);
event AddDefaultDailyRestriction(uint256  _allowedTokens, uint256  _startTime, uint256  _rollingPeriodInDays, uint256  _endTime, enum VolumeRestrictionTMStorage.RestrictionType  _typeOfRestriction);
event ModifyDefaultRestriction(uint256  _allowedTokens, uint256  _startTime, uint256  _rollingPeriodInDays, uint256  _endTime, enum VolumeRestrictionTMStorage.RestrictionType  _typeOfRestriction);
event ModifyDefaultDailyRestriction(uint256  _allowedTokens, uint256  _startTime, uint256  _rollingPeriodInDays, uint256  _endTime, enum VolumeRestrictionTMStorage.RestrictionType  _typeOfRestriction);
event IndividualRestrictionRemoved(address indexed _holder);
event IndividualDailyRestrictionRemoved(address indexed _holder);
event DefaultRestrictionRemoved();
event DefaultDailyRestrictionRemoved();
```

## Functions

* [(address \_securityToken, address \_polyAddress)](/polymath/api/volumerestrictiontm.md)
* [executeTransfer(address \_from, address , uint256 \_amount, bytes )](/polymath/api/volumerestrictiontm.md#executetransfer)
* [verifyTransfer(address \_from, address , uint256 \_amount, bytes )](/polymath/api/volumerestrictiontm.md#verifytransfer)
* [\_verifyTransfer(address \_from, uint256 \_amount)](/polymath/api/volumerestrictiontm.md#_verifytransfer)
* [changeExemptWalletList(address \_wallet, bool \_exempted)](/polymath/api/volumerestrictiontm.md#changeexemptwalletlist)
* [addIndividualRestriction(address \_holder, uint256 \_allowedTokens, uint256 \_startTime, uint256 \_rollingPeriodInDays, uint256 \_endTime, enum VolumeRestrictionTMStorage.RestrictionType \_restrictionType)](/polymath/api/volumerestrictiontm.md#addindividualrestriction)
* [addIndividualDailyRestriction(address \_holder, uint256 \_allowedTokens, uint256 \_startTime, uint256 \_endTime, enum VolumeRestrictionTMStorage.RestrictionType \_restrictionType)](/polymath/api/volumerestrictiontm.md#addindividualdailyrestriction)
* [addIndividualDailyRestrictionMulti(address\[\] \_holders, uint256\[\] \_allowedTokens, uint256\[\] \_startTimes, uint256\[\] \_endTimes, enum VolumeRestrictionTMStorage.RestrictionType\[\] \_restrictionTypes)](/polymath/api/volumerestrictiontm.md#addindividualdailyrestrictionmulti)
* [addIndividualRestrictionMulti(address\[\] \_holders, uint256\[\] \_allowedTokens, uint256\[\] \_startTimes, uint256\[\] \_rollingPeriodInDays, uint256\[\] \_endTimes, enum VolumeRestrictionTMStorage.RestrictionType\[\] \_restrictionTypes)](/polymath/api/volumerestrictiontm.md#addindividualrestrictionmulti)
* [addDefaultRestriction(uint256 \_allowedTokens, uint256 \_startTime, uint256 \_rollingPeriodInDays, uint256 \_endTime, enum VolumeRestrictionTMStorage.RestrictionType \_restrictionType)](/polymath/api/volumerestrictiontm.md#adddefaultrestriction)
* [addDefaultDailyRestriction(uint256 \_allowedTokens, uint256 \_startTime, uint256 \_endTime, enum VolumeRestrictionTMStorage.RestrictionType \_restrictionType)](/polymath/api/volumerestrictiontm.md#adddefaultdailyrestriction)
* [removeIndividualRestriction(address \_holder)](/polymath/api/volumerestrictiontm.md#removeindividualrestriction)
* [\_removeIndividualRestriction(address \_holder)](/polymath/api/volumerestrictiontm.md#_removeindividualrestriction)
* [removeIndividualRestrictionMulti(address\[\] \_holders)](/polymath/api/volumerestrictiontm.md#removeindividualrestrictionmulti)
* [removeIndividualDailyRestriction(address \_holder)](/polymath/api/volumerestrictiontm.md#removeindividualdailyrestriction)
* [\_removeIndividualDailyRestriction(address \_holder)](/polymath/api/volumerestrictiontm.md#_removeindividualdailyrestriction)
* [removeIndividualDailyRestrictionMulti(address\[\] \_holders)](/polymath/api/volumerestrictiontm.md#removeindividualdailyrestrictionmulti)
* [removeDefaultRestriction()](/polymath/api/volumerestrictiontm.md#removedefaultrestriction)
* [removeDefaultDailyRestriction()](/polymath/api/volumerestrictiontm.md#removedefaultdailyrestriction)
* [modifyIndividualRestriction(address \_holder, uint256 \_allowedTokens, uint256 \_startTime, uint256 \_rollingPeriodInDays, uint256 \_endTime, enum VolumeRestrictionTMStorage.RestrictionType \_restrictionType)](/polymath/api/volumerestrictiontm.md#modifyindividualrestriction)
* [modifyIndividualDailyRestriction(address \_holder, uint256 \_allowedTokens, uint256 \_startTime, uint256 \_endTime, enum VolumeRestrictionTMStorage.RestrictionType \_restrictionType)](/polymath/api/volumerestrictiontm.md#modifyindividualdailyrestriction)
* [modifyIndividualDailyRestrictionMulti(address\[\] \_holders, uint256\[\] \_allowedTokens, uint256\[\] \_startTimes, uint256\[\] \_endTimes, enum VolumeRestrictionTMStorage.RestrictionType\[\] \_restrictionTypes)](/polymath/api/volumerestrictiontm.md#modifyindividualdailyrestrictionmulti)
* [modifyIndividualRestrictionMulti(address\[\] \_holders, uint256\[\] \_allowedTokens, uint256\[\] \_startTimes, uint256\[\] \_rollingPeriodInDays, uint256\[\] \_endTimes, enum VolumeRestrictionTMStorage.RestrictionType\[\] \_restrictionTypes)](/polymath/api/volumerestrictiontm.md#modifyindividualrestrictionmulti)
* [modifyDefaultRestriction(uint256 \_allowedTokens, uint256 \_startTime, uint256 \_rollingPeriodInDays, uint256 \_endTime, enum VolumeRestrictionTMStorage.RestrictionType \_restrictionType)](/polymath/api/volumerestrictiontm.md#modifydefaultrestriction)
* [modifyDefaultDailyRestriction(uint256 \_allowedTokens, uint256 \_startTime, uint256 \_endTime, enum VolumeRestrictionTMStorage.RestrictionType \_restrictionType)](/polymath/api/volumerestrictiontm.md#modifydefaultdailyrestriction)
* [\_restrictionCheck(uint256 \_amount, address \_from, bool \_isDefault, struct VolumeRestrictionTMStorage.VolumeRestriction \_restriction)](/polymath/api/volumerestrictiontm.md#_restrictioncheck)
* [\_validAllowedAmount(struct VolumeRestrictionTMStorage.VolumeRestriction dailyRestriction, struct VolumeRestrictionTMStorage.VolumeRestriction restriction, uint256 allowedAmount, uint256 allowedDailyAmount)](/polymath/api/volumerestrictiontm.md#_validallowedamount)
* [\_isValidAmountAfterRestrictionChanges(bool \_isDefault, address \_from, uint256 \_amount, uint256 \_sumOfLastPeriod, uint256 \_allowedAmount)](/polymath/api/volumerestrictiontm.md#_isvalidamountafterrestrictionchanges)
* [\_dailyTxCheck(uint256 \_amount, address \_from, bool \_isDefault, uint256 \_dailyLastTradedDayTime, struct VolumeRestrictionTMStorage.VolumeRestriction \_restriction)](/polymath/api/volumerestrictiontm.md#_dailytxcheck)
* [\_bucketCheck(address \_from, bool isDefault, uint256 \_fromTime, uint256 \_diffDays, uint256 \_rollingPeriodInDays, struct VolumeRestrictionTMStorage.BucketDetails \_bucketDetails)](/polymath/api/volumerestrictiontm.md#_bucketcheck)
* [\_checkValidAmountToTransact(uint256 \_amountToTransact, address \_from, bool \_isDefault, struct VolumeRestrictionTMStorage.VolumeRestriction \_restriction, uint256 \_sumOfLastPeriod)](/polymath/api/volumerestrictiontm.md#_checkvalidamounttotransact)
* [\_allowedAmountToTransact(uint256 \_sumOfLastPeriod, struct VolumeRestrictionTMStorage.VolumeRestriction \_restriction)](/polymath/api/volumerestrictiontm.md#_allowedamounttotransact)
* [\_updateStorage(address \_from, uint256 \_amount, uint256 \_lastTradedDayTime, uint256 \_sumOfLastPeriod, uint256 \_daysCovered, uint256 \_dailyLastTradedDayTime, uint256 \_endTime, bool isDefault)](/polymath/api/volumerestrictiontm.md#_updatestorage)
* [\_updateStorageActual(address \_from, uint256 \_amount, uint256 \_lastTradedDayTime, uint256 \_sumOfLastPeriod, uint256 \_daysCovered, uint256 \_dailyLastTradedDayTime, uint256 \_endTime, bool isDefault, struct VolumeRestrictionTMStorage.BucketDetails details)](/polymath/api/volumerestrictiontm.md#_updatestorageactual)
* [\_checkInputParams(uint256 \_allowedTokens, uint256 \_startTime, uint256 \_rollingPeriodDays, uint256 \_endTime, enum VolumeRestrictionTMStorage.RestrictionType \_restrictionType, uint256 \_earliestStartTime, bool isModifyDaily)](/polymath/api/volumerestrictiontm.md#_checkinputparams)
* [\_isAllowedToModify(uint256 \_startTime)](/polymath/api/volumerestrictiontm.md#_isallowedtomodify)
* [\_getValidStartTime(uint256 \_startTime)](/polymath/api/volumerestrictiontm.md#_getvalidstarttime)
* [getTokensByPartition(bytes32 \_partition, address \_tokenHolder, uint256 \_additionalBalance)](/polymath/api/volumerestrictiontm.md#gettokensbypartition)
* [getIndividualBucketDetailsToUser(address \_user)](/polymath/api/volumerestrictiontm.md#getindividualbucketdetailstouser)
* [getDefaultBucketDetailsToUser(address \_user)](/polymath/api/volumerestrictiontm.md#getdefaultbucketdetailstouser)
* [\_getBucketDetails(struct VolumeRestrictionTMStorage.BucketDetails \_bucket)](/polymath/api/volumerestrictiontm.md#_getbucketdetails)
* [getTotalTradedByUser(address \_user, uint256 \_at)](/polymath/api/volumerestrictiontm.md#gettotaltradedbyuser)
* [getInitFunction()](/polymath/api/volumerestrictiontm.md#getinitfunction)
* [getExemptAddress()](/polymath/api/volumerestrictiontm.md#getexemptaddress)
* [getIndividualRestriction(address \_investor)](/polymath/api/volumerestrictiontm.md#getindividualrestriction)
* [getIndividualDailyRestriction(address \_investor)](/polymath/api/volumerestrictiontm.md#getindividualdailyrestriction)
* [getDefaultRestriction()](/polymath/api/volumerestrictiontm.md#getdefaultrestriction)
* [getDefaultDailyRestriction()](/polymath/api/volumerestrictiontm.md#getdefaultdailyrestriction)
* [\_volumeRestrictionSplay(struct VolumeRestrictionTMStorage.VolumeRestriction \_volumeRestriction)](/polymath/api/volumerestrictiontm.md#_volumerestrictionsplay)
* [getRestrictionData()](/polymath/api/volumerestrictiontm.md#getrestrictiondata)
* [\_checkLengthOfArray(address\[\] \_holders, uint256\[\] \_allowedTokens, uint256\[\] \_startTimes, uint256\[\] \_rollingPeriodInDays, uint256\[\] \_endTimes, enum VolumeRestrictionTMStorage.RestrictionType\[\] \_restrictionTypes)](/polymath/api/volumerestrictiontm.md#_checklengthofarray)
* [getPermissions()](/polymath/api/volumerestrictiontm.md#getpermissions)

Constructor

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

**Arguments**

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

### executeTransfer

⤾ overrides [ITransferManager.executeTransfer](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ITransferManager.md#executetransfer)

Used to verify the transfer/transferFrom transaction and prevent tranaction whose volume of tokens will voilate the maximum volume transfer restriction

```javascript
function executeTransfer(address _from, address , uint256 _amount, bytes ) external nonpayable onlySecurityToken 
returns(success enum ITransferManager.Result)
```

**Arguments**

| Name     | Type    | Description                      |
| -------- | ------- | -------------------------------- |
| \_from   | address | Address of the sender            |
|          | address | \_from Address of the sender     |
| \_amount | uint256 | The amount of tokens to transfer |
|          | bytes   | \_from Address of the sender     |

### verifyTransfer

⤾ overrides [ITransferManager.verifyTransfer](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ITransferManager.md#verifytransfer)

Used to verify the transfer/transferFrom transaction and prevent tranaction whose volume of tokens will voilate the maximum volume transfer restriction

```javascript
function verifyTransfer(address _from, address , uint256 _amount, bytes ) public view
returns(enum ITransferManager.Result, bytes32)
```

**Arguments**

| Name     | Type    | Description                      |
| -------- | ------- | -------------------------------- |
| \_from   | address | Address of the sender            |
|          | address | \_from Address of the sender     |
| \_amount | uint256 | The amount of tokens to transfer |
|          | bytes   | \_from Address of the sender     |

### \_verifyTransfer

Used to verify the transfer/transferFrom transaction and prevent tranaction whose volume of tokens will voilate the maximum volume transfer restriction

```javascript
function _verifyTransfer(address _from, uint256 _amount) internal view
returns(enum ITransferManager.Result, uint256, uint256, uint256, uint256, uint256, uint256, bool)
```

**Arguments**

| Name     | Type    | Description                      |
| -------- | ------- | -------------------------------- |
| \_from   | address | Address of the sender            |
| \_amount | uint256 | The amount of tokens to transfer |

### changeExemptWalletList

Add/Remove wallet address from the exempt list

```javascript
function changeExemptWalletList(address _wallet, bool _exempted) public nonpayable withPerm
```

**Arguments**

| Name       | Type    | Description                                                              |
| ---------- | ------- | ------------------------------------------------------------------------ |
| \_wallet   | address | Ethereum wallet/contract address that need to be exempted                |
| \_exempted | bool    | Boolean value used to add (i.e true) or remove (i.e false) from the list |

### addIndividualRestriction

Use to add the new individual restriction for a given token holder

```javascript
function addIndividualRestriction(address _holder, uint256 _allowedTokens, uint256 _startTime, uint256 _rollingPeriodInDays, uint256 _endTime, enum VolumeRestrictionTMStorage.RestrictionType _restrictionType) public nonpayable withPerm
```

**Arguments**

| Name                  | Type                                            | Description                                                          |
| --------------------- | ----------------------------------------------- | -------------------------------------------------------------------- |
| \_holder              | address                                         | Address of the token holder, whom restriction will be implied        |
| \_allowedTokens       | uint256                                         | Amount of tokens allowed to be trade for a given address.            |
| \_startTime           | uint256                                         | Unix timestamp at which restriction get into effect                  |
| \_rollingPeriodInDays | uint256                                         | Rolling period in days (Minimum value should be 1 day)               |
| \_endTime             | uint256                                         | Unix timestamp at which restriction effects will gets end.           |
| \_restrictionType     | enum VolumeRestrictionTMStorage.RestrictionType | Whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### addIndividualDailyRestriction

Use to add the new individual daily restriction for all token holder

```javascript
function addIndividualDailyRestriction(address _holder, uint256 _allowedTokens, uint256 _startTime, uint256 _endTime, enum VolumeRestrictionTMStorage.RestrictionType _restrictionType) public nonpayable withPerm
```

**Arguments**

| Name              | Type                                            | Description                                                          |
| ----------------- | ----------------------------------------------- | -------------------------------------------------------------------- |
| \_holder          | address                                         | Address of the token holder, whom restriction will be implied        |
| \_allowedTokens   | uint256                                         | Amount of tokens allowed to be traded for all token holder.          |
| \_startTime       | uint256                                         | Unix timestamp at which restriction get into effect                  |
| \_endTime         | uint256                                         | Unix timestamp at which restriction effects will gets end.           |
| \_restrictionType | enum VolumeRestrictionTMStorage.RestrictionType | Whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### addIndividualDailyRestrictionMulti

Use to add the new individual daily restriction for multiple token holders

```javascript
function addIndividualDailyRestrictionMulti(address[] _holders, uint256[] _allowedTokens, uint256[] _startTimes, uint256[] _endTimes, enum VolumeRestrictionTMStorage.RestrictionType[] _restrictionTypes) public nonpayable
```

**Arguments**

| Name               | Type                                               | Description                                                                                           |
| ------------------ | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| \_holders          | address\[]                                         | Array of address of the token holders, whom restriction will be implied                               |
| \_allowedTokens    | uint256\[]                                         | Array of amount of tokens allowed to be trade for a given address.                                    |
| \_startTimes       | uint256\[]                                         | Array of unix timestamps at which restrictions get into effect                                        |
| \_endTimes         | uint256\[]                                         | Array of unix timestamps at which restriction effects will gets end.                                  |
| \_restrictionTypes | enum VolumeRestrictionTMStorage.RestrictionType\[] | Array of restriction types value whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### addIndividualRestrictionMulti

Use to add the new individual restriction for multiple token holders

```javascript
function addIndividualRestrictionMulti(address[] _holders, uint256[] _allowedTokens, uint256[] _startTimes, uint256[] _rollingPeriodInDays, uint256[] _endTimes, enum VolumeRestrictionTMStorage.RestrictionType[] _restrictionTypes) public nonpayable
```

**Arguments**

| Name                  | Type                                               | Description                                                                                           |
| --------------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| \_holders             | address\[]                                         | Array of address of the token holders, whom restriction will be implied                               |
| \_allowedTokens       | uint256\[]                                         | Array of amount of tokens allowed to be trade for a given address.                                    |
| \_startTimes          | uint256\[]                                         | Array of unix timestamps at which restrictions get into effect                                        |
| \_rollingPeriodInDays | uint256\[]                                         | Array of rolling period in days (Minimum value should be 1 day)                                       |
| \_endTimes            | uint256\[]                                         | Array of unix timestamps at which restriction effects will gets end.                                  |
| \_restrictionTypes    | enum VolumeRestrictionTMStorage.RestrictionType\[] | Array of restriction types value whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### addDefaultRestriction

Use to add the new default restriction for all token holder

```javascript
function addDefaultRestriction(uint256 _allowedTokens, uint256 _startTime, uint256 _rollingPeriodInDays, uint256 _endTime, enum VolumeRestrictionTMStorage.RestrictionType _restrictionType) external nonpayable withPerm
```

**Arguments**

| Name                  | Type                                            | Description                                                          |
| --------------------- | ----------------------------------------------- | -------------------------------------------------------------------- |
| \_allowedTokens       | uint256                                         | Amount of tokens allowed to be traded for all token holder.          |
| \_startTime           | uint256                                         | Unix timestamp at which restriction get into effect                  |
| \_rollingPeriodInDays | uint256                                         | Rolling period in days (Minimum value should be 1 day)               |
| \_endTime             | uint256                                         | Unix timestamp at which restriction effects will gets end.           |
| \_restrictionType     | enum VolumeRestrictionTMStorage.RestrictionType | Whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### addDefaultDailyRestriction

Use to add the new default daily restriction for all token holder

```javascript
function addDefaultDailyRestriction(uint256 _allowedTokens, uint256 _startTime, uint256 _endTime, enum VolumeRestrictionTMStorage.RestrictionType _restrictionType) external nonpayable withPerm
```

**Arguments**

| Name              | Type                                            | Description                                                          |
| ----------------- | ----------------------------------------------- | -------------------------------------------------------------------- |
| \_allowedTokens   | uint256                                         | Amount of tokens allowed to be traded for all token holder.          |
| \_startTime       | uint256                                         | Unix timestamp at which restriction get into effect                  |
| \_endTime         | uint256                                         | Unix timestamp at which restriction effects will gets end.           |
| \_restrictionType | enum VolumeRestrictionTMStorage.RestrictionType | Whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### removeIndividualRestriction

use to remove the individual restriction for a given address

```javascript
function removeIndividualRestriction(address _holder) public nonpayable withPerm
```

**Arguments**

| Name     | Type    | Description         |
| -------- | ------- | ------------------- |
| \_holder | address | Address of the user |

### \_removeIndividualRestriction

```javascript
function _removeIndividualRestriction(address _holder) internal nonpayable
```

**Arguments**

| Name     | Type    | Description |
| -------- | ------- | ----------- |
| \_holder | address |             |

### removeIndividualRestrictionMulti

use to remove the individual restriction for a given address

```javascript
function removeIndividualRestrictionMulti(address[] _holders) public nonpayable withPerm
```

**Arguments**

| Name      | Type       | Description                  |
| --------- | ---------- | ---------------------------- |
| \_holders | address\[] | Array of address of the user |

### removeIndividualDailyRestriction

use to remove the individual daily restriction for a given address

```javascript
function removeIndividualDailyRestriction(address _holder) public nonpayable withPerm
```

**Arguments**

| Name     | Type    | Description         |
| -------- | ------- | ------------------- |
| \_holder | address | Address of the user |

### \_removeIndividualDailyRestriction

```javascript
function _removeIndividualDailyRestriction(address _holder) internal nonpayable
```

**Arguments**

| Name     | Type    | Description |
| -------- | ------- | ----------- |
| \_holder | address |             |

### removeIndividualDailyRestrictionMulti

use to remove the individual daily restriction for a given address

```javascript
function removeIndividualDailyRestrictionMulti(address[] _holders) public nonpayable withPerm
```

**Arguments**

| Name      | Type       | Description                  |
| --------- | ---------- | ---------------------------- |
| \_holders | address\[] | Array of address of the user |

### removeDefaultRestriction

Use to remove the default restriction

```javascript
function removeDefaultRestriction() public nonpayable withPerm
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### removeDefaultDailyRestriction

Use to remove the daily default restriction

```javascript
function removeDefaultDailyRestriction() external nonpayable withPerm
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### modifyIndividualRestriction

Use to modify the existing individual restriction for a given token holder

```javascript
function modifyIndividualRestriction(address _holder, uint256 _allowedTokens, uint256 _startTime, uint256 _rollingPeriodInDays, uint256 _endTime, enum VolumeRestrictionTMStorage.RestrictionType _restrictionType) public nonpayable withPerm
```

**Arguments**

| Name                  | Type                                            | Description                                                          |
| --------------------- | ----------------------------------------------- | -------------------------------------------------------------------- |
| \_holder              | address                                         | Address of the token holder, whom restriction will be implied        |
| \_allowedTokens       | uint256                                         | Amount of tokens allowed to be trade for a given address.            |
| \_startTime           | uint256                                         | Unix timestamp at which restriction get into effect                  |
| \_rollingPeriodInDays | uint256                                         | Rolling period in days (Minimum value should be 1 day)               |
| \_endTime             | uint256                                         | Unix timestamp at which restriction effects will gets end.           |
| \_restrictionType     | enum VolumeRestrictionTMStorage.RestrictionType | Whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### modifyIndividualDailyRestriction

Use to modify the existing individual daily restriction for a given token holder

```javascript
function modifyIndividualDailyRestriction(address _holder, uint256 _allowedTokens, uint256 _startTime, uint256 _endTime, enum VolumeRestrictionTMStorage.RestrictionType _restrictionType) public nonpayable withPerm
```

**Arguments**

| Name              | Type                                            | Description                                                          |
| ----------------- | ----------------------------------------------- | -------------------------------------------------------------------- |
| \_holder          | address                                         | Address of the token holder, whom restriction will be implied        |
| \_allowedTokens   | uint256                                         | Amount of tokens allowed to be trade for a given address.            |
| \_startTime       | uint256                                         | Unix timestamp at which restriction get into effect                  |
| \_endTime         | uint256                                         | Unix timestamp at which restriction effects will gets end.           |
| \_restrictionType | enum VolumeRestrictionTMStorage.RestrictionType | Whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### modifyIndividualDailyRestrictionMulti

Use to modify the existing individual daily restriction for multiple token holders

```javascript
function modifyIndividualDailyRestrictionMulti(address[] _holders, uint256[] _allowedTokens, uint256[] _startTimes, uint256[] _endTimes, enum VolumeRestrictionTMStorage.RestrictionType[] _restrictionTypes) public nonpayable
```

**Arguments**

| Name               | Type                                               | Description                                                                                           |
| ------------------ | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| \_holders          | address\[]                                         | Array of address of the token holders, whom restriction will be implied                               |
| \_allowedTokens    | uint256\[]                                         | Array of amount of tokens allowed to be trade for a given address.                                    |
| \_startTimes       | uint256\[]                                         | Array of unix timestamps at which restrictions get into effect                                        |
| \_endTimes         | uint256\[]                                         | Array of unix timestamps at which restriction effects will gets end.                                  |
| \_restrictionTypes | enum VolumeRestrictionTMStorage.RestrictionType\[] | Array of restriction types value whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### modifyIndividualRestrictionMulti

Use to modify the existing individual restriction for multiple token holders

```javascript
function modifyIndividualRestrictionMulti(address[] _holders, uint256[] _allowedTokens, uint256[] _startTimes, uint256[] _rollingPeriodInDays, uint256[] _endTimes, enum VolumeRestrictionTMStorage.RestrictionType[] _restrictionTypes) public nonpayable
```

**Arguments**

| Name                  | Type                                               | Description                                                                                           |
| --------------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| \_holders             | address\[]                                         | Array of address of the token holders, whom restriction will be implied                               |
| \_allowedTokens       | uint256\[]                                         | Array of amount of tokens allowed to be trade for a given address.                                    |
| \_startTimes          | uint256\[]                                         | Array of unix timestamps at which restrictions get into effect                                        |
| \_rollingPeriodInDays | uint256\[]                                         | Array of rolling period in days (Minimum value should be 1 day)                                       |
| \_endTimes            | uint256\[]                                         | Array of unix timestamps at which restriction effects will gets end.                                  |
| \_restrictionTypes    | enum VolumeRestrictionTMStorage.RestrictionType\[] | Array of restriction types value whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### modifyDefaultRestriction

Use to modify the global restriction for all token holder

```javascript
function modifyDefaultRestriction(uint256 _allowedTokens, uint256 _startTime, uint256 _rollingPeriodInDays, uint256 _endTime, enum VolumeRestrictionTMStorage.RestrictionType _restrictionType) external nonpayable withPerm
```

**Arguments**

| Name                  | Type                                            | Description                                                          |
| --------------------- | ----------------------------------------------- | -------------------------------------------------------------------- |
| \_allowedTokens       | uint256                                         | Amount of tokens allowed to be traded for all token holder.          |
| \_startTime           | uint256                                         | Unix timestamp at which restriction get into effect                  |
| \_rollingPeriodInDays | uint256                                         | Rolling period in days (Minimum value should be 1 day)               |
| \_endTime             | uint256                                         | Unix timestamp at which restriction effects will gets end.           |
| \_restrictionType     | enum VolumeRestrictionTMStorage.RestrictionType | Whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### modifyDefaultDailyRestriction

Use to modify the daily default restriction for all token holder

```javascript
function modifyDefaultDailyRestriction(uint256 _allowedTokens, uint256 _startTime, uint256 _endTime, enum VolumeRestrictionTMStorage.RestrictionType _restrictionType) external nonpayable withPerm
```

**Arguments**

| Name              | Type                                            | Description                                                          |
| ----------------- | ----------------------------------------------- | -------------------------------------------------------------------- |
| \_allowedTokens   | uint256                                         | Amount of tokens allowed to be traded for all token holder.          |
| \_startTime       | uint256                                         | Unix timestamp at which restriction get into effect                  |
| \_endTime         | uint256                                         | Unix timestamp at which restriction effects will gets end.           |
| \_restrictionType | enum VolumeRestrictionTMStorage.RestrictionType | Whether it will be `Fixed` (fixed no. of tokens allowed to transact) |

or `Percentage` (tokens are calculated as per the totalSupply in the fly). |

### \_restrictionCheck

Internal function used to validate the transaction for a given address If it validates then it also update the storage corressponds to the default restriction

```javascript
function _restrictionCheck(uint256 _amount, address _from, bool _isDefault, struct VolumeRestrictionTMStorage.VolumeRestriction _restriction) internal view
returns(success enum ITransferManager.Result, fromTimestamp uint256, sumOfLastPeriod uint256, daysCovered uint256, dailyTime uint256, endTime uint256, allowedAmountToTransact uint256, allowedDaily bool)
```

**Arguments**

| Name          | Type                                                | Description |
| ------------- | --------------------------------------------------- | ----------- |
| \_amount      | uint256                                             |             |
| \_from        | address                                             |             |
| \_isDefault   | bool                                                |             |
| \_restriction | struct VolumeRestrictionTMStorage.VolumeRestriction |             |

### \_validAllowedAmount

```javascript
function _validAllowedAmount(struct VolumeRestrictionTMStorage.VolumeRestriction dailyRestriction, struct VolumeRestrictionTMStorage.VolumeRestriction restriction, uint256 allowedAmount, uint256 allowedDailyAmount) internal view
returns(uint256)
```

**Arguments**

| Name               | Type                                                | Description |
| ------------------ | --------------------------------------------------- | ----------- |
| dailyRestriction   | struct VolumeRestrictionTMStorage.VolumeRestriction |             |
| restriction        | struct VolumeRestrictionTMStorage.VolumeRestriction |             |
| allowedAmount      | uint256                                             |             |
| allowedDailyAmount | uint256                                             |             |

### \_isValidAmountAfterRestrictionChanges

The function is used to check specific edge case where the user restriction type change from default to individual or vice versa. It will return true when last transaction traded by the user and the current txn timestamp lies in the same day. NB - Instead of comparing the current day transaction amount, we are comparing the total amount traded on the lastTradedDayTime that makes the restriction strict. The reason is not availability of amount that transacted on the current day (because of bucket desgin).

```javascript
function _isValidAmountAfterRestrictionChanges(bool _isDefault, address _from, uint256 _amount, uint256 _sumOfLastPeriod, uint256 _allowedAmount) internal view
returns(bool)
```

**Arguments**

| Name              | Type    | Description |
| ----------------- | ------- | ----------- |
| \_isDefault       | bool    |             |
| \_from            | address |             |
| \_amount          | uint256 |             |
| \_sumOfLastPeriod | uint256 |             |
| \_allowedAmount   | uint256 |             |

### \_dailyTxCheck

```javascript
function _dailyTxCheck(uint256 _amount, address _from, bool _isDefault, uint256 _dailyLastTradedDayTime, struct VolumeRestrictionTMStorage.VolumeRestriction _restriction) internal view
returns(bool, uint256, uint256)
```

**Arguments**

| Name                     | Type                                                | Description |
| ------------------------ | --------------------------------------------------- | ----------- |
| \_amount                 | uint256                                             |             |
| \_from                   | address                                             |             |
| \_isDefault              | bool                                                |             |
| \_dailyLastTradedDayTime | uint256                                             |             |
| \_restriction            | struct VolumeRestrictionTMStorage.VolumeRestriction |             |

### \_bucketCheck

```javascript
function _bucketCheck(address _from, bool isDefault, uint256 _fromTime, uint256 _diffDays, uint256 _rollingPeriodInDays, struct VolumeRestrictionTMStorage.BucketDetails _bucketDetails) internal view
returns(uint256, uint256, uint256)
```

**Arguments**

| Name                  | Type                                            | Description |
| --------------------- | ----------------------------------------------- | ----------- |
| \_from                | address                                         |             |
| isDefault             | bool                                            |             |
| \_fromTime            | uint256                                         |             |
| \_diffDays            | uint256                                         |             |
| \_rollingPeriodInDays | uint256                                         |             |
| \_bucketDetails       | struct VolumeRestrictionTMStorage.BucketDetails |             |

### \_checkValidAmountToTransact

```javascript
function _checkValidAmountToTransact(uint256 _amountToTransact, address _from, bool _isDefault, struct VolumeRestrictionTMStorage.VolumeRestriction _restriction, uint256 _sumOfLastPeriod) internal view
returns(bool, uint256)
```

**Arguments**

| Name               | Type                                                | Description |
| ------------------ | --------------------------------------------------- | ----------- |
| \_amountToTransact | uint256                                             |             |
| \_from             | address                                             |             |
| \_isDefault        | bool                                                |             |
| \_restriction      | struct VolumeRestrictionTMStorage.VolumeRestriction |             |
| \_sumOfLastPeriod  | uint256                                             |             |

### \_allowedAmountToTransact

```javascript
function _allowedAmountToTransact(uint256 _sumOfLastPeriod, struct VolumeRestrictionTMStorage.VolumeRestriction _restriction) internal view
returns(uint256)
```

**Arguments**

| Name              | Type                                                | Description |
| ----------------- | --------------------------------------------------- | ----------- |
| \_sumOfLastPeriod | uint256                                             |             |
| \_restriction     | struct VolumeRestrictionTMStorage.VolumeRestriction |             |

### \_updateStorage

```javascript
function _updateStorage(address _from, uint256 _amount, uint256 _lastTradedDayTime, uint256 _sumOfLastPeriod, uint256 _daysCovered, uint256 _dailyLastTradedDayTime, uint256 _endTime, bool isDefault) internal nonpayable
```

**Arguments**

| Name                     | Type    | Description |
| ------------------------ | ------- | ----------- |
| \_from                   | address |             |
| \_amount                 | uint256 |             |
| \_lastTradedDayTime      | uint256 |             |
| \_sumOfLastPeriod        | uint256 |             |
| \_daysCovered            | uint256 |             |
| \_dailyLastTradedDayTime | uint256 |             |
| \_endTime                | uint256 |             |
| isDefault                | bool    |             |

### \_updateStorageActual

```javascript
function _updateStorageActual(address _from, uint256 _amount, uint256 _lastTradedDayTime, uint256 _sumOfLastPeriod, uint256 _daysCovered, uint256 _dailyLastTradedDayTime, uint256 _endTime, bool isDefault, struct VolumeRestrictionTMStorage.BucketDetails details) internal nonpayable
```

**Arguments**

| Name                     | Type                                            | Description |
| ------------------------ | ----------------------------------------------- | ----------- |
| \_from                   | address                                         |             |
| \_amount                 | uint256                                         |             |
| \_lastTradedDayTime      | uint256                                         |             |
| \_sumOfLastPeriod        | uint256                                         |             |
| \_daysCovered            | uint256                                         |             |
| \_dailyLastTradedDayTime | uint256                                         |             |
| \_endTime                | uint256                                         |             |
| isDefault                | bool                                            |             |
| details                  | struct VolumeRestrictionTMStorage.BucketDetails |             |

### \_checkInputParams

```javascript
function _checkInputParams(uint256 _allowedTokens, uint256 _startTime, uint256 _rollingPeriodDays, uint256 _endTime, enum VolumeRestrictionTMStorage.RestrictionType _restrictionType, uint256 _earliestStartTime, bool isModifyDaily) internal pure
```

**Arguments**

| Name                | Type                                            | Description |
| ------------------- | ----------------------------------------------- | ----------- |
| \_allowedTokens     | uint256                                         |             |
| \_startTime         | uint256                                         |             |
| \_rollingPeriodDays | uint256                                         |             |
| \_endTime           | uint256                                         |             |
| \_restrictionType   | enum VolumeRestrictionTMStorage.RestrictionType |             |
| \_earliestStartTime | uint256                                         |             |
| isModifyDaily       | bool                                            |             |

### \_isAllowedToModify

```javascript
function _isAllowedToModify(uint256 _startTime) internal view
```

**Arguments**

| Name        | Type    | Description |
| ----------- | ------- | ----------- |
| \_startTime | uint256 |             |

### \_getValidStartTime

```javascript
function _getValidStartTime(uint256 _startTime) internal view
returns(uint256)
```

**Arguments**

| Name        | Type    | Description |
| ----------- | ------- | ----------- |
| \_startTime | uint256 |             |

### getTokensByPartition

⤾ overrides [TransferManager.getTokensByPartition](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/TransferManager.md#gettokensbypartition)

return the amount of tokens for a given user as per the partition

```javascript
function getTokensByPartition(bytes32 _partition, address _tokenHolder, uint256 _additionalBalance) external view
returns(uint256)
```

**Arguments**

| Name                | Type    | Description                                                                 |
| ------------------- | ------- | --------------------------------------------------------------------------- |
| \_partition         | bytes32 | Identifier                                                                  |
| \_tokenHolder       | address | Whom token amount need to query                                             |
| \_additionalBalance | uint256 | It is the `_value` that transfer during transfer/transferFrom function call |

### getIndividualBucketDetailsToUser

Use to get the bucket details for a given address

```javascript
function getIndividualBucketDetailsToUser(address _user) public view
returns(uint256, uint256, uint256, uint256, uint256)
```

**Returns**

uint256 lastTradedDayTime

**Arguments**

| Name   | Type    | Description                                                         |
| ------ | ------- | ------------------------------------------------------------------- |
| \_user | address | Address of the token holder for whom the bucket details has queried |

### getDefaultBucketDetailsToUser

Use to get the bucket details for a given address

```javascript
function getDefaultBucketDetailsToUser(address _user) public view
returns(uint256, uint256, uint256, uint256, uint256)
```

**Returns**

uint256 lastTradedDayTime

**Arguments**

| Name   | Type    | Description                                                         |
| ------ | ------- | ------------------------------------------------------------------- |
| \_user | address | Address of the token holder for whom the bucket details has queried |

### \_getBucketDetails

```javascript
function _getBucketDetails(struct VolumeRestrictionTMStorage.BucketDetails _bucket) internal view
returns(uint256, uint256, uint256, uint256, uint256)
```

**Arguments**

| Name     | Type                                            | Description |
| -------- | ----------------------------------------------- | ----------- |
| \_bucket | struct VolumeRestrictionTMStorage.BucketDetails |             |

### getTotalTradedByUser

Use to get the volume of token that being traded at a particular day (`_at` + 24 hours) for a given user

```javascript
function getTotalTradedByUser(address _user, uint256 _at) external view
returns(uint256)
```

**Arguments**

| Name   | Type    | Description                 |
| ------ | ------- | --------------------------- |
| \_user | address | Address of the token holder |
| \_at   | uint256 | Timestamp                   |

### getInitFunction

⤾ overrides [IModule.getInitFunction](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/IModule.md#getinitfunction)

This function returns the signature of configure function

```javascript
function getInitFunction() public pure
returns(bytes4)
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### getExemptAddress

Use to return the list of exempted addresses

```javascript
function getExemptAddress() external view
returns(address[])
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### getIndividualRestriction

```javascript
function getIndividualRestriction(address _investor) external view
returns(uint256, uint256, uint256, uint256, enum VolumeRestrictionTMStorage.RestrictionType)
```

**Arguments**

| Name       | Type    | Description |
| ---------- | ------- | ----------- |
| \_investor | address |             |

### getIndividualDailyRestriction

```javascript
function getIndividualDailyRestriction(address _investor) external view
returns(uint256, uint256, uint256, uint256, enum VolumeRestrictionTMStorage.RestrictionType)
```

**Arguments**

| Name       | Type    | Description |
| ---------- | ------- | ----------- |
| \_investor | address |             |

### getDefaultRestriction

```javascript
function getDefaultRestriction() external view
returns(uint256, uint256, uint256, uint256, enum VolumeRestrictionTMStorage.RestrictionType)
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### getDefaultDailyRestriction

```javascript
function getDefaultDailyRestriction() external view
returns(uint256, uint256, uint256, uint256, enum VolumeRestrictionTMStorage.RestrictionType)
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### \_volumeRestrictionSplay

```javascript
function _volumeRestrictionSplay(struct VolumeRestrictionTMStorage.VolumeRestriction _volumeRestriction) internal pure
returns(uint256, uint256, uint256, uint256, enum VolumeRestrictionTMStorage.RestrictionType)
```

**Arguments**

| Name                | Type                                                | Description |
| ------------------- | --------------------------------------------------- | ----------- |
| \_volumeRestriction | struct VolumeRestrictionTMStorage.VolumeRestriction |             |

### getRestrictionData

Provide the restriction details of all the restricted addresses

```javascript
function getRestrictionData() external view
returns(allAddresses address[], allowedTokens uint256[], startTime uint256[], rollingPeriodInDays uint256[], endTime uint256[], typeOfRestriction enum VolumeRestrictionTMStorage.RestrictionType[])
```

**Returns**

address List of the restricted addresses

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |

### \_checkLengthOfArray

```javascript
function _checkLengthOfArray(address[] _holders, uint256[] _allowedTokens, uint256[] _startTimes, uint256[] _rollingPeriodInDays, uint256[] _endTimes, enum VolumeRestrictionTMStorage.RestrictionType[] _restrictionTypes) internal pure
```

**Arguments**

| Name                  | Type                                               | Description |
| --------------------- | -------------------------------------------------- | ----------- |
| \_holders             | address\[]                                         |             |
| \_allowedTokens       | uint256\[]                                         |             |
| \_startTimes          | uint256\[]                                         |             |
| \_rollingPeriodInDays | uint256\[]                                         |             |
| \_endTimes            | uint256\[]                                         |             |
| \_restrictionTypes    | enum VolumeRestrictionTMStorage.RestrictionType\[] |             |

### getPermissions

⤾ overrides [IModule.getPermissions](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/IModule.md#getpermissions)

Returns the permissions flag that are associated with Percentage transfer Manager

```javascript
function getPermissions() public view
returns(allPermissions bytes32[])
```

**Arguments**

| Name | Type | Description |
| ---- | ---- | ----------- |