NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
github-actions
2022-05-02 21:10:14 +00:00
parent 84526a0944
commit 443c7bcecc
10 changed files with 46 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
contracts/crosschain/amb/CrossChainEnabledAMB.sol
View File

@ -7,19 +7,20 @@ import "../CrossChainEnabled.sol";
import "./LibAMB.sol";
/**
* @dev [AMB](https://docs.tokenbridge.net/amb-bridge/about-amb-bridge)
* @dev https://docs.tokenbridge.net/amb-bridge/about-amb-bridge[AMB]
* specialization or the {CrossChainEnabled} abstraction.
*
* As of february 2020, AMB bridges are available between the following chains:
* - [ETH <> xDai](https://docs.tokenbridge.net/eth-xdai-amb-bridge/about-the-eth-xdai-amb)
* - [ETH <> qDai](https://docs.tokenbridge.net/eth-qdai-bridge/about-the-eth-qdai-amb)
* - [ETH <> ETC](https://docs.tokenbridge.net/eth-etc-amb-bridge/about-the-eth-etc-amb)
* - [ETH <> BSC](https://docs.tokenbridge.net/eth-bsc-amb/about-the-eth-bsc-amb)
* - [ETH <> POA](https://docs.tokenbridge.net/eth-poa-amb-bridge/about-the-eth-poa-amb)
* - [BSC <> xDai](https://docs.tokenbridge.net/bsc-xdai-amb/about-the-bsc-xdai-amb)
* - [POA <> xDai](https://docs.tokenbridge.net/poa-xdai-amb/about-the-poa-xdai-amb)
* - [Rinkeby <> xDai](https://docs.tokenbridge.net/rinkeby-xdai-amb-bridge/about-the-rinkeby-xdai-amb)
* - [Kovan <> Sokol](https://docs.tokenbridge.net/kovan-sokol-amb-bridge/about-the-kovan-sokol-amb)
*
* - https://docs.tokenbridge.net/eth-xdai-amb-bridge/about-the-eth-xdai-amb[ETH <> xDai]
* - https://docs.tokenbridge.net/eth-qdai-bridge/about-the-eth-qdai-amb[ETH <> qDai]
* - https://docs.tokenbridge.net/eth-etc-amb-bridge/about-the-eth-etc-amb[ETH <> ETC]
* - https://docs.tokenbridge.net/eth-bsc-amb/about-the-eth-bsc-amb[ETH <> BSC]
* - https://docs.tokenbridge.net/eth-poa-amb-bridge/about-the-eth-poa-amb[ETH <> POA]
* - https://docs.tokenbridge.net/bsc-xdai-amb/about-the-bsc-xdai-amb[BSC <> xDai]
* - https://docs.tokenbridge.net/poa-xdai-amb/about-the-poa-xdai-amb[POA <> xDai]
* - https://docs.tokenbridge.net/rinkeby-xdai-amb-bridge/about-the-rinkeby-xdai-amb[Rinkeby <> xDai]
* - https://docs.tokenbridge.net/kovan-sokol-amb-bridge/about-the-kovan-sokol-amb[Kovan <> Sokol]
*
* _Available since v4.6._
*/

2
contracts/crosschain/amb/LibAMB.sol
View File

