Skip to content

Commit daca9e3

Browse files
author
Docs Syncer
committed
CI: 6b614ea
1 parent 4711c4d commit daca9e3

26 files changed

+197
-1015
lines changed

docs/reference/contracts/contracts-registry/AContractsRegistry.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,19 @@ a new `B` contract to a ContractsRegistry and re-inject all the required depende
3636
is also meant to be compatible with factories.
3737

3838
Users may also fetch all the contracts present in the system as they are now located in a single place.
39+
## Structs info
40+
41+
### AContractsRegistryStorage
42+
43+
```solidity
44+
struct AContractsRegistryStorage {
45+
AdminableProxyUpgrader proxyUpgrader;
46+
mapping(string => address) contracts;
47+
mapping(address => bool) isProxy;
48+
}
49+
```
50+
51+
3952
## Events info
4053

4154
### ContractAdded

docs/reference/contracts/contracts-registry/pools/APoolContractsRegistry.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,19 @@ injection mechanism into the pools.
1919
The PoolContractsRegistry contract operates by managing ProxyBeacons that point to pools' implementations.
2020
The factory contract would deploy BeaconProxies that point to these ProxyBeacons, allowing simple and cheap
2121
upgradeability mechanics.
22+
## Structs info
23+
24+
### APoolContractsRegistryStorage
25+
26+
```solidity
27+
struct APoolContractsRegistryStorage {
28+
address contractsRegistry;
29+
mapping(string => UpgradeableBeacon) beacons;
30+
mapping(string => EnumerableSet.AddressSet) pools;
31+
}
32+
```
33+
34+
2235
## Errors info
2336

2437
### NoMappingExists
@@ -170,6 +183,13 @@ Return values:
170183
| :--- | :------ | :--------------------------------- |
171184
| [0] | uint256 | the number of pools with this name |
172185

186+
### getContractsRegistry (0xbcb9491c)
187+
188+
```solidity
189+
function getContractsRegistry() public view returns (address)
190+
```
191+
192+
Returns the address of the contracts registry
173193
### listPools (0x71dd21c6)
174194

175195
```solidity
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,17 @@ The actual `deploy()` function has to be implemented in the descendants of this
1717
is made via the BeaconProxy pattern.
1818

1919
Both "create1" and "create2" deployment modes are supported.
20+
## Structs info
21+
22+
### APoolFactoryStorage
23+
24+
```solidity
25+
struct APoolFactoryStorage {
26+
address contractsRegistry;
27+
}
28+
```
29+
30+
2031
## Functions info
2132

2233
### setDependencies (0x69130451)
@@ -36,3 +47,11 @@ Parameters:
3647
| Name | Type | Description |
3748
| :----------------- | :------ | :---------------------- |
3849
| contractsRegistry_ | address | the dependency registry |
50+
51+
### getContractsRegistry (0xbcb9491c)
52+
53+
```solidity
54+
function getContractsRegistry() public view returns (address)
55+
```
56+
57+
Returns the address of the contracts registry

docs/reference/contracts/diamond/access/access-control/ADiamondAccessControl.md

Lines changed: 0 additions & 83 deletions
This file was deleted.

docs/reference/contracts/diamond/access/access-control/ADiamondAccessControlStorage.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

docs/reference/contracts/diamond/access/ownable/ADiamondOwnableStorage.md

Lines changed: 0 additions & 67 deletions
This file was deleted.

docs/reference/contracts/diamond/access/ownable/DiamondOwnable.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

0 commit comments

Comments
 (0)