@coti-io/coti-contracts 1.2.0 → 1.3.1

package/contracts/pod/IInboxMiner.sol

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "./IInbox.sol";
+
+/// @title IInboxMiner
+/// @notice Miner API: apply mined cross-chain payloads to this chain's inbox and withdraw fees.
+interface IInboxMiner {
+    error RetryFailedRequestNotAFailedRequest();
+    error RequestIdRequired();
+    error RetryFailedRequestExecutionFailed(bytes returnData);
+    /// @notice The `sourceChainId` passed to {batchProcessRequests} is this chain's own id.
+    error SourceChainIsThisChain(uint256 chainId);
+    /// @notice A mined request's encoded source chain does not match the batch `sourceChainId`.
+    error RequestSourceChainMismatch(bytes32 requestId, uint256 expectedSourceChainId, uint256 actualSourceChainId);
+    /// @notice A mined request's encoded target chain is not this chain.
+    error RequestTargetChainMismatch(bytes32 requestId, uint256 expectedTargetChainId, uint256 actualTargetChainId);
+    /// @notice Inbound message processing is paused (circuit breaker).
+    error MessageProcessingPaused();
+
+    /// @notice Emitted when {retryFailedRequest} successfully re-executes a previously failed incoming request.
+    event RetryFailedRequestSuccess(bytes32 indexed requestId);
+    /// @notice Emitted when the owner toggles the message-processing circuit breaker.
+    event MessageProcessingPausedUpdated(bool paused);
+
+    /// @notice Mined inbound request. `targetFee` and `callerFee` are gas unit budgets (see {IInbox.Request}).
+    struct MinedRequest {
+        bytes32 requestId;
+        address sourceContract;
+        address targetContract;
+        IInbox.MpcMethodCall methodCall;
+        bytes4 callbackSelector;
+        bytes4 errorSelector;
+        bool isTwoWay;
+        bytes32 sourceRequestId;
+        uint256 targetFee;
+        uint256 callerFee;
+    }
+
+    /// @notice Validate and execute a batch of mined requests from `sourceChainId`.
+    /// @param sourceChainId Chain that produced the mined data.
+    /// @param mined Ordered requests to apply.
+    function batchProcessRequests(uint256 sourceChainId, MinedRequest[] memory mined) external;
+
+    /// @notice Withdraw accumulated native token fees to `to` (owner-only in concrete implementations).
+    function collectFees(address payable to) external;
+
+    /// @notice Pause or unpause inbound message processing (owner-only circuit breaker).
+    function setMessageProcessingPaused(bool paused) external;
+
+    /// @notice Re-execute a mined incoming request whose target call failed (e.g. OOG). Open to any payer for gas.
+    function retryFailedRequest(bytes32 requestId) external;
+}

package/contracts/pod/InboxUser.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "./IInbox.sol";
+
+/// @title InboxUser
+/// @notice Mixin that restricts selected functions to the configured {IInbox} and exposes `inbox`.
+abstract contract InboxUser {
+    /// @notice Cross-chain inbox used for messaging.
+    IInbox public inbox;
+
+    /// @notice Caller is not the configured inbox.
+    error OnlyInbox(address caller);
+
+    /// @notice Restrict a function to the configured inbox.
+    /// @dev Reverts unless `msg.sender` is the configured inbox.
+    modifier onlyInbox() {
+        if (msg.sender != address(inbox)) {
+            revert OnlyInbox(msg.sender);
+        }
+        _;
+    }
+
+    /// @notice Set the inbox contract (typically once from a constructor or initializer).
+    /// @param _inbox Inbox address.
+    function setInbox(address _inbox) internal {
+        inbox = IInbox(_inbox);
+    }
+}

package/contracts/pod/InboxUserCotiTestnet.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "./InboxUser.sol";
+import "./PodNetworkConstants.sol";
+
+/// @title InboxUserCotiTestnet
+/// @notice Mixin that configures {InboxUser} for COTI testnet inbox address.
+abstract contract InboxUserCotiTestnet is InboxUser {
+    constructor() {
+        setInbox(PodNetworkConstants.COTI_TESTNET_INBOX);
+    }
+}

