Update version to 0.1.42

Author: fassko

README.md

@@ -1,93 +1,83 @@
-# Flare periphery package for smart contract development
+# Flare periphery package for Foundry
 
-This package contains a collection of smart contracts deployed on the **Flare**, Coston2 (test network for Flare), **Songbird** and Coston (test network for Songbird) networks.
+This package contains a collection of smart contract interfaces deployed on the **Flare**, Coston2 (test network for Flare), **Songbird** and Coston (test network for Songbird) networks.
 
 The intention of this package is to provide a set of **interfaces** for easier integration and development of smart contracts on Flare based networks.
-Interfaces in the most recent version of this package are the same as the ones deployed on the networks. This package exposes all public and most of the internal interfaces but **does not** expose any of the implementations. If you want to access the implementations, you can use the official [flare smart contracts repo](https://gitlab.com/flarenetwork/flare-smart-contracts).
+Interfaces in the most recent version of this package are the same as the ones deployed on the networks. This package exposes all public and most of the internal interfaces but **does not** expose any of the implementations. If you want to access the implementations, you can use the official [Flare smart contracts repo](https://github.com/flare-foundation/flare-smart-contracts-v2).
 
-The package functions similar to openzeppelin library packages and can easily be imported in `nodejs` based projects as well as directly in remix IDE.
+Basic familiarity with the Flare network and EVM is assumed for use. For more information, please refer to the [Flare Developer Hub](https://dev.flare.network/). For a guided introduction to smart contract development on Flare, see [Getting Started with Flare](https://dev.flare.network/network/getting-started).
 
-Basic familiarity with the Flare network and EVM is assumed for use. For more information, please refer to the [Flare documentation](https://docs.flare.network/). If you want a guided tutorial on EVM development and Flare focused smart contract development with this package, please refer to the [Flare developer blogpost series](https://medium.com/@j0-0sko/setting-up-the-environment-3c9f20dcac7c).
+## Installation
+
+Install the package using Forge Soldeer:
+
+```sh
+forge soldeer install flare-periphery~<version>
+```
+
+This will add the package to your `soldeer.lock` and make it available for import under the `flare-periphery/` prefix.
 
 ## Package structure
 
-Each of the networks has its own folder and subfolders for interfaces of specific flare based technologies. The folder structure is as follows:
+Each network has its own folder inside `src/`. All interfaces are placed flat within the respective network folder.
 
 ```
+src/
 ├── coston
-│   ├── distribution
-│   ├── ftso
-│   ├── governance
-│   ├── inflation
-│   ├── mockContracts
-│   ├── stateConnector
-│   └── util-contracts
 ├── coston2
-│   ├── distribution
-│   ├── ftso
-│   ├── governance
-│   ├── mockContracts
-│   ├── stateConnector
-│   └── util-contracts
-├── examples
-│   ├── coston
-│   ├── coston2
-│   ├── flare
-│   └── songbird
 ├── flare
-│   ├── distribution
-│   ├── ftso
-│   ├── governance
-│   ├── mockContracts
-│   ├── stateConnector
-│   └── util-contracts
 └── songbird
-    ├── distribution
-    ├── ftso
-    ├── governance
-    ├── inflation
-    ├── mockContracts
-    ├── stateConnector
-    └── util-contracts
 ```
 
+> **Note:** The `coston2` folder also includes Smart Accounts interfaces.
+
 ## Example usages
 
-### I want to use the FTSO prices in my contract
+### Using FTSO v2 feeds in your contract
+
+To read FTSO v2 feed data on Flare, import `IFtsoV2` and the relay interfaces:
 
-You should use `IFtsoRegistry` (or `IIFtsoRegistry`) for simple price queries or
-`IFtso` (or `IIFtso`) for more advanced queries.
-The `IFtsoRegistry` interface is available in
-`contracts/userInterfaces/IFtsoRegistry.sol` and the
-`IFtso` interface is available in `contracts/userInterfaces/IFtso.sol`.
+```solidity
+import { IFtsoV2 } from "flare-periphery/src/flare/IFtsoV2.sol";
+import { IRelay } from "flare-periphery/src/flare/IRelay.sol";
+```
 
-To use the interfaces deployed on `Flare` network, just import them in your contract source:
+For Coston2 (testnet):
 
 ```solidity
-import { IPriceSubmitter } from "@flarenetwork/flare-periphery-contracts/flare/ftso/userInterfaces/IPriceSubmitter.sol";
-import { IFtsoRegistry } from "@flarenetwork/flare-periphery-contracts/flare/ftso/userInterfaces/IFtsoRegistry.sol";
+import { IFtsoV2 } from "flare-periphery/src/coston2/IFtsoV2.sol";
 ```
 
-If you are using Foundry, you can install the interfaces with Forge and import them in your contract source:
+### Using the Flare Data Connector (FDC)
+
+To verify attestations using the FDC:
 
 ```solidity
-import { IPriceSubmitter } from "flare-periphery-contracts/flare/ftso/userInterfaces/IPriceSubmitter.sol";
-import { IFtsoRegistry } from "flare-periphery-contracts/flare/ftso/userInterfaces/IFtsoRegistry.sol";
+import { IFdcHub } from "flare-periphery/src/flare/IFdcHub.sol";
+import { IFdcVerification } from "flare-periphery/src/flare/IFdcVerification.sol";
 ```
 
-Very simple contract that can consume the FTSO prices is shown in `examples/networkName/SimpleFtsoExample.sol`.
+### Using FAssets interfaces
+
+FAsset interfaces are available on all networks:
 
-An example usage of the FTSO system to dynamically price token in a contract is showcased in
-`examples/network/DynamicToken.sol` with a more detailed explanation in the [blogpost](https://medium.com/@j0-0sko/taking-it-up-to-11-74dd91c39c2b).
+```solidity
+import { IAssetManager } from "flare-periphery/src/flare/IAssetManager.sol";
+import { IFAsset } from "flare-periphery/src/flare/IFAsset.sol";
+```
 
-### I want to confirm something using the attestation client
+### Using the ContractRegistry
 
-Coming soon.
+Each network folder includes a generated `ContractRegistry` Solidity library with on-chain addresses for all registered contracts:
+
+```solidity
+import { ContractRegistry } from "flare-periphery/src/flare/ContractRegistry.sol";
+```
 
 ------
 
-**You've got the tools, turn on your imagination and go, go and build something awesome**
+**You've got the tools, turn on your imagination and go build something awesome!**
 
-If you find any mistake or have any suggestions, please open an issue or contact us are directly.
+If you find any mistakes or have suggestions, please open an issue or contact us directly.
 
 **Package is provided as is, without any warranty.**

foundry.toml

@@ -1,6 +1,6 @@
 [package]
 name = "flare-periphery"
-version = "0.1.41"
+version = "0.1.42"
 
 [profile.default]
 src = "src"

src/coston2/ContractRegistry.sol

@@ -43,6 +43,7 @@ import { IAssetManagerController } from "./IAssetManagerController.sol";
 import { IAssetManager } from "./IAssetManager.sol";
 import { IJsonApiVerification } from "./IJsonApiVerification.sol";
 import { IGenericRewardManager } from "./IGenericRewardManager.sol";
+import { IMasterAccountController } from "./IMasterAccountController.sol";
 // END AUTO GENERATED - DO NOT EDIT ABOVE THIS LINE
 
 // Library is intended to be used inline, so the strings are all memory allocated (instead of calldata)
@@ -624,5 +625,18 @@ library ContractRegistry {
         );
     }
 
+    function getMasterAccountController()
+        internal
+        view
+        returns (IMasterAccountController)
+    {
+        return
+            IMasterAccountController(
+                FLARE_CONTRACT_REGISTRY.getContractAddressByHash(
+                keccak256(abi.encode("MasterAccountController"))
+            )
+        );
+    }
+
 // END AUTO GENERATED - DO NOT EDIT ABOVE THIS LINE
 }

src/flare/ContractRegistry.sol

@@ -42,6 +42,7 @@ import { IFdcRequestFeeConfigurations } from "./IFdcRequestFeeConfigurations.sol
 import { IAssetManagerController } from "./IAssetManagerController.sol";
 import { IAssetManager } from "./IAssetManager.sol";
 import { IGenericRewardManager } from "./IGenericRewardManager.sol";
+import { IMasterAccountController } from "./IMasterAccountController.sol";
 // END AUTO GENERATED - DO NOT EDIT ABOVE THIS LINE
 
 // Library is intended to be used inline, so the strings are all memory allocated (instead of calldata)
@@ -612,5 +613,18 @@ library ContractRegistry {
         );
     }
 
+    function getMasterAccountController()
+        internal
+        view
+        returns (IMasterAccountController)
+    {
+        return
+            IMasterAccountController(
+                FLARE_CONTRACT_REGISTRY.getContractAddressByHash(
+                keccak256(abi.encode("MasterAccountController"))
+            )
+        );
+    }
+
 // END AUTO GENERATED - DO NOT EDIT ABOVE THIS LINE
 }

src/flare/IAgentVaultsFacet.sol

@@ -0,0 +1,91 @@
+// 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);
+}

