Skip to content

Commit

Permalink
Allow transfers to SC addresses (#4789)
Browse files Browse the repository at this point in the history 
* Allow transfers to SC

* Add unit test for 4 scenarios
  • Loading branch information
@Leo-Besancon
Leo-Besancon authored Dec 16, 2024
1 parent 82abf69 commit c16701a
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 41 deletions.
24 changes: 6 additions & 18 deletions massa-execution-worker/src/context.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -701,24 +701,12 @@ impl ExecutionContext {
) -> Result<(), ExecutionError> {
if let Some(from_addr) = &from_addr {
// check access rights
if check_rights {
// ensure we can't spend from an address on which we have no write access
if !self.has_write_rights_on(from_addr) {
return Err(ExecutionError::RuntimeError(format!(
"spending from address {} is not allowed in this context",
from_addr
)));
}

// ensure we can't transfer towards SC addresses on which we have no write access
if let Some(to_addr) = &to_addr {
if matches!(to_addr, Address::SC(..)) && !self.has_write_rights_on(to_addr) {
return Err(ExecutionError::RuntimeError(format!(
"crediting SC address {} is not allowed without write access to it",
to_addr
)));
}
}
// ensure we can't spend from an address on which we have no write access
if check_rights && !self.has_write_rights_on(from_addr) {
return Err(ExecutionError::RuntimeError(format!(
"spending from address {} is not allowed in this context",
from_addr
)));
}
}

Expand Down
5 changes: 5 additions & 0 deletions massa-execution-worker/src/speculative_ledger.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,11 @@ impl SpeculativeLedger {
))
})?;
changes.set_balance(to_addr, new_balance);
} else if matches!(to_addr, Address::SC(..)) {
return Err(ExecutionError::RuntimeError(format!(
"cannot transfer coins to non-existing smart contract address {}",
to_addr
)));
} else if let Some(remaining_coins) =
amount.checked_sub(self.storage_costs_constants.ledger_entry_base_cost)
{
Expand Down
125 changes: 102 additions & 23 deletions massa-execution-worker/src/tests/scenarios_mandatories.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2566,10 +2566,43 @@ fn send_and_receive_transaction() {
// setup the period duration
let exec_cfg = ExecutionConfig::default();
let mut foreign_controllers = ExecutionForeignControllers::new_with_mocks();

// Set various addresses to test the execution's behavior
let existing_user_recipient_address =
Address::from_public_key(&KeyPair::generate(0).unwrap().get_public_key());
let non_existing_user_recipient_address =
Address::from_public_key(&KeyPair::generate(0).unwrap().get_public_key());
let existing_sc_recipient_address =
Address::from_str("AS1Bc3kZ6LhPLJvXV4vcVJLFRExRFbkPWD7rCg9aAdQ1NGzRwgnu").unwrap();
let non_existing_sc_recipient_address =
Address::from_str("AS1aEhosr1ebJJZ7cEMpSVKbY6xp1p4DdXabGb8fdkKKJ6WphGnR").unwrap();
let non_existing_recipient_addresses = [
non_existing_user_recipient_address,
non_existing_sc_recipient_address,
];
let recipient_addresses = vec![
existing_user_recipient_address,
existing_sc_recipient_address,
non_existing_user_recipient_address,
non_existing_sc_recipient_address,
];

foreign_controllers
.ledger_controller
.set_expectations(|ledger_controller| {
ledger_controller
.expect_get_balance()
.returning(move |address| {
if non_existing_recipient_addresses.contains(address) {
None
} else {
Some(Amount::from_str("100").unwrap())
}
});
});
let finalized_waitpoint = WaitPoint::new();
let finalized_waitpoint_trigger_handle = finalized_waitpoint.get_trigger_handle();
let recipient_address =
Address::from_public_key(&KeyPair::generate(0).unwrap().get_public_key());

selector_boilerplate(&mut foreign_controllers.selector_controller);
final_state_boilerplate(
&mut foreign_controllers.final_state,
Expand All @@ -2588,17 +2621,38 @@ fn send_and_receive_transaction() {
.times(1)
.with(predicate::eq(Slot::new(1, 0)), predicate::always())
.returning(move |_, changes| {
// 190 because 100 in the get_balance in the `final_state_boilerplate` and 90 from the transfer.
// 110 because 100 in the get_balance in the `final_state_boilerplate` and 10 from the transfer.
assert_eq!(
changes
.ledger_changes
.get_balance_or_else(&recipient_address, || None),
Some(Amount::from_str("190").unwrap())
.get_balance_or_else(&existing_user_recipient_address, || None),
Some(Amount::from_str("110").unwrap())
);
// 9.999 because -0.001 for address creation and 10 from the transfer.
assert_eq!(
changes
.ledger_changes
.get_balance_or_else(&non_existing_user_recipient_address, || None),
Some(Amount::from_str("9.999").unwrap())
);
// 110 because 100 in the get_balance in the `final_state_boilerplate` and 10 from the transfer.
assert_eq!(
changes
.ledger_changes
.get_balance_or_else(&existing_sc_recipient_address, || None),
Some(Amount::from_str("110").unwrap())
);
// Cannot transfer coins to a non-existing smart contract
assert_eq!(
changes
.ledger_changes
.get_balance_or_else(&non_existing_sc_recipient_address, || None),
None
);
// block rewards computation
let total_rewards = exec_cfg
.block_reward
.saturating_add(Amount::from_str("10").unwrap()); // add 10 MAS for fees
.saturating_add(Amount::from_str("20").unwrap()); // add 20 MAS for fees
let rewards_for_block_creator = total_rewards
.checked_div_u64(BLOCK_CREDIT_PART_COUNT)
.expect("critical: total_rewards checked_div factor is 0")
Expand All @@ -2608,45 +2662,70 @@ fn send_and_receive_transaction() {
.checked_rem_u64(BLOCK_CREDIT_PART_COUNT)
.expect("critical: total_rewards checked_rem factor is 0"),
);
// 100 initial balance, + block rewards - transferred amount (3*10) - fees (4*5)
let sender_expected_balance = Amount::from_str("100")
.unwrap()
.saturating_add(rewards_for_block_creator)
.saturating_sub(Amount::from_str("30").unwrap())
.saturating_sub(Amount::from_str("20").unwrap());

assert_eq!(
changes.ledger_changes.get_balance_or_else(
&Address::from_public_key(
&KeyPair::from_str(TEST_SK_1).unwrap().get_public_key()
),
|| None
),
Some(rewards_for_block_creator)
Some(sender_expected_balance)
);
finalized_waitpoint_trigger_handle.trigger();
});
let mut universe = ExecutionTestUniverse::new(foreign_controllers, exec_cfg.clone());
// create the operation
let operation = Operation::new_verifiable(
Operation {
fee: Amount::from_str("10").unwrap(),
expire_period: 10,
op: OperationType::Transaction {
recipient_address,
amount: Amount::from_str("90").unwrap(),
// create the operations
let mut operation_vec = Vec::new();
for recipient_address in recipient_addresses {
let operation = Operation::new_verifiable(
Operation {
fee: Amount::from_str("5").unwrap(),
expire_period: 10,
op: OperationType::Transaction {
recipient_address,
amount: Amount::from_str("10").unwrap(),
},
},
},
OperationSerializer::new(),
&KeyPair::from_str(TEST_SK_1).unwrap(),
*CHAINID,
)
.unwrap();
OperationSerializer::new(),
&KeyPair::from_str(TEST_SK_1).unwrap(),
*CHAINID,
)
.unwrap();
operation_vec.push(operation.clone());
}

// create the block containing the transaction operation
universe.storage.store_operations(vec![operation.clone()]);
universe.storage.store_operations(operation_vec.clone());
let block = ExecutionTestUniverse::create_block(
&KeyPair::from_str(TEST_SK_1).unwrap(),
Slot::new(1, 0),
vec![operation],
operation_vec,
vec![],
vec![],
);
// store the block in storage
universe.send_and_finalize(&KeyPair::from_str(TEST_SK_1).unwrap(), block, None);
finalized_waitpoint.wait();

let events = universe
.module_controller
.get_filtered_sc_output_event(EventFilter {
is_error: Some(true),
..Default::default()
});
// match the events
println!("{:?}", events);
assert!(events.len() == 1, "1 event was expected");
assert!(events[0]
.data
.contains("cannot transfer coins to non-existing smart contract address"));
}

#[test]
Expand Down

0 comments on commit c16701a

Please sign in to comment.