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.

Sign up for GitHub

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

XVM: default account mapping for Wasm contracts #1056

Merged
merged 5 commits into from
Oct 16, 2023
Merged

XVM: default account mapping for Wasm contracts #1056

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a6f4e2
Add default account mapping for Wasm contracts.
shaunxw Oct 12, 2023
e25aad9
Only map accounts for Wasm if payable call.
shaunxw Oct 12, 2023
f2eca13
Charge weight for claim default address call.
shaunxw Oct 12, 2023
e55f316
Fix & docs update.
shaunxw Oct 12, 2023
6a58f46
To H160 DB read.
shaunxw Oct 12, 2023
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
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions chain-extensions/xvm/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ log = { workspace = true }
num-traits = { workspace = true }
pallet-contracts = { workspace = true }
pallet-contracts-primitives = { workspace = true }
pallet-unified-accounts = { workspace = true }
parity-scale-codec = { workspace = true }
scale-info = { workspace = true }
sp-core = { workspace = true }
Expand All @@ -34,6 +35,7 @@ std = [
"num-traits/std",
"pallet-contracts/std",
"pallet-contracts-primitives/std",
"pallet-unified-accounts/std",
"scale-info/std",
"sp-std/std",
"sp-core/std",
Expand Down
49 changes: 39 additions & 10 deletions chain-extensions/xvm/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,16 @@
extern crate alloc;
use alloc::format;

use astar_primitives::xvm::{Context, VmId, XvmCall};
use frame_support::dispatch::Encode;
use astar_primitives::{
evm::UnifiedAddressMapper,
xvm::{Context, VmId, XvmCall},
};
use frame_support::{dispatch::Encode, traits::Get, weights::Weight};
use frame_system::RawOrigin;
use pallet_contracts::chain_extension::{
ChainExtension, Environment, Ext, InitState, RetVal, ReturnFlags,
};
use pallet_unified_accounts::WeightInfo;
use sp_runtime::DispatchError;
use sp_std::marker::PhantomData;
use xvm_chain_extension_types::{XvmCallArgs, XvmExecutionResult};
Expand All @@ -48,18 +53,19 @@ impl TryFrom<u16> for XvmFuncId {
}

/// XVM chain extension.
pub struct XvmExtension<T, XC>(PhantomData<(T, XC)>);
pub struct XvmExtension<T, XC, UA>(PhantomData<(T, XC, UA)>);

impl<T, XC> Default for XvmExtension<T, XC> {
impl<T, XC, UA> Default for XvmExtension<T, XC, UA> {
fn default() -> Self {
XvmExtension(PhantomData)
}
}

impl<T, XC> ChainExtension<T> for XvmExtension<T, XC>
impl<T, XC, UA> ChainExtension<T> for XvmExtension<T, XC, UA>
where
T: pallet_contracts::Config,
T: pallet_contracts::Config + pallet_unified_accounts::Config,
XC: XvmCall<T::AccountId>,
UA: UnifiedAddressMapper<T::AccountId>,
{
fn call<E: Ext>(&mut self, env: Environment<E, InitState>) -> Result<RetVal, DispatchError>
where
Expand Down Expand Up @@ -87,7 +93,30 @@ where
// Similar to EVM behavior, the `source` should be (limited to) the
// contract address. Otherwise contracts would be able to do arbitrary
// things on behalf of the caller via XVM.
let source = env.ext().address();
let source = env.ext().address().clone();

// Claim the default evm address if needed.
let mut actual_weight = Weight::zero();
shaunxw marked this conversation as resolved.
Show resolved Hide resolved
if value > 0 {
// `UA::to_h160` 1 DB read.
actual_weight.saturating_accrue(T::DbWeight::get().reads(1));

if UA::to_h160(&source).is_none() {
let weight_of_claim = <T as pallet_unified_accounts::Config>::WeightInfo::claim_default_evm_address();
actual_weight.saturating_accrue(weight_of_claim);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've difficult time understanding, what if actual_weight after adding UA weight is higher than weight_limit?
As I understand, we don't have any check here to make sure such situation doesn't happen.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm aware of this, but didn't want to make the weight handling overcomplicated. It only happens in strict conditions and the weight amount is small. To make it 100% accurate, the weight limit needs to be adjusted as well, and this procedure would repeat everywhere.


let claim_result =
pallet_unified_accounts::Pallet::<T>::claim_default_evm_address(
RawOrigin::Signed(source.clone()).into(),
);
if claim_result.is_err() {
return Ok(RetVal::Diverging {
flags: ReturnFlags::REVERT,
data: format!("{:?}", claim_result.err()).into(),
});
}
}
}

let xvm_context = Context {
source_vm_id: VmId::Wasm,
Expand All @@ -104,13 +133,13 @@ where
}
}
};
let call_result =
XC::call(xvm_context, vm_id, source.clone(), to, input, value, None);
let call_result = XC::call(xvm_context, vm_id, source, to, input, value, None);

let actual_weight = match call_result {
let used_weight = match call_result {
Ok(ref info) => info.used_weight,
Err(ref err) => err.used_weight,
};
actual_weight.saturating_accrue(used_weight);
env.adjust_weight(charged_weight, actual_weight);

match call_result {
Expand Down
4 changes: 2 additions & 2 deletions runtime/local/src/chain_extensions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
// You should have received a copy of the GNU General Public License
// along with Astar. If not, see <http://www.gnu.org/licenses/>.

use super::{Runtime, Xvm};
use super::{Runtime, UnifiedAccounts, Xvm};

/// Registered WASM contracts chain extensions.
pub use pallet_chain_extension_assets::AssetsExtension;
Expand All @@ -31,7 +31,7 @@ impl RegisteredChainExtension<Runtime> for DappsStakingExtension<Runtime> {
const ID: u16 = 00;
}

impl RegisteredChainExtension<Runtime> for XvmExtension<Runtime, Xvm> {
impl RegisteredChainExtension<Runtime> for XvmExtension<Runtime, Xvm, UnifiedAccounts> {
const ID: u16 = 01;
}

Expand Down
2 changes: 1 addition & 1 deletion runtime/local/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,7 +844,7 @@ impl pallet_contracts::Config for Runtime {
type WeightInfo = pallet_contracts::weights::SubstrateWeight<Self>;
type ChainExtension = (
DappsStakingExtension<Self>,
XvmExtension<Self, Xvm>,
XvmExtension<Self, Xvm, UnifiedAccounts>,
AssetsExtension<Self, pallet_chain_extension_assets::weights::SubstrateWeight<Self>>,
);
type Schedule = Schedule;
Expand Down
4 changes: 2 additions & 2 deletions runtime/shibuya/src/chain_extensions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
// You should have received a copy of the GNU General Public License
// along with Astar. If not, see <http://www.gnu.org/licenses/>.

use super::{Runtime, Xvm};
use super::{Runtime, UnifiedAccounts, Xvm};

/// Registered WASM contracts chain extensions.
pub use pallet_chain_extension_assets::AssetsExtension;
Expand All @@ -31,7 +31,7 @@ impl RegisteredChainExtension<Runtime> for DappsStakingExtension<Runtime> {
const ID: u16 = 00;
}

impl RegisteredChainExtension<Runtime> for XvmExtension<Runtime, Xvm> {
impl RegisteredChainExtension<Runtime> for XvmExtension<Runtime, Xvm, UnifiedAccounts> {
const ID: u16 = 01;
}

Expand Down
2 changes: 1 addition & 1 deletion runtime/shibuya/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,7 @@ impl pallet_contracts::Config for Runtime {
type WeightInfo = pallet_contracts::weights::SubstrateWeight<Self>;
type ChainExtension = (
DappsStakingExtension<Self>,
XvmExtension<Self, Xvm>,
XvmExtension<Self, Xvm, UnifiedAccounts>,
AssetsExtension<Self, pallet_chain_extension_assets::weights::SubstrateWeight<Self>>,
);
type Schedule = Schedule;
Expand Down
8 changes: 0 additions & 8 deletions tests/integration/src/setup.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,6 @@ mod shibuya {
get_evm_signature(who, secret)
));
}

pub fn claim_default_accounts(account: AccountId) {
let default_h160 = UnifiedAccounts::to_default_h160(&account);
assert_ok!(UnifiedAccounts::claim_default_evm_address(
RuntimeOrigin::signed(account.clone())
));
assert_eq!(UnifiedAccounts::to_h160(&account).unwrap(), default_h160);
}
}

#[cfg(feature = "shiden")]
Expand Down
4 changes: 0 additions & 4 deletions tests/integration/src/xvm.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,10 +330,6 @@ fn calling_evm_payable_from_wasm_works() {
let wasm_caller_addr = deploy_wasm_contract(CALL_EVM_PAYBLE_NAME);

let value = UNIT;

// claim the default mappings for wasm contract
claim_default_accounts(wasm_caller_addr.clone());

Comment on lines -333 to -336
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a check for AccountClaimed event for the first payable call to make sure the mappings? thanks

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's an integration test, which shouldn't assume how it works under the hood. It's supposed to only check balances to make sure the payable call worked.

let evm_payable = evm_payable_callee_addr.as_ref().to_vec();
let deposit_func = hex::decode("d0e30db0").expect("invalid deposit function hex");
let input = hex::decode("0000002a")
Expand Down