Add auto-generated contract documentation

taikoxyz · Jul 6, 2023 · 76e210e · 76e210e
1 parent 109e22e
commit 76e210e
Show file tree

Hide file tree

Showing 8 changed files with 909 additions and 0 deletions.
diff --git a/.../website/pages/docs/reference/contract-documentation/nft_bridge/Erc721Bridge.md b/.../website/pages/docs/reference/contract-documentation/nft_bridge/Erc721Bridge.md
@@ -0,0 +1,245 @@
+---
+title: Erc721Bridge
+---
+
+## Erc721Bridge
+
+This contract is an ERC-721 token bridge contract which is deployed on both L1 and L2.
+which calls the library implementations. See _IErc721Bridge_ for more details.
+
+_The code hash for the same address on L1 and L2 may be different._
+
+### MessageStatusChanged
+
+```solidity
+event MessageStatusChanged(bytes32 msgHash, enum LibErc721BridgeStatus.MessageStatus status, address transactor)
+```
+
+### DestChainEnabled
+
+```solidity
+event DestChainEnabled(uint256 chainId, bool enabled)
+```
+
+### init
+
+```solidity
+function init(address _addressManager) external
+```
+
+Initializer to be called after being deployed behind a proxy.
+
+_Initializer function to setup the EssentialContract._
+
+#### Parameters
+
+| Name             | Type    | Description                                 |
+| ---------------- | ------- | ------------------------------------------- |
+| \_addressManager | address | The address of the AddressManager contract. |
+
+### sendMessageErc721
+
+```solidity
+function sendMessageErc721(struct IErc721Bridge.Message message) external payable returns (bytes32 msgHash)
+```
+
+Sends a message from the current chain to the destination chain specified
+in the message.
+
+_Sends a message by calling the LibErc721BridgeSend.sendMessageErc721 library
+function._
+
+#### Parameters
+
+| Name    | Type                         | Description                        |
+| ------- | ---------------------------- | ---------------------------------- |
+| message | struct IErc721Bridge.Message | The message to send. (See IBridge) |
+
+#### Return Values
+
+| Name    | Type    | Description                            |
+| ------- | ------- | -------------------------------------- |
+| msgHash | bytes32 | The hash of the message that was sent. |
+
+### releaseTokenErc721
+
+```solidity
+function releaseTokenErc721(struct IErc721Bridge.Message message, bytes proof) external
+```
+
+Releases the Ether locked in the bridge as part of a cross-chain
+transfer.
+
+_Releases the Ether by calling the LibBridgeRelease.releaseEther
+library function._
+
+#### Parameters
+
+| Name    | Type                         | Description                                                             |
+| ------- | ---------------------------- | ----------------------------------------------------------------------- |
+| message | struct IErc721Bridge.Message | The message containing the details of the Ether transfer. (See IBridge) |
+| proof   | bytes                        | The proof of the cross-chain transfer.                                  |
+
+### isMessageSentErc721
+
+```solidity
+function isMessageSentErc721(bytes32 msgHash) public view virtual returns (bool)
+```
+
+Check if the message with the given hash has been sent.
+
+#### Parameters
+
+| Name    | Type    | Description              |
+| ------- | ------- | ------------------------ |
+| msgHash | bytes32 | The hash of the message. |
+
+#### Return Values
+
+| Name | Type | Description                                                 |
+| ---- | ---- | ----------------------------------------------------------- |
+| [0]  | bool | Returns true if the message has been sent, false otherwise. |
+
+### isMessageReceivedErc721
+
+```solidity
+function isMessageReceivedErc721(bytes32 msgHash, uint256 srcChainId, bytes proof) public view virtual returns (bool)
+```
+
+Check if the message with the given hash has been received.
+
+#### Parameters
+
+| Name       | Type    | Description                   |
+| ---------- | ------- | ----------------------------- |
+| msgHash    | bytes32 | The hash of the message.      |
+| srcChainId | uint256 | The source chain ID.          |
+| proof      | bytes   | The proof of message receipt. |
+
+#### Return Values
+
+| Name | Type | Description                                                     |
+| ---- | ---- | --------------------------------------------------------------- |
+| [0]  | bool | Returns true if the message has been received, false otherwise. |
+
+### isMessageFailedErc721
+
+```solidity
+function isMessageFailedErc721(bytes32 msgHash, uint256 destChainId, bytes proof) public view virtual returns (bool)
+```
+
+Check if the message with the given hash has failed.
+
+#### Parameters
+
+| Name        | Type    | Description                   |
+| ----------- | ------- | ----------------------------- |
+| msgHash     | bytes32 | The hash of the message.      |
+| destChainId | uint256 | The destination chain ID.     |
+| proof       | bytes   | The proof of message failure. |
+
+#### Return Values
+
+| Name | Type | Description                                              |
+| ---- | ---- | -------------------------------------------------------- |
+| [0]  | bool | Returns true if the message has failed, false otherwise. |
+
+### getMessageStatusErc721
+
+```solidity
+function getMessageStatusErc721(bytes32 msgHash) public view virtual returns (enum LibErc721BridgeStatus.MessageStatus)
+```
+
+Get the status of the message with the given hash.
+
+#### Parameters
+
+| Name    | Type    | Description              |
+| ------- | ------- | ------------------------ |
+| msgHash | bytes32 | The hash of the message. |
+
+#### Return Values
+
+| Name | Type                                     | Description                        |
+| ---- | ---------------------------------------- | ---------------------------------- |
+| [0]  | enum LibErc721BridgeStatus.MessageStatus | Returns the status of the message. |
+
+### context
+
+```solidity
+function context() public view returns (struct IErc721Bridge.Context)
+```
+
+Get the current context
+
+#### Return Values
+
+| Name | Type                         | Description                  |
+| ---- | ---------------------------- | ---------------------------- |
+| [0]  | struct IErc721Bridge.Context | Returns the current context. |
+
+### isDestChainEnabled
+
+```solidity
+function isDestChainEnabled(uint256 _chainId) public view returns (bool enabled)
+```
+
+Check if the destination chain with the given ID is enabled.
+
+#### Parameters
+
+| Name      | Type    | Description          |
+| --------- | ------- | -------------------- |
+| \_chainId | uint256 | The ID of the chain. |
+
+#### Return Values
+
+| Name    | Type | Description                                                        |
+| ------- | ---- | ------------------------------------------------------------------ |
+| enabled | bool | Returns true if the destination chain is enabled, false otherwise. |
+
+### hashMessage
+
+```solidity
+function hashMessage(struct IErc721Bridge.Message message) public pure returns (bytes32)
+```
+
+Compute the hash of a given message.
+
+#### Parameters
+
+| Name    | Type                         | Description                          |
+| ------- | ---------------------------- | ------------------------------------ |
+| message | struct IErc721Bridge.Message | The message to compute the hash for. |
+
+#### Return Values
+
+| Name | Type    | Description                      |
+| ---- | ------- | -------------------------------- |
+| [0]  | bytes32 | Returns the hash of the message. |
+
+### getMessageStatusSlot
+
+```solidity
+function getMessageStatusSlot(bytes32 msgHash) public pure returns (bytes32)
+```
+
+Get the slot associated with a given message hash status.
+
+#### Parameters
+
+| Name    | Type    | Description              |
+| ------- | ------- | ------------------------ |
+| msgHash | bytes32 | The hash of the message. |
+
+#### Return Values
+
+| Name | Type    | Description                                                     |
+| ---- | ------- | --------------------------------------------------------------- |
+| [0]  | bytes32 | Returns the slot associated with the given message hash status. |
+
+---
+
+## title: ProxiedErc721Bridge
+
+## ProxiedErc721Bridge
diff --git a/...s/website/pages/docs/reference/contract-documentation/nft_bridge/Erc721Vault.md b/...s/website/pages/docs/reference/contract-documentation/nft_bridge/Erc721Vault.md
@@ -0,0 +1,116 @@
+---
+title: Erc721Vault
+---
+
+## Erc721Vault
+
+This contract is for vaulting (and releasing) ERC721 tokens
+
+_Only the contract owner can authorize or deauthorize addresses._
+
+### ContractMapping
+
+```solidity
+struct ContractMapping {
+  address sisterContract;
+  string tokenName;
+  string tokenSymbol;
+  mapping(uint256 => bool) tokenInVault;
+}
+```
+
+### originalToWrapperData
+
+```solidity
+mapping(address => struct Erc721Vault.ContractMapping) originalToWrapperData
+```
+
+### Authorized
+
+```solidity
+event Authorized(address addr, bool authorized)
+```
+
+### TokensReleased
+
+```solidity
+event TokensReleased(address to, address contractAddress, uint256[] tokenIds)
+```
+
+### onlyAuthorized
+
+```solidity
+modifier onlyAuthorized()
+```
+
+### init
+
+```solidity
+function init(address addressManager) external
+```
+
+Initialize the contract with an address manager
+
+#### Parameters
+
+| Name           | Type    | Description                        |
+| -------------- | ------- | ---------------------------------- |
+| addressManager | address | The address of the address manager |
+
+### releaseTokens
+
+```solidity
+function releaseTokens(address recipient, address tokenContract, uint256[] tokenIds) public
+```
+
+Transfer token(s) from Erc721Vault to a designated address, checking that the
+sender is authorized.
+
+#### Parameters
+
+| Name          | Type      | Description                  |
+| ------------- | --------- | ---------------------------- |
+| recipient     | address   | Address to receive Ether.    |
+| tokenContract | address   | Token contract.              |
+| tokenIds      | uint256[] | Array of tokenIds to be sent |
+
+### authorize
+
+```solidity
+function authorize(address addr, bool authorized) public
+```
+
+Set the authorized status of an address, only the owner can call this.
+
+#### Parameters
+
+| Name       | Type    | Description                              |
+| ---------- | ------- | ---------------------------------------- |
+| addr       | address | Address to set the authorized status of. |
+| authorized | bool    | Authorized status to set.                |
+
+### isAuthorized
+
+```solidity
+function isAuthorized(address addr) public view returns (bool)
+```
+
+Get the authorized status of an address.
+
+#### Parameters
+
+| Name | Type    | Description                              |
+| ---- | ------- | ---------------------------------------- |
+| addr | address | Address to get the authorized status of. |
+
+### onERC721Received
+
+```solidity
+function onERC721Received(address, address, uint256, bytes) external pure returns (bytes4)
+```
+
+---
+
+## title: ProxiedErc721Vault
+
+## ProxiedErc721Vault