Merge pull request #9 from flare-foundation/0.1.39

Version 0.1.39

Author: fassko

coston/IAssetManager.sol

@@ -163,7 +163,7 @@ interface IAssetManager is
     ) external view returns (CollateralType.Data memory);
 
     /**
-     * Get the list of all available and deprecated tokens used for collateral.
+     * Get the list of all available tokens used for collateral.
      */
     function getCollateralTypes()
         external
@@ -261,14 +261,6 @@ interface IAssetManager is
         string memory _name
     ) external;
 
-    /**
-     * When current pool collateral token contract (WNat) is replaced by the method setPoolWNatCollateralType,
-     * pools don't switch automatically. Instead, the agent must call this method that swaps old WNat tokens for
-     * new ones and sets it for use by the pool.
-     * NOTE: may only be called by the agent vault owner.
-     */
-    function upgradeWNatContract(address _agentVault) external;
-
     ////////////////////////////////////////////////////////////////////////////////////
     // Collateral withdrawal announcement
 
@@ -592,6 +584,25 @@ interface IAssetManager is
         uint256 _collateralReservationId
     ) external;
 
+    /**
+     * The minter can make several mistakes in the underlying payment:
+     * - the payment is too late and is already defaulted before executing
+     * - the payment is too small so executeMinting reverts
+     * - the payment is performed twice
+     * In all of these cases the paid amount ends up on the agent vault's underlying account, but it is not
+     * confirmed and therefore the agent cannot withdraw it without triggering full liquidation (of course
+     * the agent can legally withdraw it once the vault is closed).
+     * This method enables the agent to confirm such payments, converting the deposited amount to agent's
+     * free underlying.
+     * NOTE: may only be called by the agent vault owner.
+     * @param _payment proof of the underlying payment (must have correct payment reference)
+     * @param _collateralReservationId collateral reservation id
+     */
+    function confirmClosedMintingPayment(
+        IPayment.Proof calldata _payment,
+        uint256 _collateralReservationId
+    ) external;
+
     /**
      * If a collateral reservation request exists for more than 24 hours, payment or non-payment proof are no longer
      * available. In this case the agent can call this method, which burns reserved collateral at market price

coston/IAssetManagerEvents.sol

@@ -174,6 +174,16 @@ interface IAssetManagerEvents {
         uint256 reservedAmountUBA
     );
 
+    /**
+     * Emitted when a late or too small payment for an already defaulted or expired minting is confirmed.
+     * It is equivalent to agent performing underlying topup.
+     */
+    event ConfirmedClosedMintingPayment(
+        address indexed agentVault,
+        bytes32 transactionHash,
+        uint256 depositedUBA
+    );
+
     /**
      * Agent performed self minting, either by executing selfMint with underlying deposit or
      * by executing mintFromFreeUnderlying (in this case, `mintFromFreeUnderlying` is true and

coston/ICoreVaultClientSettings.sol

@@ -13,6 +13,10 @@ interface ICoreVaultClientSettings {
         uint256 _transferTimeExtensionSeconds
     ) external;
 
+    function setCoreVaultTransferDefaultPenaltyBIPS(
+        uint256 _transferDefaultPenaltyBIPS
+    ) external;
+
     function setCoreVaultRedemptionFeeBIPS(uint256 _redemptionFeeBIPS) external;
 
     function setCoreVaultMinimumAmountLeftBIPS(
@@ -30,6 +34,11 @@ interface ICoreVaultClientSettings {
         view
         returns (uint256);
 
+    function getCoreVaultTransferDefaultPenaltyBIPS()
+        external
+        view
+        returns (uint256);
+
     function getCoreVaultRedemptionFeeBIPS() external view returns (uint256);
 
     function getCoreVaultMinimumAmountLeftBIPS()

coston2/IAgentVaultsFacet.sol

@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.4 <0.9;
+
+/**
+ * @title IAgentVaultsFacet
+ * @notice Interface for the AgentVaultsFacet contract.
+ */
+interface IAgentVaultsFacet {
+    /**
+     * @notice Emitted when an agent vault is added.
+     * @param agentVaultId The agent vault ID.
+     * @param agentVaultAddress The agent vault address.
+     */
+    event AgentVaultAdded(
+        uint256 indexed agentVaultId,
+        address indexed agentVaultAddress
+    );
+
+    /**
+     * @notice Emitted when an agent vault is removed.
+     * @param agentVaultId The agent vault ID.
+     * @param agentVaultAddress The agent vault address.
+     */
+    event AgentVaultRemoved(
+        uint256 indexed agentVaultId,
+        address indexed agentVaultAddress
+    );
+
+    /**
+     * @notice Reverts if array lengths do not match.
+     */
+    error AgentsVaultsLengthsMismatch();
+
+    /**
+     * @notice Reverts if the agent vault ID is zero.
+     * @param index The index in the input array.
+     */
+    error AgentVaultIdZero(uint256 index);
+
+    /**
+     * @notice Reverts if the agent vault ID is already added.
+     * @param agentVaultId The agent vault ID.
+     */
+    error AgentVaultIdAlreadyAdded(uint256 agentVaultId);
+
+    /**
+     * @notice Reverts if the agent vault address is zero.
+     * @param index The index in the input array.
+     */
+    error AgentVaultAddressZero(uint256 index);
+
+    /**
+     * @notice Reverts if the agent vault address is already added.
+     * @param agentVaultAddress The agent vault address.
+     */
+    error AgentVaultAddressAlreadyAdded(address agentVaultAddress);
+
+    /**
+     * @notice Reverts if the agent vault is invalid.
+     * @param agentVaultId The agent vault ID.
+     */
+    error InvalidAgentVault(uint256 agentVaultId);
+
+    /**
+     * @notice Reverts if the agent is not available.
+     * @param agentVault The agent vault address.
+     */
+    error AgentNotAvailable(address agentVault);
+
+    /**
+     * Returns the list of registered agent vault IDs and their corresponding addresses.
+     * @return _agentVaultIds The list of registered agent vault IDs.
+     * @return _agentVaultAddresses The list of registered agent vault addresses.
+     */
+    function getAgentVaults()
+        external
+        view
+        returns (
+            uint256[] memory _agentVaultIds,
+            address[] memory _agentVaultAddresses
+        );
+}

