Create voucher with , VoucherHub address, Set account as owner, expiration and deal with Authorization

contracts/IVoucherHub.sol

@@ -1,19 +1,87 @@
 // SPDX-FileCopyrightText: 2024 IEXEC BLOCKCHAIN TECH <[email protected]>
 // SPDX-License-Identifier: Apache-2.0
-
 pragma solidity ^0.8.20;
 
+/**
+ * @title Interface of the voucher hub contract.
+ */
 interface IVoucherHub {
+    struct VoucherType {
+        string description;
+        uint256 duration;
+    }
     event VoucherCreated(address indexed voucher, address owner, uint256 expiration);
     event VoucherTypeCreated(uint256 indexed id, string description, uint256 duration);
     event VoucherTypeDescriptionUpdated(uint256 indexed id, string description);
     event VoucherTypeDurationUpdated(uint256 indexed id, uint256 duration);
     event EligibleAssetAdded(uint256 indexed id, address asset);
     event EligibleAssetRemoved(uint256 indexed id, address asset);
 
+    /**
+     * @notice Creates a new voucher for the specified owner.
+     * @param owner The address of the voucher owner.
+     * @param voucherType The ID of the voucher type.
+     * @return voucherAddress The address of the created voucher contract.
+     */
     function createVoucher(
-        address account,
-        uint256 expiration
+        address owner,
+        uint256 voucherType
     ) external returns (address voucherAddress);
+
+    /**
+     * @notice Get the voucher address of a given account.
+     * @param account The address of the voucher owner.
+     * @return voucherAddress The address of the voucher contract.
+     */
     function getVoucher(address account) external view returns (address voucherAddress);
+
+    /**
+     * @notice Get the voucher beacon address.
+     * @return voucherBeacon The address of the voucher beacon.
+     */
+    function getVoucherBeacon() external view returns (address voucherBeacon);
+
+    /**
+     * @notice Get the iExec Poco address.
+     * @return iexecPoco The address of the iExec Poco contract.
+     */
+    function getIexecPoco() external view returns (address iexecPoco);
+
+    /**
+     * @notice Get the count of voucher types.
+     * @return count The count of voucher types.
+     */
+    function getVoucherTypeCount() external view returns (uint256 count);
+
+    /**
+     * @notice Get the voucher type details by ID.
+     * @param id The ID of the voucher type.
+     * @return VoucherType The details of the voucher type.
+     */
+    function getVoucherType(uint256 id) external view returns (VoucherType memory);
+
+    /**
+     * @notice Add an eligible asset for a voucher type.
+     * @param voucherTypeId The ID of the voucher type.
+     * @param asset The address of the asset to add.
+     */
+    function addEligibleAsset(uint256 voucherTypeId, address asset) external;
+
+    /**
+     * @notice Remove an eligible asset for a voucher type.
+     * @param voucherTypeId The ID of the voucher type.
+     * @param asset The address of the asset to remove.
+     */
+    function removeEligibleAsset(uint256 voucherTypeId, address asset) external;
+
+    /**
+     * @notice Check if an asset is eligible to match orders sponsoring.
+     * @param voucherTypeId The ID of the voucher type.
+     * @param asset The address of the asset to check.
+     * @return isEligible True if the asset is eligible, otherwise False.
+     */
+    function isAssetEligibleToMatchOrdersSponsoring(
+        uint256 voucherTypeId,
+        address asset
+    ) external view returns (bool isEligible);
 }

contracts/VoucherHub.sol

