Skip to content

Commit 19f5a77

Browse files
zguesmizguesmi
committed
docs: Upate solidity docs
1 parent bce551a commit 19f5a77

File tree

1 file changed

+143
-143
lines changed

1 file changed

+143
-143
lines changed

‎docs/solidity/index.md‎

Lines changed: 143 additions & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,32 @@ event Reward(address owner, uint256 amount, bytes32 ref)
5252
event Seize(address owner, uint256 amount, bytes32 ref)
5353
```
5454

55+
## IexecOrderManagementFacet
56+
57+
### manageAppOrder
58+
59+
```solidity
60+
function manageAppOrder(struct IexecLibOrders_v5.AppOrderOperation _apporderoperation) external
61+
```
62+
63+
### manageDatasetOrder
64+
65+
```solidity
66+
function manageDatasetOrder(struct IexecLibOrders_v5.DatasetOrderOperation _datasetorderoperation) external
67+
```
68+
69+
### manageWorkerpoolOrder
70+
71+
```solidity
72+
function manageWorkerpoolOrder(struct IexecLibOrders_v5.WorkerpoolOrderOperation _workerpoolorderoperation) external
73+
```
74+
75+
### manageRequestOrder
76+
77+
```solidity
78+
function manageRequestOrder(struct IexecLibOrders_v5.RequestOrderOperation _requestorderoperation) external
79+
```
80+
5581
## Matching
5682

5783
```solidity
@@ -471,6 +497,115 @@ function groupmember_purpose() external pure returns (uint256)
471497
function eip712domain_separator() external view returns (bytes32)
472498
```
473499

500+
## IexecPocoBoostAccessorsFacet
501+
502+
Access to PoCo Boost tasks must be done with PoCo Classic `IexecPocoAccessors`.
503+
504+
### viewDealBoost
505+
506+
```solidity
507+
function viewDealBoost(bytes32 id) external view returns (struct IexecLibCore_v5.DealBoost deal)
508+
```
509+
510+
Get a deal created by PoCo Boost facet.
511+
512+
#### Parameters
513+
514+
| Name | Type | Description |
515+
| ---- | ---- | ----------- |
516+
| id | bytes32 | The ID of the deal. |
517+
518+
## IexecPocoBoostFacet
519+
520+
Works for deals with requested trust = 0.
521+
522+
### matchOrdersBoost
523+
524+
```solidity
525+
function matchOrdersBoost(struct IexecLibOrders_v5.AppOrder appOrder, struct IexecLibOrders_v5.DatasetOrder datasetOrder, struct IexecLibOrders_v5.WorkerpoolOrder workerpoolOrder, struct IexecLibOrders_v5.RequestOrder requestOrder) external returns (bytes32)
526+
```
527+
528+
This boost match orders is only compatible with trust <= 1.
529+
The requester gets debited.
530+
531+
#### Parameters
532+
533+
| Name | Type | Description |
534+
| ---- | ---- | ----------- |
535+
| appOrder | struct IexecLibOrders_v5.AppOrder | The order signed by the application developer. |
536+
| datasetOrder | struct IexecLibOrders_v5.DatasetOrder | The order signed by the dataset provider. |
537+
| workerpoolOrder | struct IexecLibOrders_v5.WorkerpoolOrder | The order signed by the workerpool manager. |
538+
| requestOrder | struct IexecLibOrders_v5.RequestOrder | The order signed by the requester. |
539+
540+
#### Return Values
541+
542+
| Name | Type | Description |
543+
| ---- | ---- | ----------- |
544+
| [0] | bytes32 | The ID of the deal. |
545+
546+
### sponsorMatchOrdersBoost
547+
548+
```solidity
549+
function sponsorMatchOrdersBoost(struct IexecLibOrders_v5.AppOrder appOrder, struct IexecLibOrders_v5.DatasetOrder datasetOrder, struct IexecLibOrders_v5.WorkerpoolOrder workerpoolOrder, struct IexecLibOrders_v5.RequestOrder requestOrder) external returns (bytes32)
550+
```
551+
552+
Sponsor match orders boost for a requester.
553+
Unlike the standard `matchOrdersBoost(..)` hook where the requester pays for
554+
the deal, this current hook makes it possible for any `msg.sender` to pay for
555+
a third party requester.
556+
557+
Be aware that anyone seeing a valid request order on the network
558+
(via an off-chain public marketplace, via a `sponsorMatchOrdersBoost(..)`
559+
pending transaction in the mempool or by any other means) might decide
560+
to call the standard `matchOrdersBoost(..)` hook which will result in the
561+
requester being debited instead. Therefore, such a front run would result
562+
in a loss of some of the requester funds deposited in the iExec account
563+
(a loss value equivalent to the price of the deal).
564+
565+
#### Parameters
566+
567+
| Name | Type | Description |
568+
| ---- | ---- | ----------- |
569+
| appOrder | struct IexecLibOrders_v5.AppOrder | The app order. |
570+
| datasetOrder | struct IexecLibOrders_v5.DatasetOrder | The dataset order. |
571+
| workerpoolOrder | struct IexecLibOrders_v5.WorkerpoolOrder | The workerpool order. |
572+
| requestOrder | struct IexecLibOrders_v5.RequestOrder | The requester order. |
573+
574+
### pushResultBoost
575+
576+
```solidity
577+
function pushResultBoost(bytes32 dealId, uint256 index, bytes results, bytes resultsCallback, bytes authorizationSign, address enclaveChallenge, bytes enclaveSign) external
578+
```
579+
580+
Accept results of a task computed by a worker during Boost workflow.
581+
582+
#### Parameters
583+
584+
| Name | Type | Description |
585+
| ---- | ---- | ----------- |
586+
| dealId | bytes32 | The id of the target deal. |
587+
| index | uint256 | The index of the target task of the deal. |
588+
| results | bytes | The results of the task computed by the worker. |
589+
| resultsCallback | bytes | The results of the task computed by the worker that will be forwarded as call data to the callback address set by the requester. |
590+
| authorizationSign | bytes | The authorization signed by the scheduler. authorizing the worker to push a result. |
591+
| enclaveChallenge | address | The enclave address which can produce enclave signature. |
592+
| enclaveSign | bytes | The signature generated from the enclave. |
593+
594+
### claimBoost
595+
596+
```solidity
597+
function claimBoost(bytes32 dealId, uint256 index) external
598+
```
599+
600+
Claim task to get a refund if task is not completed after deadline.
601+
602+
#### Parameters
603+
604+
| Name | Type | Description |
605+
| ---- | ---- | ----------- |
606+
| dealId | bytes32 | The ID of the deal. |
607+
| index | uint256 | The index of the task. |
608+
474609
## IexecLibCore_v5
475610

476611
### Account
@@ -1374,14 +1509,14 @@ function isRegistered(address _entry) external view returns (bool)
13741509
### setName
13751510

13761511
```solidity
1377-
function setName(address, string) external view
1512+
function setName(address, string) external
13781513
```
13791514

13801515
Sets the reverse registration name for a registry contract.
13811516

1382-
_This functionality is supported only on the Bellecour chain.
1383-
On other chains, this function will revert to maintain retrocompatibility
1384-
in the SDK._
1517+
_This functionality is supported only on Bellecour Sidechain, calls on other chains
1518+
will revert. The function is kept as nonpayable to maintain retrocompatibility with the
1519+
iExec SDK._
13851520

13861521
## RegistryEntry
13871522

@@ -1403,14 +1538,14 @@ function owner() public view returns (address)
14031538
### setName
14041539

14051540
```solidity
1406-
function setName(address, string) external view
1541+
function setName(address, string) external
14071542
```
14081543

14091544
Sets the reverse registration name for a registry entry contract.
14101545

1411-
_This functionality is supported only on the Bellecour chain.
1412-
On other chains, this function will revert to maintain retrocompatibility
1413-
in the SDK._
1546+
_This functionality is supported only on Bellecour Sidechain, calls on other chains
1547+
will revert. The function is kept as nonpayable to maintain retrocompatibility with the
1548+
iExec SDK._
14141549

14151550
## App
14161551

@@ -1612,138 +1747,3 @@ function createWorkerpool(address _workerpoolOwner, string _workerpoolDescriptio
16121747
function predictWorkerpool(address _workerpoolOwner, string _workerpoolDescription) external view returns (contract Workerpool)
16131748
```
16141749

