Skip to content

Commit a597457

Browse files
author
YukiTsuchida
committed
refactor: forge fmt
1 parent d0a1da7 commit a597457

File tree

14 files changed

+2545
-2991
lines changed

14 files changed

+2545
-2991
lines changed

‎contracts/Migrations.sol‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,15 @@
22
pragma solidity >=0.4.22 <0.9.0;
33

44
contract Migrations {
5-
address public owner = msg.sender;
6-
uint public last_completed_migration;
5+
address public owner = msg.sender;
6+
uint256 public last_completed_migration;
77

8-
modifier restricted() {
9-
require(
10-
msg.sender == owner,
11-
"This function is restricted to the contract's owner"
12-
);
13-
_;
14-
}
8+
modifier restricted() {
9+
require(msg.sender == owner, "This function is restricted to the contract's owner");
10+
_;
11+
}
1512

16-
function setCompleted(uint completed) public restricted {
17-
last_completed_migration = completed;
18-
}
13+
function setCompleted(uint256 completed) public restricted {
14+
last_completed_migration = completed;
15+
}
1916
}

‎contracts/core/ContractRegistry.sol‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ import "./IContractModule.sol";
77
// ContractRegistry is a registry that manages a contract of Cross Framework
88
abstract contract ContractRegistry {
99
// registerModule registers a given module to the registry
10-
function registerModule(IContractModule module) virtual internal;
10+
function registerModule(IContractModule module) internal virtual;
1111

1212
// getModule returns a module that matches a given packet
13-
function getModule(Packet.Data memory packet) virtual internal returns (IContractModule);
13+
function getModule(Packet.Data memory packet) internal virtual returns (IContractModule);
1414
}

‎contracts/core/CrossModule.sol‎

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import "./PacketHandler.sol";
99
import "./IBCKeeper.sol";
1010

