Merge pull request #449 from bob-collective/feat/add_gateway_interfac…

…es_plus_tests feat: add gateway strategy plus test cases
bob-collective · Jan 30, 2025 · 59afafa · 59afafa
2 parents 2c3fefa + a8b9bb8
commit 59afafa
Show file tree

Hide file tree

Showing 60 changed files with 3,214 additions and 491 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -29,8 +29,9 @@ jobs:
           forge build --sizes --deny-warnings
         id: build
       - name: Run forge tests
+        # Currently forked tests are disabled to increase reliability of CI builds
         run: |
-          forge test -vvv --deny-warnings
+          forge test --no-match-contract Forked -vvv --deny-warnings
         id: test
       - name: Run forge docs
         run: |

diff --git a/docs/docs/contracts/contract_references.md b/docs/docs/contracts/contract_references.md
diff --git a/docs/docs/contracts/src/src/SystemState.sol/library.SystemState.md b/docs/docs/contracts/src/src/SystemState.sol/library.SystemState.md
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
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
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
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
diff --git a/...docs/contracts/src/src/gateway/CommonStructs.sol/struct.StrategySlippageArgs.md b/...docs/contracts/src/src/gateway/CommonStructs.sol/struct.StrategySlippageArgs.md
@@ -0,0 +1,10 @@
+# StrategySlippageArgs
+[Git Source](https://github.com/bob-collective/bob/blob/master/src/gateway/CommonStructs.sol)
+
+
+```solidity
+struct StrategySlippageArgs {
+    uint256 amountOutMin;
+}
+```
+
diff --git a/...s/contracts/src/src/gateway/IStrategy.sol/abstract.IStrategyWithSlippageArgs.md b/...s/contracts/src/src/gateway/IStrategy.sol/abstract.IStrategyWithSlippageArgs.md
@@ -0,0 +1,27 @@
+# IStrategyWithSlippageArgs
+[Git Source](https://github.com/bob-collective/bob/blob/master/src/gateway/IStrategy.sol)
+
+**Inherits:**
+[IStrategy](../../gateway/IStrategy.sol/interface.IStrategy.md)
+
+
+## Functions
+### handleGatewayMessageWithSlippageArgs
+
+
+```solidity
+function handleGatewayMessageWithSlippageArgs(
+    IERC20 tokenSent,
+    uint256 amountIn,
+    address recipient,
+    StrategySlippageArgs memory args
+) public virtual;
+```
+
+### handleGatewayMessage
+
+
+```solidity
+function handleGatewayMessage(IERC20 tokenSent, uint256 amountIn, address recipient, bytes memory message) external;
+```
+