@artblocks/contracts 1.2.1 → 1.3.0

package/contracts/interfaces/v0.8.x/IDelegateRegistry.sol

@@ -0,0 +1,318 @@
+// SPDX-License-Identifier: CC0-1.0
+pragma solidity >=0.8.13;
+
+/**
+ * @title IDelegateRegistry
+ * @custom:version 2.0
+ * @custom:author foobar (0xfoobar)
+ * @notice A standalone immutable registry storing delegated permissions from one address to another
+ */
+interface IDelegateRegistry {
+    /// @notice Delegation type, NONE is used when a delegation does not exist or is revoked
+    enum DelegationType {
+        NONE,
+        ALL,
+        CONTRACT,
+        ERC721,
+        ERC20,
+        ERC1155
+    }
+
+    /// @notice Struct for returning delegations
+    struct Delegation {
+        DelegationType type_;
+        address to;
+        address from;
+        bytes32 rights;
+        address contract_;
+        uint256 tokenId;
+        uint256 amount;
+    }
+
+    /// @notice Emitted when an address delegates or revokes rights for their entire wallet
+    event DelegateAll(
+        address indexed from,
+        address indexed to,
+        bytes32 rights,
+        bool enable
+    );
+
+    /// @notice Emitted when an address delegates or revokes rights for a contract address
+    event DelegateContract(
+        address indexed from,
+        address indexed to,
+        address indexed contract_,
+        bytes32 rights,
+        bool enable
+    );
+
+    /// @notice Emitted when an address delegates or revokes rights for an ERC721 tokenId
+    event DelegateERC721(
+        address indexed from,
+        address indexed to,
+        address indexed contract_,
+        uint256 tokenId,
+        bytes32 rights,
+        bool enable
+    );
+
+    /// @notice Emitted when an address delegates or revokes rights for an amount of ERC20 tokens
+    event DelegateERC20(
+        address indexed from,
+        address indexed to,
+        address indexed contract_,
+        bytes32 rights,
+        uint256 amount
+    );
+
+    /// @notice Emitted when an address delegates or revokes rights for an amount of an ERC1155 tokenId
+    event DelegateERC1155(
+        address indexed from,
+        address indexed to,
+        address indexed contract_,
+        uint256 tokenId,
+        bytes32 rights,
+        uint256 amount
+    );
+
+    /// @notice Thrown if multicall calldata is malformed
+    error MulticallFailed();
+
+    /**
+     * -----------  WRITE -----------
+     */
+
+    /**
+     * @notice Call multiple functions in the current contract and return the data from all of them if they all succeed
+     * @param data The encoded function data for each of the calls to make to this contract
+     * @return results The results from each of the calls passed in via data
+     */
+    function multicall(
+        bytes[] calldata data
+    ) external payable returns (bytes[] memory results);
+
+    /**
+     * @notice Allow the delegate to act on behalf of `msg.sender` for all contracts
+     * @param to The address to act as delegate
+     * @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
+     * @param enable Whether to enable or disable this delegation, true delegates and false revokes
+     * @return delegationHash The unique identifier of the delegation
+     */
+    function delegateAll(
+        address to,
+        bytes32 rights,
+        bool enable
+    ) external payable returns (bytes32 delegationHash);
+
+    /**
+     * @notice Allow the delegate to act on behalf of `msg.sender` for a specific contract
+     * @param to The address to act as delegate
+     * @param contract_ The contract whose rights are being delegated
+     * @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
+     * @param enable Whether to enable or disable this delegation, true delegates and false revokes
+     * @return delegationHash The unique identifier of the delegation
+     */
+    function delegateContract(
+        address to,
+        address contract_,
+        bytes32 rights,
+        bool enable
+    ) external payable returns (bytes32 delegationHash);
+
+    /**
+     * @notice Allow the delegate to act on behalf of `msg.sender` for a specific ERC721 token
+     * @param to The address to act as delegate
+     * @param contract_ The contract whose rights are being delegated
+     * @param tokenId The token id to delegate
+     * @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
+     * @param enable Whether to enable or disable this delegation, true delegates and false revokes
+     * @return delegationHash The unique identifier of the delegation
+     */
+    function delegateERC721(
+        address to,
+        address contract_,
+        uint256 tokenId,
+        bytes32 rights,
+        bool enable
+    ) external payable returns (bytes32 delegationHash);
+
+    /**
+     * @notice Allow the delegate to act on behalf of `msg.sender` for a specific amount of ERC20 tokens
+     * @dev The actual amount is not encoded in the hash, just the existence of a amount (since it is an upper bound)
+     * @param to The address to act as delegate
+     * @param contract_ The address for the fungible token contract
+     * @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
+     * @param amount The amount to delegate, > 0 delegates and 0 revokes
+     * @return delegationHash The unique identifier of the delegation
+     */
+    function delegateERC20(
+        address to,
+        address contract_,
+        bytes32 rights,
+        uint256 amount
+    ) external payable returns (bytes32 delegationHash);
+
+    /**
+     * @notice Allow the delegate to act on behalf of `msg.sender` for a specific amount of ERC1155 tokens
+     * @dev The actual amount is not encoded in the hash, just the existence of a amount (since it is an upper bound)
+     * @param to The address to act as delegate
+     * @param contract_ The address of the contract that holds the token
+     * @param tokenId The token id to delegate
+     * @param rights Specific subdelegation rights granted to the delegate, pass an empty bytestring to encompass all rights
+     * @param amount The amount of that token id to delegate, > 0 delegates and 0 revokes
+     * @return delegationHash The unique identifier of the delegation
+     */
+    function delegateERC1155(
+        address to,
+        address contract_,
+        uint256 tokenId,
+        bytes32 rights,
+        uint256 amount
+    ) external payable returns (bytes32 delegationHash);
+
+    /**
+     * ----------- CHECKS -----------
+     */
+
+    /**
+     * @notice Check if `to` is a delegate of `from` for the entire wallet
+     * @param to The potential delegate address
+     * @param from The potential address who delegated rights
+     * @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
+     * @return valid Whether delegate is granted to act on the from's behalf
+     */
+    function checkDelegateForAll(
+        address to,
+        address from,
+        bytes32 rights
+    ) external view returns (bool);
+
+    /**
+     * @notice Check if `to` is a delegate of `from` for the specified `contract_` or the entire wallet
+     * @param to The delegated address to check
+     * @param contract_ The specific contract address being checked
+     * @param from The cold wallet who issued the delegation
+     * @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
+     * @return valid Whether delegate is granted to act on from's behalf for entire wallet or that specific contract
+     */
+    function checkDelegateForContract(
+        address to,
+        address from,
+        address contract_,
+        bytes32 rights
+    ) external view returns (bool);
+
+    /**
+     * @notice Check if `to` is a delegate of `from` for the specific `contract` and `tokenId`, the entire `contract_`, or the entire wallet
+     * @param to The delegated address to check
+     * @param contract_ The specific contract address being checked
+     * @param tokenId The token id for the token to delegating
+     * @param from The wallet that issued the delegation
+     * @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
+     * @return valid Whether delegate is granted to act on from's behalf for entire wallet, that contract, or that specific tokenId
+     */
+    function checkDelegateForERC721(
+        address to,
+        address from,
+        address contract_,
+        uint256 tokenId,
+        bytes32 rights
+    ) external view returns (bool);
+
+    /**
+     * @notice Returns the amount of ERC20 tokens the delegate is granted rights to act on the behalf of
+     * @param to The delegated address to check
+     * @param contract_ The address of the token contract
+     * @param from The cold wallet who issued the delegation
+     * @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
+     * @return balance The delegated balance, which will be 0 if the delegation does not exist
+     */
+    function checkDelegateForERC20(
+        address to,
+        address from,
+        address contract_,
+        bytes32 rights
+    ) external view returns (uint256);
+
+    /**
+     * @notice Returns the amount of a ERC1155 tokens the delegate is granted rights to act on the behalf of
+     * @param to The delegated address to check
+     * @param contract_ The address of the token contract
+     * @param tokenId The token id to check the delegated amount of
+     * @param from The cold wallet who issued the delegation
+     * @param rights Specific rights to check for, pass the zero value to ignore subdelegations and check full delegations only
+     * @return balance The delegated balance, which will be 0 if the delegation does not exist
+     */
+    function checkDelegateForERC1155(
+        address to,
+        address from,
+        address contract_,
+        uint256 tokenId,
+        bytes32 rights
+    ) external view returns (uint256);
+
+    /**
+     * ----------- ENUMERATIONS -----------
+     */
+
+    /**
+     * @notice Returns all enabled delegations a given delegate has received
+     * @param to The address to retrieve delegations for
+     * @return delegations Array of Delegation structs
+     */
+    function getIncomingDelegations(
+        address to
+    ) external view returns (Delegation[] memory delegations);
+
+    /**
+     * @notice Returns all enabled delegations an address has given out
+     * @param from The address to retrieve delegations for
+     * @return delegations Array of Delegation structs
+     */
+    function getOutgoingDelegations(
+        address from
+    ) external view returns (Delegation[] memory delegations);
+
+    /**
+     * @notice Returns all hashes associated with enabled delegations an address has received
+     * @param to The address to retrieve incoming delegation hashes for
+     * @return delegationHashes Array of delegation hashes
+     */
+    function getIncomingDelegationHashes(
+        address to
+    ) external view returns (bytes32[] memory delegationHashes);
+
+    /**
+     * @notice Returns all hashes associated with enabled delegations an address has given out
+     * @param from The address to retrieve outgoing delegation hashes for
+     * @return delegationHashes Array of delegation hashes
+     */
+    function getOutgoingDelegationHashes(
+        address from
+    ) external view returns (bytes32[] memory delegationHashes);
+
+    /**
+     * @notice Returns the delegations for a given array of delegation hashes
+     * @param delegationHashes is an array of hashes that correspond to delegations
+     * @return delegations Array of Delegation structs, return empty structs for nonexistent or revoked delegations
+     */
+    function getDelegationsFromHashes(
+        bytes32[] calldata delegationHashes
+    ) external view returns (Delegation[] memory delegations);
+
+    /**
+     * ----------- STORAGE ACCESS -----------
+     */
+
+    /**
+     * @notice Allows external contracts to read arbitrary storage slots
+     */
+    function readSlot(bytes32 location) external view returns (bytes32);
+
+    /**
+     * @notice Allows external contracts to read an arbitrary array of storage slots
+     */
+    function readSlots(
+        bytes32[] calldata locations
+    ) external view returns (bytes32[] memory);
+}

