@artblocks/contracts 1.0.4 → 1.2.0

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

@@ -0,0 +1,124 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {EngineConfiguration} from "./IGenArt721CoreContractV3_Engine.sol";
+
+interface IEngineFactoryV0 {
+    /// @notice Engine Core type
+    enum EngineCoreType {
+        Engine, // GenArt721CoreV3_Engine Contract
+        EngineFlex // GenArt721CoreV3_Engine_Flex Contract
+    }
+    /**
+     * @notice This contract was deployed.
+     * @param engineImplementation address with the implementation of the Engine contract
+     * @param engineFlexImplementation address with the implementation of the Engine Flex contract
+     * @param type_ type of this contract
+     */
+    event Deployed(
+        address indexed engineImplementation,
+        address indexed engineFlexImplementation,
+        bytes32 indexed type_
+    );
+    /**
+     * @notice New Engine or Engine Flex contract was created.
+     * @param engineContract address of the newly created Engine contract
+     */
+    event EngineContractCreated(address indexed engineContract);
+    /**
+     * @notice This contract was abandoned and no longer can be used to create
+     * new Engine or Engine Flex contracts.
+     */
+    event Abandoned();
+
+    /**
+     * @notice Creates a new Engine or Engine Flex contract with the provided
+     * `engineConfiguration`, depending on the `engineCoreContractType`.
+     * @param engineCoreContractType Type of Engine Core contract.
+     * @param engineConfiguration EngineConfiguration data to configure the
+     * contract with.
+     * @param adminACLContract Address of admin access control contract, to be
+     * set as contract owner. A new contract will be deployed if address is null.
+     * @param salt Salt used to deterministically deploy the clone.
+     * @return engineContract The address of the newly created Engine or Engine Flex
+     * contract. The address is also emitted in both the `EngineCreated` and
+     * `EngineFlexCreated` events.
+     */
+    function createEngineContract(
+        EngineCoreType engineCoreContractType,
+        EngineConfiguration calldata engineConfiguration,
+        address adminACLContract,
+        bytes32 salt
+    ) external returns (address engineContract);
+
+    /**
+     * @notice Drains the contract's balance to the `recipient`.
+     * @param recipient The address to send funds to.
+     * Only callable by the owner.
+     */
+    function drainETH(address payable recipient) external;
+
+    /**
+     * @notice Drains the contract's balance of an input ERC20 token to
+     * the `recipient`.
+     * @param ERC20TokenAddress The address of the ERC20 token to withdraw.
+     * @param recipient The address to send ERC20 tokens to.
+     * Only callable by the owner.
+     */
+    function drainERC20(address ERC20TokenAddress, address recipient) external;
+
+    /**
+     * @notice Calls transferOwnership on the core registry.
+     * Useful for updating the owner of the core registry contract.
+     * @param _owner address of the new owner
+     */
+    function transferCoreRegistryOwnership(address _owner) external;
+
+    /**
+     * @notice Registers multiple contracts with the core registry.
+     * @param contractAddresses An array of contract addresses to register.
+     * @param coreVersions An array of versions corresponding to the contract addresses.
+     * @param coreTypes An array of types corresponding to the contract addresses.
+     */
+    function registerMultipleContracts(
+        address[] calldata contractAddresses,
+        bytes32[] calldata coreVersions,
+        bytes32[] calldata coreTypes
+    ) external;
+
+    /**
+     * @notice Unregisters multiple contracts from the core registry.
+     * @param contractAddresses An array of contract addresses to unregister.
+     */
+    function unregisterMultipleContracts(
+        address[] calldata contractAddresses
+    ) external;
+
+    /**
+     * @notice The implementation contract that is cloned when creating new
+     * Engine Core contracts.
+     */
+    function engineImplementation() external view returns (address);
+
+    /**
+     * @notice The implementation contract that is cloned when creating new
+     * Engine Flex Core contracts.
+     */
+    function engineFlexImplementation() external view returns (address);
+
+    /**
+     * @notice Indicates whether the contract is abandoned.
+     * Once abandoned, the contract can no longer be used to create new Engine
+     * or Engine Flex contracts.
+     * @return bool True if the contract is abandoned, false otherwise.
+     */
+    function isAbandoned() external view returns (bool);
+
+    /**
+     * @notice Indicates the type of the contract, e.g. `EngineFactoryV0`.
+     * @return type_ The type of the contract.
+     */
+    function type_() external pure returns (bytes32);
+}

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

