Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove contract_id() in favor of ContractId::this() #5867

Merged
merged 5 commits into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions examples/liquidity_pool/src/main.sw
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@ use std::{
mint_to_address,
transfer_to_address,
},
call_frames::{
contract_id,
msg_asset_id,
},
call_frames::msg_asset_id,
constants::DEFAULT_SUB_ID,
context::msg_amount,
hash::*,
Expand Down
7 changes: 3 additions & 4 deletions sway-lib-std/src/asset.sw
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ library;
use ::address::Address;
use ::alias::SubId;
use ::asset_id::AssetId;
use ::call_frames::contract_id;
use ::contract_id::ContractId;
use ::error_signals::FAILED_TRANSFER_TO_ADDRESS_SIGNAL;
use ::identity::Identity;
Expand Down Expand Up @@ -41,7 +40,7 @@ use ::outputs::{Output, output_amount, output_count, output_type};
/// ```
pub fn mint_to(to: Identity, sub_id: SubId, amount: u64) {
mint(sub_id, amount);
transfer(to, AssetId::new(contract_id(), sub_id), amount);
transfer(to, AssetId::new(ContractId::this(), sub_id), amount);
}

/// Mint `amount` coins of the current contract's `asset_id` and send them
Expand Down Expand Up @@ -71,7 +70,7 @@ pub fn mint_to(to: Identity, sub_id: SubId, amount: u64) {
/// ```
pub fn mint_to_contract(to: ContractId, sub_id: SubId, amount: u64) {
mint(sub_id, amount);
force_transfer_to_contract(to, AssetId::new(contract_id(), sub_id), amount);
force_transfer_to_contract(to, AssetId::new(ContractId::this(), sub_id), amount);
}

/// Mint `amount` coins of the current contract's `asset_id` and send them to
Expand All @@ -95,7 +94,7 @@ pub fn mint_to_contract(to: ContractId, sub_id: SubId, amount: u64) {
/// ```
pub fn mint_to_address(to: Address, sub_id: SubId, amount: u64) {
mint(sub_id, amount);
transfer_to_address(to, AssetId::new(contract_id(), sub_id), amount);
transfer_to_address(to, AssetId::new(ContractId::this(), sub_id), amount);
}

/// Mint `amount` coins of the current contract's `sub_id`. The newly minted assets are owned by the current contract.
Expand Down
30 changes: 0 additions & 30 deletions sway-lib-std/src/call_frames.sw
Original file line number Diff line number Diff line change
Expand Up @@ -18,36 +18,6 @@ const FIRST_PARAMETER_OFFSET: u64 = 73;
/// Where 74 (73 + 1) is the current offset in words from the start of the call frame.
const SECOND_PARAMETER_OFFSET: u64 = 74;

// Accessing the current call frame
//
/// Get the current contract's id when called in an internal context.
///
/// # Additional Information
///
/// **_Note:_** If called in an external context, this will **not** return a contract ID.
/// If called externally, will actually return a pointer to the transaction ID.
///
/// # Returns
///
/// * [ContractId] - The contract id of this contract.
///
/// # Examples
///
/// ```sway
/// use std::{call_frames::contract_id, constants::ZERO_B256, asset::mint};
///
/// fn foo() {
/// let this_contract = contract_id();
/// mint(ZERO_B256, 50);
/// Address::from(ZERO_B256).transfer(AssetId::default(this_contract), 50);
/// }
/// ```
pub fn contract_id() -> ContractId {
ContractId::from(asm() {
fp: b256
})
}

/// Get the `asset_id` of coins being sent from the current call frame.
///
/// # Returns
Expand Down
3 changes: 1 addition & 2 deletions sway-lib-std/src/context.sw
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
library;

use ::asset_id::AssetId;
use ::call_frames::contract_id;
use ::contract_id::ContractId;
use ::registers::balance;

Expand All @@ -28,7 +27,7 @@ use ::registers::balance;
/// }
/// ```
pub fn this_balance(asset_id: AssetId) -> u64 {
balance_of(contract_id(), asset_id)
balance_of(ContractId::this(), asset_id)
}

/// Get the balance of coin `asset_id` for the contract at 'target'.
Expand Down
1 change: 0 additions & 1 deletion sway-lib-std/src/identity.sw
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ use ::assert::assert;
use ::address::Address;
use ::alias::SubId;
use ::asset_id::AssetId;
use ::call_frames::contract_id;
use ::constants::{BASE_ASSET_ID, ZERO_B256};
use ::contract_id::ContractId;
use ::hash::{Hash, Hasher};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ abi NFT {
use std::{
block::height,
call_frames::{
contract_id,
msg_asset_id,
},
context::msg_amount,
Expand Down Expand Up @@ -79,7 +78,7 @@ impl EnglishAuction for Contract {

match total_bid {
AuctionAsset::NFTAsset(nft_asset) => {
transfer_nft(nft_asset, sender, Identity::ContractId(contract_id()));
transfer_nft(nft_asset, sender, Identity::ContractId(ContractId::this()));
},
AuctionAsset::TokenAsset(token_asset) => {
require(token_asset == 42, 42);
Expand Down Expand Up @@ -120,7 +119,7 @@ impl EnglishAuction for Contract {
let sender = msg_sender().unwrap();
// TODO: Remove this when StorageVec in structs is supported
require(initial_price == 1, 42);
transfer_nft(asset, sender, Identity::ContractId(contract_id()));
transfer_nft(asset, sender, Identity::ContractId(ContractId::this()));
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
contract;

use std::{call_frames::{contract_id, msg_asset_id}, context::{balance_of, msg_amount, this_balance}, registers::{global_gas, context_gas}};
use std::{call_frames::msg_asset_id, context::{balance_of, msg_amount, this_balance}, registers::{global_gas, context_gas}};
use context_testing_abi::*;

impl ContextTesting for Contract {
fn get_id() -> ContractId {
contract_id()
ContractId::this()
}

fn get_this_balance(asset_id: AssetId) -> u64 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ pub struct TestStruct2 {
}

abi CallFramesTest {
fn get_id() -> ContractId;
fn get_id_contract_id_this() -> ContractId;
fn get_asset_id() -> AssetId;
fn get_code_size() -> u64;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
contract;

use context_testing_abi::ContextTesting;
use std::{asset::mint, call_frames::contract_id, constants::ZERO_B256, hash::*};
use std::{asset::mint, constants::ZERO_B256, hash::*};

abi ContextCaller {
fn call_get_this_balance_with_coins(send_amount: u64, context_id: ContractId) -> u64;
Expand Down
7 changes: 0 additions & 7 deletions test/src/sdk-harness/test_projects/call_frames/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,6 @@ async fn get_call_frames_instance() -> (CallFramesTestContract<WalletUnlocked>,
(instance, id.into())
}

#[tokio::test]
async fn can_get_contract_id() {
let (instance, id) = get_call_frames_instance().await;
let result = instance.methods().get_id().call().await.unwrap();
assert_eq!(result.value, id);
}

#[tokio::test]
async fn can_get_id_contract_id_this() {
let (instance, id) = get_call_frames_instance().await;
Expand Down
4 changes: 0 additions & 4 deletions test/src/sdk-harness/test_projects/call_frames/src/main.sw
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ use call_frames_test_abi::{CallFramesTest, TestStruct, TestStruct2};
use std::call_frames::*;

impl CallFramesTest for Contract {
fn get_id() -> ContractId {
contract_id()
}

fn get_id_contract_id_this() -> ContractId {
ContractId::this()
}
Expand Down
Loading