package/contracts/interfaces/v0.8.x/IDependencyRegistryV0.sol

@@ -85,6 +85,8 @@ interface IDependencyRegistryV0 {
 
     event CoreRegistryAddressUpdated(address indexed coreRegistryAddress);
 
+    event UniversalBytecodeStorageReaderUpdated(address indexed newReader);
+
     /**
      * @notice Returns the count of scripts for dependency `dependencyNameAndVersion`.
      * @param dependencyNameAndVersion Dependency type to be queried.

package/contracts/interfaces/v0.8.x/IPMPAugmentHook.sol

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {IPMPV0} from "./IPMPV0.sol";
+import {IWeb3Call} from "./IWeb3Call.sol";
+
+import {IERC165} from "@openzeppelin-5.0/contracts/interfaces/IERC165.sol";
+
+interface IPMPAugmentHook is IERC165 {
+    /**
+     * @notice Augment the token parameters for a given token.
+     * @dev This hook is called when a token's PMPs are read.
+     * @dev This must return all desired tokenParams, not just additional data.
+     * @param coreContract The address of the core contract to call.
+     * @param tokenId The tokenId of the token to get data for.
+     * @param tokenParams The token parameters for the queried token.
+     * @return augmentedTokenParams The augmented token parameters.
+     */
+    function onTokenPMPReadAugmentation(
+        address coreContract,
+        uint256 tokenId,
+        IWeb3Call.TokenParam[] calldata tokenParams
+    )
+        external
+        view
+        returns (IWeb3Call.TokenParam[] memory augmentedTokenParams);
+
+    // @dev ERC156 function supportsInterface must be implemented and broadcast true for this interfaceId
+}

