Skip to content

Commit

Permalink
Merge pull request #948 from lukso-network/fix-documentation-generation
Browse files Browse the repository at this point in the history
refactor: fix documentation generation
  • Loading branch information
CJ42 authored Apr 3, 2024
2 parents 596d709 + 6856f5c commit a29e74e
Show file tree
Hide file tree
Showing 35 changed files with 28,817 additions and 167 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
:::
:::info Solidity implementation

[`ERC725.sol`]([object Object])
[`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)

:::

Expand All @@ -28,7 +28,7 @@ When marked as 'public', a method can be called both externally and internally,
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#constructor)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)

:::

Expand Down Expand Up @@ -61,7 +61,7 @@ Deploy a new ERC725 contract with the provided `initialOwner` as the contract [`
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#execute)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `execute(uint256,address,uint256,bytes)`
- Function selector: `0x44c028fe`

Expand Down Expand Up @@ -128,7 +128,7 @@ Generic executor function to:
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#executebatch)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `executeBatch(uint256[],address[],uint256[],bytes[])`
- Function selector: `0x31858452`

Expand Down Expand Up @@ -194,7 +194,7 @@ Batch executor function that behaves the same as [`execute`](#execute) but allow
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#getdata)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `getData(bytes32)`
- Function selector: `0x54f6127f`

Expand Down Expand Up @@ -227,7 +227,7 @@ Get in the ERC725Y storage the bytes data stored at a specific data key `dataKey
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#getdatabatch)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `getDataBatch(bytes32[])`
- Function selector: `0xdedff9c6`

Expand Down Expand Up @@ -262,7 +262,7 @@ Get in the ERC725Y storage the bytes data stored at multiple data keys `dataKeys
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#owner)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `owner()`
- Function selector: `0x8da5cb5b`

Expand All @@ -287,7 +287,7 @@ Returns the address of the current owner.
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#renounceownership)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `renounceOwnership()`
- Function selector: `0x715018a6`

Expand All @@ -306,7 +306,7 @@ Leaves the contract without owner. It will not be possible to call `onlyOwner` f
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#setdata)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `setData(bytes32,bytes)`
- Function selector: `0x7f23690c`

Expand Down Expand Up @@ -356,7 +356,7 @@ Sets a single bytes value `dataValue` in the ERC725Y storage for a specific data
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#setdatabatch)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `setDataBatch(bytes32[],bytes[])`
- Function selector: `0x97902421`

Expand Down Expand Up @@ -406,7 +406,7 @@ Batch data setting function that behaves the same as [`setData`](#setdata) but a
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#supportsinterface)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `supportsInterface(bytes4)`
- Function selector: `0x01ffc9a7`

Expand Down Expand Up @@ -437,7 +437,7 @@ See [`IERC165-supportsInterface`](#ierc165-supportsinterface).
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#transferownership)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Function signature: `transferOwnership(address)`
- Function selector: `0xf2fde38b`

Expand Down Expand Up @@ -716,7 +716,7 @@ mapping(bytes32 => bytes) _store
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#contractcreated)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Event signature: `ContractCreated(uint256,address,uint256,bytes32)`
- Event topic hash: `0xa1fb700aaee2ae4a2ff6f91ce7eba292f89c2f5488b8ec4c5c5c8150692595c3`

Expand Down Expand Up @@ -751,7 +751,7 @@ Emitted when a new contract was created and deployed.
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#datachanged)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Event signature: `DataChanged(bytes32,bytes)`
- Event topic hash: `0xece574603820d07bc9b91f2a932baadf4628aabcb8afba49776529c14a6104b2`

Expand Down Expand Up @@ -779,7 +779,7 @@ Emitted when data at a specific `dataKey` was changed to a new value `dataValue`
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#executed)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Event signature: `Executed(uint256,address,uint256,bytes4)`
- Event topic hash: `0x4810874456b8e6487bd861375cf6abd8e1c8bb5858c8ce36a86a04dabfac199e`

Expand Down Expand Up @@ -814,7 +814,7 @@ Emitted when calling an address `target` (EOA or contract) with `value`.
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#ownershiptransferred)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Event signature: `OwnershipTransferred(address,address)`
- Event topic hash: `0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0`

Expand Down Expand Up @@ -843,7 +843,7 @@ event OwnershipTransferred(
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725x_contractdeploymentfailed)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725X_ContractDeploymentFailed()`
- Error hash: `0x0b07489b`

Expand All @@ -862,7 +862,7 @@ Reverts when contract deployment failed via [`execute`](#execute) or [`executeBa
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725x_createoperationsrequireemptyrecipientaddress)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725X_CreateOperationsRequireEmptyRecipientAddress()`
- Error hash: `0x3041824a`

Expand All @@ -881,7 +881,7 @@ Reverts when passing a `to` address that is not `address(0)` (= address zero) wh
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725x_executeparametersemptyarray)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725X_ExecuteParametersEmptyArray()`
- Error hash: `0xe9ad2b5f`

Expand All @@ -900,7 +900,7 @@ Reverts when one of the array parameter provided to the [`executeBatch`](#execut
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725x_executeparameterslengthmismatch)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725X_ExecuteParametersLengthMismatch()`
- Error hash: `0x3ff55f4d`

Expand All @@ -919,7 +919,7 @@ Reverts when there is not the same number of elements in the `operationTypes`, `
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725x_insufficientbalance)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725X_InsufficientBalance(uint256,uint256)`
- Error hash: `0x0df9a8f8`

Expand All @@ -945,7 +945,7 @@ Reverts when trying to send more native tokens `value` than available in current
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725x_msgvaluedisallowedindelegatecall)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725X_MsgValueDisallowedInDelegateCall()`
- Error hash: `0x5ac83135`

Expand All @@ -964,7 +964,7 @@ Reverts when trying to send native tokens (`value` / `values[]` parameter of [`e
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725x_msgvaluedisallowedinstaticcall)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725X_MsgValueDisallowedInStaticCall()`
- Error hash: `0x72f2bc6a`

Expand All @@ -983,7 +983,7 @@ Reverts when trying to send native tokens (`value` / `values[]` parameter of [`e
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725x_nocontractbytecodeprovided)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725X_NoContractBytecodeProvided()`
- Error hash: `0xb81cd8d9`

Expand All @@ -1002,7 +1002,7 @@ Reverts when no contract bytecode was provided as parameter when trying to deplo
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725x_unknownoperationtype)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725X_UnknownOperationType(uint256)`
- Error hash: `0x7583b3bc`

Expand All @@ -1027,7 +1027,7 @@ Reverts when the `operationTypeProvided` is none of the default operation types
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725y_datakeysvaluesemptyarray)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725Y_DataKeysValuesEmptyArray()`
- Error hash: `0x97da5f95`

Expand All @@ -1046,7 +1046,7 @@ Reverts when one of the array parameter provided to [`setDataBatch`](#setdatabat
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725y_datakeysvalueslengthmismatch)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725Y_DataKeysValuesLengthMismatch()`
- Error hash: `0x3bcc8979`

Expand All @@ -1065,7 +1065,7 @@ Reverts when there is not the same number of elements in the `datakeys` and `dat
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#erc725y_msgvaluedisallowed)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `ERC725Y_MsgValueDisallowed()`
- Error hash: `0xf36ba737`

Expand All @@ -1084,7 +1084,7 @@ Reverts when sending value to the [`setData`](#setdata) or [`setDataBatch`](#set
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#ownablecallernottheowner)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `OwnableCallerNotTheOwner(address)`
- Error hash: `0xbf1169c5`

Expand All @@ -1109,7 +1109,7 @@ Reverts when only the owner is allowed to call the function.
:::note References

- Specification details: [**ERC-725**](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-725.md#ownablecannotsetzeroaddressasowner)
- Solidity implementation: [`ERC725.sol`]([object Object])
- Solidity implementation: [`ERC725.sol`](https://github.com/ERC725Alliance/ERC725/blob/main/implementations/contracts/ERC725.sol)
- Error signature: `OwnableCannotSetZeroAddressAsOwner()`
- Error hash: `0x1ad8836c`

Expand Down
Loading

0 comments on commit a29e74e

Please sign in to comment.