Merge pull request #17 from datachainlab/def-interface-initiator

feat: IInitiator

Author: YukiTsuchida

.husky/pre-commit

@@ -3,6 +3,4 @@
 
 set -e
 
-npm run fmt:sol
-
-git add -A
+npx lint-staged

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+  "*.sol": ["npm run fmt:sol"]
+}

package.json

@@ -7,7 +7,7 @@
     "postinstall": "husky && forge build",
     "clean": "rm -rf build",
     "test": "forge test -vvv",
-    "lint:sol": "solhint -f table 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'",
+    "lint:sol": "solhint -f table --max-warnings 0 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'",
     "fmt:sol": "forge fmt",
     "coverage:sol": "forge coverage --report lcov"
   },

proto/cross/core/initiator/Initiator.proto

@@ -0,0 +1,77 @@
+syntax = "proto3";
+
+import "google/protobuf/any.proto";
+import "gogoproto/gogo.proto";
+import "ibc/core/client/v1/client.proto";
+import "cross/core/tx/Tx.proto";
+import "cross/core/auth/Auth.proto";
+
+option go_package = "github.com/datachainlab/cross/x/core/initiator/types";
+option (gogoproto.goproto_getters_all) = false;
+
+message MsgInitiateTx {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string chain_id = 1;
+  uint64 nonce    = 2;
+
+  Tx.CommitProtocol commit_protocol = 3;
+
+  repeated ContractTransaction contract_transactions = 4 [(gogoproto.nullable) = false];
+
+  repeated Account signers = 5 [(gogoproto.nullable) = false];
+
+  ibc.core.client.v1.Height timeout_height = 6
+      [(gogoproto.moretags) = "yaml:\"timeout_height\"", (gogoproto.nullable) = false];
+
+  uint64 timeout_timestamp = 7
+      [(gogoproto.moretags) = "yaml:\"timeout_timestamp\""];
+}
+
+message MsgInitiateTxResponse {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  bytes txID = 1 [(gogoproto.casttype) = "github.com/datachainlab/cross/x/core/types.TxID"];
+
+  enum InitiateTxStatus {
+    option (gogoproto.goproto_enum_prefix) = false;
+
+    INITIATE_TX_STATUS_UNKNOWN   = 0;
+    INITIATE_TX_STATUS_PENDING   = 1;
+    INITIATE_TX_STATUS_VERIFIED  = 2;
+  }
+
+  InitiateTxStatus status = 2;
+}
+
+message QuerySelfXCCRequest {}
+
+message QuerySelfXCCResponse {
+  google.protobuf.Any xcc = 1 [(gogoproto.nullable) = true];
+}
+
+message ContractTransaction {
+  option (gogoproto.equal) = false;
+
+  google.protobuf.Any cross_chain_channel = 1 [(gogoproto.nullable) = true];
+  repeated Account signers = 2 [(gogoproto.nullable) = false];
+  bytes call_info = 3 [(gogoproto.casttype) = "github.com/datachainlab/cross/x/core/tx/types.ContractCallInfo"];
+  ReturnValue return_value = 4;
+  repeated Link links = 5 [(gogoproto.nullable) = false];
+}
+
+message Link {
+  uint32 src_index = 1;
+}
+
+message GenesisState {}
+
+message InitiateTxState {
+  option (gogoproto.equal) = false;
+
+  MsgInitiateTxResponse.InitiateTxStatus status = 1;
+
+  MsgInitiateTx msg = 2 [(gogoproto.nullable) = false];
+}

proto/cross/core/tx/Tx.proto

@@ -0,0 +1,58 @@
+syntax = "proto3";
+
+import "gogoproto/gogo.proto";
+import "google/protobuf/any.proto";
+import "ibc/core/client/v1/client.proto";
+import "cross/core/auth/Auth.proto";
+
+option go_package = "github.com/datachainlab/cross/x/core/tx/types";
+option (gogoproto.goproto_getters_all) = false;
+
+message Tx {
+  option (gogoproto.equal) = false;
+
+  bytes id = 1 [(gogoproto.casttype) = "github.com/datachainlab/cross/x/core/types.TxID"];
+
+  enum CommitProtocol {
+    option (gogoproto.goproto_enum_prefix) = false;
+
+    COMMIT_PROTOCOL_UNKNOWN = 0;
+    COMMIT_PROTOCOL_SIMPLE  = 1;
+    COMMIT_PROTOCOL_TPC     = 2;
+  }
+
+  CommitProtocol commit_protocol = 2;
+
+  repeated ResolvedContractTransaction contract_transactions = 3 [(gogoproto.nullable) = false];
+
+  ibc.core.client.v1.Height timeout_height = 4
+      [(gogoproto.moretags) = "yaml:\"timeout_height\"", (gogoproto.nullable) = false];
+
+  uint64 timeout_timestamp = 5
+      [(gogoproto.moretags) = "yaml:\"timeout_timestamp\""];
+}
+
+message ResolvedContractTransaction {
+  option (gogoproto.equal) = false;
+
+  google.protobuf.Any cross_chain_channel = 1 [(gogoproto.nullable) = true];
+  repeated Account signers = 2 [(gogoproto.nullable) = false];
+  bytes call_info = 3 [(gogoproto.casttype) = "ContractCallInfo"];
+  ReturnValue return_value = 4;
+  repeated google.protobuf.Any call_results = 5 [(gogoproto.nullable) = false];
+}
+
+message ReturnValue {
+  bytes value = 1;
+}
+
+message ConstantValueCallResult {
+  google.protobuf.Any cross_chain_channel = 1 [(gogoproto.nullable) = false];
+  bytes k = 2;
+  bytes v = 3;
+}
+
+message ContractCallResult {
+  bytes data = 1;
+  repeated google.protobuf.Any events = 2 [(gogoproto.nullable) = false];
+}

src/core/IInitiator.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {MsgInitiateTx, MsgInitiateTxResponse, QuerySelfXCCResponse} from "../proto/cross/core/initiator/Initiator.sol";
+
+interface IInitiator {
+    event TxInitiated(bytes txId, address indexed proposer);
+
+    function initiateTx(MsgInitiateTx.Data calldata msg_) external returns (MsgInitiateTxResponse.Data memory resp);
+
+    function selfXCC() external view returns (QuerySelfXCCResponse.Data memory resp);
+}

src/proto/cross/core/atomic/simple/AtomicSimple.sol

@@ -1,6 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
-
 import "@hyperledger-labs/yui-ibc-solidity/contracts/proto/ProtoBufRuntime.sol";
 import "@hyperledger-labs/yui-ibc-solidity/contracts/proto/GoogleProtobufAny.sol";
 import "../../auth/Auth.sol";
@@ -599,7 +598,6 @@ library Header {
         if (r.fields.length != 0) {
             for (i = 0; i < r.fields.length; i++) {
                 pointer += ProtoBufRuntime._encode_key(1, ProtoBufRuntime.WireType.LengthDelim, pointer, bs);
-
                 pointer += HeaderField._encode_nested(r.fields[i], pointer, bs);
             }
         }
@@ -1434,7 +1432,6 @@ library PacketDataCallResolvedContractTransaction {
         if (r.signers.length != 0) {
             for (i = 0; i < r.signers.length; i++) {
                 pointer += ProtoBufRuntime._encode_key(2, ProtoBufRuntime.WireType.LengthDelim, pointer, bs);
-
                 pointer += Account._encode_nested(r.signers[i], pointer, bs);
             }
         }
@@ -1449,7 +1446,6 @@ library PacketDataCallResolvedContractTransaction {
         if (r.objects.length != 0) {
             for (i = 0; i < r.objects.length; i++) {
                 pointer += ProtoBufRuntime._encode_key(5, ProtoBufRuntime.WireType.LengthDelim, pointer, bs);
-
                 pointer += GoogleProtobufAny._encode_nested(r.objects[i], pointer, bs);
             }
         }

src/proto/cross/core/auth/Auth.sol

@@ -1,6 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
-
 import "@hyperledger-labs/yui-ibc-solidity/contracts/proto/ProtoBufRuntime.sol";
 import "@hyperledger-labs/yui-ibc-solidity/contracts/proto/GoogleProtobufAny.sol";