Fix links in documentation (#3387)

(cherry picked from commit 14ca3aeb79)
Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
pull/3394/head
Hadrien Croubois 3 years ago
parent d4fb3a89f9
commit 9473998144
  1. 21
      contracts/crosschain/amb/CrossChainEnabledAMB.sol
  2. 2
      contracts/crosschain/amb/LibAMB.sol
  3. 4
      contracts/crosschain/arbitrum/CrossChainEnabledArbitrumL1.sol
  4. 2
      contracts/crosschain/arbitrum/CrossChainEnabledArbitrumL2.sol
  5. 2
      contracts/crosschain/arbitrum/LibArbitrumL1.sol
  6. 2
      contracts/crosschain/arbitrum/LibArbitrumL2.sol
  7. 4
      contracts/crosschain/optimism/CrossChainEnabledOptimism.sol
  8. 4
      contracts/crosschain/optimism/LibOptimism.sol
  9. 4
      contracts/crosschain/polygon/CrossChainEnabledPolygonChild.sol

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

@ -8,7 +8,7 @@ import "../errors.sol";
/** /**
* @dev Primitives for cross-chain aware contracts using the * @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. * family of bridges.
*/ */
library LibAMB { library LibAMB {

@ -7,7 +7,7 @@ import "../CrossChainEnabled.sol";
import "./LibArbitrumL1.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). * {CrossChainEnabled} abstraction the L1 side (mainnet).
* *
* This version should only be deployed on L1 to process cross-chain messages * 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 * The bridge contract is provided and maintained by the arbitrum team. You can
* find the address of this contract on the rinkeby testnet in * 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._ * _Available since v4.6._
*/ */

@ -7,7 +7,7 @@ import "../CrossChainEnabled.sol";
import "./LibArbitrumL2.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). * {CrossChainEnabled} abstraction the L2 side (arbitrum).
* *
* This version should only be deployed on L2 to process cross-chain messages * This version should only be deployed on L2 to process cross-chain messages

@ -10,7 +10,7 @@ import "../errors.sol";
/** /**
* @dev Primitives for cross-chain aware contracts for * @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 * This version should only be used on L1 to process cross-chain messages
* originating from L2. For the other side, use {LibArbitrumL2}. * originating from L2. For the other side, use {LibArbitrumL2}.

@ -8,7 +8,7 @@ import "../errors.sol";
/** /**
* @dev Primitives for cross-chain aware contracts for * @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 * This version should only be used on L2 to process cross-chain messages
* originating from L1. For the other side, use {LibArbitrumL1}. * originating from L1. For the other side, use {LibArbitrumL1}.

@ -7,12 +7,12 @@ import "../CrossChainEnabled.sol";
import "./LibOptimism.sol"; import "./LibOptimism.sol";
/** /**
* @dev [Optimism](https://www.optimism.io/) specialization or the * @dev https://www.optimism.io/[Optimism] specialization or the
* {CrossChainEnabled} abstraction. * {CrossChainEnabled} abstraction.
* *
* The messenger (`CrossDomainMessenger`) contract is provided and maintained by * The messenger (`CrossDomainMessenger`) contract is provided and maintained by
* the optimism team. You can find the address of this contract on mainnet and * 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._ * _Available since v4.6._
*/ */

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

@ -11,7 +11,7 @@ import "../../vendor/polygon/IFxMessageProcessor.sol";
address constant DEFAULT_SENDER = 0x000000000000000000000000000000000000dEaD; 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). * {CrossChainEnabled} abstraction the child side (polygon/mumbai).
* *
* This version should only be deployed on child chain to process cross-chain * 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 * The fxChild contract is provided and maintained by the polygon team. You can
* find the address of this contract polygon and mumbai in * 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._ * _Available since v4.6._
*/ */

Loading…
Cancel
Save