package/contracts/pod/PodNetworkConstants.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+/// @title PodNetworkConstants
+/// @notice Deployment constants used by chain-specific PoD dapp helper contracts.
+library PodNetworkConstants {
+    /// @notice Deterministic inbox address shared by every chain (CreateX CREATE3 deploy).
+    /// @dev Same value on Sepolia, COTI testnet, and Avalanche Fuji because the CREATE3 address
+    /// depends only on the deployer EOA and salt (see scripts/createx.ts).
+    address internal constant INBOX = 0xAb625bE229F603f6BBF964474AFf6d5487e364De;
+
+    /// @notice Source-chain inbox used by PoD dapps on Sepolia.
+    address internal constant SEPOLIA_INBOX = INBOX;
+
+    /// @notice Avalanche Fuji chain id used as a source chain paired with COTI testnet.
+    uint256 internal constant AVALANCHE_FUJI_CHAIN_ID = 43113;
+
+    /// @notice Source-chain inbox used by PoD dapps on Avalanche Fuji.
+    address internal constant AVALANCHE_FUJI_INBOX = INBOX;
+
+    /// @notice COTI testnet chain id used for remote MPC execution.
+    uint256 internal constant COTI_TESTNET_CHAIN_ID = 7082400;
+
+    /// @notice COTI-side MPC executor paired with source-chain PoD dapps.
+    /// @dev Redeploy and update this after the deterministic inbox redeploy on COTI.
+    address internal constant COTI_TESTNET_MPC_EXECUTOR = 0xC76aaE4F3810fBBd5d96b92DEFeBE0034405Ad9c;
+
+    /// @notice COTI testnet inbox used by COTI-side dapps.
+    address internal constant COTI_TESTNET_INBOX = INBOX;
+}

package/contracts/pod/examples/MpcAdder.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "../../utils/mpc/MpcCore.sol";
+
+import "../mpc/PodLib.sol";
+import "../mpc/PodLibBase.sol";
+
+/// @title MpcAdder
+/// @notice Example dApp: 64-bit encrypted add over the inbox using {PodLib}.
+contract MpcAdder is PodLib {
+    event AddRequest(bytes32 requestId);
+
+    ctUint64 private _result;
+
+    /// @notice Create an MPC adder bound to an inbox.
+    /// @param _inbox The inbox contract address.
+    constructor(address _inbox) PodLibBase(msg.sender) {
+        setInbox(_inbox);
+    }
+
+    /// @notice Send an MPC add request using encrypted inputs.
+    /// @param a Encrypted input a (itUint64).
+    /// @param b Encrypted input b (itUint64).
+    /// @param callbackFeeLocalWei Wei slice for callback leg; total inbox payment is `msg.value`.
+    function add(itUint64 calldata a, itUint64 calldata b, uint256 callbackFeeLocalWei) external payable {
+        bytes32 requestId = add64(
+            a,
+            b,
+            msg.sender,
+            MpcAdder.receiveC.selector,
+            PodLibBase.onDefaultMpcError.selector,
+            msg.value,
+            callbackFeeLocalWei
+        );
+        emit AddRequest(requestId);
+    }
+
+    /// @notice Receive the response and store the ciphertext result.
+    /// @param data The response payload containing the ciphertext.
+    function receiveC(bytes memory data) external virtual onlyMpcExecutor {
+        _receiveResult(data);
+    }
+
+    /// @dev Allows {MpcAdderPausable} to gate delivery without duplicating storage.
+    function _receiveResult(bytes memory data) internal virtual {
+        _result = abi.decode(data, (ctUint64));
+    }
+
+    /// @notice Return the last received ciphertext result.
+    function resultCiphertext() external view returns (ctUint64) {
+        return _result;
+    }
+}
+
+
+

package/contracts/pod/examples/MpcAdderPausable.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "@openzeppelin/contracts/utils/Pausable.sol";
+
+import "./MpcAdder.sol";
+
+/// @title MpcAdderPausable
+/// @notice Same as {MpcAdder}, but `receiveC` reverts while paused (simulates callback failure until unpaused).
+contract MpcAdderPausable is MpcAdder, Pausable {
+    constructor(address _inbox) MpcAdder(_inbox) {}
+
+    /// @inheritdoc MpcAdder
+    function receiveC(bytes memory data) external override onlyMpcExecutor whenNotPaused {
+        _receiveResult(data);
+    }
+
+    function pause() external onlyOwner {
+        _pause();
+    }
+
+    function unpause() external onlyOwner {
+        _unpause();
+    }
+}

