Skip to content

Commit d2c510f

Browse files
authored
fix: fix doc (#322)
1 parent f181251 commit d2c510f

File tree

1 file changed

+133
-91
lines changed

1 file changed

+133
-91
lines changed

docs/solidity/index.md

Lines changed: 133 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ function recover() external returns (uint256)
250250
function receiveApproval(address sender, uint256 amount, address token, bytes data) external returns (bool)
251251
```
252252

253-
Receives approval and optionally matches orders in one transaction
253+
Receives approval, deposit and optionally matches orders in one transaction
254254

255255
Usage patterns:
256256
1. Simple deposit: RLC.approveAndCall(escrow, amount, "")
@@ -1338,6 +1338,138 @@ struct PocoStorage {
13381338
function isRegistered(address _entry) external view returns (bool)
13391339
```
13401340

1341+
## IApp
1342+
1343+
### owner
1344+
1345+
```solidity
1346+
function owner() external view returns (address)
1347+
```
1348+
1349+
### m_appName
1350+
1351+
```solidity
1352+
function m_appName() external view returns (string)
1353+
```
1354+
1355+
### m_appType
1356+
1357+
```solidity
1358+
function m_appType() external view returns (string)
1359+
```
1360+
1361+
### m_appMultiaddr
1362+
1363+
```solidity
1364+
function m_appMultiaddr() external view returns (bytes)
1365+
```
1366+
1367+
### m_appChecksum
1368+
1369+
```solidity
1370+
function m_appChecksum() external view returns (bytes32)
1371+
```
1372+
1373+
### m_appMREnclave
1374+
1375+
```solidity
1376+
function m_appMREnclave() external view returns (bytes)
1377+
```
1378+
1379+
## IDataset
1380+
1381+
### owner
1382+
1383+
```solidity
1384+
function owner() external view returns (address)
1385+
```
1386+
1387+
### m_datasetName
1388+
1389+
```solidity
1390+
function m_datasetName() external view returns (string)
1391+
```
1392+
1393+
### m_datasetMultiaddr
1394+
1395+
```solidity
1396+
function m_datasetMultiaddr() external view returns (bytes)
1397+
```
1398+
1399+
### m_datasetChecksum
1400+
1401+
```solidity
1402+
function m_datasetChecksum() external view returns (bytes32)
1403+
```
1404+
1405+
## IWorkerpool
1406+
1407+
### owner
1408+
1409+
```solidity
1410+
function owner() external view returns (address)
1411+
```
1412+
1413+
### m_workerpoolDescription
1414+
1415+
```solidity
1416+
function m_workerpoolDescription() external view returns (string)
1417+
```
1418+
1419+
### m_schedulerRewardRatioPolicy
1420+
1421+
```solidity
1422+
function m_schedulerRewardRatioPolicy() external view returns (uint256)
1423+
```
1424+
1425+
### m_workerStakeRatioPolicy
1426+
1427+
```solidity
1428+
function m_workerStakeRatioPolicy() external view returns (uint256)
1429+
```
1430+
1431+
## FacetBase
1432+
1433+
_Every facet must inherit from this contract._
1434+
1435+
## IexecERC20Base
1436+
1437+
### transfer
1438+
1439+
```solidity
1440+
function transfer(address recipient, uint256 amount) external returns (bool)
1441+
```
1442+
1443+
### approve
1444+
1445+
```solidity
1446+
function approve(address spender, uint256 value) external returns (bool)
1447+
```
1448+
1449+
### approveAndCall
1450+
1451+
```solidity
1452+
function approveAndCall(address spender, uint256 value, bytes extraData) external returns (bool)
1453+
```
1454+
1455+
### transferFrom
1456+
1457+
```solidity
1458+
function transferFrom(address sender, address recipient, uint256 amount) external returns (bool)
1459+
```
1460+
1461+
### increaseAllowance
1462+
1463+
```solidity
1464+
function increaseAllowance(address spender, uint256 addedValue) external returns (bool)
1465+
```
1466+
1467+
### decreaseAllowance
1468+
1469+
```solidity
1470+
function decreaseAllowance(address spender, uint256 subtractedValue) external returns (bool)
1471+
```
1472+
13411473
## Registry
13421474

13431475
### master
@@ -1510,44 +1642,6 @@ function createApp(address _appOwner, string _appName, string _appType, bytes _a
15101642
function predictApp(address _appOwner, string _appName, string _appType, bytes _appMultiaddr, bytes32 _appChecksum, bytes _appMREnclave) external view returns (contract App)
15111643
```
15121644

1513-
## IApp
1514-
1515-
### owner
1516-
1517-
```solidity
1518-
function owner() external view returns (address)
1519-
```
1520-
1521-
### m_appName
1522-
1523-
```solidity
1524-
function m_appName() external view returns (string)
1525-
```
1526-
1527-
### m_appType
1528-
1529-
```solidity
1530-
function m_appType() external view returns (string)
1531-
```
1532-
1533-
### m_appMultiaddr
1534-
1535-
```solidity
1536-
function m_appMultiaddr() external view returns (bytes)
1537-
```
1538-
1539-
### m_appChecksum
1540-
1541-
```solidity
1542-
function m_appChecksum() external view returns (bytes32)
1543-
```
1544-
1545-
### m_appMREnclave
1546-
1547-
```solidity
1548-
function m_appMREnclave() external view returns (bytes)
1549-
```
1550-
15511645
## Dataset
15521646

15531647
_Referenced in the SDK with the current path `contracts/registries/datasets/Dataset.sol`.
@@ -1606,32 +1700,6 @@ function createDataset(address _datasetOwner, string _datasetName, bytes _datase
16061700
function predictDataset(address _datasetOwner, string _datasetName, bytes _datasetMultiaddr, bytes32 _datasetChecksum) external view returns (contract Dataset)
16071701
```
16081702

1609-
## IDataset
1610-
1611-
### owner
1612-
1613-
```solidity
1614-
function owner() external view returns (address)
1615-
```
1616-
1617-
### m_datasetName
1618-
1619-
```solidity
1620-
function m_datasetName() external view returns (string)
1621-
```
1622-
1623-
### m_datasetMultiaddr
1624-
1625-
```solidity
1626-
function m_datasetMultiaddr() external view returns (bytes)
1627-
```
1628-
1629-
### m_datasetChecksum
1630-
1631-
```solidity
1632-
function m_datasetChecksum() external view returns (bytes32)
1633-
```
1634-
16351703
## Address
16361704

16371705
## BaseUpgradeabilityProxy
@@ -1699,32 +1767,6 @@ fallback() external payable
16991767
_Fallback function.
17001768
Implemented entirely in `_fallback`._
17011769

1702-
## IWorkerpool
1703-
1704-
### owner
1705-
1706-
```solidity
1707-
function owner() external view returns (address)
1708-
```
1709-
1710-
### m_workerpoolDescription
1711-
1712-
```solidity
1713-
function m_workerpoolDescription() external view returns (string)
1714-
```
1715-
1716-
### m_schedulerRewardRatioPolicy
1717-
1718-
```solidity
1719-
function m_schedulerRewardRatioPolicy() external view returns (uint256)
1720-
```
1721-
1722-
### m_workerStakeRatioPolicy
1723-
1724-
```solidity
1725-
function m_workerStakeRatioPolicy() external view returns (uint256)
1726-
```
1727-
17281770
## Workerpool
17291771

17301772
_Referenced in the SDK with the current path `contracts/registries/workerpools/Workerpool.sol`.

0 commit comments

Comments
 (0)