Skip to content

N
nebula
Commit 9036a066 authored by Indeavr's avatar Indeavr
Browse files
Options

refac (docs): latest mds

parent a7cf8e67
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 34 additions and 5476 deletions
packages/contracts/docs/Address.md
View file @ 9036a066
......@@ -6,15 +6,7 @@
*Collection of functions related to the address type*
packages/contracts/docs/AddressDictator.md
View file @ 9036a066
......@@ -2,27 +2,18 @@
> AddressDictator
*The AddressDictator (glory to Arstotzka) is a contract that allows us to safely manipulate many different addresses in the AddressManager without transferring ownership of the AddressManager to a hot wallet or hardware wallet.*
## Methods
### finalOwner
```solidity
function finalOwner() external view returns (address)
```
......@@ -30,27 +21,16 @@ function finalOwner() external view returns (address)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined
### getNamedAddresses
```solidity
function getNamedAddresses() external view returns (struct AddressDictator.NamedAddress[])
```
Returns the full namedAddresses array.
......@@ -58,27 +38,16 @@ Returns the full namedAddresses array.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | AddressDictator.NamedAddress[] | undefined
### manager
```solidity
function manager() external view returns (contract Lib_AddressManager)
```
......@@ -86,27 +55,16 @@ function manager() external view returns (contract Lib_AddressManager)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | contract Lib_AddressManager | undefined
### returnOwnership
```solidity
function returnOwnership() external nonpayable
```
Transfers ownership of this contract to the finalOwner. Only callable by the Final Owner, which is intended to be our multisig. This function shouldn't be necessary, but it gives a sense of reassurance that we can recover if something really surprising goes wrong.
......@@ -114,17 +72,10 @@ Transfers ownership of this contract to the finalOwner. Only callable by the Fin
### setAddresses
```solidity
function setAddresses() external nonpayable
```
Called to finalize the transfer, this function is callable by anyone, but will only result in an upgrade if this contract is the owner Address Manager.
......@@ -135,11 +86,3 @@ Called to finalize the transfer, this function is callable by anyone, but will o
packages/contracts/docs/BondManager.md
View file @ 9036a066
......@@ -2,64 +2,40 @@
> BondManager
*This contract is, for now, a stub of the "real" BondManager that does nothing but allow the "OVM_Proposer" to submit state root batches.*
## Methods
### isCollateralized
```solidity
function isCollateralized(address _who) external view returns (bool)
```
Checks whether a given address is properly collateralized and can perform actions within the system.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _who | address | Address to check.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | true if the address is properly collateralized, false otherwise.
### libAddressManager
```solidity
function libAddressManager() external view returns (contract Lib_AddressManager)
```
......@@ -67,61 +43,34 @@ function libAddressManager() external view returns (contract Lib_AddressManager)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | contract Lib_AddressManager | undefined
### resolve
```solidity
function resolve(string _name) external view returns (address)
```
Resolves the address associated with a given name.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _name | string | Name to resolve an address for.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | Address associated with the given name.
packages/contracts/docs/ChainStorageContainer.md
View file @ 9036a066
......@@ -2,63 +2,21 @@
> ChainStorageContainer
*The Chain Storage Container provides its owner contract with read, write and delete functionality. This provides gas efficiency gains by enabling it to overwrite storage slots which can no longer be used in a fraud proof due to the fraud window having passed, and the associated chain state or transactions being finalized. Three distinct Chain Storage Containers will be deployed on Layer 1: 1. Stores transaction batches for the Canonical Transaction Chain 2. Stores queued transactions for the Canonical Transaction Chain 3. Stores chain state batches for the State Commitment Chain*
## Methods
### deleteElementsAfterInclusive
```solidity
function deleteElementsAfterInclusive(uint256 _index, bytes27 _globalMetadata) external nonpayable
```
Removes all objects after and including a given index. Also allows setting the global metadata field.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _index | uint256 | Object index to delete from.
| _globalMetadata | bytes27 | New global metadata for the container.
### deleteElementsAfterInclusive
```solidity
function deleteElementsAfterInclusive(uint256 _index) external nonpayable
```
Removes all objects after and including a given index.
Removes all objects after and including a given index. Also allows setting the global metadata field.
......@@ -66,57 +24,34 @@ Removes all objects after and including a given index.
| Name | Type | Description |
|---|---|---|
| _index | uint256 | Object index to delete from.
### get
```solidity
function get(uint256 _index) external view returns (bytes32)
```
Retrieves an object from the container.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _index | uint256 | Index of the particular object to access.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | 32 byte object value.
### getGlobalMetadata
```solidity
function getGlobalMetadata() external view returns (bytes27)
```
Retrieves the container's global metadata field.
......@@ -124,27 +59,16 @@ Retrieves the container's global metadata field.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes27 | Container global metadata field.
### length
```solidity
function length() external view returns (uint256)
```
Retrieves the number of objects stored in the container.
......@@ -152,27 +76,16 @@ Retrieves the number of objects stored in the container.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | Number of objects in the container.
### libAddressManager
```solidity
function libAddressManager() external view returns (contract Lib_AddressManager)
```
......@@ -180,27 +93,16 @@ function libAddressManager() external view returns (contract Lib_AddressManager)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | contract Lib_AddressManager | undefined
### owner
```solidity
function owner() external view returns (string)
```
......@@ -208,63 +110,19 @@ function owner() external view returns (string)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined
### push
```solidity
function push(bytes32 _object, bytes27 _globalMetadata) external nonpayable
```
Pushes an object into the container. Function allows setting the global metadata since we'll need to touch the "length" storage slot anyway, which also contains the global metadata (it's an optimization).
#### Parameters
| Name | Type | Description |
|---|---|---|
| _object | bytes32 | A 32 byte value to insert into the container.
| _globalMetadata | bytes27 | New global metadata for the container.
### push
```solidity
function push(bytes32 _object) external nonpayable
```
Pushes an object into the container.
Pushes an object into the container. Function allows setting the global metadata since we'll need to touch the "length" storage slot anyway, which also contains the global metadata (it's an optimization).
......@@ -272,81 +130,46 @@ Pushes an object into the container.
| Name | Type | Description |
|---|---|---|
| _object | bytes32 | A 32 byte value to insert into the container.
### resolve
```solidity
function resolve(string _name) external view returns (address)
```
Resolves the address associated with a given name.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _name | string | Name to resolve an address for.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | Address associated with the given name.
### setGlobalMetadata
```solidity
function setGlobalMetadata(bytes27 _globalMetadata) external nonpayable
```
Sets the container's global metadata field. We're using `bytes27` here because we use five bytes to maintain the length of the underlying data structure, meaning we have an extra 27 bytes to store arbitrary data.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _globalMetadata | bytes27 | New global metadata to set.
packages/contracts/docs/ChugSplashDictator.md
View file @ 9036a066
......@@ -2,27 +2,18 @@
> ChugSplashDictator
*Like the AddressDictator, but specifically for the Proxy__OVM_L1StandardBridge. We're working on a generalized version of this but this is good enough for the moment.*
## Methods
### bridgeSlotKey
```solidity
function bridgeSlotKey() external view returns (bytes32)
```
......@@ -30,27 +21,16 @@ function bridgeSlotKey() external view returns (bytes32)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined
### bridgeSlotVal
```solidity
function bridgeSlotVal() external view returns (bytes32)
```
......@@ -58,27 +38,16 @@ function bridgeSlotVal() external view returns (bytes32)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined
### codeHash
```solidity
function codeHash() external view returns (bytes32)
```
......@@ -86,54 +55,32 @@ function codeHash() external view returns (bytes32)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined
### doActions
```solidity
function doActions(bytes _code) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _code | bytes | undefined
### finalOwner
```solidity
function finalOwner() external view returns (address)
```
......@@ -141,27 +88,16 @@ function finalOwner() external view returns (address)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined
### isUpgrading
```solidity
function isUpgrading() external view returns (bool)
```
......@@ -169,27 +105,16 @@ function isUpgrading() external view returns (bool)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
### messengerSlotKey
```solidity
function messengerSlotKey() external view returns (bytes32)
```
......@@ -197,27 +122,16 @@ function messengerSlotKey() external view returns (bytes32)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined
### messengerSlotVal
```solidity
function messengerSlotVal() external view returns (bytes32)
```
......@@ -225,27 +139,16 @@ function messengerSlotVal() external view returns (bytes32)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined
### returnOwnership
```solidity
function returnOwnership() external nonpayable
```
Transfers ownership of this contract to the finalOwner. Only callable by the finalOwner, which is intended to be our multisig. This function shouldn't be necessary, but it gives a sense of reassurance that we can recover if something really surprising goes wrong.
......@@ -253,17 +156,10 @@ Transfers ownership of this contract to the finalOwner. Only callable by the fin
### target
```solidity
function target() external view returns (contract L1ChugSplashProxy)
```
......@@ -271,24 +167,12 @@ function target() external view returns (contract L1ChugSplashProxy)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | contract L1ChugSplashProxy | undefined
packages/contracts/docs/Context.md
View file @ 9036a066
......@@ -6,15 +6,7 @@
*Provides information about the current execution context, including the sender of the transaction and its data. While these are generally available via msg.sender and msg.data, they should not be accessed in such a direct manner, since when dealing with meta-transactions the account sending and paying for execution may not be the actual sender (as far as an application is concerned). This contract is only required for intermediate, library-like contracts.*
packages/contracts/docs/ContextUpgradeable.md
View file @ 9036a066
......@@ -6,15 +6,7 @@
*Provides information about the current execution context, including the sender of the transaction and its data. While these are generally available via msg.sender and msg.data, they should not be accessed in such a direct manner, since when dealing with meta-transactions the account sending and paying for execution may not be the actual sender (as far as an application is concerned). This contract is only required for intermediate, library-like contracts.*
packages/contracts/docs/CrossDomainEnabled.md
View file @ 9036a066
......@@ -2,27 +2,18 @@
> CrossDomainEnabled
*Helper contract for contracts performing cross-domain communications Compiler used: defined by inheriting contract*
## Methods
### messenger
```solidity
function messenger() external view returns (address)
```
......@@ -30,24 +21,12 @@ function messenger() external view returns (address)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined
packages/contracts/docs/ERC165Checker.md
View file @ 9036a066
......@@ -6,15 +6,7 @@
*Library used to query support of an interface declared via {IERC165}. Note that these functions return the actual result of the query: they do not `revert` if an interface is not supported. It is up to the caller to decide what to do in these cases.*
packages/contracts/docs/ERC20.md
View file @ 9036a066
......@@ -6,475 +6,278 @@
*Implementation of the {IERC20} interface. This implementation is agnostic to the way tokens are created. This means that a supply mechanism has to be added in a derived contract using {_mint}. For a generic mechanism see {ERC20PresetMinterPauser}. TIP: For a detailed writeup see our guide https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How to implement supply mechanisms]. We have followed general OpenZeppelin Contracts guidelines: functions revert instead returning `false` on failure. This behavior is nonetheless conventional and does not conflict with the expectations of ERC20 applications. Additionally, an {Approval} event is emitted on calls to {transferFrom}. This allows applications to reconstruct the allowance for all accounts just by listening to said events. Other implementations of the EIP may not emit these events, as it isn't required by the specification. Finally, the non-standard {decreaseAllowance} and {increaseAllowance} functions have been added to mitigate the well-known issues around setting allowances. See {IERC20-approve}.*
## Methods
### allowance
```solidity
function allowance(address owner, address spender) external view returns (uint256)
```
*See {IERC20-allowance}.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner | address | undefined
| spender | address | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
### approve
```solidity
function approve(address spender, uint256 amount) external nonpayable returns (bool)
```
*See {IERC20-approve}. Requirements: - `spender` cannot be the zero address.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined
| amount | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
### balanceOf
```solidity
function balanceOf(address account) external view returns (uint256)
```
*See {IERC20-balanceOf}.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| account | address | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
### decimals
```solidity
function decimals() external view returns (uint8)
```
*Returns the number of decimals used to get its user representation. For example, if `decimals` equals `2`, a balance of `505` tokens should be displayed to a user as `5.05` (`505 / 10 ** 2`). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the value {ERC20} uses, unless this function is overridden; NOTE: This information is only used for _display_ purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint8 | undefined
### decreaseAllowance
```solidity
function decreaseAllowance(address spender, uint256 subtractedValue) external nonpayable returns (bool)
```
*Atomically decreases the allowance granted to `spender` by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - `spender` cannot be the zero address. - `spender` must have allowance for the caller of at least `subtractedValue`.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined
| subtractedValue | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
### increaseAllowance
```solidity
function increaseAllowance(address spender, uint256 addedValue) external nonpayable returns (bool)
```
*Atomically increases the allowance granted to `spender` by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - `spender` cannot be the zero address.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined
| addedValue | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
### name
```solidity
function name() external view returns (string)
```
*Returns the name of the token.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined
### symbol
```solidity
function symbol() external view returns (string)
```
*Returns the symbol of the token, usually a shorter version of the name.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined
### totalSupply
```solidity
function totalSupply() external view returns (uint256)
```
*See {IERC20-totalSupply}.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
### transfer
```solidity
function transfer(address recipient, uint256 amount) external nonpayable returns (bool)
```
*See {IERC20-transfer}. Requirements: - `recipient` cannot be the zero address. - the caller must have a balance of at least `amount`.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| recipient | address | undefined
| amount | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
### transferFrom
```solidity
function transferFrom(address sender, address recipient, uint256 amount) external nonpayable returns (bool)
```
*See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. Requirements: - `sender` and `recipient` cannot be the zero address. - `sender` must have a balance of at least `amount`. - the caller must have allowance for ``sender``'s tokens of at least `amount`.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| sender | address | undefined
| recipient | address | undefined
| amount | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
## Events
### Approval
```solidity
event Approval(address indexed owner, address indexed spender, uint256 value)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner `indexed` | address | undefined |
| spender `indexed` | address | undefined |
| value | uint256 | undefined |
### Transfer
```solidity
event Transfer(address indexed from, address indexed to, uint256 value)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| from `indexed` | address | undefined |
| to `indexed` | address | undefined |
| value | uint256 | undefined |
packages/contracts/docs/IBondManager.md
View file @ 9036a066
......@@ -2,61 +2,36 @@
> IBondManager
## Methods
### isCollateralized
```solidity
function isCollateralized(address _who) external view returns (bool)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _who | address | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
packages/contracts/docs/ICanonicalTransactionChain.md
View file @ 9036a066
......@@ -2,45 +2,29 @@
> ICanonicalTransactionChain
## Methods
### appendSequencerBatch
```solidity
function appendSequencerBatch() external nonpayable
```
Allows the sequencer to append a batch of transactions.
*This function uses a custom encoding scheme for efficiency reasons. .param _shouldStartAtElement Specific batch we expect to start appending to. .param _totalElementsToAppend Total number of batch elements we expect to append. .param _contexts Array of batch contexts. .param _transactionDataFields Array of raw transaction data.*
### batches
```solidity
function batches() external view returns (contract IChainStorageContainer)
```
Accesses the batch storage container.
......@@ -48,60 +32,34 @@ Accesses the batch storage container.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | contract IChainStorageContainer | Reference to the batch storage container.
### enqueue
```solidity
function enqueue(address _target, uint256 _gasLimit, bytes _data) external nonpayable
```
Adds a transaction to the queue.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _target | address | Target contract to send the transaction to.
| _gasLimit | uint256 | Gas limit for the given transaction.
| _data | bytes | Transaction data.
### getLastBlockNumber
```solidity
function getLastBlockNumber() external view returns (uint40)
```
Returns the blocknumber of the last transaction.
......@@ -109,27 +67,16 @@ Returns the blocknumber of the last transaction.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint40 | Blocknumber for the last transaction.
### getLastTimestamp
```solidity
function getLastTimestamp() external view returns (uint40)
```
Returns the timestamp of the last transaction.
......@@ -137,27 +84,16 @@ Returns the timestamp of the last transaction.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint40 | Timestamp for the last transaction.
### getNextQueueIndex
```solidity
function getNextQueueIndex() external view returns (uint40)
```
Returns the index of the next element to be enqueued.
......@@ -165,27 +101,16 @@ Returns the index of the next element to be enqueued.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint40 | Index for the next queue element.
### getNumPendingQueueElements
```solidity
function getNumPendingQueueElements() external view returns (uint40)
```
Get the number of queue elements which have not yet been included.
......@@ -193,64 +118,38 @@ Get the number of queue elements which have not yet been included.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint40 | Number of pending queue elements.
### getQueueElement
```solidity
function getQueueElement(uint256 _index) external view returns (struct Lib_OVMCodec.QueueElement _element)
```
Gets the queue element at a particular index.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _index | uint256 | Index of the queue element to access.
#### Returns
| Name | Type | Description |
|---|---|---|
| _element | Lib_OVMCodec.QueueElement | Queue element at the given index.
### getQueueLength
```solidity
function getQueueLength() external view returns (uint40)
```
Retrieves the length of the queue, including both pending and canonical transactions.
......@@ -258,27 +157,16 @@ Retrieves the length of the queue, including both pending and canonical transact
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint40 | Length of the queue.
### getTotalBatches
```solidity
function getTotalBatches() external view returns (uint256 _totalBatches)
```
Retrieves the total number of batches submitted.
......@@ -286,27 +174,16 @@ Retrieves the total number of batches submitted.
#### Returns
| Name | Type | Description |
|---|---|---|
| _totalBatches | uint256 | Total submitted batches.
### getTotalElements
```solidity
function getTotalElements() external view returns (uint256 _totalElements)
```
Retrieves the total number of elements submitted.
......@@ -314,214 +191,127 @@ Retrieves the total number of elements submitted.
#### Returns
| Name | Type | Description |
|---|---|---|
| _totalElements | uint256 | Total submitted elements.
### setGasParams
```solidity
function setGasParams(uint256 _l2GasDiscountDivisor, uint256 _enqueueGasCost) external nonpayable
```
Allows the Burn Admin to update the parameters which determine the amount of gas to burn. The value of enqueueL2GasPrepaid is immediately updated as well.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l2GasDiscountDivisor | uint256 | undefined
| _enqueueGasCost | uint256 | undefined
## Events
### L2GasParamsUpdated
```solidity
event L2GasParamsUpdated(uint256 l2GasDiscountDivisor, uint256 enqueueGasCost, uint256 enqueueL2GasPrepaid)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| l2GasDiscountDivisor | uint256 | undefined |
| enqueueGasCost | uint256 | undefined |
| enqueueL2GasPrepaid | uint256 | undefined |
### QueueBatchAppended
```solidity
event QueueBatchAppended(uint256 _startingQueueIndex, uint256 _numQueueElements, uint256 _totalElements)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _startingQueueIndex | uint256 | undefined |
| _numQueueElements | uint256 | undefined |
| _totalElements | uint256 | undefined |
### SequencerBatchAppended
```solidity
event SequencerBatchAppended(uint256 _startingQueueIndex, uint256 _numQueueElements, uint256 _totalElements)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _startingQueueIndex | uint256 | undefined |
| _numQueueElements | uint256 | undefined |
| _totalElements | uint256 | undefined |
### TransactionBatchAppended
```solidity
event TransactionBatchAppended(uint256 indexed _batchIndex, bytes32 _batchRoot, uint256 _batchSize, uint256 _prevTotalElements, bytes _extraData)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _batchIndex `indexed` | uint256 | undefined |
| _batchRoot | bytes32 | undefined |
| _batchSize | uint256 | undefined |
| _prevTotalElements | uint256 | undefined |
| _extraData | bytes | undefined |
### TransactionEnqueued
```solidity
event TransactionEnqueued(address indexed _l1TxOrigin, address indexed _target, uint256 _gasLimit, bytes _data, uint256 indexed _queueIndex, uint256 _timestamp)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1TxOrigin `indexed` | address | undefined |
| _target `indexed` | address | undefined |
| _gasLimit | uint256 | undefined |
| _data | bytes | undefined |
| _queueIndex `indexed` | uint256 | undefined |
| _timestamp | uint256 | undefined |
packages/contracts/docs/IChainStorageContainer.md
View file @ 9036a066
......@@ -2,63 +2,21 @@
> IChainStorageContainer
## Methods
### deleteElementsAfterInclusive
```solidity
function deleteElementsAfterInclusive(uint256 _index, bytes27 _globalMetadata) external nonpayable
```
Removes all objects after and including a given index. Also allows setting the global metadata field.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _index | uint256 | Object index to delete from.
| _globalMetadata | bytes27 | New global metadata for the container.
### deleteElementsAfterInclusive
```solidity
function deleteElementsAfterInclusive(uint256 _index) external nonpayable
```
Removes all objects after and including a given index.
Removes all objects after and including a given index. Also allows setting the global metadata field.
......@@ -66,57 +24,34 @@ Removes all objects after and including a given index.
| Name | Type | Description |
|---|---|---|
| _index | uint256 | Object index to delete from.
### get
```solidity
function get(uint256 _index) external view returns (bytes32)
```
Retrieves an object from the container.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _index | uint256 | Index of the particular object to access.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | 32 byte object value.
### getGlobalMetadata
```solidity
function getGlobalMetadata() external view returns (bytes27)
```
Retrieves the container's global metadata field.
......@@ -124,27 +59,16 @@ Retrieves the container's global metadata field.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes27 | Container global metadata field.
### length
```solidity
function length() external view returns (uint256)
```
Retrieves the number of objects stored in the container.
......@@ -152,63 +76,19 @@ Retrieves the number of objects stored in the container.
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | Number of objects in the container.
### push
```solidity
function push(bytes32 _object, bytes27 _globalMetadata) external nonpayable
```
Pushes an object into the container. Function allows setting the global metadata since we'll need to touch the "length" storage slot anyway, which also contains the global metadata (it's an optimization).
#### Parameters
| Name | Type | Description |
|---|---|---|
| _object | bytes32 | A 32 byte value to insert into the container.
| _globalMetadata | bytes27 | New global metadata for the container.
### push
```solidity
function push(bytes32 _object) external nonpayable
```
Pushes an object into the container.
Pushes an object into the container. Function allows setting the global metadata since we'll need to touch the "length" storage slot anyway, which also contains the global metadata (it's an optimization).
......@@ -216,44 +96,24 @@ Pushes an object into the container.
| Name | Type | Description |
|---|---|---|
| _object | bytes32 | A 32 byte value to insert into the container.
### setGlobalMetadata
```solidity
function setGlobalMetadata(bytes27 _globalMetadata) external nonpayable
```
Sets the container's global metadata field. We're using `bytes27` here because we use five bytes to maintain the length of the underlying data structure, meaning we have an extra 27 bytes to store arbitrary data.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _globalMetadata | bytes27 | New global metadata to set.
packages/contracts/docs/ICrossDomainMessenger.md
View file @ 9036a066
......@@ -2,60 +2,36 @@
> ICrossDomainMessenger
## Methods
### sendMessage
```solidity
function sendMessage(address _target, bytes _message, uint32 _gasLimit) external nonpayable
```
Sends a cross domain message to the target messenger.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _target | address | Target contract address.
| _message | bytes | Message to send to the target.
| _gasLimit | uint32 | Gas limit for the provided message.
### xDomainMessageSender
```solidity
function xDomainMessageSender() external view returns (address)
```
......@@ -63,112 +39,67 @@ function xDomainMessageSender() external view returns (address)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined
## Events
### FailedRelayedMessage
```solidity
event FailedRelayedMessage(bytes32 indexed msgHash)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| msgHash `indexed` | bytes32 | undefined |
### RelayedMessage
```solidity
event RelayedMessage(bytes32 indexed msgHash)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| msgHash `indexed` | bytes32 | undefined |
### SentMessage
```solidity
event SentMessage(address indexed target, address sender, bytes message, uint256 messageNonce, uint256 gasLimit)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| target `indexed` | address | undefined |
| sender | address | undefined |
| message | bytes | undefined |
| messageNonce | uint256 | undefined |
| gasLimit | uint256 | undefined |
packages/contracts/docs/IERC165.md
View file @ 9036a066
......@@ -6,57 +6,32 @@
*Interface of the ERC165 standard, as defined in the https://eips.ethereum.org/EIPS/eip-165[EIP]. Implementers can declare support of contract interfaces, which can then be queried by others ({ERC165Checker}). For an implementation, see {ERC165}.*
## Methods
### supportsInterface
```solidity
function supportsInterface(bytes4 interfaceId) external view returns (bool)
```
*Returns true if this contract implements the interface defined by `interfaceId`. See the corresponding https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section] to learn more about how these ids are created. This function call must use less than 30 000 gas.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| interfaceId | bytes4 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
packages/contracts/docs/IERC20.md
View file @ 9036a066
......@@ -6,311 +6,181 @@
*Interface of the ERC20 standard as defined in the EIP.*
## Methods
### allowance
```solidity
function allowance(address owner, address spender) external view returns (uint256)
```
*Returns the remaining number of tokens that `spender` will be allowed to spend on behalf of `owner` through {transferFrom}. This is zero by default. This value changes when {approve} or {transferFrom} are called.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner | address | undefined
| spender | address | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
### approve
```solidity
function approve(address spender, uint256 amount) external nonpayable returns (bool)
```
*Sets `amount` as the allowance of `spender` over the caller's tokens. Returns a boolean value indicating whether the operation succeeded. IMPORTANT: Beware that changing an allowance with this method brings the risk that someone may use both the old and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 Emits an {Approval} event.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined
| amount | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
### balanceOf
```solidity
function balanceOf(address account) external view returns (uint256)
```
*Returns the amount of tokens owned by `account`.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| account | address | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
### totalSupply
```solidity
function totalSupply() external view returns (uint256)
```
*Returns the amount of tokens in existence.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
### transfer
```solidity
function transfer(address recipient, uint256 amount) external nonpayable returns (bool)
```
*Moves `amount` tokens from the caller's account to `recipient`. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| recipient | address | undefined
| amount | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
### transferFrom
```solidity
function transferFrom(address sender, address recipient, uint256 amount) external nonpayable returns (bool)
```
*Moves `amount` tokens from `sender` to `recipient` using the allowance mechanism. `amount` is then deducted from the caller's allowance. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| sender | address | undefined
| recipient | address | undefined
| amount | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
## Events
### Approval
```solidity
event Approval(address indexed owner, address indexed spender, uint256 value)
```
*Emitted when the allowance of a `spender` for an `owner` is set by a call to {approve}. `value` is the new allowance.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner `indexed` | address | undefined |
| spender `indexed` | address | undefined |
| value | uint256 | undefined |
### Transfer
```solidity
event Transfer(address indexed from, address indexed to, uint256 value)
```
*Emitted when `value` tokens are moved from one account (`from`) to another (`to`). Note that `value` may be zero.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| from `indexed` | address | undefined |
| to `indexed` | address | undefined |
| value | uint256 | undefined |
packages/contracts/docs/IERC20Metadata.md
View file @ 9036a066
......@@ -6,395 +6,232 @@
*Interface for the optional metadata functions from the ERC20 standard. _Available since v4.1._*
## Methods
### allowance
```solidity
function allowance(address owner, address spender) external view returns (uint256)
```
*Returns the remaining number of tokens that `spender` will be allowed to spend on behalf of `owner` through {transferFrom}. This is zero by default. This value changes when {approve} or {transferFrom} are called.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner | address | undefined
| spender | address | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
### approve
```solidity
function approve(address spender, uint256 amount) external nonpayable returns (bool)
```
*Sets `amount` as the allowance of `spender` over the caller's tokens. Returns a boolean value indicating whether the operation succeeded. IMPORTANT: Beware that changing an allowance with this method brings the risk that someone may use both the old and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 Emits an {Approval} event.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| spender | address | undefined
| amount | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
### balanceOf
```solidity
function balanceOf(address account) external view returns (uint256)
```
*Returns the amount of tokens owned by `account`.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| account | address | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
### decimals
```solidity
function decimals() external view returns (uint8)
```
*Returns the decimals places of the token.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint8 | undefined
### name
```solidity
function name() external view returns (string)
```
*Returns the name of the token.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined
### symbol
```solidity
function symbol() external view returns (string)
```
*Returns the symbol of the token.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | string | undefined
### totalSupply
```solidity
function totalSupply() external view returns (uint256)
```
*Returns the amount of tokens in existence.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined
### transfer
```solidity
function transfer(address recipient, uint256 amount) external nonpayable returns (bool)
```
*Moves `amount` tokens from the caller's account to `recipient`. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| recipient | address | undefined
| amount | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
### transferFrom
```solidity
function transferFrom(address sender, address recipient, uint256 amount) external nonpayable returns (bool)
```
*Moves `amount` tokens from `sender` to `recipient` using the allowance mechanism. `amount` is then deducted from the caller's allowance. Returns a boolean value indicating whether the operation succeeded. Emits a {Transfer} event.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| sender | address | undefined
| recipient | address | undefined
| amount | uint256 | undefined
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined
## Events
### Approval
```solidity
event Approval(address indexed owner, address indexed spender, uint256 value)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| owner `indexed` | address | undefined |
| spender `indexed` | address | undefined |
| value | uint256 | undefined |
### Transfer
```solidity
event Transfer(address indexed from, address indexed to, uint256 value)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| from `indexed` | address | undefined |
| to `indexed` | address | undefined |
| value | uint256 | undefined |
packages/contracts/docs/IL1CrossDomainMessenger.md
View file @ 9036a066
......@@ -2,33 +2,21 @@
> IL1CrossDomainMessenger
## Methods
### relayMessage
```solidity
function relayMessage(address _target, address _sender, bytes _message, uint256 _messageNonce, IL1CrossDomainMessenger.L2MessageInclusionProof _proof) external nonpayable
```
Relays a cross domain message to a contract.
......@@ -36,107 +24,55 @@ function relayMessage(address _target, address _sender, bytes _message, uint256
| Name | Type | Description |
|---|---|---|
| _target | address | undefined
| _sender | address | undefined
| _message | bytes | undefined
| _messageNonce | uint256 | undefined
| _proof | IL1CrossDomainMessenger.L2MessageInclusionProof | undefined
| _target | address | Target contract address.
| _sender | address | Message sender address.
| _message | bytes | Message to send to the target.
| _messageNonce | uint256 | Nonce for the provided message.
| _proof | IL1CrossDomainMessenger.L2MessageInclusionProof | Inclusion proof for the given message.
### replayMessage
```solidity
function replayMessage(address _target, address _sender, bytes _message, uint256 _queueIndex, uint32 _oldGasLimit, uint32 _newGasLimit) external nonpayable
```
Replays a cross domain message to the target messenger.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _target | address | Target contract address.
| _sender | address | Original sender address.
| _message | bytes | Message to send to the target.
| _queueIndex | uint256 | CTC Queue index for the message to replay.
| _oldGasLimit | uint32 | Original gas limit used to send the message.
| _newGasLimit | uint32 | New gas limit to be used for this message.
### sendMessage
```solidity
function sendMessage(address _target, bytes _message, uint32 _gasLimit) external nonpayable
```
Sends a cross domain message to the target messenger.
#### Parameters
| Name | Type | Description |
|---|---|---|
| _target | address | Target contract address.
| _message | bytes | Message to send to the target.
| _gasLimit | uint32 | Gas limit for the provided message.
### xDomainMessageSender
```solidity
function xDomainMessageSender() external view returns (address)
```
......@@ -144,112 +80,67 @@ function xDomainMessageSender() external view returns (address)
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined
## Events
### FailedRelayedMessage
```solidity
event FailedRelayedMessage(bytes32 indexed msgHash)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| msgHash `indexed` | bytes32 | undefined |
### RelayedMessage
```solidity
event RelayedMessage(bytes32 indexed msgHash)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| msgHash `indexed` | bytes32 | undefined |
### SentMessage
```solidity
event SentMessage(address indexed target, address sender, bytes message, uint256 messageNonce, uint256 gasLimit)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| target `indexed` | address | undefined |
| sender | address | undefined |
| message | bytes | undefined |
| messageNonce | uint256 | undefined |
| gasLimit | uint256 | undefined |
packages/contracts/docs/IL1ERC20Bridge.md
View file @ 9036a066
......@@ -2,250 +2,138 @@
> IL1ERC20Bridge
## Methods
### depositERC20
```solidity
function depositERC20(address _l1Token, address _l2Token, uint256 _amount, uint32 _l2Gas, bytes _data) external nonpayable
```
*deposit an amount of the ERC20 to the caller's balance on L2.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token | address | Address of the L1 ERC20 we are depositing
| _l2Token | address | Address of the L1 respective L2 ERC20
| _amount | uint256 | Amount of the ERC20 to deposit
| _l2Gas | uint32 | Gas limit required to complete the deposit on L2.
| _data | bytes | Optional data to forward to L2. 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.
### depositERC20To
```solidity
function depositERC20To(address _l1Token, address _l2Token, address _to, uint256 _amount, uint32 _l2Gas, bytes _data) external nonpayable
```
*deposit an amount of ERC20 to a recipient's balance on L2.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token | address | Address of the L1 ERC20 we are depositing
| _l2Token | address | Address of the L1 respective L2 ERC20
| _to | address | L2 address to credit the withdrawal to.
| _amount | uint256 | Amount of the ERC20 to deposit.
| _l2Gas | uint32 | Gas limit required to complete the deposit on L2.
| _data | bytes | Optional data to forward to L2. 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.
### finalizeERC20Withdrawal
```solidity
function finalizeERC20Withdrawal(address _l1Token, address _l2Token, address _from, address _to, uint256 _amount, bytes _data) external nonpayable
```
*Complete a withdrawal from L2 to L1, and credit funds to the recipient's balance of the L1 ERC20 token. This call will fail if the initialized withdrawal from L2 has not been finalized.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token | address | Address of L1 token to finalizeWithdrawal for.
| _l2Token | address | Address of L2 token where withdrawal was initiated.
| _from | address | L2 address initiating the transfer.
| _to | address | L1 address to credit the withdrawal to.
| _amount | uint256 | Amount of the ERC20 to deposit.
| _data | bytes | Data provided by the sender on L2. 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.
### l2TokenBridge
```solidity
function l2TokenBridge() external nonpayable returns (address)
```
*get the address of the corresponding L2 bridge contract.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | Address of the corresponding L2 bridge contract.
## Events
### ERC20DepositInitiated
```solidity
event ERC20DepositInitiated(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256 _amount, bytes _data)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token `indexed` | address | undefined |
| _l2Token `indexed` | address | undefined |
| _from `indexed` | address | undefined |
| _to | address | undefined |
| _amount | uint256 | undefined |
| _data | bytes | undefined |
### ERC20WithdrawalFinalized
```solidity
event ERC20WithdrawalFinalized(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256 _amount, bytes _data)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token `indexed` | address | undefined |
| _l2Token `indexed` | address | undefined |
| _from `indexed` | address | undefined |
| _to | address | undefined |
| _amount | uint256 | undefined |
| _data | bytes | undefined |
packages/contracts/docs/IL1StandardBridge.md
View file @ 9036a066
......@@ -2,411 +2,230 @@
> IL1StandardBridge
## Methods
### depositERC20
```solidity
function depositERC20(address _l1Token, address _l2Token, uint256 _amount, uint32 _l2Gas, bytes _data) external nonpayable
```
*deposit an amount of the ERC20 to the caller's balance on L2.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token | address | Address of the L1 ERC20 we are depositing
| _l2Token | address | Address of the L1 respective L2 ERC20
| _amount | uint256 | Amount of the ERC20 to deposit
| _l2Gas | uint32 | Gas limit required to complete the deposit on L2.
| _data | bytes | Optional data to forward to L2. 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.
### depositERC20To
```solidity
function depositERC20To(address _l1Token, address _l2Token, address _to, uint256 _amount, uint32 _l2Gas, bytes _data) external nonpayable
```
*deposit an amount of ERC20 to a recipient's balance on L2.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token | address | Address of the L1 ERC20 we are depositing
| _l2Token | address | Address of the L1 respective L2 ERC20
| _to | address | L2 address to credit the withdrawal to.
| _amount | uint256 | Amount of the ERC20 to deposit.
| _l2Gas | uint32 | Gas limit required to complete the deposit on L2.
| _data | bytes | Optional data to forward to L2. 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.
### depositETH
```solidity
function depositETH(uint32 _l2Gas, bytes _data) external payable
```
*Deposit an amount of the ETH to the caller's balance on L2.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l2Gas | uint32 | Gas limit required to complete the deposit on L2.
| _data | bytes | Optional data to forward to L2. 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.
### depositETHTo
```solidity
function depositETHTo(address _to, uint32 _l2Gas, bytes _data) external payable
```
*Deposit an amount of ETH to a recipient's balance on L2.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| _to | address | L2 address to credit the withdrawal to.
| _l2Gas | uint32 | Gas limit required to complete the deposit on L2.
| _data | bytes | Optional data to forward to L2. 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.
### finalizeERC20Withdrawal
```solidity
function finalizeERC20Withdrawal(address _l1Token, address _l2Token, address _from, address _to, uint256 _amount, bytes _data) external nonpayable
```
*Complete a withdrawal from L2 to L1, and credit funds to the recipient's balance of the L1 ERC20 token. This call will fail if the initialized withdrawal from L2 has not been finalized.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token | address | Address of L1 token to finalizeWithdrawal for.
| _l2Token | address | Address of L2 token where withdrawal was initiated.
| _from | address | L2 address initiating the transfer.
| _to | address | L1 address to credit the withdrawal to.
| _amount | uint256 | Amount of the ERC20 to deposit.
| _data | bytes | Data provided by the sender on L2. 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.
### finalizeETHWithdrawal
```solidity
function finalizeETHWithdrawal(address _from, address _to, uint256 _amount, bytes _data) external nonpayable
```
*Complete a withdrawal from L2 to L1, and credit funds to the recipient's balance of the L1 ETH token. Since only the xDomainMessenger can call this function, it will never be called before the withdrawal is finalized.*
#### Parameters
| Name | Type | Description |
|---|---|---|
| _from | address | L2 address initiating the transfer.
| _to | address | L1 address to credit the withdrawal to.
| _amount | uint256 | Amount of the ERC20 to deposit.
| _data | bytes | Optional data to forward to L2. 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.
### l2TokenBridge
```solidity
function l2TokenBridge() external nonpayable returns (address)
```
*get the address of the corresponding L2 bridge contract.*
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | Address of the corresponding L2 bridge contract.
## Events
### ERC20DepositInitiated
```solidity
event ERC20DepositInitiated(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256 _amount, bytes _data)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token `indexed` | address | undefined |
| _l2Token `indexed` | address | undefined |
| _from `indexed` | address | undefined |
| _to | address | undefined |
| _amount | uint256 | undefined |
| _data | bytes | undefined |
### ERC20WithdrawalFinalized
```solidity
event ERC20WithdrawalFinalized(address indexed _l1Token, address indexed _l2Token, address indexed _from, address _to, uint256 _amount, bytes _data)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _l1Token `indexed` | address | undefined |
| _l2Token `indexed` | address | undefined |
| _from `indexed` | address | undefined |
| _to | address | undefined |
| _amount | uint256 | undefined |
| _data | bytes | undefined |
### ETHDepositInitiated
```solidity
event ETHDepositInitiated(address indexed _from, address indexed _to, uint256 _amount, bytes _data)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _from `indexed` | address | undefined |
| _to `indexed` | address | undefined |
| _amount | uint256 | undefined |
| _data | bytes | undefined |
### ETHWithdrawalFinalized
```solidity
event ETHWithdrawalFinalized(address indexed _from, address indexed _to, uint256 _amount, bytes _data)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _from `indexed` | address | undefined |
| _to `indexed` | address | undefined |
| _amount | uint256 | undefined |
| _data | bytes | undefined |
packages/contracts/docs/IL2ERC20Bridge.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/IL2StandardERC20.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/Initializable.md
View file @ 9036a066
......@@ -6,15 +6,7 @@
*This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed behind a proxy. Since a proxied contract can't have a constructor, it's common to move constructor logic to an external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer function so it can only be called once. The {initializer} modifier provided by this contract will have this effect. TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}. CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.*
packages/contracts/docs/L1StandardBridge.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/L2StandardBridge.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/L2StandardERC20.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/Lib_Buffer.md
View file @ 9036a066
......@@ -2,19 +2,11 @@
> Lib_Buffer
*This library implements a bytes32 storage array with some additional gas-optimized functionality. In particular, it encodes its length as a uint40, and tightly packs this with an overwritable "extra data" field so we can store more information with a single SSTORE.*
packages/contracts/docs/Lib_Bytes32Utils.md
View file @ 9036a066
......@@ -2,8 +2,6 @@
> Lib_Byte32Utils
......@@ -12,9 +10,3 @@
packages/contracts/docs/Lib_BytesUtils.md
View file @ 9036a066
......@@ -2,8 +2,6 @@
> Lib_BytesUtils
......@@ -12,9 +10,3 @@
packages/contracts/docs/Lib_MerkleTree.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/Lib_MerkleTrie.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/Lib_OVMCodec.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/Lib_RLPReader.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/Lib_RLPWriter.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/OVM_ETH.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/Ownable.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/SafeERC20.md
View file @ 9036a066
This diff is collapsed.
packages/contracts/docs/WETH9.md
View file @ 9036a066
This diff is collapsed.
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