Remove reentrancy library (FuelLabs#3698)

## Overview Closes FuelLabs#3217, migrates the reentrancy library to Sway-libs. > Notice: Awaiting merge and version bump from Sway-libs ([relevant pull request](FuelLabs/sway-libs#70)). ## Changes - remove reentrancy library - remove reentrancy tests - modifies documentation to point to new reentrancy guard url - modifies imports of `std::reentrancy::` to `sway_libs::reentrancy` --------- Co-authored-by: Mohammad Fawaz <[email protected]>
ahocom55 · Feb 7, 2023 · b80283f · b80283f
1 parent 776d8ec
commit b80283f
Show file tree

Hide file tree

Showing 25 changed files with 16 additions and 456 deletions.
diff --git a/docs/book/src/blockchain-development/calling_contracts.md b/docs/book/src/blockchain-development/calling_contracts.md
@@ -78,12 +78,12 @@ fn main() {
 
 A common attack vector for smart contracts is [re-entrancy](https://docs.soliditylang.org/en/v0.8.4/security-considerations.html#re-entrancy). Similar to the EVM, the FuelVM allows for re-entrancy.
 
-A _stateless_ re-entrancy guard is included in the Sway standard library. The guard will panic (revert) at run time if re-entrancy is detected.
+A _stateless_ re-entrancy guard is included in the [sway-libs](https://github.com/FuelLabs/sway-libs) library. The guard will panic (revert) at run time if re-entrancy is detected.
 
 ```sway
 contract;
 
-use std::reentrancy::reentrancy_guard;
+use reentrancy::reentrancy_guard;
 
 abi MyContract {
     fn some_method();

diff --git a/docs/reference/src/code/operations/re_entrency/Forc.lock b/docs/reference/src/code/operations/re_entrency/Forc.lock
@@ -1,13 +1,21 @@
 [[package]]
 name = 'core'
-source = 'path+from-root-6A09A1886494359D'
+source = 'path+from-root-F3A20BA79C738864'
 
 [[package]]
 name = 're_entrency'
-source = 'root'
+source = 'member'
+dependencies = [
+    'reentrancy',
+    'std',
+]
+
+[[package]]
+name = 'reentrancy'
+source = 'git+https://github.com/FuelLabs/sway-libs?tag=v0.6.0#e238aa410e01c5bdccfba1bfd9c86449f9aec832'
 dependencies = ['std']
 
 [[package]]
 name = 'std'
-source = 'git+https://github.com/fuellabs/sway?tag=v0.30.0#37deaee8fccf5804d78a003cf64f14fac654fc41'
+source = 'git+https://github.com/fuellabs/sway?tag=v0.33.1#acd4c1e0fbdc406800a06c845430a80dd3560fcc'
 dependencies = ['core']
diff --git a/docs/reference/src/code/operations/re_entrency/Forc.toml b/docs/reference/src/code/operations/re_entrency/Forc.toml
@@ -5,3 +5,4 @@ license = "Apache-2.0"
 name = "re_entrency"
 
 [dependencies]
+reentrancy = { git = "https://github.com/FuelLabs/sway-libs", tag = "v0.6.0" }
diff --git a/docs/reference/src/code/operations/re_entrency/src/main.sw b/docs/reference/src/code/operations/re_entrency/src/main.sw
@@ -1,7 +1,7 @@
 contract;
 
 // ANCHOR: import
-use std::reentrancy::reentrancy_guard;
+use reentrancy::reentrancy_guard;
 // ANCHOR_END: import
 abi Vault {
     fn deposit();

diff --git a/docs/reference/src/documentation/operations/reentrancy.md b/docs/reference/src/documentation/operations/reentrancy.md
@@ -9,7 +9,7 @@ To mitigate security concerns there are two approaches that are commonly used:
 
 ## Re-entrancy Guard
 
-Sway provides a stateless [re-entrancy](https://github.com/FuelLabs/sway/blob/master/sway-lib-std/src/reentrancy.sw) guard in the [standard library](https://github.com/FuelLabs/sway/tree/master/sway-lib-std) which reverts at run-time when re-entrancy is detected.
+Sway provides a stateless [re-entrancy](https://github.com/FuelLabs/sway-libs/blob/master/libs/reentrancy/src/lib.sw) guard, which reverts at run-time when re-entrancy is detected.
 
 To use the guard we must import it.
 

diff --git a/sway-lib-std/src/lib.sw b/sway-lib-std/src/lib.sw
@@ -31,7 +31,6 @@ dep math;
 dep block;
 dep token;
 dep ecr;
-dep reentrancy;
 dep vm/mod;
 dep flags;
 dep u128;

diff --git a/sway-lib-std/src/reentrancy.sw b/sway-lib-std/src/reentrancy.sw
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_attacker_abi/.gitignore b/test/src/sdk-harness/test_artifacts/reentrancy_attacker_abi/.gitignore
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_attacker_abi/Forc.lock b/test/src/sdk-harness/test_artifacts/reentrancy_attacker_abi/Forc.lock
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_attacker_abi/Forc.toml b/test/src/sdk-harness/test_artifacts/reentrancy_attacker_abi/Forc.toml
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_attacker_abi/src/main.sw b/test/src/sdk-harness/test_artifacts/reentrancy_attacker_abi/src/main.sw
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_attacker_contract/.gitignore b/test/src/sdk-harness/test_artifacts/reentrancy_attacker_contract/.gitignore
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_attacker_contract/Forc.lock b/test/src/sdk-harness/test_artifacts/reentrancy_attacker_contract/Forc.lock
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_attacker_contract/Forc.toml b/test/src/sdk-harness/test_artifacts/reentrancy_attacker_contract/Forc.toml
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_attacker_contract/src/main.sw b/test/src/sdk-harness/test_artifacts/reentrancy_attacker_contract/src/main.sw
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_target_abi/.gitignore b/test/src/sdk-harness/test_artifacts/reentrancy_target_abi/.gitignore
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_target_abi/Forc.lock b/test/src/sdk-harness/test_artifacts/reentrancy_target_abi/Forc.lock
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_target_abi/Forc.toml b/test/src/sdk-harness/test_artifacts/reentrancy_target_abi/Forc.toml
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_target_abi/src/main.sw b/test/src/sdk-harness/test_artifacts/reentrancy_target_abi/src/main.sw
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_target_contract/.gitignore b/test/src/sdk-harness/test_artifacts/reentrancy_target_contract/.gitignore
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_target_contract/Forc.lock b/test/src/sdk-harness/test_artifacts/reentrancy_target_contract/Forc.lock
diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_target_contract/Forc.toml b/test/src/sdk-harness/test_artifacts/reentrancy_target_contract/Forc.toml
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,3 +5,4 @@ license = "Apache-2.0"
		name = "re_entrency"

		[dependencies]
		reentrancy = { git = "https://github.com/FuelLabs/sway-libs", tag = "v0.6.0" }