ORMPUpgradeablePort

SUPPORTED.md

@@ -1,7 +1,8 @@
 ## Canonical Cross-chain Deployment Addresses
-| Port     |   Name  |  Canonical Cross-chain Deployment Address  |
-|----------|---------|--------------------------------------------|
-| ORMPPort |   ORMP  | 0x0000000005d961F950adA391C1511c92bbc64D9F |
+| Port                            |   Name     |  Canonical Cross-chain Deployment Address  |
+|---------------------------------|------------|--------------------------------------------|
+| ORMPPort                        |   ORMP     | 0x0000000005d961F950adA391C1511c92bbc64D9F |
+| ORMPUpgradeableAndRetryablePort |   ORMP-UR  | 0x000000000EA450D971d3A68c754Fb5C212d3101b |
 
 ## Supported Chains
 ### Mainnet

bin/config.sh

@@ -15,15 +15,21 @@ get_uri() {
 # forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[11155111,44]"     $uri --chain-id 421614   --broadcast --skip-simulation --legacy
 # forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[44,421614]"       $uri --chain-id 11155111 --broadcast
 
-export PORT_KEY="MULTIPORT_ADDR"
-uri=$(get_uri "QmQsKZG4SSbqZ12a1VpZRsURrHbRe5mVbZZQ7GmLs42ZRN")
-forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[421614,11155111]" $uri --chain-id 43       --broadcast -g 200
-forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[11155111,44]"     $uri --chain-id 421614   --broadcast --skip-simulation --legacy
+export PORT_KEY="ORMPURPORT_ADDR"
+uri=$(get_uri "QmX8rYZP1u5paFfJdaEe75DLdZXmjs8FSkC7mrN6vefc32")
+# forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[421614,11155111]" $uri --chain-id 43       --broadcast -g 200
+forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[11155111,44]"     $uri --chain-id 421614   --broadcast --skip-simulation
 forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[44,421614]"       $uri --chain-id 11155111 --broadcast
 
-forge script script/config/MultiPortConfig.s.sol:MultiPortConfig --chain-id 43       --broadcast -g 200
-forge script script/config/MultiPortConfig.s.sol:MultiPortConfig --chain-id 421614   --broadcast --skip-simulation --legacy
-forge script script/config/MultiPortConfig.s.sol:MultiPortConfig --chain-id 11155111 --broadcast
+# export PORT_KEY="MULTIPORT_ADDR"
+# uri=$(get_uri "QmQsKZG4SSbqZ12a1VpZRsURrHbRe5mVbZZQ7GmLs42ZRN")
+# forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[421614,11155111]" $uri --chain-id 43       --broadcast -g 200
+# forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[11155111,44]"     $uri --chain-id 421614   --broadcast --skip-simulation --legacy
+# forge script script/config/PortConfig.s.sol:PortConfig --sig "run(uint256[],string)" "[44,421614]"       $uri --chain-id 11155111 --broadcast
+#
+# forge script script/config/MultiPortConfig.s.sol:MultiPortConfig --chain-id 43       --broadcast -g 200
+# forge script script/config/MultiPortConfig.s.sol:MultiPortConfig --chain-id 421614   --broadcast --skip-simulation --legacy
+# forge script script/config/MultiPortConfig.s.sol:MultiPortConfig --chain-id 11155111 --broadcast
 
 export PORT_KEY="XACCOUNTFACTORY_ADDR"
 uri=$(get_uri "QmahfNo9m9TqHUxARhug93Ubzn3HVutfQ9bDAxWq9ksJhy")

bin/deploy.sh

@@ -22,10 +22,16 @@ forge script script/deploy/DeployXAccountFactory.s.sol:DeployXAccountFactory --c
 forge script script/deploy/DeployXAccountFactory.s.sol:DeployXAccountFactory --chain-id 11155111 --broadcast --verify --legacy
 forge script script/deploy/DeployXAccountFactory.s.sol:DeployXAccountFactory --chain-id 43       --broadcast --verify 
 
+# Deploy ormp port on testnet
 # forge script script/deploy/DeployORMPPort.s.sol:DeployORMPPort --chain-id 43       --broadcast --verify --legacy --skip-simulation
 # forge script script/deploy/DeployORMPPort.s.sol:DeployORMPPort --chain-id 421614   --broadcast --verify --legacy --skip-simulation
 # forge script script/deploy/DeployORMPPort.s.sol:DeployORMPPort --chain-id 11155111 --broadcast --verify --legacy
 
+# Deploy ormp-ur port on testnet
+# forge script script/deploy/DeployORMPURPort.s.sol:DeployORMPURPort --chain-id 43       --broadcast --verify --legacy 
+# forge script script/deploy/DeployORMPURPort.s.sol:DeployORMPURPort --chain-id 421614   --broadcast --verify --legacy --skip-simulation
+# forge script script/deploy/DeployORMPURPort.s.sol:DeployORMPURPort --chain-id 11155111 --broadcast --verify --legacy
+
 # forge script script/deploy/DeployORMPPort.s.sol:DeployORMPPort --chain-id 1     --broadcast --verify --slow
 # forge script script/deploy/DeployORMPPort.s.sol:DeployORMPPort --chain-id 44    --broadcast --verify --slow
 # forge script script/deploy/DeployORMPPort.s.sol:DeployORMPPort --chain-id 46    --broadcast --verify --slow

script/deploy/DeployORMPPort.s.sol → script/deploy/DeployORMPUPort.s.sol

@@ -7,15 +7,15 @@ import {console2 as console} from "forge-std/console2.sol";
 import {Common} from "create3-deploy/script/Common.s.sol";
 import {ScriptTools} from "create3-deploy/script/ScriptTools.sol";
 
-import "../../src/ports/ORMPPort.sol";
+import "../../src/ports/ORMPUpgradeablePort.sol";
 
 interface III {
     function owner() external view returns (address);
     function transferOwnership(address newOwner) external;
     function pendingOwner() external view returns (address);
 }
 
-contract DeployORMPPort is Common {
+contract DeployORMPUPort is Common {
     using stdJson for string;
     using ScriptTools for string;
 
@@ -31,7 +31,7 @@ contract DeployORMPPort is Common {
     address dao;
 
     function name() public pure override returns (string memory) {
-        return "DeployORMPPort";
+        return "DeployORMPUPort";
     }
 
     function setUp() public override {
@@ -42,8 +42,8 @@ contract DeployORMPPort is Common {
         config = ScriptTools.readInput(instanceId);
         c3 = ScriptTools.readInput("../c3");
         ORMP = c3.readAddress(".ORMP_ADDR");
-        ADDR = c3.readAddress(".ORMPPORT_ADDR");
-        SALT = c3.readBytes32(".ORMPPORT_SALT");
+        ADDR = c3.readAddress(".ORMPUPORT_ADDR");
+        SALT = c3.readBytes32(".ORMPUPORT_SALT");
 
         deployer = config.readAddress(".DEPLOYER");
         dao = config.readAddress(".DAO");
@@ -61,12 +61,12 @@ contract DeployORMPPort is Common {
 
     function deploy() public broadcast returns (address) {
         string memory name_ = config.readString(".metadata.name");
-        bytes memory byteCode = type(ORMPPort).creationCode;
+        bytes memory byteCode = type(ORMPUpgradeablePort).creationCode;
         bytes memory initCode = bytes.concat(byteCode, abi.encode(deployer, ORMP, name_));
         address port = _deploy3(SALT, initCode);
         require(port == ADDR, "!addr");
         require(III(ADDR).owner() == deployer);
-        console.log("ORMPPort deployed: %s", port);
+        console.log("ORMPUpgradeablePort deployed: %s", port);
         return port;
     }
 

script/deploy/DeployORMPURPort.s.sol

@@ -0,0 +1,78 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.17;
+
+import {stdJson} from "forge-std/StdJson.sol";
+import {Script} from "forge-std/Script.sol";
+import {console2 as console} from "forge-std/console2.sol";
+import {Common} from "create3-deploy/script/Common.s.sol";
+import {ScriptTools} from "create3-deploy/script/ScriptTools.sol";
+
+import "../../src/ports/ORMPUpgradeableAndRetryablePort.sol";
+
+interface III {
+    function owner() external view returns (address);
+    function transferOwnership(address newOwner) external;
+    function pendingOwner() external view returns (address);
+}
+
+contract DeployORMPURPort is Common {
+    using stdJson for string;
+    using ScriptTools for string;
+
+    address ORMP;
+    address ADDR;
+    bytes32 SALT;
+
+    string c3;
+    string config;
+    string instanceId;
+    string outputName;
+    address deployer;
+    address dao;
+
+    function name() public pure override returns (string memory) {
+        return "DeployORMPURPort";
+    }
+
+    function setUp() public override {
+        super.setUp();
+
+        instanceId = vm.envOr("INSTANCE_ID", string("deploy_ormp_ur_port.c"));
+        outputName = "deploy_ormp_ur_port.a";
+        config = ScriptTools.readInput(instanceId);
+        c3 = ScriptTools.readInput("../c3");
+        ORMP = c3.readAddress(".ORMP_ADDR");
+        ADDR = c3.readAddress(".ORMPURPORT_ADDR");
+        SALT = c3.readBytes32(".ORMPURPORT_SALT");
+
+        deployer = config.readAddress(".DEPLOYER");
+        dao = config.readAddress(".DAO");
+    }
+
+    function run() public {
+        require(deployer == msg.sender, "!deployer");
+
+        deploy();
+        // setConfig();
+
+        ScriptTools.exportContract(outputName, "DAO", dao);
+        ScriptTools.exportContract(outputName, "ORMPUR_PORT", ADDR);
+    }
+
+    function deploy() public broadcast returns (address) {
+        string memory name_ = config.readString(".metadata.name");
+        bytes memory byteCode = type(ORMPUpgradeableAndRetryablePort).creationCode;
+        bytes memory initCode = bytes.concat(byteCode, abi.encode(deployer, ORMP, name_));
+        address port = _deploy3(SALT, initCode);
+        require(port == ADDR, "!addr");
+        require(III(ADDR).owner() == deployer);
+        console.log("ORMPUpgradeableAndRetryablePort deployed: %s", port);
+        return port;
+    }
+
+    function setConfig() public broadcast {
+        III(ADDR).transferOwnership(dao);
+        require(III(ADDR).pendingOwner() == dao, "!dao");
+        // TODO:: dao.acceptOwnership()
+    }
+}

script/input/11155111/deploy_ormp_ur_port.c.json

@@ -0,0 +1,7 @@
+{
+  "DAO": "0x0f14341A7f464320319025540E8Fe48Ad0fe5aec",
+  "DEPLOYER": "0x0f14341A7f464320319025540E8Fe48Ad0fe5aec",
+  "metadata": {
+    "name": "ORMP-UR"
+  }
+}

script/input/421614/deploy_ormp_ur_port.c.json

@@ -0,0 +1,7 @@
+{
+  "DAO": "0x0f14341A7f464320319025540E8Fe48Ad0fe5aec",
+  "DEPLOYER": "0x0f14341A7f464320319025540E8Fe48Ad0fe5aec",
+  "metadata": {
+    "name": "ORMP-UR"
+  }
+}

script/input/43/deploy_ormp_ur_port.c.json

@@ -0,0 +1,7 @@
+{
+  "DAO": "0x0f14341A7f464320319025540E8Fe48Ad0fe5aec",
+  "DEPLOYER": "0x0f14341A7f464320319025540E8Fe48Ad0fe5aec",
+  "metadata": {
+    "name": "ORMP-UR"
+  }
+}

script/input/c3.json

@@ -6,6 +6,8 @@
   "PORTREGISTRY_SALT": "0x09b30e96d39e3a44a10fb03ee7f325b13af3b681afd2bbe4c87e23cbbeabd26f",
   "ORMPPORT_ADDR": "0x0000000005d961F950adA391C1511c92bbc64D9F",
   "ORMPPORT_SALT": "0xe9cab07c7534f6d34500c7fc83b0d4205012e3e7cc3c1cf1d74f67858d413740",
+  "ORMPURPORT_ADDR": "0x000000000EA450D971d3A68c754Fb5C212d3101b",
+  "ORMPURPORT_SALT": "0x6da6ca9d7ad25e6d11f456555cdb5b4bc167bbe4788d32b39d547daccdaf24b8",
   "MULTIPORT_ADDR": "0x000002C33f83AE045d5EBB8972F09674379e6A31",
   "MULTIPORT_SALT": "0xc6935a1d5d0b9a995e68ffe1151c3c05162d221283fbd8083888e169b43792f2",
   "SAFEMSGPORTMODULE_ADDR": "0x000080fc9c29c366DC8c1C656846E277BA7b6cB9",

script/output/11155111/deploy_ormp_ur_port.a-latest.json

@@ -0,0 +1,4 @@
+{
+  "DAO": "0x0f14341A7f464320319025540E8Fe48Ad0fe5aec",
+  "ORMPUR_PORT": "0x000000000EA450D971d3A68c754Fb5C212d3101b"
+}

script/output/421614/deploy_ormp_ur_port.a-latest.json

@@ -0,0 +1,4 @@
+{
+  "DAO": "0x0f14341A7f464320319025540E8Fe48Ad0fe5aec",
+  "ORMPUR_PORT": "0x000000000EA450D971d3A68c754Fb5C212d3101b"
+}

script/output/43/deploy_ormp_ur_port.a-latest.json

@@ -0,0 +1,4 @@
+{
+  "DAO": "0x0f14341A7f464320319025540E8Fe48Ad0fe5aec",
+  "ORMPUR_PORT": "0x000000000EA450D971d3A68c754Fb5C212d3101b"
+}

script/test/ORMPPort.t.sol

@@ -7,22 +7,22 @@ import "ORMP/src/ORMP.sol";
 import "ORMP/src/interfaces/IORMP.sol";
 import "ORMP/src/UserConfig.sol";
 
-import "../../src/ports/ORMPPort.sol";
+import "../../src/ports/ORMPUpgradeablePort.sol";
 import "../../src/ports/base/FromPortLookup.sol";
 
 contract ORMPPortTest is Test {
     using Chains for uint256;
 
-    ORMPPort ormpPort;
+    ORMPUpgradeablePort ormpPort;
     address dao;
     address ormpProtocol;
 
     function setUp() public {
         uint256 chainId = Chains.Darwinia;
         vm.createSelectFork(chainId.toChainName());
         dao = address(0x1);
-        ormpProtocol = address(0x00000000001523057a05d6293C1e5171eE33eE0A);
-        ormpPort = new ORMPPort(dao, vm.envOr("ORMP_ADDRESS", address(ormpProtocol)), "ORMP");
+        ormpProtocol = vm.envOr("ORMP_ADDRESS", 0x00000000001523057a05d6293C1e5171eE33eE0A);
+        ormpPort = new ORMPUpgradeablePort(dao, vm.envOr("ORMP_ADDRESS", ormpProtocol), "ORMP");
     }
 
     function testSetUri() public {
@@ -38,14 +38,14 @@ contract ORMPPortTest is Test {
 
     function testSetAppConfig() public {
         vm.prank(dao);
-        ormpPort.setAppConfig(address(0x2), address(0x3));
+        ormpPort.setAppConfig(ormpProtocol, address(0x2), address(0x3));
         UC memory uc = IORMP(vm.envOr("ORMP_ADDRESS", address(ormpProtocol))).getAppConfig(address(ormpPort));
         assertEq(uc.oracle, address(0x2));
         assertEq(uc.relayer, address(0x3));
         // Cannot
         vm.expectRevert(bytes("Ownable: caller is not the owner"));
         vm.prank(address(0));
-        ormpPort.setAppConfig(address(0x2), address(0x3));
+        ormpPort.setAppConfig(ormpProtocol, address(0x2), address(0x3));
     }
 
     function testSetPort() public {

src/examples/ExampleRetryableDapp.sol

@@ -0,0 +1,35 @@
+// This file is part of Darwinia.
+// Copyright (C) 2018-2023 Darwinia Network
+// SPDX-License-Identifier: GPL-3.0
+//
+// Darwinia is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Darwinia is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Darwinia. If not, see <https://www.gnu.org/licenses/>.
+
+pragma solidity ^0.8.17;
+
+import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
+import "ORMP/src/Common.sol";
+import "../interfaces/IMessageRetryablePort.sol";
+import "./ExampleReceiverDapp.sol";
+
+contract ExampleRetryableDapp is ExampleReceiverDapp, ReentrancyGuard {
+    constructor(address port, address dapp) ExampleReceiverDapp(port, dapp) {}
+
+    function retry(bytes calldata failedMessage) external payable {
+        IMessageRetryablePort(PORT).retry(failedMessage);
+    }
+
+    function clear(bytes calldata failedMessage) external {
+        IMessageRetryablePort(PORT).clear(failedMessage);
+    }
+}

src/interfaces/IMessageRetryablePort.sol

@@ -0,0 +1,23 @@
+// This file is part of Darwinia.
+// Copyright (C) 2018-2023 Darwinia Network
+// SPDX-License-Identifier: GPL-3.0
+//
+// Darwinia is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Darwinia is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Darwinia. If not, see <https://www.gnu.org/licenses/>.
+
+pragma solidity ^0.8.0;
+
+interface IMessageRetryablePort {
+    function retry(bytes calldata failedMessage) external payable;
+    function clear(bytes calldata failedMessage) external;
+}