Skip to content

Commit 9273aed

Browse files
authored
docs: Add registries to Solidity documentation (#258)
1 parent 00a111e commit 9273aed

File tree

2 files changed

+345
-27
lines changed

2 files changed

+345
-27
lines changed

docs/solidity/index.md

Lines changed: 345 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -90,32 +90,6 @@ event Reward(address owner, uint256 amount, bytes32 ref)
9090
event Seize(address owner, uint256 amount, bytes32 ref)
9191
```
9292

93-
## IexecOrderManagementFacet
94-
95-
### manageAppOrder
96-
97-
```solidity
98-
function manageAppOrder(struct IexecLibOrders_v5.AppOrderOperation _apporderoperation) external
99-
```
100-
101-
### manageDatasetOrder
102-
103-
```solidity
104-
function manageDatasetOrder(struct IexecLibOrders_v5.DatasetOrderOperation _datasetorderoperation) external
105-
```
106-
107-
### manageWorkerpoolOrder
108-
109-
```solidity
110-
function manageWorkerpoolOrder(struct IexecLibOrders_v5.WorkerpoolOrderOperation _workerpoolorderoperation) external
111-
```
112-
113-
### manageRequestOrder
114-
115-
```solidity
116-
function manageRequestOrder(struct IexecLibOrders_v5.RequestOrderOperation _requestorderoperation) external
117-
```
118-
11993
## Matching
12094

12195
```solidity
@@ -860,6 +834,46 @@ struct PocoStorage {
860834
function isRegistered(address _entry) external view returns (bool)
861835
```
862836

837+
## IWorkerpool
838+
839+
### m_schedulerRewardRatioPolicy
840+
841+
```solidity
842+
function m_schedulerRewardRatioPolicy() external returns (uint256)
843+
```
844+
845+
### m_workerStakeRatioPolicy
846+
847+
```solidity
848+
function m_workerStakeRatioPolicy() external returns (uint256)
849+
```
850+
851+
## IexecOrderManagementFacet
852+
853+
### manageAppOrder
854+
855+
```solidity
856+
function manageAppOrder(struct IexecLibOrders_v5.AppOrderOperation _apporderoperation) external
857+
```
858+
859+
### manageDatasetOrder
860+
861+
```solidity
862+
function manageDatasetOrder(struct IexecLibOrders_v5.DatasetOrderOperation _datasetorderoperation) external
863+
```
864+
865+
### manageWorkerpoolOrder
866+
867+
```solidity
868+
function manageWorkerpoolOrder(struct IexecLibOrders_v5.WorkerpoolOrderOperation _workerpoolorderoperation) external
869+
```
870+
871+
### manageRequestOrder
872+
873+
```solidity
874+
function manageRequestOrder(struct IexecLibOrders_v5.RequestOrderOperation _requestorderoperation) external
875+
```
876+
863877
## IexecInterfaceNative
864878

865879
A global interface that aggregates all the interfaces needed to interact with
@@ -1355,3 +1369,308 @@ struct PocoStorage {
13551369
}
13561370
```
13571371

1372+
## IRegistry
1373+
1374+
### isRegistered
1375+
1376+
```solidity
1377+
function isRegistered(address _entry) external view returns (bool)
1378+
```
1379+
1380+
## Registry
1381+
1382+
### master
1383+
1384+
```solidity
1385+
address master
1386+
```
1387+
1388+
### proxyCode
1389+
1390+
```solidity
1391+
bytes proxyCode
1392+
```
1393+
1394+
### proxyCodeHash
1395+
1396+
```solidity
1397+
bytes32 proxyCodeHash
1398+
```
1399+
1400+
### previous
1401+
1402+
```solidity
1403+
contract IRegistry previous
1404+
```
1405+
1406+
### initialized
1407+
1408+
```solidity
1409+
bool initialized
1410+
```
1411+
1412+
### constructor
1413+
1414+
```solidity
1415+
constructor(address _master, string _name, string _symbol) public
1416+
```
1417+
1418+
### initialize
1419+
1420+
```solidity
1421+
function initialize(address _previous) external
1422+
```
1423+
1424+
### setBaseURI
1425+
1426+
```solidity
1427+
function setBaseURI(string _baseURI) external
1428+
```
1429+
1430+
### isRegistered
1431+
1432+
```solidity
1433+
function isRegistered(address _entry) external view returns (bool)
1434+
```
1435+
1436+
### setName
1437+
1438+
```solidity
1439+
function setName(address, string) external view
1440+
```
1441+
1442+
Sets the reverse registration name for a registry contract.
1443+
1444+
_This functionality is supported only on the Bellecour chain.
1445+
On other chains, this function will revert to maintain retrocompatibility
1446+
in the SDK._
1447+
1448+
## RegistryEntry
1449+
1450+
_Referenced in the SDK with the current path `contracts/registries/RegistryEntry.sol`.
1451+
Changing the name or the path would cause a breaking change in the SDK._
1452+
1453+
### registry
1454+
1455+
```solidity
1456+
contract IRegistry registry
1457+
```
1458+
1459+
### owner
1460+
1461+
```solidity
1462+
function owner() public view returns (address)
1463+
```
1464+
1465+
### setName
1466+
1467+
```solidity
1468+
function setName(address, string) external view
1469+
```
1470+
1471+
Sets the reverse registration name for a registry entry contract.
1472+
1473+
_This functionality is supported only on the Bellecour chain.
1474+
On other chains, this function will revert to maintain retrocompatibility
1475+
in the SDK._
1476+
1477+
## App
1478+
1479+
_Referenced in the SDK with the current path `contracts/registries/apps/AppRegistry.sol`.
1480+
Changing the name or the path would cause a breaking change in the SDK._
1481+
1482+
### m_appName
1483+
1484+
```solidity
1485+
string m_appName
1486+
```
1487+
1488+
Members
1489+
1490+
### m_appType
1491+
1492+
```solidity
1493+
string m_appType
1494+
```
1495+
1496+
### m_appMultiaddr
1497+
1498+
```solidity
1499+
bytes m_appMultiaddr
1500+
```
1501+
1502+
### m_appChecksum
1503+
1504+
```solidity
1505+
bytes32 m_appChecksum
1506+
```
1507+
1508+
### m_appMREnclave
1509+
1510+
```solidity
1511+
bytes m_appMREnclave
1512+
```
1513+
1514+
### initialize
1515+
1516+
```solidity
1517+
function initialize(string _appName, string _appType, bytes _appMultiaddr, bytes32 _appChecksum, bytes _appMREnclave) public
1518+
```
1519+
1520+
Constructor
1521+
1522+
## AppRegistry
1523+
1524+
_Referenced in the SDK with the current path `contracts/registries/apps/AppRegistry.sol`.
1525+
Changing the name or the path would cause a breaking change in the SDK._
1526+
1527+
### constructor
1528+
1529+
```solidity
1530+
constructor() public
1531+
```
1532+
1533+
Constructor
1534+
1535+
### createApp
1536+
1537+
```solidity
1538+
function createApp(address _appOwner, string _appName, string _appType, bytes _appMultiaddr, bytes32 _appChecksum, bytes _appMREnclave) external returns (contract App)
1539+
```
1540+
1541+
### predictApp
1542+
1543+
```solidity
1544+
function predictApp(address _appOwner, string _appName, string _appType, bytes _appMultiaddr, bytes32 _appChecksum, bytes _appMREnclave) external view returns (contract App)
1545+
```
1546+
1547+
## Dataset
1548+
1549+
_Referenced in the SDK with the current path `contracts/registries/datasets/Dataset.sol`.
1550+
Changing the name or the path would cause a breaking change in the SDK._
1551+
1552+
### m_datasetName
1553+
1554+
```solidity
1555+
string m_datasetName
1556+
```
1557+
1558+
Members
1559+
1560+
### m_datasetMultiaddr
1561+
1562+
```solidity
1563+
bytes m_datasetMultiaddr
1564+
```
1565+
1566+
### m_datasetChecksum
1567+
1568+
```solidity
1569+
bytes32 m_datasetChecksum
1570+
```
1571+
1572+
### initialize
1573+
1574+
```solidity
1575+
function initialize(string _datasetName, bytes _datasetMultiaddr, bytes32 _datasetChecksum) public
1576+
```
1577+
1578+
Constructor
1579+
1580+
## DatasetRegistry
1581+
1582+
_Referenced in the SDK with the current path `contracts/registries/datasets/DatasetRegistry.sol`.
1583+
Changing the name or the path would cause a breaking change in the SDK._
1584+
1585+
### constructor
1586+
1587+
```solidity
1588+
constructor() public
1589+
```
1590+
1591+
Constructor
1592+
1593+
### createDataset
1594+
1595+
```solidity
1596+
function createDataset(address _datasetOwner, string _datasetName, bytes _datasetMultiaddr, bytes32 _datasetChecksum) external returns (contract Dataset)
1597+
```
1598+
1599+
### predictDataset
1600+
1601+
```solidity
1602+
function predictDataset(address _datasetOwner, string _datasetName, bytes _datasetMultiaddr, bytes32 _datasetChecksum) external view returns (contract Dataset)
1603+
```
1604+
1605+
## Workerpool
1606+
1607+
_Referenced in the SDK with the current path `contracts/registries/workerpools/Workerpool.sol`.
1608+
Changing the name or the path would cause a breaking change in the SDK._
1609+
1610+
### m_workerpoolDescription
1611+
1612+
```solidity
1613+
string m_workerpoolDescription
1614+
```
1615+
1616+
Parameters
1617+
1618+
### m_workerStakeRatioPolicy
1619+
1620+
```solidity
1621+
uint256 m_workerStakeRatioPolicy
1622+
```
1623+
1624+
### m_schedulerRewardRatioPolicy
1625+
1626+
```solidity
1627+
uint256 m_schedulerRewardRatioPolicy
1628+
```
1629+
1630+
### PolicyUpdate
1631+
1632+
```solidity
1633+
event PolicyUpdate(uint256 oldWorkerStakeRatioPolicy, uint256 newWorkerStakeRatioPolicy, uint256 oldSchedulerRewardRatioPolicy, uint256 newSchedulerRewardRatioPolicy)
1634+
```
1635+
1636+
Events
1637+
1638+
### initialize
1639+
1640+
```solidity
1641+
function initialize(string _workerpoolDescription) public
1642+
```
1643+
1644+
Constructor
1645+
1646+
### changePolicy
1647+
1648+
```solidity
1649+
function changePolicy(uint256 _newWorkerStakeRatioPolicy, uint256 _newSchedulerRewardRatioPolicy) external
1650+
```
1651+
1652+
## WorkerpoolRegistry
1653+
1654+
_Referenced in the SDK with the current path `contracts/registries/workerpools/WorkerpoolRegistry.sol`.
1655+
Changing the name or the path would cause a breaking change in the SDK._
1656+
1657+
### constructor
1658+
1659+
```solidity
1660+
constructor() public
1661+
```
1662+
1663+
Constructor
1664+
1665+
### createWorkerpool
1666+
1667+
```solidity
1668+
function createWorkerpool(address _workerpoolOwner, string _workerpoolDescription) external returns (contract Workerpool)
1669+
```
1670+
1671+
### predictWorkerpool
1672+
1673+
```solidity
1674+
function predictWorkerpool(address _workerpoolOwner, string _workerpoolDescription) external view returns (contract Workerpool)
1675+
```
1676+

hardhat.config.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,6 @@ const config: HardhatUserConfig = {
272272
'facets/SignatureVerifier.sol', // contains only internal/private
273273
'facets/SignatureVerifier.v8.sol',
274274
'interfaces', // interesting for events but too much doc duplication if enabled
275-
'registries', // ignore them for now
276275
'tools',
277276
'Diamond.sol', // not relevant
278277
'IexecInterfaceNativeABILegacy.sol', // not relevant

0 commit comments

Comments
 (0)