> 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/imoduleregistry.md).

# Interface for the Polymath Module Registry contract (IModuleRegistry.sol)

View Source: [contracts/interfaces/IModuleRegistry.sol](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/contracts/interfaces/IModuleRegistry.sol)

**↘ Derived Contracts:** [**ModuleRegistry**](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md)

**IModuleRegistry**

**Events**

```javascript
event Pause(address  account);
event Unpause(address  account);
event ModuleUsed(address indexed _moduleFactory, address indexed _securityToken);
event ModuleRegistered(address indexed _moduleFactory, address indexed _owner);
event ModuleVerified(address indexed _moduleFactory);
event ModuleUnverified(address indexed _moduleFactory);
event ModuleRemoved(address indexed _moduleFactory, address indexed _decisionMaker);
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
```

## Functions

* [useModule(address \_moduleFactory)](/polymath/api/imoduleregistry.md#usemodule)
* [useModule(address \_moduleFactory, bool \_isUpgrade)](/polymath/api/imoduleregistry.md#usemodule)
* [registerModule(address \_moduleFactory)](/polymath/api/imoduleregistry.md#registermodule)
* [removeModule(address \_moduleFactory)](/polymath/api/imoduleregistry.md#removemodule)
* [isCompatibleModule(address \_moduleFactory, address \_securityToken)](/polymath/api/imoduleregistry.md#iscompatiblemodule)
* [verifyModule(address \_moduleFactory)](/polymath/api/imoduleregistry.md#verifymodule)
* [unverifyModule(address \_moduleFactory)](/polymath/api/imoduleregistry.md#unverifymodule)
* [getFactoryDetails(address \_factoryAddress)](/polymath/api/imoduleregistry.md#getfactorydetails)
* [getTagsByTypeAndToken(uint8 \_moduleType, address \_securityToken)](/polymath/api/imoduleregistry.md#gettagsbytypeandtoken)
* [getTagsByType(uint8 \_moduleType)](/polymath/api/imoduleregistry.md#gettagsbytype)
* [getAllModulesByType(uint8 \_moduleType)](/polymath/api/imoduleregistry.md#getallmodulesbytype)
* [getModulesByType(uint8 \_moduleType)](/polymath/api/imoduleregistry.md#getmodulesbytype)
* [getModulesByTypeAndToken(uint8 \_moduleType, address \_securityToken)](/polymath/api/imoduleregistry.md#getmodulesbytypeandtoken)
* [updateFromRegistry()](/polymath/api/imoduleregistry.md#updatefromregistry)
* [owner()](/polymath/api/imoduleregistry.md#owner)
* [isPaused()](/polymath/api/imoduleregistry.md#ispaused)
* [reclaimERC20(address \_tokenContract)](/polymath/api/imoduleregistry.md#reclaimerc20)
* [pause()](/polymath/api/imoduleregistry.md#pause)
* [unpause()](/polymath/api/imoduleregistry.md#unpause)
* [transferOwnership(address \_newOwner)](/polymath/api/imoduleregistry.md#transferownership)

### useModule

⤿ Overridden Implementation(s): [ModuleRegistry.useModule](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#usemodule)

Called by a security token (2.x) to notify the registry it is using a module

```javascript
function useModule(address _moduleFactory) external nonpayable
```

**Arguments**

| Name            | Type    | Description                                   |
| --------------- | ------- | --------------------------------------------- |
| \_moduleFactory | address | is the address of the relevant module factory |

### useModule

⤿ Overridden Implementation(s): [ModuleRegistry.useModule](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#usemodule)

Called by a security token to notify the registry it is using a module

```javascript
function useModule(address _moduleFactory, bool _isUpgrade) external nonpayable
```

**Arguments**

| Name            | Type    | Description                                           |
| --------------- | ------- | ----------------------------------------------------- |
| \_moduleFactory | address | is the address of the relevant module factory         |
| \_isUpgrade     | bool    | whether the use is part of an existing module upgrade |

### registerModule

⤿ Overridden Implementation(s): [ModuleRegistry.registerModule](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#registermodule)

Called by the ModuleFactory owner to register new modules for SecurityToken to use

```javascript
function registerModule(address _moduleFactory) external nonpayable
```

**Arguments**

| Name            | Type    | Description                                           |
| --------------- | ------- | ----------------------------------------------------- |
| \_moduleFactory | address | is the address of the module factory to be registered |

### removeModule

⤿ Overridden Implementation(s): [ModuleRegistry.removeModule](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#removemodule)

Called by the ModuleFactory owner or registry curator to delete a ModuleFactory

```javascript
function removeModule(address _moduleFactory) external nonpayable
```

**Arguments**

| Name            | Type    | Description                                        |
| --------------- | ------- | -------------------------------------------------- |
| \_moduleFactory | address | is the address of the module factory to be deleted |

### isCompatibleModule

⤿ Overridden Implementation(s): [ModuleRegistry.isCompatibleModule](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#iscompatiblemodule)

Check that a module and its factory are compatible

```javascript
function isCompatibleModule(address _moduleFactory, address _securityToken) external view
returns(isCompatible bool)
```

**Returns**

bool whether module and token are compatible

**Arguments**

| Name            | Type    | Description                                   |
| --------------- | ------- | --------------------------------------------- |
| \_moduleFactory | address | is the address of the relevant module factory |
| \_securityToken | address | is the address of the relevant security token |

### verifyModule

⤿ Overridden Implementation(s): [ModuleRegistry.verifyModule](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#verifymodule)

Called by Polymath to verify modules for SecurityToken to use.

```javascript
function verifyModule(address _moduleFactory) external nonpayable
```

**Arguments**

| Name            | Type    | Description                                           |
| --------------- | ------- | ----------------------------------------------------- |
| \_moduleFactory | address | is the address of the module factory to be registered |

### unverifyModule

⤿ Overridden Implementation(s): [ModuleRegistry.unverifyModule](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#unverifymodule)

Called by Polymath to unverify modules for SecurityToken to use.

```javascript
function unverifyModule(address _moduleFactory) external nonpayable
```

**Arguments**

| Name            | Type    | Description                                           |
| --------------- | ------- | ----------------------------------------------------- |
| \_moduleFactory | address | is the address of the module factory to be registered |

### getFactoryDetails

⤿ Overridden Implementation(s): [ModuleRegistry.getFactoryDetails](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#getfactorydetails)

Returns the verified status, and reputation of the entered Module Factory

```javascript
function getFactoryDetails(address _factoryAddress) external view
returns(isVerified bool, factoryOwner address, usingTokens address[])
```

**Returns**

bool indicating whether module factory is verified

**Arguments**

| Name             | Type    | Description                          |
| ---------------- | ------- | ------------------------------------ |
| \_factoryAddress | address | is the address of the module factory |

### getTagsByTypeAndToken

⤿ Overridden Implementation(s): [ModuleRegistry.getTagsByTypeAndToken](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#gettagsbytypeandtoken)

Returns all the tags related to the a module type which are valid for the given token

```javascript
function getTagsByTypeAndToken(uint8 _moduleType, address _securityToken) external view
returns(tags bytes32[], factories address[])
```

**Returns**

list of tags

**Arguments**

| Name            | Type    | Description        |
| --------------- | ------- | ------------------ |
| \_moduleType    | uint8   | is the module type |
| \_securityToken | address | is the token       |

### getTagsByType

⤿ Overridden Implementation(s): [ModuleRegistry.getTagsByType](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#gettagsbytype)

Returns all the tags related to the a module type which are valid for the given token

```javascript
function getTagsByType(uint8 _moduleType) external view
returns(tags bytes32[], factories address[])
```

**Returns**

list of tags

**Arguments**

| Name         | Type  | Description        |
| ------------ | ----- | ------------------ |
| \_moduleType | uint8 | is the module type |

### getAllModulesByType

⤿ Overridden Implementation(s): [ModuleRegistry.getAllModulesByType](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#getallmodulesbytype)

Returns the list of addresses of all Module Factory of a particular type

```javascript
function getAllModulesByType(uint8 _moduleType) external view
returns(factories address[])
```

**Returns**

address array that contains the list of addresses of module factory contracts.

**Arguments**

| Name         | Type  | Description    |
| ------------ | ----- | -------------- |
| \_moduleType | uint8 | Type of Module |

### getModulesByType

⤿ Overridden Implementation(s): [ModuleRegistry.getModulesByType](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#getmodulesbytype)

Returns the list of addresses of Module Factory of a particular type

```javascript
function getModulesByType(uint8 _moduleType) external view
returns(factories address[])
```

**Returns**

address array that contains the list of addresses of module factory contracts.

**Arguments**

| Name         | Type  | Description    |
| ------------ | ----- | -------------- |
| \_moduleType | uint8 | Type of Module |

### getModulesByTypeAndToken

⤿ Overridden Implementation(s): [ModuleRegistry.getModulesByTypeAndToken](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#getmodulesbytypeandtoken)

Returns the list of available Module factory addresses of a particular type for a given token.

```javascript
function getModulesByTypeAndToken(uint8 _moduleType, address _securityToken) external view
returns(factories address[])
```

**Returns**

address array that contains the list of available addresses of module factory contracts.

**Arguments**

| Name            | Type    | Description                     |
| --------------- | ------- | ------------------------------- |
| \_moduleType    | uint8   | is the module type to look for  |
| \_securityToken | address | is the address of SecurityToken |

### updateFromRegistry

⤿ Overridden Implementation(s): [ModuleRegistry.updateFromRegistry](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#updatefromregistry)

Use to get the latest contract address of the regstries

```javascript
function updateFromRegistry() external nonpayable
```

**Arguments**

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

### owner

⤿ Overridden Implementation(s): [ModuleRegistry.owner](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#owner)

Get the owner of the contract

```javascript
function owner() external view
returns(ownerAddress address)
```

**Returns**

address owner

**Arguments**

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

### isPaused

⤿ Overridden Implementation(s): [ModuleRegistry.isPaused](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#ispaused)

Check whether the contract operations is paused or not

```javascript
function isPaused() external view
returns(paused bool)
```

**Returns**

bool

**Arguments**

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

### reclaimERC20

⤿ Overridden Implementation(s): [ModuleRegistry.reclaimERC20](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#reclaimerc20)

Reclaims all ERC20Basic compatible tokens

```javascript
function reclaimERC20(address _tokenContract) external nonpayable
```

**Arguments**

| Name            | Type    | Description                       |
| --------------- | ------- | --------------------------------- |
| \_tokenContract | address | The address of the token contract |

### pause

⤿ Overridden Implementation(s): [ModuleRegistry.pause](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#pause)

Called by the owner to pause, triggers stopped state

```javascript
function pause() external nonpayable
```

**Arguments**

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

### unpause

⤿ Overridden Implementation(s): [ModuleRegistry.unpause](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#unpause)

Called by the owner to unpause, returns to normal state

```javascript
function unpause() external nonpayable
```

**Arguments**

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

### transferOwnership

⤿ Overridden Implementation(s): [ModuleRegistry.transferOwnership](https://github.com/PolymathNetwork/polymath-core/tree/096ba240a927c98e1f1a182d2efee7c4c4c1dfc5/docs/api/ModuleRegistry.md#transferownership)

Allows the current owner to transfer control of the contract to a newOwner.

```javascript
function transferOwnership(address _newOwner) external nonpayable
```

**Arguments**

| Name       | Type    | Description                           |
| ---------- | ------- | ------------------------------------- |
| \_newOwner | address | The address to transfer ownership to. |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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/imoduleregistry.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.