Deprecate Fixed Point library (#278)

FuelLabs · Aug 1, 2024 · 0b64cbf · 0b64cbf
1 parent ddfe684
commit 0b64cbf
Show file tree

Hide file tree

Showing 136 changed files with 7 additions and 5,474 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,6 +20,7 @@ Description of the upcoming release here.
 
 - [#265](https://github.com/FuelLabs/sway-libs/pull/265) Enables the metadata events now that the Rust SDK supports wrapped heap types.
 - [#269](https://github.com/FuelLabs/sway-libs/pull/269) Hashes the string "admin" and with the bits of an Identity when creating a storage slot to storage an admin in the Admin Library.
+- [#278](https://github.com/FuelLabs/sway-libs/pull/278) Deprecates the Fixed Point number library.
 
 ### Fixed
 
@@ -34,7 +35,7 @@ Description of the upcoming release here.
 #### Breaking
 
 - [#263](https://github.com/FuelLabs/sway-libs/pull/263) Removes the `TwosComplement` trait in favor of `WrappingNeg`.
-  
+
 The following demonstrates the breaking change. While this example code uses the `I8` type, the same logic may be applied to the `I16`, `I32`, `I64`, `I128`, and `I256` types.
 
 Before:
@@ -80,3 +81,5 @@ After:
 ```sway
 let my_negative_i8: I8 = I8::neg_try_from(1u8).unwrap();
 ```
+
+- [#278](https://github.com/FuelLabs/sway-libs/pull/278) Deprecates the Fixed Point number library. The Fixed Point number library is no longer available.
diff --git a/README.md b/README.md
@@ -57,9 +57,11 @@ For implementation details on the libraries please see the [Sway Libs Docs](http
 
 #### Math
 
-- [Fixed Point Number](https://docs.fuel.network/docs/sway-libs/fixed_point/) is an interface to implement fixed-point numbers.
 - [Signed Integers](https://docs.fuel.network/docs/sway-libs/queue/) is an interface to implement signed integers.
 
+> **NOTE:**
+> The Fixed Point Number library has been deprecated pending a re-write.
+
 #### Data Structures
 
 - [Queue](https://docs.fuel.network/docs/sway-libs/queue/) is a linear data structure that provides First-In-First-Out (FIFO) operations.

diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
@@ -14,7 +14,6 @@
 - [Reentrancy Guard Library](./reentrancy/index.md)
 - [Bytecode Library](./bytecode/index.md)
 - [Merkle Library](./merkle/index.md)
-- [Fixed Point Number Library](./fixed_point/index.md)
 - [Signed Integers Library](./signed_integers/index.md)
 - [Queue Library](./queue/index.md)
 - [Upgradability](./upgradability/index.md)
diff --git a/docs/book/src/fixed_point/index.md b/docs/book/src/fixed_point/index.md
diff --git a/docs/book/src/index.md b/docs/book/src/index.md
@@ -50,10 +50,6 @@ The [Merkle Proof](./merkle/index.md) Library is used to verify Binary Merkle Tr
 
 Math Libraries are libraries which provide mathematic functions or number types that are outside of the std-lib's scope.
 
-### [Fixed Point Number Library](./fixed_point/index.md)
-
-The [Fixed Point Number](./fixed_point/index.md) Library is an interface to implement fixed-point numbers.
-
 ### [Signed Integers](./signed_integers/index.md)
 
 The [Signed Integers](./signed_integers/index.md) Library is an interface to implement signed integers.

diff --git a/examples/Forc.lock b/examples/Forc.lock
@@ -55,14 +55,6 @@ dependencies = [
 name = "core"
 source = "path+from-root-E19CE48B3E858B72"
 
-[[package]]
-name = "fixed_point_examples"
-source = "member"
-dependencies = [
-    "std",
-    "sway_libs",
-]
-
 [[package]]
 name = "merkle_examples"
 source = "member"

diff --git a/examples/Forc.toml b/examples/Forc.toml
@@ -10,7 +10,6 @@ members = [
   "./asset/setting_src20_attributes",
   "./asset/supply_docs",
   "./bytecode",
-  "./fixed_point",
   "./merkle",
   "./ownership",
   "./pausable/pausable",

diff --git a/examples/fixed_point/Forc.toml b/examples/fixed_point/Forc.toml
diff --git a/examples/fixed_point/src/main.sw b/examples/fixed_point/src/main.sw
diff --git a/libs/src/fixed_point.sw b/libs/src/fixed_point.sw