package/contracts/interfaces/v0.8.x/IPMPConfigureHook.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {IPMPV0} from "./IPMPV0.sol";
+
+import {IERC165} from "@openzeppelin-5.0/contracts/interfaces/IERC165.sol";
+
+interface IPMPConfigureHook is IERC165 {
+    /**
+     * @notice Execution logic to be executed when a token's PMP is configured.
+     * @dev This hook is executed after the PMP is configured.
+     * @param coreContract The address of the core contract that was configured.
+     * @param tokenId The tokenId of the token that was configured.
+     * @param pmpInput The PMP input that was used to successfully configure the token.
+     */
+    function onTokenPMPConfigure(
+        address coreContract,
+        uint256 tokenId,
+        IPMPV0.PMPInput calldata pmpInput
+    ) external;
+
+    // @dev ERC156 function supportsInterface must be implemented and broadcast true for this interfaceId
+}

package/contracts/interfaces/v0.8.x/IPMPV0.sol

@@ -0,0 +1,224 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {IPMPConfigureHook} from "./IPMPConfigureHook.sol";
+import {IPMPAugmentHook} from "./IPMPAugmentHook.sol";
+import {IWeb3Call} from "./IWeb3Call.sol";
+
+import {ImmutableStringArray} from "../../libs/v0.8.x/ImmutableStringArray.sol";
+
+/**
+ * @title Project Metadata Parameters (PMP) Interface, V0
+ * @author Art Blocks Inc.
+ * @notice Interface for the Project Metadata Parameters (PMP) contract that defines
+ * how projects can expose configurable parameters for tokens. This interface establishes
+ * the standard for parameter configuration, validation, and retrieval.
+ * @dev This interface extends the IWeb3Call interface to provide compatibility with
+ * existing Web3 infrastructure.
+ */
+interface IPMPV0 is IWeb3Call {
+    /**
+     * @notice Emitted when project hooks are configured.
+     * @param coreContract The address of the core contract.
+     * @param projectId The project ID for which hooks were configured.
+     * @param tokenPMPPostConfigHook The hook to call after a token's PMP is configured.
+     * @param tokenPMPReadAugmentationHook The hook to call when reading a token's PMPs.
+     */
+    event ProjectHooksConfigured(
+        address coreContract,
+        uint256 projectId,
+        IPMPConfigureHook tokenPMPPostConfigHook,
+        IPMPAugmentHook tokenPMPReadAugmentationHook
+    );
+
+    /**
+     * @notice Emitted when a project's available parameters are configured.
+     * @param coreContract The address of the core contract.
+     * @param projectId The project ID for which parameters were configured.
+     * @param pmpInputConfigs Array of parameter configurations defining the available parameters.
+     * @param projectConfigNonce The nonce of the project configuration.
+     */
+    event ProjectConfigured(
+        address coreContract,
+        uint256 projectId,
+        PMPInputConfig[] pmpInputConfigs,
+        uint8 projectConfigNonce
+    );
+
+    /**
+     * @notice Emitted when a token's parameters are configured.
+     * @param coreContract The address of the core contract.
+     * @param tokenId The token ID for which parameters were configured.
+     * @param pmpInputs Array of parameter inputs that were configured.
+     */
+    event TokenParamsConfigured(
+        address coreContract,
+        uint256 tokenId,
+        PMPInput[] pmpInputs
+    );
+
+    /**
+     * @notice Emitted when the delegation registry is updated.
+     * @dev At the time of writing, the delegate.xyz v2 contract is the only
+     * delegate registry contract that is supported.
+     * @param delegationRegistry The address of the new delegation registry.
+     */
+    event DelegationRegistryUpdated(address delegationRegistry);
+
+    /**
+     * @notice Defines who can configure a parameter for a token.
+     * @dev Enum ordering is relied on (ArtistAndTokenOwnerAndAddress being last).
+     */
+    enum AuthOption {
+        Artist,
+        TokenOwner,
+        Address,
+        ArtistAndTokenOwner,
+        ArtistAndAddress,
+        TokenOwnerAndAddress,
+        ArtistAndTokenOwnerAndAddress
+    }
+
+    /**
+     * @notice Defines the type of parameter that can be configured.
+     * @dev Enum ordering is relied on (String being last).
+     */
+    enum ParamType {
+        Unconfigured, // @dev default value, used to check if PMP is configured
+        Select,
+        Bool,
+        Uint256Range,
+        Int256Range,
+        DecimalRange,
+        HexColor,
+        Timestamp,
+        String // utilizes string in PMP struct, all other param types utilize the generic bytes32 param
+    }
+
+    /**
+     * @notice Structure for a parameter configuration input.
+     * @dev Used when configuring a project's available parameters.
+     */
+    struct PMPInputConfig {
+        string key; // slot 0: 32 bytes
+        PMPConfig pmpConfig; // slot 1: 32 bytes
+    }
+
+    /**
+     * @notice Structure for a parameter configuration.
+     * @dev Defines the constraints and options for a parameter.
+     */
+    struct PMPConfig {
+        AuthOption authOption; // slot 0: 1 byte
+        ParamType paramType; // slot 0: 1 byte
+        uint48 pmpLockedAfterTimestamp; // slot 0: 6 bytes
+        address authAddress; // slot 0: 20 bytes
+        string[] selectOptions; // slot 1: 32 bytes
+        // @dev use bytes32 for all range types for SSTORE efficiency
+        // @dev minRange and maxRange cast to defined numeric type when verifying assigned PMP values
+        bytes32 minRange; // slot 2: 32 bytes
+        bytes32 maxRange; // slot 3: 32 bytes
+    }
+
+    /**
+     * @notice View structure for a parameter configuration.
+     * @dev Used when reading a project's available parameters.
+     * @dev any populated select options are loaded and returned as a string array
+     * instead of remaining as a pointer to a data contract
+     */
+    struct PMPConfigView {
+        uint8 highestConfigNonce;
+        AuthOption authOption;
+        ParamType paramType;
+        uint48 pmpLockedAfterTimestamp;
+        address authAddress;
+        uint8 selectOptionsLength;
+        string[] selectOptions;
+        bytes32 minRange;
+        bytes32 maxRange;
+    }
+
+    /**
+     * @notice Structure for a parameter input.
+     * @dev Used when configuring a token's parameters.
+     */
+    struct PMPInput {
+        string key; // slot 0: 32 bytes
+        ParamType configuredParamType;
+        // @dev store values as bytes32 for efficiency, cast appropriately when reading
+        bytes32 configuredValue;
+        bool configuringArtistString;
+        string configuredValueString;
+    }
+
+    /**
+     * @notice Storage structure for a configured parameter.
+     * @dev Includes both artist and non-artist configured string values.
+     */
+    struct PMPStorage {
+        ParamType configuredParamType; // slot 0: 1 byte
+        // @dev store values as bytes32 for efficiency, cast appropriately when reading
+        bytes32 configuredValue; // slot 1: 32 bytes
+        string artistConfiguredValueString; // slot 2: 32 bytes
+        string nonArtistConfiguredValueString; // slot 3: 32 bytes
+    }
+
+    /**
+     * @notice Configure the hooks for a project.
+     * @param coreContract The address of the core contract.
+     * @param projectId The project ID to configure hooks for.
+     * @param tokenPMPPostConfigHook The hook to call after a token's PMP is configured.
+     * @param tokenPMPReadAugmentationHook The hook to call when reading a token's PMPs.
+     */
+    function configureProjectHooks(
+        address coreContract,
+        uint256 projectId,
+        IPMPConfigureHook tokenPMPPostConfigHook,
+        IPMPAugmentHook tokenPMPReadAugmentationHook
+    ) external;
+
+    /**
+     * @notice Configure the available parameters for a project.
+     * @param coreContract The address of the core contract.
+     * @param projectId The project ID to configure parameters for.
+     * @param pmpInputConfigs Array of parameter configurations defining the available parameters.
+     */
+    function configureProject(
+        address coreContract,
+        uint256 projectId,
+        PMPInputConfig[] calldata pmpInputConfigs
+    ) external;
+
+    /**
+     * @notice Configure the parameters for a specific token.
+     * @param coreContract The address of the core contract.
+     * @param tokenId The token ID to configure parameters for.
+     * @param pmpInputs Array of parameter inputs to configure.
+     */
+    function configureTokenParams(
+        address coreContract,
+        uint256 tokenId,
+        PMPInput[] calldata pmpInputs
+    ) external;
+
+    /**
+     * @notice Checks if the given wallet has the owner role for the given token.
+     * It returns true if the wallet is the owner of the token or if the wallet
+     * is a delegate of the token owner; otherwise it returns false.
+     * Reverts if an invalid coreContract or tokenId is provided.
+     * Provided for convenience, as the same check is performed in the
+     * configureTokenParams function.
+     * @param wallet The wallet address to check.
+     * @param coreContract The address of the core contract to call.
+     * @param tokenId The tokenId of the token to check.
+     * @return isTokenOwnerOrDelegate True if the wallet is the owner or a delegate of the token,
+     * false otherwise.
+     */
+    function isTokenOwnerOrDelegate(
+        address wallet,
+        address coreContract,
+        uint256 tokenId
+    ) external view returns (bool);
+}

package/contracts/interfaces/v0.8.x/IUniversalBytecodeStorageReader.sol

@@ -25,4 +25,9 @@ interface IUniversalBytecodeStorageReader is IBytecodeStorageReader_Base {
     function updateBytecodeStorageReaderContract(
         IBytecodeStorageReader_Base newBytecodeStorageReaderContract
     ) external;
+
+    function activeBytecodeStorageReaderContract()
+        external
+        view
+        returns (IBytecodeStorageReader_Base);
 }

package/contracts/interfaces/v0.8.x/IWeb3Call.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+interface IWeb3Call {
+    /**
+     * @notice TokenParam struct defines the parameters for a given token.
+     * @param key The key of the token parameter.
+     * @param value The value of the token parameter.
+     */
+    struct TokenParam {
+        string key;
+        string value;
+    }
+
+    /**
+     * @notice Get the token parameters for a given token.
+     * If none are configured, the tokenParams should be empty.
+     * @param coreContract The address of the core contract to call.
+     * @param tokenId The tokenId of the token to get data for.
+     * @return tokenParams An array of token parameters for the queried token.
+     */
+    function getTokenParams(
+        address coreContract,
+        uint256 tokenId
+    ) external view returns (TokenParam[] memory tokenParams);
+}