package/contracts/pod/examples/MpcAdderPausable.sol.bak

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "@openzeppelin/contracts/utils/Pausable.sol";
+
+import "./MpcAdder.sol";
+
+/// @title MpcAdderPausable
+/// @notice Same as {MpcAdder}, but `receiveC` reverts while paused (simulates callback failure until unpaused).
+contract MpcAdderPausable is MpcAdder, Pausable {
+    constructor(address _inbox) MpcAdder(_inbox) {}
+
+    /// @inheritdoc MpcAdder
+    function receiveC(bytes memory data) external override onlyInbox whenNotPaused {
+        _receiveResult(data);
+    }
+
+    function pause() external onlyOwner {
+        _pause();
+    }
+
+    function unpause() external onlyOwner {
+        _unpause();
+    }
+}

package/contracts/pod/examples/it128/PodAdder128.sol

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "../../../utils/mpc/MpcCore.sol";
+
+import "../../mpc/PodLib.sol";
+import "../../mpc/PodLibBase.sol";
+
+/// @title PodAdder128
+/// @notice Example 128-bit MPC adder using {PodLib}.
+contract PodAdder128 is PodLib {
+    event AddRequest(bytes32 requestId);
+
+    ctUint128 private _result;
+
+    /// @notice Create an MPC adder bound to an inbox.
+    /// @param _inbox The inbox contract address.
+    constructor(address _inbox) PodLibBase(msg.sender) {
+        setInbox(_inbox);
+    }
+
+    /// @notice Send an MPC add request using encrypted inputs.
+    /// @param a Encrypted input a (itUint128).
+    /// @param b Encrypted input b (itUint128).
+    function add(itUint128 calldata a, itUint128 calldata b, uint256 callbackFeeLocalWei) external payable {
+        bytes32 requestId = add128(
+            a,
+            b,
+            msg.sender,
+            PodAdder128.receiveC.selector,
+            PodLibBase.onDefaultMpcError.selector,
+            msg.value,
+            callbackFeeLocalWei
+        );
+        emit AddRequest(requestId);
+    }
+
+    /// @notice Receive the response and store the ciphertext result.
+    /// @param data The response payload containing the ciphertext.
+    function receiveC(bytes memory data) external onlyInbox {
+        _result = abi.decode(data, (ctUint128));
+    }
+
+    /// @notice Return the last received ciphertext result.
+    function resultCiphertext() external view returns (ctUint128) {
+        return _result;
+    }
+}

package/contracts/pod/examples/it256/PodAdder256.sol

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "../../../utils/mpc/MpcCore.sol";
+
+import "../../mpc/PodLib.sol";
+import "../../mpc/PodLibBase.sol";
+
+/// @title PodAdder256
+/// @notice Example 256-bit MPC adder using {PodLib}.
+contract PodAdder256 is PodLib {
+    event AddRequest(bytes32 requestId);
+
+    ctUint256 private _result;
+
+    /// @notice Create an MPC adder bound to an inbox.
+    /// @param _inbox The inbox contract address.
+    constructor(address _inbox) PodLibBase(msg.sender) {
+        setInbox(_inbox);
+    }
+
+    /// @notice Send an MPC add request using encrypted inputs.
+    /// @param a Encrypted input a (itUint256).
+    /// @param b Encrypted input b (itUint256).
+    function add(itUint256 calldata a, itUint256 calldata b, uint256 callbackFeeLocalWei) external payable {
+        bytes32 requestId = add256(
+            a,
+            b,
+            msg.sender,
+            PodAdder256.receiveC.selector,
+            PodLibBase.onDefaultMpcError.selector,
+            msg.value,
+            callbackFeeLocalWei
+        );
+        emit AddRequest(requestId);
+    }
+
+    /// @notice Receive the response and store the ciphertext result.
+    /// @param data The response payload containing the ciphertext.
+    function receiveC(bytes memory data) external onlyInbox {
+        _result = abi.decode(data, (ctUint256));
+    }
+
+    /// @notice Return the last received ciphertext result.
+    function resultCiphertext() external view returns (ctUint256 memory) {
+        return _result;
+    }
+}

