Commit 557b24ad authored by Mark Tyneway's avatar Mark Tyneway

contracts: update docs

New docstrings were added, now the auto generated docs are updated
as well.
parent 055e4e7c
......@@ -352,8 +352,8 @@ Allows the Burn Admin to update the parameters which determine the amount of gas
| Name | Type | Description |
|---|---|---|
| _l2GasDiscountDivisor | uint256 | undefined
| _enqueueGasCost | uint256 | undefined
| _l2GasDiscountDivisor | uint256 | The ratio of the cost of L1 gas to the cost of L2 gas
| _enqueueGasCost | uint256 | The approximate cost of calling the enqueue function
......
......@@ -16,7 +16,7 @@
function isCollateralized(address _who) external view returns (bool)
```
Checks whether a given address is properly collateralized and can perform actions within the system.
......@@ -24,13 +24,13 @@ function isCollateralized(address _who) external view returns (bool)
| Name | Type | Description |
|---|---|---|
| _who | address | undefined
| _who | address | Address to check.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
| _0 | bool | true if the address is properly collateralized, false otherwise.
......
......@@ -63,8 +63,8 @@ function withdraw(address _l2Token, uint256 _amount, uint32 _l1Gas, bytes _data)
| Name | Type | Description |
|---|---|---|
| _l2Token | address | Address of L2 token where withdrawal was initiated.
| _amount | uint256 | Amount of the token to withdraw. param _l1Gas Unused, but included for potential forward compatibility considerations.
| _l1Gas | uint32 | undefined
| _amount | uint256 | Amount of the token to withdraw.
| _l1Gas | uint32 | Unused, but included for potential forward compatibility considerations.
| _data | bytes | Optional data to forward to L1. This data is provided solely as a convenience for external contracts. Aside from enforcing a maximum length, these contracts provide no guarantees about its content.
### withdrawTo
......@@ -83,8 +83,8 @@ function withdrawTo(address _l2Token, address _to, uint256 _amount, uint32 _l1Ga
|---|---|---|
| _l2Token | address | Address of L2 token where withdrawal is initiated.
| _to | address | L1 adress to credit the withdrawal to.
| _amount | uint256 | Amount of the token to withdraw. param _l1Gas Unused, but included for potential forward compatibility considerations.
| _l1Gas | uint32 | undefined
| _amount | uint256 | Amount of the token to withdraw.
| _l1Gas | uint32 | Unused, but included for potential forward compatibility considerations.
| _data | bytes | Optional data to forward to L1. This data is provided solely as a convenience for external contracts. Aside from enforcing a maximum length, these contracts provide no guarantees about its content.
......
......@@ -138,7 +138,7 @@ Verifies a batch inclusion proof.
| Name | Type | Description |
|---|---|---|
| _verified | bool | undefined
| _verified | bool | Whether or not the batch inclusion proof is verified.
......
......@@ -80,8 +80,8 @@ function withdraw(address _l2Token, uint256 _amount, uint32 _l1Gas, bytes _data)
| Name | Type | Description |
|---|---|---|
| _l2Token | address | Address of L2 token where withdrawal was initiated.
| _amount | uint256 | Amount of the token to withdraw. param _l1Gas Unused, but included for potential forward compatibility considerations.
| _l1Gas | uint32 | undefined
| _amount | uint256 | Amount of the token to withdraw.
| _l1Gas | uint32 | Unused, but included for potential forward compatibility considerations.
| _data | bytes | Optional data to forward to L1. This data is provided solely as a convenience for external contracts. Aside from enforcing a maximum length, these contracts provide no guarantees about its content.
### withdrawTo
......@@ -100,8 +100,8 @@ function withdrawTo(address _l2Token, address _to, uint256 _amount, uint32 _l1Ga
|---|---|---|
| _l2Token | address | Address of L2 token where withdrawal is initiated.
| _to | address | L1 adress to credit the withdrawal to.
| _amount | uint256 | Amount of the token to withdraw. param _l1Gas Unused, but included for potential forward compatibility considerations.
| _l1Gas | uint32 | undefined
| _amount | uint256 | Amount of the token to withdraw.
| _l1Gas | uint32 | Unused, but included for potential forward compatibility considerations.
| _data | bytes | Optional data to forward to L1. This data is provided solely as a convenience for external contracts. Aside from enforcing a maximum length, these contracts provide no guarantees about its content.
......
......@@ -228,7 +228,7 @@ Verifies a batch inclusion proof.
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
| _0 | bool | Whether or not the batch inclusion proof is verified.
......
......@@ -25,7 +25,7 @@ function getL1BlockNumber() external view returns (uint256)
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
| _0 | uint256 | Block number of L1
......
......@@ -16,7 +16,7 @@
function passMessageToL1(bytes _message) external nonpayable
```
Passes a message to L1.
......@@ -24,7 +24,7 @@ function passMessageToL1(bytes _message) external nonpayable
| Name | Type | Description |
|---|---|---|
| _message | bytes | undefined
| _message | bytes | Message to pass to L1.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment