feat: add interface contract for FxBridgeLogic (#264)

contract/compile.sh

@@ -26,7 +26,7 @@ echo "===> Compiling contracts"
 [[ ! -d "$project_dir/contract/artifacts" ]] && mkdir -p "$project_dir/contract/artifacts"
 
 # add core contracts
-contracts=(WFXUpgradable FIP20Upgradable ICrossChain IStaking FxBridgeLogicETH FxBridgeLogicBSC FxBridgeLogic)
+contracts=(WFXUpgradable FIP20Upgradable ICrossChain IStaking IFxBridgeLogic)
 contracts_test=(CrossChainTest StakingTest)
 # add 3rd party contracts
 contracts+=(ERC1967Proxy)

solidity/contracts/bridge/IFxBridgeLogic.sol

@@ -0,0 +1,203 @@
+// SPDX-License-Identifier: Apache-2.0
+
+pragma solidity ^0.8.0;
+
+interface IFxBridgeLogic {
+    /* solhint-disable func-name-mixedcase */
+    function state_fxBridgeId() external view returns (bytes32);
+    function state_powerThreshold() external view returns (uint256);
+
+    function state_lastEventNonce() external view returns (uint256);
+    function state_lastOracleSetCheckpoint() external view returns (bytes32);
+    function state_lastOracleSetNonce() external view returns (uint256);
+    function state_lastBatchNonces(
+        address _erc20Address
+    ) external view returns (uint256);
+
+    function bridgeTokens() external view returns (address[] memory);
+    function tokenStatus(
+        address _tokenAddr
+    ) external view returns (TokenStatus memory);
+    function version() external view returns (string memory);
+    function state_lastRefundNonce(uint256 _nonce) external view returns (bool);
+    /* solhint-disable func-name-mixedcase */
+
+    struct TokenStatus {
+        bool isOriginated;
+        bool isActive;
+        bool isExist;
+    }
+
+    struct TransferInfo {
+        uint256 amount;
+        address destination;
+        uint256 fee;
+        address exchange;
+        uint256 minExchange;
+    }
+
+    struct BridgeToken {
+        address addr;
+        string name;
+        string symbol;
+        uint8 decimals;
+    }
+
+    function addBridgeToken(
+        address _tokenAddr,
+        bytes32 _channelIBC,
+        bool _isOriginated
+    ) external returns (bool);
+
+    function pauseBridgeToken(address _tokenAddr) external returns (bool);
+
+    function activeBridgeToken(address _tokenAddr) external returns (bool);
+
+    function updateOracleSet(
+        address[] memory _newOracles,
+        uint256[] memory _newPowers,
+        uint256 _newOracleSetNonce,
+        address[] memory _currentOracles,
+        uint256[] memory _currentPowers,
+        uint256 _currentOracleSetNonce,
+        uint8[] memory _v,
+        bytes32[] memory _r,
+        bytes32[] memory _s
+    ) external;
+
+    function sendToFx(
+        address _tokenContract,
+        bytes32 _destination,
+        bytes32 _targetIBC,
+        uint256 _amount
+    ) external;
+
+    function bridgeCall(
+        string memory _dstChainId,
+        uint256 _gasLimit,
+        address _receiver,
+        address _to,
+        bytes calldata _message,
+        uint256 _value,
+        bytes memory _asset
+    ) external;
+
+    function submitBatch(
+        address[] memory _currentOracles,
+        uint256[] memory _currentPowers,
+        uint8[] memory _v,
+        bytes32[] memory _r,
+        bytes32[] memory _s,
+        uint256[] memory _amounts,
+        address[] memory _destinations,
+        uint256[] memory _fees,
+        uint256[2] memory _nonceArray,
+        address _tokenContract,
+        uint256 _batchTimeout,
+        address _feeReceive
+    ) external;
+
+    function refundBridgeToken(
+        address[] memory _currentOracles,
+        uint256[] memory _currentPowers,
+        uint8[] memory _v,
+        bytes32[] memory _r,
+        bytes32[] memory _s,
+        uint256[2] memory _nonceArray,
+        address _receiver,
+        address[] memory _tokens,
+        uint256[] memory _amounts,
+        uint256 _timeout
+    ) external;
+
+    function transferOwner(
+        address _token,
+        address _newOwner
+    ) external returns (bool);
+
+    /* =============== QUERY FUNCTIONS =============== */
+
+    function lastBatchNonce(
+        address _erc20Address
+    ) external view returns (uint256);
+
+    function checkAssetStatus(address _tokenAddr) external view returns (bool);
+
+    /* ============== HELP FUNCTIONS =============== */
+
+    function makeCheckpoint(
+        address[] memory _oracles,
+        uint256[] memory _powers,
+        uint256 _oracleSetNonce,
+        bytes32 _fxBridgeId
+    ) external pure returns (bytes32);
+
+    function checkOracleSignatures(
+        address[] memory _currentOracles,
+        uint256[] memory _currentPowers,
+        uint8[] memory _v,
+        bytes32[] memory _r,
+        bytes32[] memory _s,
+        bytes32 _theHash,
+        uint256 _powerThreshold
+    ) external pure;
+
+    function pause() external;
+
+    function unpause() external;
+
+    function getBridgeTokenList() external view returns (BridgeToken[] memory);
+
+    function decodeType(
+        bytes memory _asset
+    ) external pure returns (string memory, bytes memory);
+
+    /* =============== EVENTS =============== */
+
+    event TransactionBatchExecutedEvent(
+        uint256 indexed _batchNonce,
+        address indexed _token,
+        uint256 _eventNonce
+    );
+    event SendToFxEvent(
+        address indexed _tokenContract,
+        address indexed _sender,
+        bytes32 indexed _destination,
+        bytes32 _targetIBC,
+        uint256 _amount,
+        uint256 _eventNonce
+    );
+    event AddBridgeTokenEvent(
+        address indexed _tokenContract,
+        string _name,
+        string _symbol,
+        uint8 _decimals,
+        uint256 _eventNonce,
+        bytes32 _channelIBC
+    );
+    event OracleSetUpdatedEvent(
+        uint256 indexed _newOracleSetNonce,
+        uint256 _eventNonce,
+        address[] _oracles,
+        uint256[] _powers
+    );
+    event TransferOwnerEvent(address _token, address _newOwner);
+
+    event BridgeCallEvent(
+        address indexed _sender,
+        address indexed _receiver,
+        address indexed _to,
+        uint256 _eventNonce,
+        string _dstChainId,
+        uint256 _gasLimit,
+        uint256 _value,
+        bytes _message,
+        bytes _asset
+    );
+
+    event RefundTokenExecutedEvent(
+        address indexed _receiver,
+        uint256 indexed _refundNonce,
+        uint256 _eventNonce
+    );
+}