@@ -16,6 +16,4 @@ interface IFilteredMinterDAExpSettlementV0 is
     IFilteredMinterDAExpSettlement_Mixin,
     IFilteredMinterV1,
     IFilteredMinterDAExpV0
-{
-
-}
+{}

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

@@ -16,6 +16,4 @@ interface IFilteredMinterDAExpSettlementV1 is
     IFilteredMinterDAExpSettlement_Mixin,
     IFilteredMinterV2,
     IFilteredMinterDAExpV0
-{
-
-}
+{}

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

@@ -11,6 +11,4 @@ pragma solidity ^0.8.0;
  * add support for manually setting project max invocations.
  * @author Art Blocks Inc.
  */
-interface IFilteredMinterDAExpV1 is IFilteredMinterDAExpV0, IFilteredMinterV2 {
-
-}
+interface IFilteredMinterDAExpV1 is IFilteredMinterDAExpV0, IFilteredMinterV2 {}

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

@@ -11,6 +11,4 @@ pragma solidity ^0.8.0;
  * add support for manually setting project max invocations.
  * @author Art Blocks Inc.
  */
-interface IFilteredMinterDALinV1 is IFilteredMinterDALinV0, IFilteredMinterV2 {
-
-}
+interface IFilteredMinterDALinV1 is IFilteredMinterDALinV0, IFilteredMinterV2 {}

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

@@ -14,6 +14,4 @@ pragma solidity ^0.8.0;
 interface IFilteredMinterHolderV2 is
     IFilteredMinterHolderV1,
     IFilteredMinterV2
-{
-
-}
+{}

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

@@ -14,6 +14,4 @@ pragma solidity ^0.8.0;
 interface IFilteredMinterMerkleV2 is
     IFilteredMinterMerkleV1,
     IFilteredMinterV2
-{
-
-}
+{}

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

@@ -4,8 +4,6 @@
 pragma solidity ^0.8.0;
 
 import "./IAdminACLV0.sol";
-/// use the Royalty Registry's IManifold interface for token royalties
-import "./IManifold.sol";
 
 /**
  * @title This interface is intended to house interface items that are common
@@ -14,7 +12,121 @@ import "./IManifold.sol";
  * add support the Royalty Registry by default.
  * @author Art Blocks Inc.
  */