coston2/IAssetManager.sol

@@ -163,7 +163,7 @@ interface IAssetManager is
     ) external view returns (CollateralType.Data memory);
 
     /**
-     * Get the list of all available and deprecated tokens used for collateral.
+     * Get the list of all available tokens used for collateral.
      */
     function getCollateralTypes()
         external
@@ -261,14 +261,6 @@ interface IAssetManager is
         string memory _name
     ) external;
 
-    /**
-     * When current pool collateral token contract (WNat) is replaced by the method setPoolWNatCollateralType,
-     * pools don't switch automatically. Instead, the agent must call this method that swaps old WNat tokens for
-     * new ones and sets it for use by the pool.
-     * NOTE: may only be called by the agent vault owner.
-     */
-    function upgradeWNatContract(address _agentVault) external;
-
     ////////////////////////////////////////////////////////////////////////////////////
     // Collateral withdrawal announcement
 
@@ -592,6 +584,25 @@ interface IAssetManager is
         uint256 _collateralReservationId
     ) external;
 
+    /**
+     * The minter can make several mistakes in the underlying payment:
+     * - the payment is too late and is already defaulted before executing
+     * - the payment is too small so executeMinting reverts
+     * - the payment is performed twice
+     * In all of these cases the paid amount ends up on the agent vault's underlying account, but it is not
+     * confirmed and therefore the agent cannot withdraw it without triggering full liquidation (of course
+     * the agent can legally withdraw it once the vault is closed).
+     * This method enables the agent to confirm such payments, converting the deposited amount to agent's
+     * free underlying.
+     * NOTE: may only be called by the agent vault owner.
+     * @param _payment proof of the underlying payment (must have correct payment reference)
+     * @param _collateralReservationId collateral reservation id
+     */
+    function confirmClosedMintingPayment(
+        IPayment.Proof calldata _payment,
+        uint256 _collateralReservationId
+    ) external;
+
     /**
      * If a collateral reservation request exists for more than 24 hours, payment or non-payment proof are no longer
      * available. In this case the agent can call this method, which burns reserved collateral at market price

coston2/IAssetManagerEvents.sol

@@ -174,6 +174,16 @@ interface IAssetManagerEvents {
         uint256 reservedAmountUBA
     );
 
+    /**
+     * Emitted when a late or too small payment for an already defaulted or expired minting is confirmed.
+     * It is equivalent to agent performing underlying topup.
+     */
+    event ConfirmedClosedMintingPayment(
+        address indexed agentVault,
+        bytes32 transactionHash,
+        uint256 depositedUBA
+    );
+
     /**
      * Agent performed self minting, either by executing selfMint with underlying deposit or
      * by executing mintFromFreeUnderlying (in this case, `mintFromFreeUnderlying` is true and

coston2/ICoreVaultClientSettings.sol

@@ -13,6 +13,10 @@ interface ICoreVaultClientSettings {
         uint256 _transferTimeExtensionSeconds
     ) external;
 
+    function setCoreVaultTransferDefaultPenaltyBIPS(
+        uint256 _transferDefaultPenaltyBIPS
+    ) external;
+
     function setCoreVaultRedemptionFeeBIPS(uint256 _redemptionFeeBIPS) external;
 
     function setCoreVaultMinimumAmountLeftBIPS(
@@ -30,6 +34,11 @@ interface ICoreVaultClientSettings {
         view
         returns (uint256);
 
+    function getCoreVaultTransferDefaultPenaltyBIPS()
+        external
+        view
+        returns (uint256);
+
     function getCoreVaultRedemptionFeeBIPS() external view returns (uint256);
 
     function getCoreVaultMinimumAmountLeftBIPS()

coston2/IExecutorsFacet.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.4 <0.9;
+
+/**
+ * @title IExecutorsFacet
+ * @notice Interface for the ExecutorsFacet contract.
+ */
+interface IExecutorsFacet {
+    /**
+     * @notice Emitted when the executor address is set.
+     * @param executor The new executor address.
+     */
+    event ExecutorSet(address executor);
+
+    /**
+     * @notice Emitted when the executor fee is set.
+     * @param executorFee The new executor fee.
+     */
+    event ExecutorFeeSet(uint256 executorFee);
+
+    /**
+     * @notice Reverts if the executor address is invalid.
+     */
+    error InvalidExecutor();
+
+    /**
+     * @notice Reverts if the executor fee is invalid.
+     */
+    error InvalidExecutorFee();
+
+    /**
+     * Returns the executor address and fee.
+     * @return _executor The executor address.
+     * @return _executorFee The executor fee (in wei).
+     */
+    function getExecutorInfo()
+        external
+        view
+        returns (address payable _executor, uint256 _executorFee);
+}

