Remove nested folders

FuelLabs · Apr 2, 2024 · 5766711 · 5766711
1 parent b99741e
commit 5766711
Show file tree

Hide file tree

Showing 23 changed files with 86 additions and 87 deletions.
diff --git a/docs/book/spell-check-custom-words.txt b/docs/book/spell-check-custom-words.txt
@@ -206,4 +206,5 @@ abi
 Enqueuing
 Dequeuing
 StorageMetadata
-functionly
+functionly
+verifiably
diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
@@ -4,22 +4,22 @@
 
 - [Getting Started](./getting_started/index.md)
   - [Running Tests](./getting_started/running_tests.md)
-- [Libraries](./libraries/index.md)
-  - [Asset Libraries](./libraries/asset/index.md)
-    - [Asset Library](./libraries/asset/asset/index.md)
-      - [Base](./libraries/asset/asset/base.md)
-      - [Supply](./libraries/asset/asset/supply.md)
-      - [Metadata](./libraries/asset/asset/metadata.md)
-  - [Access Control and Security Libraries](./libraries/access_security/index.md)
-    - [Admin Library](./libraries/access_security/admin/index.md)
-    - [Ownership Library](./libraries/access_security/ownership/index.md)
-    - [Pausable Library](./libraries/access_security/pausable/index.md)
-    - [Reentrancy Guard Library](./libraries/access_security/reentrancy/index.md)
-  - [Cryptography Libraries](./libraries/cryptography/index.md)
-    - [Bytecode Library](./libraries/cryptography/bytecode/index.md)
-    - [Merkle Library](./libraries/cryptography/merkle/index.md)
-  - [Math Libraries](./libraries/math/index.md)
-    - [Fixed Point Number Library](./libraries/math/fixed_point/index.md)
-    - [Signed Integers Library](./libraries/math/signed_integers/index.md)
-  - [Data Structure Libraries](./libraries/data_structures/index.md)
-    - [Queue Library](./libraries/data_structures/queue/index.md)
+- [Libraries](./libraries.md)
+  - [Asset Libraries](./asset_libraries.md)
+    - [Asset Library](./asset/index.md)
+      - [Base](./asset/base.md)
+      - [Supply](./asset/supply.md)
+      - [Metadata](./asset/metadata.md)
+  - [Access Control and Security Libraries](./access_security_libraries.md)
+    - [Admin Library](./admin/index.md)
+    - [Ownership Library](./ownership/index.md)
+    - [Pausable Library](./pausable/index.md)
+    - [Reentrancy Guard Library](./reentrancy/index.md)
+  - [Cryptography Libraries](./cryptography_libraries.md)
+    - [Bytecode Library](./bytecode/index.md)
+    - [Merkle Library](./merkle/index.md)
+  - [Math Libraries](./math_libraries.md)
+    - [Fixed Point Number Library](./fixed_point/index.md)
+    - [Signed Integers Library](./signed_integers/index.md)
+  - [Data Structure Libraries](./data_structures_libraries.md)
+    - [Queue Library](./queue/index.md)
diff --git a/...ok/src/libraries/access_security/index.md → docs/book/src/access_security_libraries.md b/...ok/src/libraries/access_security/index.md → docs/book/src/access_security_libraries.md
diff --git a/.../libraries/access_security/admin/index.md → docs/book/src/admin/index.md b/.../libraries/access_security/admin/index.md → docs/book/src/admin/index.md
diff --git a/docs/book/src/libraries/asset/asset/base.md → docs/book/src/asset/base.md b/docs/book/src/libraries/asset/asset/base.md → docs/book/src/asset/base.md
diff --git a/docs/book/src/libraries/asset/asset/index.md → docs/book/src/asset/index.md b/docs/book/src/libraries/asset/asset/index.md → docs/book/src/asset/index.md
diff --git a/...ook/src/libraries/asset/asset/metadata.md → docs/book/src/asset/metadata.md b/...ook/src/libraries/asset/asset/metadata.md → docs/book/src/asset/metadata.md
diff --git a/.../book/src/libraries/asset/asset/supply.md → docs/book/src/asset/supply.md b/.../book/src/libraries/asset/asset/supply.md → docs/book/src/asset/supply.md
@@ -46,7 +46,6 @@ storage {
 
 To use a base function, simply pass the `StorageKey` from the prescribed storage block. The example below shows the implementation of the [SRC-3](https://github.com/FuelLabs/sway-standards/blob/master/SRCs/src-3.md) standard in combination with the Asset Library with no user defined restrictions or custom functionality. It is recommended that the [Ownership Library](../../access_security/ownership/) is used in conjunction with the Asset Library;s supply functionality to ensure only a single user has permissions to mint an Asset.
 
-
 ```sway
 use sway_libs::asset::supply::{_mint, _burn};
 use standards::src3::SRC3;

diff --git a/docs/book/src/libraries/asset/index.md → docs/book/src/asset_libraries.md b/docs/book/src/libraries/asset/index.md → docs/book/src/asset_libraries.md
diff --git a/.../libraries/cryptography/bytecode/index.md → docs/book/src/bytecode/index.md b/.../libraries/cryptography/bytecode/index.md → docs/book/src/bytecode/index.md
diff --git a/.../book/src/libraries/cryptography/index.md → docs/book/src/cryptography_libraries.md b/.../book/src/libraries/cryptography/index.md → docs/book/src/cryptography_libraries.md
diff --git a/...ok/src/libraries/data_structures/index.md → docs/book/src/data_structures_libraries.md b/...ok/src/libraries/data_structures/index.md → docs/book/src/data_structures_libraries.md
diff --git a/...k/src/libraries/math/fixed_point/index.md → docs/book/src/fixed_point/index.md b/...k/src/libraries/math/fixed_point/index.md → docs/book/src/fixed_point/index.md
diff --git a/docs/book/src/index.md b/docs/book/src/index.md
@@ -6,4 +6,3 @@ These libraries contain helper functions and other tools valuable to blockchain
 
 > **NOTE:**
 > Sway is a language under heavy development therefore the libraries may not be the most ergonomic. Over time they should receive updates / improvements in order to demonstrate how Sway can be used in real use cases.
-> 
diff --git a/docs/book/src/libraries.md b/docs/book/src/libraries.md
@@ -0,0 +1,65 @@
+# Libraries
+
+There are several types of libraries that Sway Libs encompases. These include libraries that provide convenience functions, standards supporting libraries, data type libraries, security functionality libraries.
+
+For implementation details on the libraries please see the [Sway Libs Docs](https://fuellabs.github.io/sway-libs/master/sway_libs/).
+
+## [Assets Libraries](./asset_libraries.md)
+
+Asset Libraries are any libraries that use [Native Assets](https://docs.fuel.network/docs/sway/blockchain-development/native_assets) on the Fuel Network.
+
+### [Asset Library](./asset/index.md)
+
+The [Asset](./asset/asset/index.md) Library provides helper functions for the [SRC-20](https://github.com/FuelLabs/sway-standards/blob/master/SRCs/src-20.md), [SRC-3](https://github.com/FuelLabs/sway-standards/blob/master/SRCs/src-3.md), and [SRC-7](https://github.com/FuelLabs/sway-standards/blob/master/SRCs/src-7.md) standards.
+
+## [Access Control and Security Libraries](./access_security_libraries.md)
+
+Access Control and Security Libraries are any libraries that are built and intended to provide additional safety when developing smart contracts.
+
+### [Ownership Library](./ownership/index.md)
+
+The [Ownership](./ownership/index.md) Library is used to apply restrictions on functions such that only a **single** user may call them.
+
+### [Admin Library](./admin/index.md)
+
+The [Admin](./admin/index.md) Library is used to apply restrictions on functions such that only a select few users may call them like a whitelist.
+
+### [Pausable Library](./pausable/index.md)
+
+The [Pausable](./pausable/index.md) Library allows contracts to implement an emergency stop mechanism.
+
+### [Reentrancy Guard Library](./reentrancy/index.md)
+
+The [Reentrancy Guard](./reentrancy/index.md) Library is used to detect and prevent reentrancy attacks.
+
+## [Cryptography Libraries](./cryptography_libraries.md)
+
+Cryptography Libraries are any libraries that provided cryptographic functionality beyond what the std-lib provides.
+
+### [Bytecode Library](./bytecode/index.md)
+
+The [Bytecode](./bytecode/index.md) Library is used for on-chain verification and computation of bytecode roots for contracts and predicates.
+
+### [Merkle Library](./merkle/index.md)
+
+The [Merkle Proof](./merkle/index.md) Library is used to verify Binary Merkle Trees computed off-chain.
+
+## [Math Libraries](./math_libraries.md)
+
+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.
+
+## [Data Structures Libraries](./data_structures_libraries.md)
+
+Data Structure Libraries are libraries which provide complex data structures which unlock additional functionality for Smart Contracts.
+
+### [Queue](./queue/index.md)
+
+The [Queue](./queue/index.md) Library is a linear data structure that provides First-In-First-Out (FIFO) operations.
diff --git a/docs/book/src/libraries/index.md b/docs/book/src/libraries/index.md
diff --git a/docs/book/src/libraries/math/index.md → docs/book/src/math_libraries.md b/docs/book/src/libraries/math/index.md → docs/book/src/math_libraries.md
diff --git a/...rc/libraries/cryptography/merkle/index.md → docs/book/src/merkle/index.md b/...rc/libraries/cryptography/merkle/index.md → docs/book/src/merkle/index.md
diff --git a/...raries/access_security/ownership/index.md → docs/book/src/ownership/index.md b/...raries/access_security/ownership/index.md → docs/book/src/ownership/index.md
diff --git a/...braries/access_security/pausable/index.md → docs/book/src/pausable/index.md b/...braries/access_security/pausable/index.md → docs/book/src/pausable/index.md
diff --git a/.../libraries/data_structures/queue/index.md → docs/book/src/queue/index.md b/.../libraries/data_structures/queue/index.md → docs/book/src/queue/index.md
diff --git a/...aries/access_security/reentrancy/index.md → docs/book/src/reentrancy/index.md b/...aries/access_security/reentrancy/index.md → docs/book/src/reentrancy/index.md
diff --git a/...c/libraries/math/signed_integers/index.md → docs/book/src/signed_integers/index.md b/...c/libraries/math/signed_integers/index.md → docs/book/src/signed_integers/index.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -46,7 +46,6 @@ storage { @@
     To use a base function, simply pass the `StorageKey` from the prescribed storage block. The example below shows the implementation of the [SRC-3](https://github.com/FuelLabs/sway-standards/blob/master/SRCs/src-3.md) standard in combination with the Asset Library with no user defined restrictions or custom functionality. It is recommended that the [Ownership Library](../../access_security/ownership/) is used in conjunction with the Asset Library;s supply functionality to ensure only a single user has permissions to mint an Asset.
     ```sway
     use sway_libs::asset::supply::{_mint, _burn};
     use standards::src3::SRC3;
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +6,3 @@ These libraries contain helper functions and other tools valuable to blockchain

		> NOTE:
		> Sway is a language under heavy development therefore the libraries may not be the most ergonomic. Over time they should receive updates / improvements in order to demonstrate how Sway can be used in real use cases.
		>