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

Update the code of xAcount use case #377

Merged
merged 1 commit into from
Feb 4, 2024
Merged

Update the code of xAcount use case #377

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
69 changes: 7 additions & 62 deletions src/components/UseCase/data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,64 +7,9 @@ export const cases: {
}[] = [
{
title: "xAccount",
code: `// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

/// @dev ISafeXAccountFactory represents a factory contract responsible for the creation of SafeXAccounts.
interface ISafeXAccountFactory {
/// @dev Cross chian function for create SafeXAccount on target chain.
/// @notice If recovery address is \`address(0)\`, do not enabale recovery module.
/// @param code Port code that used for create SafeXAccount.
/// @param toChainId Target chain id.
/// @param params Port params correspond with the port.
/// @param recovery The default safe recovery module address on target chain for SafeXAccount.
function xCreate(bytes4 code, uint256 toChainId, bytes calldata params, address recovery) external payable;
/// @dev Calculate SafeXAccount address on target chain.
/// @notice The module address is only effective during its creation and may be replaced by the SafeXAccount in the future.
/// @param fromChainId Chain id that SafeXAccount belongs in.
/// @param toChainId Chain id that SafeXAccount lives in.
/// @param deployer Owner that SafeXAccount belongs to.
/// @return (SafeXAccount address, module address).
function safeXAccountOf(uint256 fromChainId, uint256 toChainId, address deployer)
external
view
returns (address, address);
}

/// @dev ISafeMsgportModule serves as a module integrated within the Safe system, specifically devised to enable remote administration and control of the safeXAccount.
interface ISafeMsgportModule {
/// @dev Receive xCall from root chain xOwner.
/// @param target Target of the transaction that should be executed
/// @param value Wei value of the transaction that should be executed
/// @param data Data of the transaction that should be executed
/// @param operation Operation (Call or Delegatecall) of the transaction that should be executed
/// @return xExecute return data Return data after xCall.
function xExecute(address target, uint256 value, bytes calldata data, uint8 operation)
external
payable
returns (bytes memory);
}

/// @dev IPortRegistry functions as a comprehensive registry for all chain message ports.
interface IPortRegistry {
/// @dev Fetch port address by chainId and port code.
function get(uint256 chainId, bytes4 code) external view returns (address);
}

/// @dev IMessagePort serves as a universal interface facilitating the transmission of cross-chain messages across all msgport channels.
interface IMessagePort {
/// @dev Send a cross-chain message over the MessagePort.
/// @notice Send a cross-chain message over the MessagePort.
/// @param toChainId The message destination chain id. <https://eips.ethereum.org/EIPS/eip-155>
/// @param toDapp The user application contract address which receive the message.
/// @param message The calldata which encoded by ABI Encoding.
/// @param params Extend parameters to adapt to different message protocols.
function send(uint256 toChainId, address toDapp, bytes calldata message, bytes calldata params) external payable;
}

/// @dev SafeXAccountDemo is a demonstration showcasing the utilization of SafeXAccount to execute an xCall.
contract ExampleSafeXAccount {
// SafeXAccountFactory address
code: `/// @dev ExampleXAccount is a demonstration showcasing the utilization of xAccount to execute an xCall.
contract ExampleXAccount {
// XAccountFactory address
address public factory;
// PortRegistry address
address public registry;
Expand All @@ -74,15 +19,15 @@ contract ExampleSafeXAccount {
registry = registry_;
}

/// @dev The function is utilized to create a SafeXAccount on the target chain.
/// @dev The function is utilized to create a xAccount on the target chain.
function createXAccountOnTargetChain(bytes4 code, uint256 toChainId, bytes calldata params, address recovery)
public
payable
{
ISafeXAccountFactory(factory).xCreate{value: msg.value}(code, toChainId, params, recovery);
IXAccountFactory(factory).xCreate{value: msg.value}(code, toChainId, params, recovery);
}

/// @dev The function facilitates the execution of an xCall across a SafeXAccount.
/// @dev The function facilitates the execution of an xCall across a xAccount.
function crossChainCall(
bytes4 code,
uint256 toChainId,
Expand All @@ -95,7 +40,7 @@ contract ExampleSafeXAccount {
bytes memory message =
abi.encodeWithSelector(ISafeMsgportModule.xExecute.selector, target, value, data, operation);
address port = IPortRegistry(registry).get(toChainId, code);
(, address module) = ISafeXAccountFactory(factory).safeXAccountOf(block.chainid, toChainId, address(this));
(, address module) = IXAccountFactory(factory).xAccountOf(block.chainid, toChainId, address(this));
IMessagePort(port).send{value: msg.value}(toChainId, module, message, params);
}
}`,
Expand Down
Loading