coston2/IInstructionFeesFacet.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.4 <0.9;
+
+/**
+ * @title IInstructionFeesFacet
+ * @notice Interface for the InstructionFeesFacet contract.
+ */
+interface IInstructionFeesFacet {
+    /**
+     * @notice Emitted when the default instruction fee is set.
+     * @param defaultInstructionFee The new default instruction fee.
+     */
+    event DefaultInstructionFeeSet(uint256 defaultInstructionFee);
+
+    /**
+     * @notice Emitted when an instruction-specific fee is set.
+     * @param instructionId The instruction ID.
+     * @param instructionFee The fee for the instruction.
+     */
+    event InstructionFeeSet(
+        uint256 indexed instructionId,
+        uint256 instructionFee
+    );
+
+    /**
+     * @notice Emitted when an instruction-specific fee is removed.
+     * @param instructionId The instruction ID.
+     */
+    event InstructionFeeRemoved(uint256 indexed instructionId);
+
+    /**
+     * @notice Reverts if array lengths do not match.
+     */
+    error InstructionFeesLengthsMismatch();
+
+    /**
+     * @notice Reverts if the instruction fee is invalid.
+     * @param instructionId The instruction ID.
+     */
+    error InvalidInstructionFee(uint256 instructionId);
+
+    /**
+     * @notice Reverts if the instruction fee is not set.
+     * @param instructionId The instruction ID.
+     */
+    error InstructionFeeNotSet(uint256 instructionId);
+
+    /**
+     * @notice Returns the default instruction fee.
+     * @return The default instruction fee in underlying asset's smallest unit (e.g., drops for XRP).
+     */
+    function getDefaultInstructionFee() external view returns (uint256);
+
+    /**
+     * @notice Returns the instruction fee for a given instruction ID.
+     * @param _instructionId The ID of the instruction.
+     * @return The instruction fee in underlying asset's smallest unit (e.g., drops for XRP).
+     */
+    function getInstructionFee(
+        uint256 _instructionId
+    ) external view returns (uint256);
+}