src/flare/ICustomInstructionsFacet.sol

@@ -0,0 +1,85 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.4 <0.9;
+
+/**
+ * @title ICustomInstructionsFacet
+ * @notice Interface for the CustomInstructionsFacet contract.
+ */
+interface ICustomInstructionsFacet {
+
+    /// @notice Struct containing custom call information
+    struct CustomCall {
+        /// @notice Target contract address
+        address targetContract;
+        /// @notice value (in wei) to send with the call
+        uint256 value;
+        /// @notice Call data
+        bytes data;
+    }
+
+    /**
+     * @notice Emitted when a custom instruction is registered.
+     * @param customInstructionHash The hash representing the registered instructions.
+     */
+    event CustomInstructionRegistered(bytes32 indexed customInstructionHash);
+
+    /**
+     * @notice Emitted when a custom instruction is already registered.
+     * @param customInstructionHash The hash representing the already registered instructions.
+     */
+    event CustomInstructionAlreadyRegistered(bytes32 indexed customInstructionHash);
+
+    /**
+     * @notice Reverts if the custom instruction is empty (zero custom calls).
+     */
+    error EmptyCustomInstruction();
+
+    /**
+     * @notice Reverts if the target address of a custom call is zero.
+     */
+    error TargetAddressZero();
+
+    /**
+     * @notice Reverts if the target address of a custom call is not a contract.
+     * @param target The target address.
+     */
+    error TargetNotAContract(address target);
+
+    /**
+     * @notice Register custom instruction and return the call hash.
+     * @param _customInstruction Custom instruction (array of custom calls) to register.
+     * @return _customInstructionHash The hash representing the registered custom instruction.
+     */
+    function registerCustomInstruction(
+        CustomCall[] memory _customInstruction
+    ) external returns (bytes32 _customInstructionHash);
+
+    /**
+     * @notice Get a custom instruction for a given call hash.
+     * @param _customInstructionHash The hash representing the custom instruction.
+     * @return _customInstruction Custom instruction (array of custom calls) for the hash.
+     */
+    function getCustomInstruction(
+        bytes32 _customInstructionHash
+    ) external view returns (CustomCall[] memory _customInstruction);
+    /**
+     * @notice Get paginated custom instruction hashes.
+     * @param _start The starting index.
+     * @param _end The ending index.
+     * @return _customInstructionHashes Array of custom instruction hashes for the requested page.
+     * @return _totalLength The total number of custom instruction hashes.
+     */
+    function getCustomInstructionHashes(
+        uint256 _start,
+        uint256 _end
+    ) external view returns (bytes32[] memory _customInstructionHashes, uint256 _totalLength);
+
+    /**
+     * @notice Encode a custom instruction to get its call hash.
+     * @param _customInstruction Custom instruction (array of custom calls) to encode.
+     * @return _customInstructionHash The hash representing the custom instruction.
+     */
+    function encodeCustomInstruction(
+        CustomCall[] memory _customInstruction
+    ) external pure returns (bytes32 _customInstructionHash);
+}