-interface IGenArt721CoreContractV3_Base is IManifold {
+interface IGenArt721CoreContractV3_Base {
+    // This interface emits generic events that contain fields that indicate
+    // which parameter has been updated. This is sufficient for application
+    // state management, while also simplifying the contract and indexing code.
+    // This was done as an alternative to having custom events that emit what
+    // field-values have changed for each event, given that changed values can
+    // be introspected by indexers due to the design of this smart contract
+    // exposing these state changes via publicly viewable fields.
+
+    /**
+     * @notice Project's royalty splitter was updated to `_splitter`.
+     * @dev New event in v3.2
+     * @param projectId The project ID.
+     * @param royaltySplitter The new splitter address to receive royalties.
+     */
+    event ProjectRoyaltySplitterUpdated(
+        uint256 indexed projectId,
+        address indexed royaltySplitter
+    );
+
+    // The following fields are used to indicate which contract-level parameter
+    // has been updated in the `PlatformUpdated` event:
+    // @dev only append to the end of this enum in the case of future updates
+    enum PlatformUpdatedFields {
+        FIELD_NEXT_PROJECT_ID, // 0
+        FIELD_NEW_PROJECTS_FORBIDDEN, // 1
+        FIELD_DEFAULT_BASE_URI, // 2
+        FIELD_RANDOMIZER_ADDRESS, // 3
+        FIELD_NEXT_CORE_CONTRACT, // 4
+        FIELD_ARTBLOCKS_DEPENDENCY_REGISTRY_ADDRESS, // 5
+        FIELD_ARTBLOCKS_ON_CHAIN_GENERATOR_ADDRESS, // 6
+        FIELD_PROVIDER_SALES_ADDRESSES, // 7
+        FIELD_PROVIDER_PRIMARY_SALES_PERCENTAGES, // 8
+        FIELD_PROVIDER_SECONDARY_SALES_BPS, // 9
+        FIELD_SPLIT_PROVIDER // 10
+    }
+
+    // The following fields are used to indicate which project-level parameter
+    // has been updated in the `ProjectUpdated` event:
+    // @dev only append to the end of this enum in the case of future updates
+    enum ProjectUpdatedFields {
+        FIELD_PROJECT_COMPLETED, // 0
+        FIELD_PROJECT_ACTIVE, // 1
+        FIELD_PROJECT_ARTIST_ADDRESS, // 2
+        FIELD_PROJECT_PAUSED, // 3
+        FIELD_PROJECT_CREATED, // 4
+        FIELD_PROJECT_NAME, // 5
+        FIELD_PROJECT_ARTIST_NAME, // 6
+        FIELD_PROJECT_SECONDARY_MARKET_ROYALTY_PERCENTAGE, // 7
+        FIELD_PROJECT_DESCRIPTION, // 8
+        FIELD_PROJECT_WEBSITE, // 9
+        FIELD_PROJECT_LICENSE, // 10
+        FIELD_PROJECT_MAX_INVOCATIONS, // 11
+        FIELD_PROJECT_SCRIPT, // 12
+        FIELD_PROJECT_SCRIPT_TYPE, // 13
+        FIELD_PROJECT_ASPECT_RATIO, // 14
+        FIELD_PROJECT_BASE_URI, // 15
+        FIELD_PROJECT_PROVIDER_SECONDARY_FINANCIALS // 16
+    }
+
+    /**
+     * @notice Error codes for the GenArt721 contract. Used by the GenArt721Error
+     * custom error.
+     * @dev only append to the end of this enum in the case of future updates
+     */
+    enum ErrorCodes {
+        OnlyNonZeroAddress, // 0
+        OnlyNonEmptyString, // 1
+        OnlyNonEmptyBytes, // 2
+        TokenDoesNotExist, // 3
+        ProjectDoesNotExist, // 4
+        OnlyUnlockedProjects, // 5
+        OnlyAdminACL, // 6
+        OnlyArtist, // 7
+        OnlyArtistOrAdminACL, // 8
+        OnlyAdminACLOrRenouncedArtist, // 9
+        OnlyMinterContract, // 10
+        MaxInvocationsReached, // 11
+        ProjectMustExistAndBeActive, // 12
+        PurchasesPaused, // 13
+        OnlyRandomizer, // 14
+        TokenHashAlreadySet, // 15
+        NoZeroHashSeed, // 16
+        OverMaxSumOfPercentages, // 17
+        IndexOutOfBounds, // 18
+        OverMaxSumOfBPS, // 19
+        MaxOf100Percent, // 20
+        PrimaryPayeeIsZeroAddress, // 21
+        SecondaryPayeeIsZeroAddress, // 22
+        MustMatchArtistProposal, // 23
+        NewProjectsForbidden, // 24
+        NewProjectsAlreadyForbidden, // 25
+        OnlyArtistOrAdminIfLocked, // 26
+        OverMaxSecondaryRoyaltyPercentage, // 27
+        OnlyMaxInvocationsDecrease, // 28
+        OnlyGteInvocations, // 29
+        ScriptIdOutOfRange, // 30
+        NoScriptsToRemove, // 31
+        ScriptTypeAndVersionFormat, // 32
+        AspectRatioTooLong, // 33
+        AspectRatioNoNumbers, // 34
+        AspectRatioImproperFormat, // 35
+        OnlyNullPlatformProvider, // 36
+        ContractInitialized // 37
+    }
+
+    /**
+     * @notice Emits an error code `_errorCode` in the GenArt721Error event.
+     * @dev Emitting error codes instead of error strings saves significant
+     * contract bytecode size, allowing for more contract functionality within
+     * the 24KB contract size limit.
+     * @param _errorCode The error code to emit. See ErrorCodes enum.
+     */
+    error GenArt721Error(ErrorCodes _errorCode);
+
     /**
      * @notice Token ID `_tokenId` minted to `_to`.
      */
@@ -95,14 +207,6 @@ interface IGenArt721CoreContractV3_Base is IManifold {
         uint256 _projectId
     ) external view returns (address payable);
 
-    function projectIdToAdditionalPayeePrimarySales(
-        uint256 _projectId
-    ) external view returns (address payable);
-
-    function projectIdToAdditionalPayeePrimarySalesPercentage(
-        uint256 _projectId
-    ) external view returns (uint256);
-
     function projectIdToSecondaryMarketRoyaltyPercentage(
         uint256 _projectId
     ) external view returns (uint256);

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

@@ -5,8 +5,59 @@ pragma solidity ^0.8.0;
 
 import "./IAdminACLV0.sol";
 import "./IGenArt721CoreContractV3_Base.sol";
+import "./ISplitProviderV0.sol";
+
+/**
+ * @notice Struct representing Engine contract configuration.
+ * @param tokenName Name of token.
+ * @param tokenSymbol Token symbol.
+ * @param renderProviderAddress address to send render provider revenue to
+ * @param randomizerContract Randomizer contract.
+ * @param splitProviderAddress Address to use as royalty splitter provider for the contract.
+ * @param minterFilterAddress Address of the Minter Filter to set as the Minter
+ * on the contract.
+ * @param startingProjectId The initial next project ID.
+ * @param autoApproveArtistSplitProposals Whether or not to always
+ * auto-approve proposed artist split updates.
+ * @param nullPlatformProvider Enforce always setting zero platform provider fees and addresses.
+ * @param allowArtistProjectActivation Allow artist to activate their own projects.
+ * @dev _startingProjectId should be set to a value much, much less than
+ * max(uint248), but an explicit input type of `uint248` is used as it is
+ * safer to cast up to `uint256` than it is to cast down for the purposes
+ * of setting `_nextProjectId`.
+ */
+struct EngineConfiguration {
+    string tokenName;
+    string tokenSymbol;
+    address renderProviderAddress;
+    address platformProviderAddress;
+    address newSuperAdminAddress;
+    address randomizerContract;
+    address splitProviderAddress;
+    address minterFilterAddress;
+    uint248 startingProjectId;
+    bool autoApproveArtistSplitProposals;
+    bool nullPlatformProvider;
+    bool allowArtistProjectActivation;
+}
 
 interface IGenArt721CoreContractV3_Engine is IGenArt721CoreContractV3_Base {
+    // @dev new function in V3.2
+    /**
+     * @notice Initializes the contract with the provided `engineConfiguration`.
+     * This function should be called atomically, immediately after deployment.
+     * Only callable once. Validation on `engineConfiguration` is performed by caller.
+     * @param engineConfiguration EngineConfiguration to configure the contract with.
+     * @param adminACLContract_ Address of admin access control contract, to be
+     * set as contract owner.
+     * @param defaultBaseURIHost Base URI prefix to initialize default base URI with.
+     */
+    function initialize(
+        EngineConfiguration calldata engineConfiguration,
+        address adminACLContract_,
+        string memory defaultBaseURIHost
+    ) external;
+
     // @dev new function in V3
     function getPrimaryRevenueSplits(
         uint256 _projectId,
@@ -49,24 +100,49 @@ interface IGenArt721CoreContractV3_Engine is IGenArt721CoreContractV3_Base {
         view
         returns (uint256);
 
-    // @dev The render provider secondary sales royalties payment address
-    function renderProviderSecondarySalesAddress()
+    /** @notice The default render provider payment address for all secondary sales royalty
+     * revenues, for all new projects. Individual project payment info is defined
+     * in each project's ProjectFinance struct.
+     * @return The default render provider payment address for secondary sales royalties.
+     */
+    function defaultRenderProviderSecondarySalesAddress()
         external
         view
         returns (address payable);
 
-    // @dev The platform provider secondary sales royalties payment address
-    function platformProviderSecondarySalesAddress()
+    /** @notice The default platform provider payment address for all secondary sales royalty
+     * revenues, for all new projects. Individual project payment info is defined
+     * in each project's ProjectFinance struct.
+     * @return The default platform provider payment address for secondary sales royalties.
+     */
+    function defaultPlatformProviderSecondarySalesAddress()
         external
         view
         returns (address payable);
 
-    // @dev Basis points of secondary sales allocated to the render provider
-    function renderProviderSecondarySalesBPS() external view returns (uint256);
+    /** @notice The default render provider payment basis points for all secondary sales royalty
+     * revenues, for all new projects. Individual project payment info is defined
+     * in each project's ProjectFinance struct.
+     * @return The default render provider payment basis points for secondary sales royalties.
+     */
+    function defaultRenderProviderSecondarySalesBPS()
+        external
+        view
+        returns (uint256);
 
-    // @dev Basis points of secondary sales allocated to the platform provider
-    function platformProviderSecondarySalesBPS()
+    /** @notice The default platform provider payment basis points for all secondary sales royalty
+     * revenues, for all new projects. Individual project payment info is defined
+     * in each project's ProjectFinance struct.
+     * @return The default platform provider payment basis points for secondary sales royalties.
+     */
+    function defaultPlatformProviderSecondarySalesBPS()
         external
         view
         returns (uint256);
+
+    /**
+     * @notice The address of the current split provider being used by the contract.
+     * @return The address of the current split provider.
+     */
+    function splitProvider() external view returns (ISplitProviderV0);
 }

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

@@ -18,8 +18,8 @@ interface IGenArt721CoreContractV3_Engine_Flex is
      * @notice When an external asset dependency is updated or added, this event is emitted.
      * @param _projectId The project ID of the project that was updated.
      * @param _index The index of the external asset dependency that was updated.
-     * @param _cid The content ID of the external asset dependency. This is an empty string
-     * if the dependency type is ONCHAIN.
+     * @param _cid Field that contains the CID of the dependency if IPFS or ARWEAVE, empty string of ONCHAIN, or a string representation
+     * of the Art Blocks Dependency Registry's `dependencyNameAndVersion` if ART_BLOCKS_DEPENDENCY_REGISTRY.
      * @param _dependencyType The type of the external asset dependency.
      * @param _externalAssetDependencyCount The number of external asset dependencies.
      */
@@ -54,17 +54,31 @@ interface IGenArt721CoreContractV3_Engine_Flex is
     event ProjectExternalAssetDependenciesLocked(uint256 indexed _projectId);
 
     /**
-     * @notice An external asset dependency type. Can be one of IPFS, ARWEAVE, or ONCHAIN.
+     * @notice An external asset dependency type. Can be one of IPFS, ARWEAVE, ONCHAIN, or ART_BLOCKS_DEPENDENCY_REGISTRY.
      */
     enum ExternalAssetDependencyType {
         IPFS,
         ARWEAVE,
-        ONCHAIN
+        ONCHAIN,
+        ART_BLOCKS_DEPENDENCY_REGISTRY
     }
 
     /**
-     * @notice An external asset dependency. This is a struct that contains the CID of the dependency,
-     * the type of the dependency, and the address of the bytecode for this dependency.
+     * @notice Project storage that relate to Flex data.
+     */
+    struct ProjectFlex {
+        bool externalAssetDependenciesLocked;
+        uint24 externalAssetDependencyCount;
+        mapping(uint256 => ExternalAssetDependency) externalAssetDependencies;
+    }
+
+    /**
+     * @notice An external asset dependency, without the retrieved data of any ONCHAIN assets. This reflects what is
+     * stored in this contract's storage.
+     * @param CID field that contains the CID of the dependency if IPFS or ARWEAVE, empty string of ONCHAIN, or a string representation
+     * of the Art Blocks Dependency Registry's `dependencyNameAndVersion` if ART_BLOCKS_DEPENDENCY_REGISTRY.
+     * @param dependencyType field that contains the type of the dependency.
+     * @param bytecodeAddress field that contains the address of the bytecode for this dependency if ONCHAIN, null address otherwise.
      */
     struct ExternalAssetDependency {
         string cid;
@@ -73,8 +87,12 @@ interface IGenArt721CoreContractV3_Engine_Flex is
     }
 
     /**
-     * @notice An external asset dependency with data. This is a convenience struct that contains the CID of the dependency,
-     * the type of the dependency, the address of the bytecode for this dependency, and the data retrieved from this bytecode address.
+     * @notice An external asset dependency with data. This is a convenience struct.
+     * @param CID field that contains the CID of the dependency if IPFS or ARWEAVE, empty string of ONCHAIN, or a string representation
+     * of the Art Blocks Dependency Registry's `dependencyNameAndVersion` if ART_BLOCKS_DEPENDENCY_REGISTRY.
+     * @param dependencyType field that contains the type of the dependency.
+     * @param bytecodeAddress field that contains the address of the bytecode for this dependency if ONCHAIN, null address otherwise.
+     * @param data field that contains the data retrieved from this bytecode address if ONCHAIN, empty string otherwise.
      */
     struct ExternalAssetDependencyWithData {
         string cid;

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

@@ -0,0 +1,141 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import "./IAdminACLV0.sol";
+import "./IGenArt721CoreContractV3_Engine_PreV3p2.sol";
+
+/**
+ * @title This interface is intended to house interface items that are common
+ * across all GenArt721CoreContractV3 Engine Flex and derivative implementations.
+ * @author Art Blocks Inc.
+ */
+interface IGenArt721CoreContractV3_Engine_Flex_PreV3p2 is
+    IGenArt721CoreContractV3_Engine_PreV3p2
+{
+    /**
+     * @notice When an external asset dependency is updated or added, this event is emitted.
+     * @param _projectId The project ID of the project that was updated.
+     * @param _index The index of the external asset dependency that was updated.
+     * @param _cid The content ID of the external asset dependency. This is an empty string
+     * if the dependency type is ONCHAIN.
+     * @param _dependencyType The type of the external asset dependency.
+     * @param _externalAssetDependencyCount The number of external asset dependencies.
+     */
+    event ExternalAssetDependencyUpdated(
+        uint256 indexed _projectId,
+        uint256 indexed _index,
+        string _cid,
+        ExternalAssetDependencyType _dependencyType,
+        uint24 _externalAssetDependencyCount
+    );
+
+    /**
+     * @notice The project id `_projectId` has had an external asset dependency removed at index `_index`.
+     */
+    event ExternalAssetDependencyRemoved(
+        uint256 indexed _projectId,
+        uint256 indexed _index
+    );
+
+    /**
+     * @notice The preferred gateway for dependency type `_dependencyType` has been updated to `_gatewayAddress`.
+     */
+    event GatewayUpdated(
+        ExternalAssetDependencyType indexed _dependencyType,
+        string _gatewayAddress
+    );
+
+    /**
+     * @notice The project id `_projectId` has had all external asset dependencies locked.
+     * @dev This is a one-way operation. Once locked, the external asset dependencies cannot be updated.
+     */
+    event ProjectExternalAssetDependenciesLocked(uint256 indexed _projectId);
+
+    /**
+     * @notice An external asset dependency type. Can be one of IPFS, ARWEAVE, or ONCHAIN.
+     */
+    enum ExternalAssetDependencyType {
+        IPFS,
+        ARWEAVE,
+        ONCHAIN
+    }
+
+    /**
+     * @notice Project storage that relate to Flex data.
+     */
+    struct ProjectFlex {
+        bool externalAssetDependenciesLocked;
+        uint24 externalAssetDependencyCount;
+        mapping(uint256 => ExternalAssetDependency) externalAssetDependencies;
+    }
+
+    /**
+     * @notice An external asset dependency. This is a struct that contains the CID of the dependency,
+     * the type of the dependency, and the address of the bytecode for this dependency.
+     */
+    struct ExternalAssetDependency {
+        string cid;
+        ExternalAssetDependencyType dependencyType;
+        address bytecodeAddress;
+    }
+
+    /**
+     * @notice An external asset dependency with data. This is a convenience struct that contains the CID of the dependency,
+     * the type of the dependency, the address of the bytecode for this dependency, and the data retrieved from this bytecode address.
+     */
+    struct ExternalAssetDependencyWithData {
+        string cid;
+        ExternalAssetDependencyType dependencyType;
+        address bytecodeAddress;
+        string data;
+    }
+
+    // preferredIPFSGateway is a url string
+    function preferredIPFSGateway() external view returns (string memory);
+
+    // preferredArweaveGateway is a url string
+    function preferredArweaveGateway() external view returns (string memory);
+
+    // updates the preferred IPFS gateway
+    function updateIPFSGateway(string calldata _gateway) external;
+
+    // updates the preferred Arweave gateway
+    function updateArweaveGateway(string calldata _gateway) external;
+
+    // locks the external asset dependencies for a project
+    function lockProjectExternalAssetDependencies(uint256 _projectId) external;
+
+    // updates the external asset dependency for a project at a given index
+    function updateProjectExternalAssetDependency(
+        uint256 _projectId,
+        uint256 _index,
+        string memory _cidOrData,
+        ExternalAssetDependencyType _dependencyType
+    ) external;
+
+    // adds an external asset dependency for a project
+    function addProjectExternalAssetDependency(
+        uint256 _projectId,
+        string memory _cidOrData,
+        ExternalAssetDependencyType _dependencyType
+    ) external;
+
+    // removes an external asset dependency for a project at a given index
+    function removeProjectExternalAssetDependency(
+        uint256 _projectId,
+        uint256 _index
+    ) external;
+
+    // getter function for project external asset dependencies
+    function projectExternalAssetDependencyByIndex(
+        uint256 _projectId,
+        uint256 _index
+    ) external view returns (ExternalAssetDependencyWithData memory);
+
+    // getter function project external asset dependency count
+    function projectExternalAssetDependencyCount(
+        uint256 _projectId
+    ) external view returns (uint256);
+}