package/contracts/pod/fee/IInboxFeeManager.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.20;
+
+/// @title IInboxFeeManager
+/// @notice Read-only fee estimation surface exposed by inbox contracts for PoD dapps.
+interface IInboxFeeManager {
+    /// @notice Template for minimum fees in gas units.
+    struct FeeConfig {
+        uint256 constantFee;
+        uint256 gasPerByte;
+        uint256 callbackExecutionGas;
+        uint256 errorLength;
+        uint256 bufferRatioX10000;
+    }
+
+    /// @notice Oracle used to convert gas budgets between local and remote fee tokens.
+    function priceOracle() external view returns (address);
+
+    /// @notice Minimum fee template for the local callback leg.
+    function localMinFeeConfig() external view returns (FeeConfig memory);
+
+    /// @notice Minimum fee template for the remote execution leg.
+    function remoteMinFeeConfig() external view returns (FeeConfig memory);
+
+    /// @notice Estimate the local-token wei required for a two-way message.
+    /// @param remoteMethodCallSize Remote calldata size term.
+    /// @param callBackMethodCallSize Callback calldata size term.
+    /// @param remoteMethodExecutionGas Remote execution gas term.
+    /// @param callBackMethodExecutionGas Callback execution gas term.
+    /// @param gasPrice Wei per gas assumption.
+    /// @return targetFeeLocalWei Local-token wei estimated for the remote execution leg.
+    /// @return callerFeeLocalWei Local-token wei estimated for the callback leg.
+    function calculateTwoWayFeeRequiredInLocalToken(
+        uint256 remoteMethodCallSize,
+        uint256 callBackMethodCallSize,
+        uint256 remoteMethodExecutionGas,
+        uint256 callBackMethodExecutionGas,
+        uint256 gasPrice
+    ) external view returns (uint256 targetFeeLocalWei, uint256 callerFeeLocalWei);
+}

package/contracts/pod/manifest.json

@@ -0,0 +1,52 @@
+{
+  "generatedAt": "2026-06-28T23:14:27Z",
+  "source": "/Users/ith/nk/pod-mpc-lib/contracts",
+  "target": "/Users/ith/nk/coti-contracts/contracts/pod",
+  "files": [
+    "examples/it128/PodAdder128.sol",
+    "examples/it256/PodAdder256.sol",
+    "examples/MpcAdder.sol",
+    "examples/MpcAdderPausable.sol",
+    "fee/IInboxFeeManager.sol",
+    "IInbox.sol",
+    "IInboxMiner.sol",
+    "InboxUser.sol",
+    "InboxUserCotiTestnet.sol",
+    "mpc/coti-side/IPodExecutorOps.sol",
+    "mpc/PodLib.sol",
+    "mpc/PodLib128.sol",
+    "mpc/PodLib256.sol",
+    "mpc/PodLib64.sol",
+    "mpc/PodLibBase.sol",
+    "mpc/PodUser.sol",
+    "mpc/PodUserFuji.sol",
+    "mpc/PodUserSepolia.sol",
+    "mpccodec/MpcAbiCodec.sol",
+    "PodNetworkConstants.sol",
+    "privacy/IPrivacyPortal.sol",
+    "privacy/PrivacyPortal.sol",
+    "privacy/PrivacyPortalFactory.sol",
+    "token/erc7984/Erc7984Constants.sol",
+    "token/erc7984/Erc7984Pointers.sol",
+    "token/erc7984/IERC7984.sol",
+    "token/erc7984/IERC7984PortalWrapper.sol",
+    "token/erc7984/PodErc7984Mixin.sol",
+    "token/erc7984/README.md",
+    "token/perc20/cotiside/IPodErc20CotiSide.sol",
+    "token/perc20/cotiside/PodErc20CotiMother.sol",
+    "token/perc20/IPodERC20.sol",
+    "token/perc20/PodERC20.sol",
+    "token/perc20/PodErc20Mintable.sol",
+    "token/perc20/PodErc20MintableInitializable.sol",
+    "utils/IWrappedNative.sol"
+  ],
+  "externalImports": [
+    "utils/mpc/MpcCore.sol",
+    "utils/mpc/MpcInterface.sol"
+  ],
+  "notes": [
+    "MpcCore.sol and MpcInterface.sol live at contracts/utils/mpc/ in coti-contracts.",
+    "OpenZeppelin imports are unchanged (@openzeppelin/contracts).",
+    "Indexers/relayers: use getRequest(requestId) for full inbox payloads (compact MessageSent logs)."
+  ]
+}

package/contracts/pod/mpc/PodLib.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.20;
+
+import "./PodLib64.sol";
+import "./PodLib128.sol";
+import "./PodLib256.sol";
+
+/// @title PodLib
+/// @notice Combined 64-, 128-, and 256-bit POD MPC helpers (linearized via {PodLib64}, {PodLib128}, {PodLib256}).
+abstract contract PodLib is PodLib64, PodLib128, PodLib256 {}