@@ -12,10 +12,6 @@ import {IVoucherHub} from "./IVoucherHub.sol";
 pragma solidity ^0.8.20;
 
 contract VoucherHub is OwnableUpgradeable, UUPSUpgradeable, IVoucherHub {
-    struct VoucherType {
-        string description;
-        uint256 duration;
-    }
     /// @custom:storage-location erc7201:iexec.voucher.storage.VoucherHub
     struct VoucherHubStorage {
         address _iexecPoco;
@@ -88,7 +84,7 @@ contract VoucherHub is OwnableUpgradeable, UUPSUpgradeable, IVoucherHub {
 
     function getVoucherType(
         uint256 id
-    ) public view whenVoucherTypeExists(id) returns (VoucherType memory) {
+    ) public view override whenVoucherTypeExists(id) returns (VoucherType memory) {
         VoucherHubStorage storage $ = _getVoucherHubStorage();
         return $.voucherTypes[id];
     }
@@ -145,19 +141,21 @@ contract VoucherHub is OwnableUpgradeable, UUPSUpgradeable, IVoucherHub {
      * address should never be changed.
      *
      * @param owner voucher owner
-     * @param expiration voucher expiration
+     * @param voucherType voucher expiration
      */
     function createVoucher(
         address owner,
-        uint256 expiration
+        uint256 voucherType
     ) external override onlyOwner returns (address voucherAddress) {
         VoucherHubStorage storage $ = _getVoucherHubStorage();
+        uint256 voucherExpiration = getVoucherType(voucherType).duration + block.timestamp;
         voucherAddress = address(new VoucherProxy{salt: _getCreate2Salt(owner)}($._voucherBeacon));
         // Initialize the created proxy contract.
         // The proxy contract does a delegatecall to its implementation.
         // Re-Entrancy safe because the target contract is controlled.
-        Voucher(voucherAddress).initialize(owner, expiration);
-        emit VoucherCreated(voucherAddress, owner, expiration);
+        Voucher(voucherAddress).initialize(owner, voucherType, voucherExpiration, address(this));
+        emit VoucherCreated(voucherAddress, owner, voucherExpiration);
+        // Create voucher and call initialize() function.
     }
 
     /**

contracts/beacon/IVoucher.sol

@@ -7,7 +7,43 @@ pragma solidity ^0.8.20;
  * @title Interface of the voucher contract.
  */
 interface IVoucher {
-    event ExpirationUpdated(uint256 newExpiration);
+    event AuthorizationSet(address indexed account);
+    event AuthorizationUnset(address indexed account);
 
-    function getExpiration() external view returns (uint256);
+    /**
+     * @notice Retrieves the expiration timestamp of the voucher.
+     * @return expirationTimestamp The expiration timestamp.
+     */
+    function getExpiration() external view returns (uint256 expirationTimestamp);
+
+    /**
+     * @notice Retrieves the type of the voucher.
+     * @return voucherType The type of the voucher.
+     */
+    function getType() external view returns (uint256 voucherType);
+
+    /**
+     * @notice Retrieves the address of the voucher hub associated with the voucher.
+     * @return voucherHubAddress The address of the voucher hub.
+     */
+    function getHub() external view returns (address voucherHubAddress);
+
+    /**
+     * @notice Sets authorization for an account.
+     * @param account The account to authorize.
+     */
+    function setAuthorization(address account) external;
+
+    /**
+     * @notice Unsets authorization for an account.
+     * @param account The account to remove authorization from.
+     */
+    function unsetAuthorization(address account) external;
+
+    /**
+     * @notice Checks if an account is authorized.
+     * @param account The account to check.
+     * @return isAuthorized True if the account is authorized, false otherwise.
+     */
+    function isAccountAuthorized(address account) external view returns (bool isAuthorized);
 }

contracts/beacon/Voucher.sol

@@ -13,14 +13,23 @@ import {IVoucher} from "./IVoucher.sol";
 contract Voucher is OwnableUpgradeable, IVoucher {
     /// @custom:storage-location erc7201:iexec.voucher.storage.Voucher
     struct VoucherStorage {
+        address _voucherHub;
         uint256 _expiration;
+        uint256 _type;
+        mapping(address => bool) _authorizedAccounts;
     }
 
     // keccak256(abi.encode(uint256(keccak256("iexec.voucher.storage.Voucher")) - 1))
     // & ~bytes32(uint256(0xff));
     bytes32 private constant VOUCHER_STORAGE_LOCATION =
         0xc2e244293dc04d6c7fa946e063317ff8e6770fd48cbaff411a60f1efc8a7e800;
 
+    function _getVoucherStorage() private pure returns (VoucherStorage storage $) {
+        assembly {
+            $.slot := VOUCHER_STORAGE_LOCATION
+        }
+    }
+
     /// @custom:oz-upgrades-unsafe-allow constructor
     constructor() {
         _disableInitializers();
@@ -30,21 +39,51 @@ contract Voucher is OwnableUpgradeable, IVoucher {
      * Initialize implementation contract.
      * @param expiration initial expiration.
      */
-    function initialize(address owner, uint256 expiration) external initializer {
+    function initialize(
+        address owner,
+        uint256 vtype,
+        uint256 expiration,
+        address voucherHub
+    ) external initializer {
         __Ownable_init(owner);
         VoucherStorage storage $ = _getVoucherStorage();
+        $._type = vtype;
+        $._voucherHub = voucherHub;
         $._expiration = expiration;
-        emit ExpirationUpdated(expiration);
+        $._authorizedAccounts[owner] = true;
+        // deposit
+        emit AuthorizationSet(owner);
     }
 
-    function getExpiration() external view override returns (uint256) {
+    function getHub() external view returns (address voucherHubAddress) {
         VoucherStorage storage $ = _getVoucherStorage();
-        return $._expiration;
+        voucherHubAddress = $._voucherHub;
     }
 
-    function _getVoucherStorage() private pure returns (VoucherStorage storage $) {
-        assembly {
-            $.slot := VOUCHER_STORAGE_LOCATION
-        }
+    function getExpiration() external view override returns (uint256 expirationTimestamp) {
+        VoucherStorage storage $ = _getVoucherStorage();
+        expirationTimestamp = $._expiration;
+    }
+
+    function getType() external view returns (uint256 voucherType) {
+        VoucherStorage storage $ = _getVoucherStorage();
+        voucherType = $._type;
+    }
+
+    function setAuthorization(address account) external onlyOwner {
+        VoucherStorage storage voucherStorage = _getVoucherStorage();
+        voucherStorage._authorizedAccounts[account] = true;
+        emit AuthorizationSet(account);
+    }
+
+    function unsetAuthorization(address account) external onlyOwner {
+        VoucherStorage storage voucherStorage = _getVoucherStorage();
+        voucherStorage._authorizedAccounts[account] = false;
+        emit AuthorizationUnset(account);
+    }
+
+    function isAccountAuthorized(address account) external view returns (bool isAuthorized) {
+        VoucherStorage storage voucherStorage = _getVoucherStorage();
+        isAuthorized = voucherStorage._authorizedAccounts[account];
     }
 }

contracts/mocks/IVoucherV2Mock.sol

@@ -0,0 +1,15 @@
+// SPDX-FileCopyrightText: 2024 IEXEC BLOCKCHAIN TECH <[email protected]>
+// SPDX-License-Identifier: Apache-2.0
+
+pragma solidity ^0.8.20;
+
+/**
+ * @title Interface of the voucher contract.
+ */
+interface IVoucher {
+    /**
+     * @notice Retrieves the expiration timestamp of the voucher.
+     * @return expirationTimestamp The expiration timestamp.
+     */
+    function getExpiration() external view returns (uint256 expirationTimestamp);
+}

contracts/mocks/VoucherV2Mock.sol

@@ -4,12 +4,15 @@
 pragma solidity ^0.8.20;
 
 import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
-import {IVoucher} from "../beacon/IVoucher.sol";
+import {IVoucher} from "./IVoucherV2Mock.sol";
 
 contract VoucherV2Mock is OwnableUpgradeable, IVoucher {
     /// @custom:storage-location erc7201:iexec.voucher.storage.Voucher
     struct VoucherStorage {
+        address _voucherHub;
         uint256 _expiration;
+        uint256 _type;
+        mapping(address => bool) _authorizedAccounts;
         uint256 _newStateVariable;
     }
 
@@ -32,7 +35,7 @@ contract VoucherV2Mock is OwnableUpgradeable, IVoucher {
         $._newStateVariable = newStateVariable;
     }
 
-    function getExpiration() external view override returns (uint256) {
+    function getExpiration() external view returns (uint256) {
         VoucherStorage storage $ = _getVoucherStorage();
         return $._expiration;
     }

scripts/common.ts

@@ -0,0 +1,32 @@
+import { ContractTransactionReceipt } from 'ethers';
+import { ethers } from 'hardhat';
+import { Voucher, VoucherProxy } from '../../typechain-types';
+import { VoucherV2Mock } from '../../typechain-types/contracts/mocks';
+
+export async function getVoucher(voucherAddress: string): Promise<Voucher> {
+    return await ethers.getContractAt('Voucher', voucherAddress);
+}
+
+export async function getVoucherV2(voucherAddress: string): Promise<VoucherV2Mock> {
+    return await ethers.getContractAt('VoucherV2Mock', voucherAddress);
+}
+
+export async function getVoucherAsProxy(voucherAddress: string): Promise<VoucherProxy> {
+    return await ethers.getContractAt('VoucherProxy', voucherAddress);
+}
+
+export async function getExpectedExpiration(
+    voucherDuration: number,
+    txReceipt: ContractTransactionReceipt | null,
+): Promise<number> {
+    if (txReceipt != null) {
+        const block = await ethers.provider.getBlock(txReceipt.blockNumber);
+        if (block) {
+            return block.timestamp + voucherDuration;
+        } else {
+            return 0;
+        }
+    } else {
+        return 0;
+    }
+}