Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions contracts/docs/apis/L1ERC1155Gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -550,3 +550,50 @@ Emitted when token mapping for ERC1155 token is updated.



## Errors

### ErrorCallerIsNotCounterpartGateway

```solidity
error ErrorCallerIsNotCounterpartGateway()
```



*Thrown when the cross chain sender is not the counterpart gateway contract.*


### ErrorCallerIsNotMessenger

```solidity
error ErrorCallerIsNotMessenger()
```



*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*


### ErrorNotInDropMessageContext

```solidity
error ErrorNotInDropMessageContext()
```



*Thrown when ScrollMessenger is not dropping message.*


### ErrorZeroAddress

```solidity
error ErrorZeroAddress()
```



*Thrown when the given address is `address(0)`.*



49 changes: 48 additions & 1 deletion contracts/docs/apis/L1ERC721Gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ function initialize(address _counterpart, address _messenger) external nonpayabl

Initialize the storage of L1ERC721Gateway.


*The parameters `_counterpart` and `_messenger` are no longer used.*

#### Parameters

Expand Down Expand Up @@ -489,3 +489,50 @@ Emitted when token mapping for ERC721 token is updated.



## Errors

### ErrorCallerIsNotCounterpartGateway

```solidity
error ErrorCallerIsNotCounterpartGateway()
```



*Thrown when the cross chain sender is not the counterpart gateway contract.*


### ErrorCallerIsNotMessenger

```solidity
error ErrorCallerIsNotMessenger()
```



*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*


### ErrorNotInDropMessageContext

```solidity
error ErrorNotInDropMessageContext()
```



*Thrown when ScrollMessenger is not dropping message.*


### ErrorZeroAddress

```solidity
error ErrorZeroAddress()
```



*Thrown when the given address is `address(0)`.*



35 changes: 33 additions & 2 deletions contracts/docs/apis/L1GatewayRouter.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ function ethGateway() external view returns (address)

The address of L1ETHGateway.


*This variable is no longer used.*


#### Returns
Expand Down Expand Up @@ -286,7 +286,7 @@ function initialize(address _ethGateway, address _defaultERC20Gateway) external

Initialize the storage of L1GatewayRouter.


*The parameters `_ethGateway` is no longer used.*

#### Parameters

Expand All @@ -295,6 +295,23 @@ Initialize the storage of L1GatewayRouter.
| _ethGateway | address | The address of L1ETHGateway contract. |
| _defaultERC20Gateway | address | The address of default ERC20 Gateway contract. |

### messenger

```solidity
function messenger() external view returns (address)
```

The address of `L1ScrollMessenger`.




#### Returns

| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |

### owner

```solidity
Expand Down Expand Up @@ -618,3 +635,17 @@ Emitted when the address of ETH Gateway is updated.



## Errors

### ErrorZeroAddress

```solidity
error ErrorZeroAddress()
```



*Thrown when the given address is `address(0)`.*



16 changes: 15 additions & 1 deletion contracts/docs/apis/L1ScrollMessenger.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ function initialize(address _counterpart, address _feeVault, address _rollup, ad

Initialize the storage of L1ScrollMessenger.


*The parameters `_counterpart`, `_rollup` and `_messageQueue` are no longer used.*

#### Parameters

Expand Down Expand Up @@ -611,3 +611,17 @@ Emitted when the maximum number of times each message can be replayed is updated



## Errors

### ErrorZeroAddress

```solidity
error ErrorZeroAddress()
```



*Thrown when the given address is `address(0)`.*



49 changes: 48 additions & 1 deletion contracts/docs/apis/L1StandardERC20Gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ function initialize(address _counterpart, address _router, address _messenger, a

Initialize the storage of L1StandardERC20Gateway.


*The parameters `_counterpart`, `_router`, `_messenger`, `_l2TokenImplementation` and `_l2TokenFactory` are no longer used.*

#### Parameters

Expand Down Expand Up @@ -374,3 +374,50 @@ Emitted when some ERC20 token is refunded.



## Errors

### ErrorCallerIsNotCounterpartGateway

```solidity
error ErrorCallerIsNotCounterpartGateway()
```



*Thrown when the cross chain sender is not the counterpart gateway contract.*


### ErrorCallerIsNotMessenger

```solidity
error ErrorCallerIsNotMessenger()
```



*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*


### ErrorNotInDropMessageContext

```solidity
error ErrorNotInDropMessageContext()
```



*Thrown when ScrollMessenger is not dropping message.*


### ErrorZeroAddress

```solidity
error ErrorZeroAddress()
```



*Thrown when the given address is `address(0)`.*



47 changes: 47 additions & 0 deletions contracts/docs/apis/L1WETHGateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,3 +372,50 @@ Emitted when some ERC20 token is refunded.



## Errors

### ErrorCallerIsNotCounterpartGateway

```solidity
error ErrorCallerIsNotCounterpartGateway()
```



*Thrown when the cross chain sender is not the counterpart gateway contract.*


### ErrorCallerIsNotMessenger

```solidity
error ErrorCallerIsNotMessenger()
```



*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*


### ErrorNotInDropMessageContext

```solidity
error ErrorNotInDropMessageContext()
```



*Thrown when ScrollMessenger is not dropping message.*


### ErrorZeroAddress

```solidity
error ErrorZeroAddress()
```



*Thrown when the given address is `address(0)`.*



55 changes: 51 additions & 4 deletions contracts/docs/apis/L2ERC1155Gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,16 +114,16 @@ Complete ERC1155 deposit from layer 1 to layer 2 and send NFT to recipient's
function initialize(address _counterpart, address _messenger) external nonpayable
```

Initialize the storage of `L2ERC1155Gateway`.



*The parameters `_counterpart` and `_messenger` are no longer used.*

#### Parameters

| Name | Type | Description |
|---|---|---|
| _counterpart | address | undefined |
| _messenger | address | undefined |
| _counterpart | address | The address of `L1ERC1155Gateway` contract in L1. |
| _messenger | address | The address of `L2ScrollMessenger` contract in L2. |

### messenger

Expand Down Expand Up @@ -496,3 +496,50 @@ Emitted when the ERC1155 NFT is transfered to gateway on layer 2.



## Errors

### ErrorCallerIsNotCounterpartGateway

```solidity
error ErrorCallerIsNotCounterpartGateway()
```



*Thrown when the cross chain sender is not the counterpart gateway contract.*


### ErrorCallerIsNotMessenger

```solidity
error ErrorCallerIsNotMessenger()
```



*Thrown when the caller is not corresponding `L1ScrollMessenger` or `L2ScrollMessenger`.*


### ErrorNotInDropMessageContext

```solidity
error ErrorNotInDropMessageContext()
```



*Thrown when ScrollMessenger is not dropping message.*


### ErrorZeroAddress

```solidity
error ErrorZeroAddress()
```



*Thrown when the given address is `address(0)`.*



Loading