@ -8,7 +8,7 @@ import "../errors.sol";
/**
* @dev Primitives for cross-chain aware contracts using the
* [AMB](https://docs.tokenbridge.net/amb-bridge/about-amb-bridge)
* https://docs.tokenbridge.net/amb-bridge/about-amb-bridge[AMB]
* family of bridges.
*/
library LibAMB {

4
contracts/crosschain/arbitrum/CrossChainEnabledArbitrumL1.sol
View File

@ -7,7 +7,7 @@ import "../CrossChainEnabled.sol";
import "./LibArbitrumL1.sol";
/**
* @dev [Arbitrum](https://arbitrum.io/) specialization or the
* @dev https://arbitrum.io/[Arbitrum] specialization or the
* {CrossChainEnabled} abstraction the L1 side (mainnet).
*
* This version should only be deployed on L1 to process cross-chain messages
@ -15,7 +15,7 @@ import "./LibArbitrumL1.sol";
*
* The bridge contract is provided and maintained by the arbitrum team. You can
* find the address of this contract on the rinkeby testnet in
* [Arbitrum's developer documentation](https://developer.offchainlabs.com/docs/useful_addresses).
* https://developer.offchainlabs.com/docs/useful_addresses[Arbitrum's developer documentation].
*
* _Available since v4.6._
*/

2
contracts/crosschain/arbitrum/CrossChainEnabledArbitrumL2.sol
View File

@ -7,7 +7,7 @@ import "../CrossChainEnabled.sol";
import "./LibArbitrumL2.sol";
/**
* @dev [Arbitrum](https://arbitrum.io/) specialization or the
* @dev https://arbitrum.io/[Arbitrum] specialization or the
* {CrossChainEnabled} abstraction the L2 side (arbitrum).
*
* This version should only be deployed on L2 to process cross-chain messages

2
contracts/crosschain/arbitrum/LibArbitrumL1.sol
View File

@ -10,7 +10,7 @@ import "../errors.sol";
/**
* @dev Primitives for cross-chain aware contracts for
* [Arbitrum](https://arbitrum.io/).
* https://arbitrum.io/[Arbitrum].
*
* This version should only be used on L1 to process cross-chain messages
* originating from L2. For the other side, use {LibArbitrumL2}.

2
contracts/crosschain/arbitrum/LibArbitrumL2.sol
View File

@ -8,7 +8,7 @@ import "../errors.sol";
/**
* @dev Primitives for cross-chain aware contracts for
* [Arbitrum](https://arbitrum.io/).
* https://arbitrum.io/[Arbitrum].
*
* This version should only be used on L2 to process cross-chain messages
* originating from L1. For the other side, use {LibArbitrumL1}.

4
contracts/crosschain/optimism/CrossChainEnabledOptimism.sol
View File

@ -7,12 +7,12 @@ import "../CrossChainEnabled.sol";
import "./LibOptimism.sol";
/**
* @dev [Optimism](https://www.optimism.io/) specialization or the
* @dev https://www.optimism.io/[Optimism] specialization or the
* {CrossChainEnabled} abstraction.
*
* The messenger (`CrossDomainMessenger`) contract is provided and maintained by
* the optimism team. You can find the address of this contract on mainnet and
* kovan in the [deployments section of Optimism monorepo](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts/deployments).
* kovan in the https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts/deployments[deployments section of Optimism monorepo].
*
* _Available since v4.6._
*/

4
contracts/crosschain/optimism/LibOptimism.sol
View File

@ -7,8 +7,8 @@ import {ICrossDomainMessenger as Optimism_Bridge} from "../../vendor/optimism/IC
import "../errors.sol";
/**
* @dev Primitives for cross-chain aware contracts for [Optimism](https://www.optimism.io/).
* See the [documentation](https://community.optimism.io/docs/developers/bridge/messaging/#accessing-msg-sender)
* @dev Primitives for cross-chain aware contracts for https://www.optimism.io/[Optimism].
* See the https://community.optimism.io/docs/developers/bridge/messaging/#accessing-msg-sender[documentation]
* for the functionality used here.
*/
library LibOptimism {

4
contracts/crosschain/polygon/CrossChainEnabledPolygonChild.sol
View File

@ -11,7 +11,7 @@ import "../../vendor/polygon/IFxMessageProcessor.sol";
address constant DEFAULT_SENDER = 0x000000000000000000000000000000000000dEaD;
/**
* @dev [Polygon](https://polygon.technology/) specialization or the
* @dev https://polygon.technology/[Polygon] specialization or the
* {CrossChainEnabled} abstraction the child side (polygon/mumbai).
*
* This version should only be deployed on child chain to process cross-chain
@ -19,7 +19,7 @@ address constant DEFAULT_SENDER = 0x000000000000000000000000000000000000dEaD;
*
* The fxChild contract is provided and maintained by the polygon team. You can
* find the address of this contract polygon and mumbai in
* [Polygon's Fx-Portal documentation](https://docs.polygon.technology/docs/develop/l1-l2-communication/fx-portal/#contract-addresses).
* https://docs.polygon.technology/docs/develop/l1-l2-communication/fx-portal/#contract-addresses[Polygon's Fx-Portal documentation].
*
* _Available since v4.6._
*/

45
docs/modules/api/pages/crosschain.adoc
View File

@ -2105,19 +2105,20 @@ The following specializations of {CrossChainEnabled} provide implementations of
import "@openzeppelin/contracts/crosschain/amb/CrossChainEnabledAMB.sol";
```
[AMB](https://docs.tokenbridge.net/amb-bridge/about-amb-bridge)
https://docs.tokenbridge.net/amb-bridge/about-amb-bridge[AMB]
specialization or the {CrossChainEnabled} abstraction.
As of february 2020, AMB bridges are available between the following chains:
- [ETH <> xDai](https://docs.tokenbridge.net/eth-xdai-amb-bridge/about-the-eth-xdai-amb)
- [ETH <> qDai](https://docs.tokenbridge.net/eth-qdai-bridge/about-the-eth-qdai-amb)
- [ETH <> ETC](https://docs.tokenbridge.net/eth-etc-amb-bridge/about-the-eth-etc-amb)
- [ETH <> BSC](https://docs.tokenbridge.net/eth-bsc-amb/about-the-eth-bsc-amb)
- [ETH <> POA](https://docs.tokenbridge.net/eth-poa-amb-bridge/about-the-eth-poa-amb)
- [BSC <> xDai](https://docs.tokenbridge.net/bsc-xdai-amb/about-the-bsc-xdai-amb)
- [POA <> xDai](https://docs.tokenbridge.net/poa-xdai-amb/about-the-poa-xdai-amb)
- [Rinkeby <> xDai](https://docs.tokenbridge.net/rinkeby-xdai-amb-bridge/about-the-rinkeby-xdai-amb)
- [Kovan <> Sokol](https://docs.tokenbridge.net/kovan-sokol-amb-bridge/about-the-kovan-sokol-amb)
- https://docs.tokenbridge.net/eth-xdai-amb-bridge/about-the-eth-xdai-amb[ETH <> xDai]
- https://docs.tokenbridge.net/eth-qdai-bridge/about-the-eth-qdai-amb[ETH <> qDai]
- https://docs.tokenbridge.net/eth-etc-amb-bridge/about-the-eth-etc-amb[ETH <> ETC]
- https://docs.tokenbridge.net/eth-bsc-amb/about-the-eth-bsc-amb[ETH <> BSC]
- https://docs.tokenbridge.net/eth-poa-amb-bridge/about-the-eth-poa-amb[ETH <> POA]
- https://docs.tokenbridge.net/bsc-xdai-amb/about-the-bsc-xdai-amb[BSC <> xDai]
- https://docs.tokenbridge.net/poa-xdai-amb/about-the-poa-xdai-amb[POA <> xDai]
- https://docs.tokenbridge.net/rinkeby-xdai-amb-bridge/about-the-rinkeby-xdai-amb[Rinkeby <> xDai]
- https://docs.tokenbridge.net/kovan-sokol-amb-bridge/about-the-kovan-sokol-amb[Kovan <> Sokol]
_Available since v4.6._
@ -2171,7 +2172,7 @@ see {CrossChainEnabled-_crossChainSender}
import "@openzeppelin/contracts/crosschain/arbitrum/CrossChainEnabledArbitrumL1.sol";
```
[Arbitrum](https://arbitrum.io/) specialization or the
https://arbitrum.io/[Arbitrum] specialization or the
{CrossChainEnabled} abstraction the L1 side (mainnet).
This version should only be deployed on L1 to process cross-chain messages
@ -2179,7 +2180,7 @@ originating from L2. For the other side, use {CrossChainEnabledArbitrumL2}.
The bridge contract is provided and maintained by the arbitrum team. You can
find the address of this contract on the rinkeby testnet in
[Arbitrum's developer documentation](https://developer.offchainlabs.com/docs/useful_addresses).
https://developer.offchainlabs.com/docs/useful_addresses[Arbitrum's developer documentation].
_Available since v4.6._
@ -2232,7 +2233,7 @@ see {CrossChainEnabled-_crossChainSender}
import "@openzeppelin/contracts/crosschain/arbitrum/CrossChainEnabledArbitrumL2.sol";
```
[Arbitrum](https://arbitrum.io/) specialization or the
https://arbitrum.io/[Arbitrum] specialization or the
{CrossChainEnabled} abstraction the L2 side (arbitrum).
This version should only be deployed on L2 to process cross-chain messages
@ -2286,12 +2287,12 @@ see {CrossChainEnabled-_crossChainSender}
import "@openzeppelin/contracts/crosschain/optimism/CrossChainEnabledOptimism.sol";
```
[Optimism](https://www.optimism.io/) specialization or the
https://www.optimism.io/[Optimism] specialization or the
{CrossChainEnabled} abstraction.
The messenger (`CrossDomainMessenger`) contract is provided and maintained by
the optimism team. You can find the address of this contract on mainnet and
kovan in the [deployments section of Optimism monorepo](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts/deployments).
kovan in the https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts/deployments[deployments section of Optimism monorepo].
_Available since v4.6._
@ -2346,7 +2347,7 @@ see {CrossChainEnabled-_crossChainSender}
import "@openzeppelin/contracts/crosschain/polygon/CrossChainEnabledPolygonChild.sol";
```
[Polygon](https://polygon.technology/) specialization or the
https://polygon.technology/[Polygon] specialization or the
{CrossChainEnabled} abstraction the child side (polygon/mumbai).
This version should only be deployed on child chain to process cross-chain
@ -2354,7 +2355,7 @@ messages originating from the parent chain.
The fxChild contract is provided and maintained by the polygon team. You can
find the address of this contract polygon and mumbai in
[Polygon's Fx-Portal documentation](https://docs.polygon.technology/docs/develop/l1-l2-communication/fx-portal/#contract-addresses).
https://docs.polygon.technology/docs/develop/l1-l2-communication/fx-portal/#contract-addresses[Polygon's Fx-Portal documentation].
_Available since v4.6._
@ -2433,7 +2434,7 @@ import "@openzeppelin/contracts/crosschain/amb/LibAMB.sol";
```
Primitives for cross-chain aware contracts using the
[AMB](https://docs.tokenbridge.net/amb-bridge/about-amb-bridge)
https://docs.tokenbridge.net/amb-bridge/about-amb-bridge[AMB]
family of bridges.
@ -2482,7 +2483,7 @@ import "@openzeppelin/contracts/crosschain/arbitrum/LibArbitrumL1.sol";
```
Primitives for cross-chain aware contracts for
[Arbitrum](https://arbitrum.io/).
https://arbitrum.io/[Arbitrum].
This version should only be used on L1 to process cross-chain messages
originating from L2. For the other side, use {LibArbitrumL2}.
@ -2534,7 +2535,7 @@ import "@openzeppelin/contracts/crosschain/arbitrum/LibArbitrumL2.sol";
```
Primitives for cross-chain aware contracts for
[Arbitrum](https://arbitrum.io/).
https://arbitrum.io/[Arbitrum].
This version should only be used on L2 to process cross-chain messages
originating from L1. For the other side, use {LibArbitrumL1}.
@ -2583,8 +2584,8 @@ function call is not the result of a cross-chain message.
import "@openzeppelin/contracts/crosschain/optimism/LibOptimism.sol";
```
Primitives for cross-chain aware contracts for [Optimism](https://www.optimism.io/).
See the [documentation](https://community.optimism.io/docs/developers/bridge/messaging/#accessing-msg-sender)
Primitives for cross-chain aware contracts for https://www.optimism.io/[Optimism].
See the https://community.optimism.io/docs/developers/bridge/messaging/#accessing-msg-sender[documentation]
for the functionality used here.