1111
abstract contract CrossModule is Context, AccessControl, IIBCModule, IBCKeeper, PacketHandler {
12-
1312
bytes32 public constant IBC_ROLE = keccak256("IBC_ROLE");
1413

1514
constructor(IBCHandler ibcHandler_) IBCKeeper(ibcHandler_) {
@@ -20,21 +19,49 @@ abstract contract CrossModule is Context, AccessControl, IIBCModule, IBCKeeper,
2019

2120
/// Module callbacks ///
2221

23-
function onRecvPacket(Packet.Data memory packet, address relayer) public virtual override returns (bytes memory acknowledgement) {
22+
function onRecvPacket(Packet.Data memory packet, address relayer)
23+
public
24+
virtual
25+
override
26+
returns (bytes memory acknowledgement)
27+
{
2428
require(hasRole(IBC_ROLE, _msgSender()), "caller must have the IBC role");
2529
return handlePacket(packet);
2630
}
2731

28-
function onAcknowledgementPacket(Packet.Data memory packet, bytes memory acknowledgement, address relayer) public virtual override {
32+
function onAcknowledgementPacket(Packet.Data memory packet, bytes memory acknowledgement, address relayer)
33+
public
34+
virtual
35+
override
36+
{
2937
require(hasRole(IBC_ROLE, _msgSender()), "caller must have the IBC role");
3038
return handleAcknowledgement(packet, acknowledgement);
3139
}
3240

33-
function onChanOpenInit(Channel.Order, string[] calldata connectionHops, string calldata portId, string calldata channelId, ChannelCounterparty.Data calldata counterparty, string calldata version) external virtual override {}
41+
function onChanOpenInit(
42+
Channel.Order,
43+
string[] calldata connectionHops,
44+
string calldata portId,
45+
string calldata channelId,
46+
ChannelCounterparty.Data calldata counterparty,
47+
string calldata version
48+
) external virtual override {}
3449

35-
function onChanOpenTry(Channel.Order, string[] calldata connectionHops, string calldata portId, string calldata channelId, ChannelCounterparty.Data calldata counterparty, string calldata version, string calldata counterpartyVersion) external virtual override {}
50+
function onChanOpenTry(
51+
Channel.Order,
52+
string[] calldata connectionHops,
53+
string calldata portId,
54+
string calldata channelId,
55+
ChannelCounterparty.Data calldata counterparty,
56+
string calldata version,
57+
string calldata counterpartyVersion
58+
) external virtual override {}
3659

37-
function onChanOpenAck(string calldata portId, string calldata channelId, string calldata counterpartyVersion) external virtual override {}
60+
function onChanOpenAck(string calldata portId, string calldata channelId, string calldata counterpartyVersion)
61+
external
62+
virtual
63+
override
64+
{}
3865

3966
function onChanOpenConfirm(string calldata portId, string calldata channelId) external virtual override {}
4067

‎contracts/core/CrossSimpleModule.sol‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ import "./SimpleContractRegistry.sol";
77
import "./IBCKeeper.sol";
88

99
contract CrossSimpleModule is CrossModule, SimpleContractRegistry, TxAtomicSimple {
10-
11-
constructor(IBCHandler ibcHandler_, IContractModule module, bool debugMode) CrossModule(ibcHandler_) public {
10+
constructor(IBCHandler ibcHandler_, IContractModule module, bool debugMode) public CrossModule(ibcHandler_) {
1211
if (debugMode) {
1312
_setupRole(IBC_ROLE, _msgSender());
1413
}
@@ -17,7 +16,11 @@ contract CrossSimpleModule is CrossModule, SimpleContractRegistry, TxAtomicSimpl
1716

1817
// debug for serialization
1918

20-
function getPacketAcknowledgementCall(PacketAcknowledgementCall.CommitStatus status) public pure returns (bytes memory acknowledgement) {
19+
function getPacketAcknowledgementCall(PacketAcknowledgementCall.CommitStatus status)
20+
public
21+
pure
22+
returns (bytes memory acknowledgement)
23+
{
2124
PacketAcknowledgementCall.Data memory ack;
2225
ack.status = status;
2326
return packPacketAcknowledgementCall(ack);

‎contracts/core/PacketHandler.sol‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ import "@hyperledger-labs/yui-ibc-solidity/contracts/core/04-channel/IBCChannel.
55

66
// PacketHandler is a handler that handles a packet and acknowledgement
77
abstract contract PacketHandler {
8-
function handlePacket(Packet.Data memory packet) virtual internal returns (bytes memory acknowledgement);
9-
function handleAcknowledgement(Packet.Data memory packet, bytes memory acknowledgement) virtual internal;
8+
function handlePacket(Packet.Data memory packet) internal virtual returns (bytes memory acknowledgement);
9+
function handleAcknowledgement(Packet.Data memory packet, bytes memory acknowledgement) internal virtual;
1010
}

‎contracts/core/SimpleContractRegistry.sol‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,15 @@ import "@hyperledger-labs/yui-ibc-solidity/contracts/core/04-channel/IBCChannel.
77

88
// SimpleContractRegistry is a simple registry that implements ContractRegistry
99
abstract contract SimpleContractRegistry is ContractRegistry {
10-
1110
// it keeps only one module.
1211
IContractModule contractModule;
1312

14-
function registerModule(IContractModule module) virtual internal override {
13+
function registerModule(IContractModule module) internal virtual override {
1514
require(address(contractModule) == address(0), "contractModule is already initialized");
1615
contractModule = module;
1716
}
1817

19-
function getModule(Packet.Data memory packet) virtual internal override returns (IContractModule) {
18+
function getModule(Packet.Data memory packet) internal virtual override returns (IContractModule) {
2019
require(address(contractModule) != address(0), "contractModule is not initialized yet");
2120
return contractModule;
2221
}

‎contracts/core/TxAtomicSimple.sol‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
// SPDX-License-Identifier: Apache-2.0
22
pragma solidity ^0.8.9;
33

4-
import {
5-
GoogleProtobufAny as Any
6-
} from "@hyperledger-labs/yui-ibc-solidity/contracts/proto/GoogleProtobufAny.sol";
4+
import {GoogleProtobufAny as Any} from "@hyperledger-labs/yui-ibc-solidity/contracts/proto/GoogleProtobufAny.sol";
75
import "./PacketHandler.sol";
86
import "./ContractRegistry.sol";
97
import "./IContractModule.sol";
@@ -12,24 +10,28 @@ import "../proto/cross/core/atomic/simple/AtomicSimple.sol";
1210

1311
// TxAtomicSimple implements PacketHandler that supports simple-commit protocol
1412
abstract contract TxAtomicSimple is IBCKeeper, PacketHandler, ContractRegistry {
15-
1613
// it's defined at simple-commit protocol
17-
uint8 constant private txIndexParticipant = 1;
14+
uint8 private constant txIndexParticipant = 1;
1815

1916
event OnContractCall(bytes tx_id, uint8 tx_index, bool success, bytes ret);
2017

21-
function handlePacket(Packet.Data memory packet) virtual internal override returns (bytes memory acknowledgement) {
18+
function handlePacket(Packet.Data memory packet) internal virtual override returns (bytes memory acknowledgement) {
2219
IContractModule module = getModule(packet);
2320

2421
PacketData.Data memory pd = PacketData.decode(packet.data);
2522
require(pd.payload.length != 0, "decoding error");
2623
Any.Data memory anyPayload = Any.decode(pd.payload);
2724
// TODO should be more gas efficient
28-
require(sha256(bytes(anyPayload.type_url)) == sha256(bytes("/cross.core.atomic.simple.PacketDataCall")), "got unexpected type_url");
25+
require(
26+
sha256(bytes(anyPayload.type_url)) == sha256(bytes("/cross.core.atomic.simple.PacketDataCall")),
27+
"got unexpected type_url"
28+
);
2929
PacketDataCall.Data memory pdc = PacketDataCall.decode(anyPayload.value);
3030

3131
PacketAcknowledgementCall.Data memory ack;
32-
try getModule(packet).onContractCall(CrossContext(pdc.tx_id, txIndexParticipant, pdc.tx.signers), pdc.tx.call_info) returns (bytes memory ret) {
32+
try getModule(packet).onContractCall(
33+
CrossContext(pdc.tx_id, txIndexParticipant, pdc.tx.signers), pdc.tx.call_info
34+
) returns (bytes memory ret) {
3335
ack.status = PacketAcknowledgementCall.CommitStatus.COMMIT_STATUS_OK;
3436
emit OnContractCall(pdc.tx_id, txIndexParticipant, true, ret);
3537
} catch (bytes memory) {
@@ -40,20 +42,22 @@ abstract contract TxAtomicSimple is IBCKeeper, PacketHandler, ContractRegistry {
4042
return packPacketAcknowledgementCall(ack);
4143
}
4244

43-
function handleAcknowledgement(Packet.Data memory packet, bytes memory acknowledgement) virtual internal override {
45+
function handleAcknowledgement(Packet.Data memory packet, bytes memory acknowledgement) internal virtual override {
4446
revert("not implemented error");
4547
}
4648

47-
function packPacketAcknowledgementCall(PacketAcknowledgementCall.Data memory ack) internal pure returns (bytes memory) {
49+
function packPacketAcknowledgementCall(PacketAcknowledgementCall.Data memory ack)
50+
internal
51+
pure
52+
returns (bytes memory)
53+
{
4854
HeaderField.Data[] memory fields;
4955
return Acknowledgement.encode(
5056
Acknowledgement.Data({
5157
is_success: true,
5258
result: PacketData.encode(
5359
PacketData.Data({
54-
header: Header.Data({
55-
fields: fields
56-
}),
60+
header: Header.Data({fields: fields}),
5761
payload: Any.encode(
5862
Any.Data({
5963
type_url: "/cross.core.atomic.simple.PacketAcknowledgementCall",

‎contracts/example/MockCrossContract.sol‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ import "../core/IContractModule.sol";
55
import "../proto/cross/core/auth/Auth.sol";
66

77
contract MockCrossContract is IContractModule {
8-
function onContractCall(CrossContext calldata context, bytes calldata callInfo) external override returns (bytes memory) {
8+
function onContractCall(CrossContext calldata context, bytes calldata callInfo)
9+
external
10+
override
11+
returns (bytes memory)
12+
{
913
require(context.signers.length == 1, "signers length must be 1");
1014
require(context.signers[0].auth_type.mode == AuthType.AuthMode.AUTH_MODE_CHANNEL, "auth mode must be CHANNEL");
1115
require(keccak256(context.signers[0].id) == keccak256(abi.encodePacked("tester")), "unexpected account ID");

0 commit comments

Comments
 (0)