Flatten the stdlib (FuelLabs#3247)

While a final design for the organization of `std` will likely involve more discussion (& consideration of the proposed `Contract` type with some of the existing free functions converted to methods on the `Contract` type), the changes I've made here remove some weirdness. This is a breaking change, so it might be a good time to clean at least this up. I've left the `vm` directory as currently, it seems like the only good use of a subdirectory in `std`. If anyone thinks this needs more discussion we can mark this a draft. ref FuelLabs#1759
hahaya09 · Nov 2, 2022 · bcfbd1b · bcfbd1b
1 parent b83ad9b
commit bcfbd1b
Show file tree

Hide file tree

Showing 33 changed files with 42 additions and 39 deletions.
diff --git a/examples/identity/src/main.sw b/examples/identity/src/main.sw
@@ -7,7 +7,7 @@ use abi::IdentityExample;
 use errors::MyError;
 
 use std::{
-    chain::auth::{
+    auth::{
         AuthError,
         msg_sender,
     },

diff --git a/examples/liquidity_pool/src/main.sw b/examples/liquidity_pool/src/main.sw
@@ -1,7 +1,7 @@
 contract;
 
 use std::{
-    context::call_frames::{
+    call_frames::{
         contract_id,
         msg_asset_id,
     },

diff --git a/examples/msg_sender/src/main.sw b/examples/msg_sender/src/main.sw
@@ -1,6 +1,6 @@
 contract;
 
-use std::chain::auth::{AuthError, msg_sender};
+use std::auth::{AuthError, msg_sender};
 
 abi MyOwnedContract {
     fn receive(field_1: u64) -> bool;

diff --git a/examples/subcurrency/src/main.sw b/examples/subcurrency/src/main.sw
@@ -1,7 +1,7 @@
 // ANCHOR: body
 contract;
 
-use std::{chain::auth::{AuthError, msg_sender}, hash::sha256, logging::log};
+use std::{auth::{AuthError, msg_sender}, hash::sha256, logging::log};
 
 ////////////////////////////////////////
 // Event declarations

diff --git a/examples/wallet_smart_contract/src/main.sw b/examples/wallet_smart_contract/src/main.sw
@@ -2,15 +2,13 @@
 contract;
 
 use std::{
-    chain::auth::{
+    auth::{
         AuthError,
         msg_sender,
     },
+    call_frames::msg_asset_id,
     constants::BASE_ASSET_ID,
-    context::{
-        call_frames::msg_asset_id,
-        msg_amount,
-    },
+    context::msg_amount,
     token::transfer_to_address,
 };
 

diff --git a/sway-lib-std/src/chain/auth.sw → sway-lib-std/src/auth.sw b/sway-lib-std/src/chain/auth.sw → sway-lib-std/src/auth.sw
diff --git a/sway-lib-std/src/context/call_frames.sw → sway-lib-std/src/call_frames.sw b/sway-lib-std/src/context/call_frames.sw → sway-lib-std/src/call_frames.sw
@@ -3,7 +3,7 @@
 //! https://fuellabs.github.io/fuel-specs/master/vm#call-frames
 library call_frames;
 
-use ::context::registers::frame_ptr;
+use ::registers::frame_ptr;
 use ::contract_id::ContractId;
 use ::intrinsics::is_reference_type;
 

diff --git a/sway-lib-std/src/chain.sw b/sway-lib-std/src/chain.sw
diff --git a/sway-lib-std/src/context.sw b/sway-lib-std/src/context.sw
@@ -1,11 +1,9 @@
 //! Functionality for accessing context-specific information about the current contract or message.
 library context;
-dep context/registers;
-dep context/call_frames;
 
 use ::contract_id::ContractId;
-use ::context::call_frames::contract_id;
-use ::context::registers::balance;
+use ::call_frames::contract_id;
+use ::registers::balance;
 
 /// Get the balance of coin `asset_id` for the current contract.
 pub fn this_balance(asset_id: ContractId) -> u64 {

diff --git a/sway-lib-std/src/ecr.sw b/sway-lib-std/src/ecr.sw
@@ -2,7 +2,7 @@ library ecr;
 
 use ::address::Address;
 use ::b512::B512;
-use ::context::registers::error;
+use ::registers::error;
 use ::hash::sha256;
 use ::result::Result;
 

diff --git a/sway-lib-std/src/flags.sw b/sway-lib-std/src/flags.sw
@@ -1,7 +1,7 @@
 //! Functionality for setting and unsetting FuelVM flags to modify behavior related to the `$err` and `$of` registers
 library flags;
 
-use ::context::registers::flags;
+use ::registers::flags;
 
 /// Call this function to allow overflowing operations to occur without a FuelVM panic.
 /// IMPORTANT !!! Don't forget to call enable_panic_on_overflow() after performing the operations for which you disabled the default panic-on-overflow behavior in the first place !

diff --git a/sway-lib-std/src/lib.sw b/sway-lib-std/src/lib.sw
@@ -12,6 +12,8 @@ dep alloc;
 dep contract_id;
 dep constants;
 dep external;
+dep registers;
+dep call_frames;
 dep context;
 dep hash;
 dep r#storage;
@@ -21,7 +23,7 @@ dep identity;
 dep tx;
 dep inputs;
 dep outputs;
-dep chain;
+dep auth;
 dep math;
 dep block;
 dep token;

diff --git a/sway-lib-std/src/reentrancy.sw b/sway-lib-std/src/reentrancy.sw
@@ -4,7 +4,8 @@
 library reentrancy;
 
 use ::assert::assert;
-use ::context::{call_frames::*, registers::frame_ptr};
+use ::call_frames::*;
+use ::registers::frame_ptr;
 
 pub fn reentrancy_guard() {
     assert(!is_reentrant());

diff --git a/sway-lib-std/src/context/registers.sw → sway-lib-std/src/registers.sw b/sway-lib-std/src/context/registers.sw → sway-lib-std/src/registers.sw
diff --git a/sway-lib-std/src/token.sw b/sway-lib-std/src/token.sw
@@ -2,7 +2,7 @@
 library token;
 
 use ::address::Address;
-use ::context::call_frames::contract_id;
+use ::call_frames::contract_id;
 use ::contract_id::ContractId;
 use ::error_signals::FAILED_TRANSFER_TO_ADDRESS_SIGNAL;
 use ::identity::Identity;

diff --git a/sway-lib-std/src/vm/evm/ecr.sw b/sway-lib-std/src/vm/evm/ecr.sw
@@ -1,7 +1,7 @@
 library ecr;
 
 use ::b512::B512;
-use ::context::registers::error;
+use ::registers::error;
 use ::ecr::{ec_recover, EcRecoverError};
 use ::hash::keccak256;
 use ::result::Result;

diff --git a/test/src/e2e_vm_tests/test_programs/should_fail/abort_control_flow_bad/src/main.sw b/test/src/e2e_vm_tests/test_programs/should_fail/abort_control_flow_bad/src/main.sw
@@ -1,6 +1,5 @@
 script;
 
-use std::chain::*;
 use std::revert::revert;
 
 fn main() {

diff --git a/test/src/e2e_vm_tests/test_programs/should_fail/better_type_error_message/src/main.sw b/test/src/e2e_vm_tests/test_programs/should_fail/better_type_error_message/src/main.sw
@@ -1,6 +1,6 @@
 script;
 
-use std::chain::auth::*;
+use std::auth::*;
 use std::identity::*;
 //use std::b512::*;
 

diff --git a/test/src/e2e_vm_tests/test_programs/should_pass/language/abort_control_flow_good/src/main.sw b/test/src/e2e_vm_tests/test_programs/should_pass/language/abort_control_flow_good/src/main.sw
@@ -1,6 +1,5 @@
 script;
 
-use std::chain::*;
 use std::revert::revert;
 
 enum Result<T, E> {

diff --git a/...c/e2e_vm_tests/test_programs/should_pass/test_contracts/auth_testing_contract/src/main.sw b/...c/e2e_vm_tests/test_programs/should_pass/test_contracts/auth_testing_contract/src/main.sw
@@ -1,5 +1,5 @@
 contract;
-use std::chain::auth::caller_is_external;
+use std::auth::caller_is_external;
 use auth_testing_abi::AuthTesting;
 
 impl AuthTesting for Contract {

diff --git a/...2e_vm_tests/test_programs/should_pass/test_contracts/context_testing_contract/src/main.sw b/...2e_vm_tests/test_programs/should_pass/test_contracts/context_testing_contract/src/main.sw
@@ -1,6 +1,6 @@
 contract;
 
-use std::{context::{balance_of, call_frames::{contract_id, msg_asset_id}, gas, msg_amount, registers::global_gas, this_balance}, contract_id::ContractId};
+use std::{call_frames::{contract_id, msg_asset_id}, context::{balance_of, gas, msg_amount, this_balance}, contract_id::ContractId, registers::global_gas};
 use context_testing_abi::*;
 
 impl ContextTesting for Contract {

diff --git a/test/src/sdk-harness/test_artifacts/auth_caller_contract/src/main.sw b/test/src/sdk-harness/test_artifacts/auth_caller_contract/src/main.sw
@@ -1,7 +1,7 @@
 contract;
 
 use auth_testing_abi::*;
-use std::chain::auth::*;
+use std::auth::*;
 
 abi AuthCaller {
     fn call_auth_contract(auth_id: ContractId, expected_id: ContractId) -> bool;

diff --git a/test/src/sdk-harness/test_artifacts/auth_caller_script/src/main.sw b/test/src/sdk-harness/test_artifacts/auth_caller_script/src/main.sw
@@ -1,7 +1,7 @@
 script;
 
 use auth_testing_abi::AuthTesting;
-use std::chain::auth::*;
+use std::auth::*;
 
 fn main() -> u64 {
     // TODO: ContractId for auth_testing_contract should ideally be passed to script as an arg when possible.

diff --git a/test/src/sdk-harness/test_artifacts/auth_testing_abi/src/main.sw b/test/src/sdk-harness/test_artifacts/auth_testing_abi/src/main.sw
@@ -1,6 +1,6 @@
 library auth_testing_abi;
 
-use std::chain::auth::*;
+use std::auth::*;
 
 abi AuthTesting {
     fn is_caller_external() -> bool;

diff --git a/test/src/sdk-harness/test_artifacts/auth_testing_contract/src/main.sw b/test/src/sdk-harness/test_artifacts/auth_testing_contract/src/main.sw
@@ -1,6 +1,6 @@
 contract;
 
-use std::chain::auth::*;
+use std::auth::*;
 use auth_testing_abi::*;
 
 impl AuthTesting for Contract {

diff --git a/test/src/sdk-harness/test_artifacts/context_caller_contract/src/main.sw b/test/src/sdk-harness/test_artifacts/context_caller_contract/src/main.sw
@@ -1,7 +1,7 @@
 contract;
 
 use context_testing_abi::ContextTesting;
-use std::{context::call_frames::contract_id, token::mint};
+use std::{call_frames::contract_id, token::mint};
 
 abi ContextCaller {
     fn call_get_this_balance_with_coins(send_amount: u64, context_id: ContractId) -> u64;

diff --git a/test/src/sdk-harness/test_artifacts/methods_contract/src/main.sw b/test/src/sdk-harness/test_artifacts/methods_contract/src/main.sw
@@ -2,7 +2,7 @@ contract;
 
 use methods_abi::MethodsContract;
 
-use std::chain::auth::*;
+use std::auth::*;
 
 fn bogus() -> Identity {
     let sender = msg_sender();

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
@@ -1,6 +1,6 @@
 contract;
 
-use std::{chain::auth::*, context::call_frames::contract_id};
+use std::{auth::*, call_frames::contract_id};
 
 use reentrancy_target_abi::Target;
 use reentrancy_attacker_abi::Attacker;

diff --git a/test/src/sdk-harness/test_artifacts/reentrancy_target_contract/src/main.sw b/test/src/sdk-harness/test_artifacts/reentrancy_target_contract/src/main.sw
@@ -1,6 +1,6 @@
 contract;
 
-use std::{chain::auth::*, context::{call_frames::contract_id, gas}, reentrancy::*};
+use std::{auth::*, call_frames::contract_id, context::gas, reentrancy::*};
 
 use reentrancy_attacker_abi::Attacker;
 use reentrancy_target_abi::Target;

diff --git a/test/src/sdk-harness/test_projects/call_frames/src/main.sw b/test/src/sdk-harness/test_projects/call_frames/src/main.sw
@@ -1,7 +1,7 @@
 contract;
 
 use call_frames_test_abi::{CallFramesTest, TestStruct, TestStruct2};
-use std::{context::call_frames::*};
+use std::call_frames::*;
 
 impl CallFramesTest for Contract {
     fn get_id() -> ContractId {

diff --git a/test/src/sdk-harness/test_projects/context/src/main.sw b/test/src/sdk-harness/test_projects/context/src/main.sw
@@ -1,6 +1,10 @@
 contract;
 
-use std::context::{*, call_frames::*, registers::*};
+use std::{
+    context::*,
+    call_frames::*,
+    registers::*,
+};
 use context_testing_abi::*;
 
 impl ContextTesting for Contract {

diff --git a/test/src/sdk-harness/test_projects/registers/src/main.sw b/test/src/sdk-harness/test_projects/registers/src/main.sw
@@ -1,6 +1,10 @@
 contract;
 
-use std::context::{*, call_frames::*, registers::*};
+use std::{
+    context::*,
+    call_frames::*,
+    registers::*
+};
 
 abi Registers {
     fn get_overflow() -> u64;

diff --git a/test/src/sdk-harness/test_projects/storage/src/main.sw b/test/src/sdk-harness/test_projects/storage/src/main.sw
@@ -1,6 +1,6 @@
 contract;
 
-use std::{context::registers::stack_ptr, storage::{get, store}};
+use std::{registers::stack_ptr, storage::{get, store}};
 
 pub enum MediumEnum {
     One: u64,