> For the complete documentation index, see [llms.txt](https://docs.rigoblock.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rigoblock.com/api/protocol/interfaces/ipoolregistry.md).

# IPoolRegistry

## Overview

#### License: Apache 2.0

```solidity
interface IPoolRegistry
```

Author: Gabriele Rigo - <gab@rigoblock.com>

## Structs info

### PoolMeta

```solidity
struct PoolMeta {
	mapping(bytes32 => bytes32) meta;
}
```

Mapping of pool meta by pool key.

Parameters:

| Name | Type                        | Description                             |
| ---- | --------------------------- | --------------------------------------- |
| meta | mapping(bytes32 => bytes32) | Mapping of bytes32 key to bytes32 meta. |

## Events info

### AuthorityChanged

```solidity
event AuthorityChanged(address indexed authority)
```

Emitted when Rigoblock Dao updates authority address.

Parameters:

| Name      | Type    | Description                            |
| --------- | ------- | -------------------------------------- |
| authority | address | Address of the new authority contract. |

### MetaChanged

```solidity
event MetaChanged(address indexed pool, bytes32 indexed key, bytes32 value)
```

Emitted when pool owner updates meta data for its pool.

Parameters:

| Name  | Type    | Description                                   |
| ----- | ------- | --------------------------------------------- |
| pool  | address | Address of the pool.                          |
| key   | bytes32 | Bytes32 key for indexing.                     |
| value | bytes32 | Bytes32 of the value associated with the key. |

### Registered

```solidity
event Registered(address indexed group, address pool, bytes32 indexed name, bytes32 indexed symbol, bytes32 id)
```

Emitted when a new pool is registered in registry.

Parameters:

| Name   | Type    | Description                     |
| ------ | ------- | ------------------------------- |
| group  | address | Address of the pool factory.    |
| pool   | address | Address of the registered pool. |
| name   | bytes32 | String name of the pool.        |
| symbol | bytes32 | String name of the pool.        |
| id     | bytes32 | Bytes32 id of the pool.         |

### RigoblockDaoChanged

```solidity
event RigoblockDaoChanged(address indexed rigoblockDao)
```

Emitted when rigoblock Dao address is updated.

Parameters:

| Name         | Type    | Description      |
| ------------ | ------- | ---------------- |
| rigoblockDao | address | New Dao address. |

## Functions info

### authority (0xbf7e214f)

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

Returns the address of the Rigoblock authority contract.

Return values:

| Name | Type    | Description                        |
| ---- | ------- | ---------------------------------- |
| \[0] | address | Address of the authority contract. |

### rigoblockDao (0x3edd80c3)

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

Returns the address of the Rigoblock Dao.

Return values:

| Name | Type    | Description                   |
| ---- | ------- | ----------------------------- |
| \[0] | address | Address of the Rigoblock Dao. |

### register (0x3f47734b)

```solidity
function register(
    address pool,
    string calldata name,
    string calldata symbol,
    bytes32 poolId
) external
```

Allows a factory which is an authority to register a pool.

Parameters:

| Name   | Type    | Description                                            |
| ------ | ------- | ------------------------------------------------------ |
| pool   | address | Address of the pool.                                   |
| name   | string  | String name of the pool (31 characters/bytes or less). |
| symbol | string  | String symbol of the pool (3 to 5 characters/bytes).   |
| poolId | bytes32 | Bytes32 of the pool id.                                |

### setAuthority (0x7a9e5e4b)

```solidity
function setAuthority(address authority) external
```

Allows Rigoblock governance to update authority.

Parameters:

| Name      | Type    | Description                        |
| --------- | ------- | ---------------------------------- |
| authority | address | Address of the authority contract. |

### setMeta (0x56d002c4)

```solidity
function setMeta(address pool, bytes32 key, bytes32 value) external
```

Allows pool owner to set metadata for a pool.

Parameters:

| Name  | Type    | Description           |
| ----- | ------- | --------------------- |
| pool  | address | Address of the pool.  |
| key   | bytes32 | Bytes32 of the key.   |
| value | bytes32 | Bytes32 of the value. |

### setRigoblockDao (0xb516e6e1)

```solidity
function setRigoblockDao(address newRigoblockDao) external
```

Allows Rigoblock Dao to update its address.

Creates internal record.

Parameters:

| Name            | Type    | Description                   |
| --------------- | ------- | ----------------------------- |
| newRigoblockDao | address | Address of the Rigoblock Dao. |

### getMeta (0x386f5adf)

```solidity
function getMeta(
    address pool,
    bytes32 key
) external view returns (bytes32 poolMeta)
```

Returns metadata for a given pool.

Parameters:

| Name | Type    | Description          |
| ---- | ------- | -------------------- |
| pool | address | Address of the pool. |
| key  | bytes32 | Bytes32 key.         |

Return values:

| Name     | Type    | Description  |
| -------- | ------- | ------------ |
| poolMeta | bytes32 | Meta by key. |

### getPoolIdFromAddress (0x2cee2191)

```solidity
function getPoolIdFromAddress(
    address pool
) external view returns (bytes32 poolId)
```

Returns the id of a pool from its address.

Parameters:

| Name | Type    | Description          |
| ---- | ------- | -------------------- |
| pool | address | Address of the pool. |

Return values:

| Name   | Type    | Description             |
| ------ | ------- | ----------------------- |
| poolId | bytes32 | bytes32 id of the pool. |
