From cebdda1540fcce89f17d600bd2a84828c8c85ba6 Mon Sep 17 00:00:00 2001 From: nakul1010 Date: Thu, 23 Nov 2023 11:09:04 +0530 Subject: [PATCH] fix: update contract docs --- .../src/src/bridge/BitcoinTx.sol/library.BitcoinTx.md | 2 +- .../src/src/bridge/BridgeState.sol/library.BridgeState.md | 2 +- .../contracts/src/src/bridge/IRelay.sol/interface.IRelay.md | 2 +- .../src/src/bridge/WitnessTx.sol/library.WitnessTx.md | 2 +- .../src/src/relay/DummyRelay.sol/contract.DummyRelay.md | 6 +++--- .../src/src/relay/LightRelay.sol/contract.LightRelay.md | 6 +++--- .../src/src/relay/LightRelay.sol/interface.ILightRelay.md | 6 +++--- .../src/src/relay/LightRelay.sol/library.RelayUtils.md | 2 +- .../contracts/src/src/relay/LightRelay.sol/struct.Epoch.md | 2 +- .../contracts/src/src/swap/Bridge.sol/contract.Bridge.md | 2 +- .../src/swap/Btc_Marketplace.sol/contract.BtcMarketPlace.md | 2 +- .../src/src/swap/Marketplace.sol/contract.MarketPlace.md | 2 +- .../src/src/swap/Wrapped.sol/contract.BobWrappedBtc.md | 2 +- 13 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/docs/contracts/src/src/bridge/BitcoinTx.sol/library.BitcoinTx.md b/docs/docs/contracts/src/src/bridge/BitcoinTx.sol/library.BitcoinTx.md index 56168b47..34bf49c3 100644 --- a/docs/docs/contracts/src/src/bridge/BitcoinTx.sol/library.BitcoinTx.md +++ b/docs/docs/contracts/src/src/bridge/BitcoinTx.sol/library.BitcoinTx.md @@ -1,5 +1,5 @@ # BitcoinTx -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/bridge/BitcoinTx.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/bridge/BitcoinTx.sol) Allows to reference Bitcoin raw transaction in Solidity. diff --git a/docs/docs/contracts/src/src/bridge/BridgeState.sol/library.BridgeState.md b/docs/docs/contracts/src/src/bridge/BridgeState.sol/library.BridgeState.md index 25593a89..a0c41681 100644 --- a/docs/docs/contracts/src/src/bridge/BridgeState.sol/library.BridgeState.md +++ b/docs/docs/contracts/src/src/bridge/BridgeState.sol/library.BridgeState.md @@ -1,5 +1,5 @@ # BridgeState -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/bridge/BridgeState.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/bridge/BridgeState.sol) ## Structs diff --git a/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md b/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md index 2abad141..6fb30f61 100644 --- a/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md +++ b/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md @@ -1,5 +1,5 @@ # IRelay -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/bridge/IRelay.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/bridge/IRelay.sol) Contains only the methods needed by tBTC v2. The Bitcoin relay provides the difficulty of the previous and current epoch. One diff --git a/docs/docs/contracts/src/src/bridge/WitnessTx.sol/library.WitnessTx.md b/docs/docs/contracts/src/src/bridge/WitnessTx.sol/library.WitnessTx.md index 2e587bbc..28a4ae9e 100644 --- a/docs/docs/contracts/src/src/bridge/WitnessTx.sol/library.WitnessTx.md +++ b/docs/docs/contracts/src/src/bridge/WitnessTx.sol/library.WitnessTx.md @@ -1,5 +1,5 @@ # WitnessTx -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/bridge/WitnessTx.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/bridge/WitnessTx.sol) ## State Variables diff --git a/docs/docs/contracts/src/src/relay/DummyRelay.sol/contract.DummyRelay.md b/docs/docs/contracts/src/src/relay/DummyRelay.sol/contract.DummyRelay.md index ae0796de..cd8483a6 100644 --- a/docs/docs/contracts/src/src/relay/DummyRelay.sol/contract.DummyRelay.md +++ b/docs/docs/contracts/src/src/relay/DummyRelay.sol/contract.DummyRelay.md @@ -1,9 +1,9 @@ # DummyRelay -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/DummyRelay.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/DummyRelay.sol) -[//]: # (**Inherits:**) +**Inherits:** -[//]: # ([IRelay](/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md)) +[IRelay](../../bridge/IRelay.sol/interface.IRelay.md) *DEV-only!* diff --git a/docs/docs/contracts/src/src/relay/LightRelay.sol/contract.LightRelay.md b/docs/docs/contracts/src/src/relay/LightRelay.sol/contract.LightRelay.md index a18a0a98..c3728c96 100644 --- a/docs/docs/contracts/src/src/relay/LightRelay.sol/contract.LightRelay.md +++ b/docs/docs/contracts/src/src/relay/LightRelay.sol/contract.LightRelay.md @@ -1,9 +1,9 @@ # LightRelay -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/LightRelay.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/LightRelay.sol) -[//]: # (**Inherits:**) +**Inherits:** -[//]: # (Ownable, [ILightRelay](/docs/docs/contracts/src/src/relay/LightRelay.sol/interface.ILightRelay.md)) +Ownable, [ILightRelay](../../relay/LightRelay.sol/interface.ILightRelay.md) *THE RELAY MUST NOT BE USED BEFORE GENESIS AND AT LEAST ONE RETARGET.* diff --git a/docs/docs/contracts/src/src/relay/LightRelay.sol/interface.ILightRelay.md b/docs/docs/contracts/src/src/relay/LightRelay.sol/interface.ILightRelay.md index 7135d7bb..bc30c774 100644 --- a/docs/docs/contracts/src/src/relay/LightRelay.sol/interface.ILightRelay.md +++ b/docs/docs/contracts/src/src/relay/LightRelay.sol/interface.ILightRelay.md @@ -1,9 +1,9 @@ # ILightRelay -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/LightRelay.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/LightRelay.sol) -[//]: # (**Inherits:**) +**Inherits:** -[//]: # ([IRelay](/docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md)) +[IRelay](../../bridge/IRelay.sol/interface.IRelay.md) ## Functions diff --git a/docs/docs/contracts/src/src/relay/LightRelay.sol/library.RelayUtils.md b/docs/docs/contracts/src/src/relay/LightRelay.sol/library.RelayUtils.md index b36577a8..23c3b5dd 100644 --- a/docs/docs/contracts/src/src/relay/LightRelay.sol/library.RelayUtils.md +++ b/docs/docs/contracts/src/src/relay/LightRelay.sol/library.RelayUtils.md @@ -1,5 +1,5 @@ # RelayUtils -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/LightRelay.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/LightRelay.sol) ## Functions diff --git a/docs/docs/contracts/src/src/relay/LightRelay.sol/struct.Epoch.md b/docs/docs/contracts/src/src/relay/LightRelay.sol/struct.Epoch.md index 7261c72d..a7e80692 100644 --- a/docs/docs/contracts/src/src/relay/LightRelay.sol/struct.Epoch.md +++ b/docs/docs/contracts/src/src/relay/LightRelay.sol/struct.Epoch.md @@ -1,5 +1,5 @@ # Epoch -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/relay/LightRelay.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/relay/LightRelay.sol) ```solidity diff --git a/docs/docs/contracts/src/src/swap/Bridge.sol/contract.Bridge.md b/docs/docs/contracts/src/src/swap/Bridge.sol/contract.Bridge.md index 75017ede..d3487baf 100644 --- a/docs/docs/contracts/src/src/swap/Bridge.sol/contract.Bridge.md +++ b/docs/docs/contracts/src/src/swap/Bridge.sol/contract.Bridge.md @@ -1,5 +1,5 @@ # Bridge -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/swap/Bridge.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/swap/Bridge.sol) ## State Variables diff --git a/docs/docs/contracts/src/src/swap/Btc_Marketplace.sol/contract.BtcMarketPlace.md b/docs/docs/contracts/src/src/swap/Btc_Marketplace.sol/contract.BtcMarketPlace.md index ad21e1d7..96ff3a11 100644 --- a/docs/docs/contracts/src/src/swap/Btc_Marketplace.sol/contract.BtcMarketPlace.md +++ b/docs/docs/contracts/src/src/swap/Btc_Marketplace.sol/contract.BtcMarketPlace.md @@ -1,5 +1,5 @@ # BtcMarketPlace -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/swap/Btc_Marketplace.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/swap/Btc_Marketplace.sol) ## State Variables diff --git a/docs/docs/contracts/src/src/swap/Marketplace.sol/contract.MarketPlace.md b/docs/docs/contracts/src/src/swap/Marketplace.sol/contract.MarketPlace.md index 33c2fc5a..f598ef09 100644 --- a/docs/docs/contracts/src/src/swap/Marketplace.sol/contract.MarketPlace.md +++ b/docs/docs/contracts/src/src/swap/Marketplace.sol/contract.MarketPlace.md @@ -1,5 +1,5 @@ # MarketPlace -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/swap/Marketplace.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/swap/Marketplace.sol) ## State Variables diff --git a/docs/docs/contracts/src/src/swap/Wrapped.sol/contract.BobWrappedBtc.md b/docs/docs/contracts/src/src/swap/Wrapped.sol/contract.BobWrappedBtc.md index 1d262e5b..6bc13267 100644 --- a/docs/docs/contracts/src/src/swap/Wrapped.sol/contract.BobWrappedBtc.md +++ b/docs/docs/contracts/src/src/swap/Wrapped.sol/contract.BobWrappedBtc.md @@ -1,5 +1,5 @@ # BobWrappedBtc -[Git Source](https://github.com/bob-collective/bob/blob/d9da9844231f0238dc8154200871bc3b4af31769/src/swap/Wrapped.sol) +[Git Source](https://github.com/bob-collective/bob/blob/b1d2e344f73495bf4b7b0690a66a25fa4693d0c3/src/swap/Wrapped.sol) **Inherits:** ERC20, ERC20Burnable, Ownable