1615-
## IexecOrderManagementFacet
1616-
1617-
### manageAppOrder
1618-
1619-
```solidity
1620-
function manageAppOrder(struct IexecLibOrders_v5.AppOrderOperation _apporderoperation) external
1621-
```
1622-
1623-
### manageDatasetOrder
1624-
1625-
```solidity
1626-
function manageDatasetOrder(struct IexecLibOrders_v5.DatasetOrderOperation _datasetorderoperation) external
1627-
```
1628-
1629-
### manageWorkerpoolOrder
1630-
1631-
```solidity
1632-
function manageWorkerpoolOrder(struct IexecLibOrders_v5.WorkerpoolOrderOperation _workerpoolorderoperation) external
1633-
```
1634-
1635-
### manageRequestOrder
1636-
1637-
```solidity
1638-
function manageRequestOrder(struct IexecLibOrders_v5.RequestOrderOperation _requestorderoperation) external
1639-
```
1640-
1641-
## IexecPocoBoostAccessorsFacet
1642-
1643-
Access to PoCo Boost tasks must be done with PoCo Classic `IexecPocoAccessors`.
1644-
1645-
### viewDealBoost
1646-
1647-
```solidity
1648-
function viewDealBoost(bytes32 id) external view returns (struct IexecLibCore_v5.DealBoost deal)
1649-
```
1650-
1651-
Get a deal created by PoCo Boost facet.
1652-
1653-
#### Parameters
1654-
1655-
| Name | Type | Description |
1656-
| ---- | ---- | ----------- |
1657-
| id | bytes32 | The ID of the deal. |
1658-
1659-
## IexecPocoBoostFacet
1660-
1661-
Works for deals with requested trust = 0.
1662-
1663-
### matchOrdersBoost
1664-
1665-
```solidity
1666-
function matchOrdersBoost(struct IexecLibOrders_v5.AppOrder appOrder, struct IexecLibOrders_v5.DatasetOrder datasetOrder, struct IexecLibOrders_v5.WorkerpoolOrder workerpoolOrder, struct IexecLibOrders_v5.RequestOrder requestOrder) external returns (bytes32)
1667-
```
1668-
1669-
This boost match orders is only compatible with trust <= 1.
1670-
The requester gets debited.
1671-
1672-
#### Parameters
1673-
1674-
| Name | Type | Description |
1675-
| ---- | ---- | ----------- |
1676-
| appOrder | struct IexecLibOrders_v5.AppOrder | The order signed by the application developer. |
1677-
| datasetOrder | struct IexecLibOrders_v5.DatasetOrder | The order signed by the dataset provider. |
1678-
| workerpoolOrder | struct IexecLibOrders_v5.WorkerpoolOrder | The order signed by the workerpool manager. |
1679-
| requestOrder | struct IexecLibOrders_v5.RequestOrder | The order signed by the requester. |
1680-
1681-
#### Return Values
1682-
1683-
| Name | Type | Description |
1684-
| ---- | ---- | ----------- |
1685-
| [0] | bytes32 | The ID of the deal. |
1686-
1687-
### sponsorMatchOrdersBoost
1688-
1689-
```solidity
1690-
function sponsorMatchOrdersBoost(struct IexecLibOrders_v5.AppOrder appOrder, struct IexecLibOrders_v5.DatasetOrder datasetOrder, struct IexecLibOrders_v5.WorkerpoolOrder workerpoolOrder, struct IexecLibOrders_v5.RequestOrder requestOrder) external returns (bytes32)
1691-
```
1692-
1693-
Sponsor match orders boost for a requester.
1694-
Unlike the standard `matchOrdersBoost(..)` hook where the requester pays for
1695-
the deal, this current hook makes it possible for any `msg.sender` to pay for
1696-
a third party requester.
1697-
1698-
Be aware that anyone seeing a valid request order on the network
1699-
(via an off-chain public marketplace, via a `sponsorMatchOrdersBoost(..)`
1700-
pending transaction in the mempool or by any other means) might decide
1701-
to call the standard `matchOrdersBoost(..)` hook which will result in the
1702-
requester being debited instead. Therefore, such a front run would result
1703-
in a loss of some of the requester funds deposited in the iExec account
1704-
(a loss value equivalent to the price of the deal).
1705-
1706-
#### Parameters
1707-
1708-
| Name | Type | Description |
1709-
| ---- | ---- | ----------- |
1710-
| appOrder | struct IexecLibOrders_v5.AppOrder | The app order. |
1711-
| datasetOrder | struct IexecLibOrders_v5.DatasetOrder | The dataset order. |
1712-
| workerpoolOrder | struct IexecLibOrders_v5.WorkerpoolOrder | The workerpool order. |
1713-
| requestOrder | struct IexecLibOrders_v5.RequestOrder | The requester order. |
1714-
1715-
### pushResultBoost
1716-
1717-
```solidity
1718-
function pushResultBoost(bytes32 dealId, uint256 index, bytes results, bytes resultsCallback, bytes authorizationSign, address enclaveChallenge, bytes enclaveSign) external
1719-
```
1720-
1721-
Accept results of a task computed by a worker during Boost workflow.
1722-
1723-
#### Parameters
1724-
1725-
| Name | Type | Description |
1726-
| ---- | ---- | ----------- |
1727-
| dealId | bytes32 | The id of the target deal. |
1728-
| index | uint256 | The index of the target task of the deal. |
1729-
| results | bytes | The results of the task computed by the worker. |
1730-
| resultsCallback | bytes | The results of the task computed by the worker that will be forwarded as call data to the callback address set by the requester. |
1731-
| authorizationSign | bytes | The authorization signed by the scheduler. authorizing the worker to push a result. |
1732-
| enclaveChallenge | address | The enclave address which can produce enclave signature. |
1733-
| enclaveSign | bytes | The signature generated from the enclave. |
1734-
1735-
### claimBoost
1736-
1737-
```solidity
1738-
function claimBoost(bytes32 dealId, uint256 index) external
1739-
```
1740-
1741-
Claim task to get a refund if task is not completed after deadline.
1742-
1743-
#### Parameters
1744-
1745-
| Name | Type | Description |
1746-
| ---- | ---- | ----------- |
1747-
| dealId | bytes32 | The ID of the deal. |
1748-
| index | uint256 | The index of the task. |
1749-

0 commit comments

Comments
 (0)