@artblocks/contracts 1.0.2 → 1.0.4

package/contracts/randomizer/shared/SharedRandomizerV0.sol

@@ -0,0 +1,260 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Creatd By: Art Blocks Inc.
+
+pragma solidity 0.8.19;
+
+import "../../interfaces/v0.8.x/IGenArt721CoreContractV3_Base.sol";
+import "../../interfaces/v0.8.x/ISharedRandomizerV0.sol";
+import "../../interfaces/v0.8.x/IPseudorandomAtomic.sol";
+
+/**
+ * @title A shared randomizer contract that enables support of many Art Blocks
+ * and Art Blocks Engine core contracts with a single randomizer.
+ * @notice This randomizer is designed to be used with many core contracts that
+ * implement the `IGenArt721CoreContractV3_Base` interface. It exclusively uses
+ * atomic callbacks, and will assign a token's hash before returning from the
+ * `assignTokenHash` function, as long as the call does not revert.
+ *
+ * The randomizer generates a token's hash seed in one of two ways:
+ * 1. If the project of the token is specified as using a hash seed setter
+ * contract, the randomizer will assign the token the hash seed as previously
+ * pre-set by the project's hash seed setter contract. If no hash seed has
+ * been set, the randomizer will revert (will not assign null token hash).
+ * 2. If the project of the token is not specified as using a hash seed setter
+ * contract, the randomizer will generate a new hash seed using the
+ * `IPseudorandomAtomic` contract, which is immutable and set during
+ * deployment.
+ *
+ * @dev When using this randomizer for ployptych minting, several requirements
+ * may be required by the hash seed setter contract, including the possibility
+ * that a token's hash seed must be available in a public getter function on
+ * the core contract. Please inspect the hash seed setter contract to ensure
+ * that all requirements are met.
+ *
+ * @notice Privileged Roles and Ownership:
+ * Privileged roles and abilities are controlled by each core contract's
+ * artists.
+ * These roles hold extensive power and can influence the behavior of this
+ * randomizer.
+ * Care must be taken to ensure that the artist addresses are secure.
+ * ----------------------------------------------------------------------------
+ * The following functions are restricted to only the Artist address:
+ * - setHashSeedSetterContract
+ * - toggleProjectUseAssignedHashSeed
+ * ----------------------------------------------------------------------------
+ * The following function is restricted to only the hash seed setter contract
+ * of a given core contract:
+ * - preSetHashSeed
+ * ----------------------------------------------------------------------------
+ * Additional admin and artist privileged roles may be described on minters,
+ * registries, and other contracts that may interact with this randomizer.
+ */
+contract SharedRandomizerV0 is ISharedRandomizerV0 {
+    IPseudorandomAtomic public immutable pseudorandomAtomicContract;
+
+    // constant used to obtain the project ID from the token ID
+    uint256 internal constant ONE_MILLION = 1_000_000;
+
+    // mapping of core contract => token ID => pre-assigned hash seed
+    // @dev this mapping is only used when the project is configured as using
+    // a hash seed setter contract. It is not populated when the project is
+    // using pseudorandomAtomicContract.
+    mapping(address => mapping(uint256 => bytes12))
+        private _preAssignedHashSeeds;
+
+    // mapping of core contract => project ID => usesHashSeedSetter Contract
+    mapping(address => mapping(uint256 => bool))
+        private _projectUsesHashSeedSetter;
+
+    // mapping of core contract => projectId => hash seed setter contract
+    mapping(address => mapping(uint256 => address))
+        private _hashSeedSetterContracts;
+
+    // modifier to restrict access to only Artist allowed calls
+    function _onlyArtist(
+        address _coreContract,
+        uint256 _projectId
+    ) internal view {
+        require(
+            msg.sender ==
+                IGenArt721CoreContractV3_Base(_coreContract)
+                    .projectIdToArtistAddress(_projectId),
+            "Only Artist"
+        );
+    }
+
+    /**
+     * Modifier to restrict access to only calls by the hash seed setter
+     * contract of a given project.
+     * @param _coreContract core contract address associated with the project
+     * @param _projectId project ID being set
+     */
+    function _onlyHashSeedSetterContract(
+        address _coreContract,
+        uint256 _projectId
+    ) internal view {
+        require(
+            msg.sender == _hashSeedSetterContracts[_coreContract][_projectId],
+            "Only Hash Seed Setter Contract"
+        );
+    }
+
+    /**
+     *
+     * @param _pseudorandomAtomicContract Address of the pseudorandom atomic
+     * contract to use for atomically generating random values. This contract
+     * does not have an owner, and therefore the pseudorandom atomic contract
+     * address cannot be changed after deployment.
+     */
+    constructor(address _pseudorandomAtomicContract) {
+        pseudorandomAtomicContract = IPseudorandomAtomic(
+            _pseudorandomAtomicContract
+        );
+        emit PseudorandomAtomicContractUpdated({
+            pseudorandomAtomicContract: _pseudorandomAtomicContract
+        });
+    }
+
+    /**
+     * @inheritdoc ISharedRandomizerV0
+     */
+    function setHashSeedSetterContract(
+        address _coreContract,
+        uint256 _projectId,
+        address _hashSeedSetterContract
+    ) external {
+        _onlyArtist(_coreContract, _projectId);
+        _hashSeedSetterContracts[_coreContract][
+            _projectId
+        ] = _hashSeedSetterContract;
+        emit HashSeedSetterForProjectUpdated({
+            coreContract: _coreContract,
+            projectId: _projectId,
+            hashSeedSetterContract: _hashSeedSetterContract
+        });
+    }
+
+    /**
+     * @inheritdoc ISharedRandomizerV0
+     */
+    function toggleProjectUseAssignedHashSeed(
+        address _coreContract,
+        uint256 _projectId
+    ) external {
+        _onlyArtist(_coreContract, _projectId);
+        _projectUsesHashSeedSetter[_coreContract][
+            _projectId
+        ] = !_projectUsesHashSeedSetter[_coreContract][_projectId];
+        emit ProjectUsingHashSeedSetterUpdated({
+            coreContract: _coreContract,
+            projectId: _projectId,
+            usingHashSeedSetter: _projectUsesHashSeedSetter[_coreContract][
+                _projectId
+            ]
+        });
+    }
+
+    /**
+     * @inheritdoc ISharedRandomizerV0
+     */
+    function preSetHashSeed(
+        address _coreContract,
+        uint256 _tokenId,
+        bytes12 _hashSeed
+    ) external {
+        uint256 projectId = _tokenIdToProjectId(_tokenId);
+        _onlyHashSeedSetterContract(_coreContract, projectId);
+        _preAssignedHashSeeds[_coreContract][_tokenId] = _hashSeed;
+        // @dev event indicating token hash seed assigned is not required for
+        // subgraph indexing because token hash seeds are still assigned
+        // atomically in `assignTokenHash` function. If token hash seeds were
+        // assigned async, event emission may be required to support subgraph
+        // indexing.
+    }
+
+    /**
+     * @inheritdoc IRandomizer_V3CoreBase
+     */
+    function assignTokenHash(uint256 _tokenId) external {
+        // @dev This function is not specifically gated to any specific caller,
+        // but will only call back to the calling contract, `msg.sender`, to
+        // set the specified token's hash seed.
+        // A third party contract calling this function will not be able to set
+        // the token hash seed on a different core contract.
+        // @dev variables are named to improve readability
+        address coreContract = msg.sender;
+        uint256 projectId = _tokenIdToProjectId(_tokenId);
+        bytes32 hashSeed;
+        if (_projectUsesHashSeedSetter[coreContract][projectId]) {
+            hashSeed = _preAssignedHashSeeds[coreContract][_tokenId];
+        } else {
+            hashSeed = _getPseudorandomAtomic(coreContract, _tokenId);
+        }
+        // verify that the hash seed is non-zero
+        require(hashSeed != 0, "Only non-zero hash seed");
+        // assign the token hash seed on the core contract
+        IGenArt721CoreContractV3_Base(coreContract).setTokenHash_8PT(
+            _tokenId,
+            hashSeed
+        );
+    }
+
+    /**
+     * @inheritdoc ISharedRandomizerV0
+     */
+    function projectUsesHashSeedSetter(
+        address _coreContract,
+        uint256 _projectId
+    ) external view returns (bool _usingHashSeedSetter) {
+        return _projectUsesHashSeedSetter[_coreContract][_projectId];
+    }
+
+    /**
+     * @inheritdoc ISharedRandomizerV0
+     */
+    function hashSeedSetterContracts(
+        address _coreContract,
+        uint256 _projectId
+    ) external view returns (address _hashSeedSetterContract) {
+        return _hashSeedSetterContracts[_coreContract][_projectId];
+    }
+
+    /**
+     * @inheritdoc ISharedRandomizerV0
+     */
+    function preAssignedHashSeed(
+        address _coreContract,
+        uint256 _tokenId
+    ) external view returns (bytes12 _hashSeed) {
+        return _preAssignedHashSeeds[_coreContract][_tokenId];
+    }
+
+    /**
+     * @notice Internal function to atomically obtain a pseudorandom number
+     * from the configured pseudorandom contract.
+     * @param _coreContract - The core contract that is requesting an atomic
+     * pseudorandom number.
+     * @param _tokenId - The token ID on `_coreContract` that is associated
+     * with the pseudorandom number request.
+     */
+    function _getPseudorandomAtomic(
+        address _coreContract,
+        uint256 _tokenId
+    ) internal view returns (bytes32) {
+        return
+            pseudorandomAtomicContract.getPseudorandomAtomic(
+                keccak256(abi.encodePacked(_coreContract, _tokenId))
+            );
+    }
+
+    /**
+     * @notice Gets the project ID for a given `_tokenId`.
+     * @param _tokenId Token ID to be queried.
+     * @return projectId Project ID for given `_tokenId`.
+     */
+    function _tokenIdToProjectId(
+        uint256 _tokenId
+    ) internal pure returns (uint256 projectId) {
+        return _tokenId / ONE_MILLION;
+    }
+}

package/contracts/royalty-registry/GenArt721RoyaltyOverride.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
-import "../interfaces/0.8.x/IArtblocksRoyaltyOverride.sol";
-import "../interfaces/0.8.x/IGenArt721CoreContractV3.sol";
+import "../interfaces/v0.8.x/IArtblocksRoyaltyOverride.sol";
+import "../interfaces/v0.8.x/IGenArt721CoreContractV3.sol";
 
 import "@openzeppelin-4.5/contracts/utils/introspection/ERC165.sol";
 

package/contracts/royalty-registry/GenArt721RoyaltyOverride_PBAB.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: LGPL-3.0-only
 // Created By: Art Blocks Inc.
 
-import "../interfaces/0.8.x/IArtblocksRoyaltyOverride.sol";
-import "../interfaces/0.8.x/IGenArt721CoreV2_PBAB.sol";
+import "../interfaces/v0.8.x/IArtblocksRoyaltyOverride.sol";
+import "../interfaces/v0.8.x/IGenArt721CoreV2_PBAB.sol";
 
 import "@openzeppelin-4.5/contracts/utils/introspection/ERC165.sol";
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artblocks/contracts",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Smart contracts used by Art Blocks",
   "files": [
     "/contracts/**/*.sol",
@@ -9,44 +9,49 @@
   "scripts": {
     "clean": "hardhat clean",
     "compile": "hardhat compile",
-    "gh-action-compile": "hardhat --config gh-action.config.ts compile",
+    "build": "hardhat --config build-package.config.ts compile",
     "docgen": "hardhat docgen",
-    "generate:typechain": "typechain --target ethers-v5 --outDir ./scripts/contracts './artifacts/contracts/**/!(*.dbg)*.json'",
+    "generate:typechain": "typechain --target ethers-v5 --out-dir ./scripts/contracts './artifacts/contracts/**/!(*.dbg)*.json'",
     "test": "hardhat test",
+    "size": "hardhat size-contracts",
     "test:parallel": "hardhat test --parallel",
     "coverage": "hardhat coverage",
     "format": "prettier --write 'contracts/**/*.sol' && prettier --write 'scripts/**/*.ts' && prettier --write 'test/**/*.ts'",
     "lint": "prettier --check 'contracts/**/*.sol' && prettier --check 'scripts/**/*.ts' && prettier --check 'test/**/*.ts' && npx eslint 'test/**/*.ts'",
     "remix": "remixd -s ./ --remix-ide https://remix.ethereum.org",
-    "codegen:dev": "NODE_ENV=dev yarn graphql-codegen --require dotenv/config --config ./graphql.config.js dotenv_config_path=./.env",
-    "codegen:staging": "NODE_ENV=staging yarn graphql-codegen --require dotenv/config --config ./graphql.config.js dotenv_config_path=./.env",
-    "codegen:mainnet": "NODE_ENV=mainnet yarn graphql-codegen --require dotenv/config --config ./graphql.config.js dotenv_config_path=./.env",
-    "deploy:dev:v3-engine": "yarn codegen:dev && NODE_ENV=dev yarn hardhat run --network goerli scripts/engine/V3/generic-engine-deployer.ts",
-    "deploy:staging:v3-engine": "yarn codegen:staging && NODE_ENV=staging yarn hardhat run --network goerli scripts/engine/V3/generic-engine-deployer.ts",
-    "deploy:mainnet:v3-engine": "yarn codegen:mainnet && NODE_ENV=mainnet yarn hardhat run --network mainnet scripts/engine/V3/generic-engine-deployer.ts",
-    "deploy:goerli:minter": "yarn hardhat run --network goerli scripts/minter-deployments/generic-minter-deployer-v3core.ts",
-    "deploy:mainnet:minter": "yarn hardhat run --network mainnet scripts/minter-deployments/generic-minter-deployer-v3core.ts"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "yarn lint",
-      "pre-push": "yarn test"
-    }
+    "codegen": "yarn --cwd=\"../..\" codegen:project contracts",
+    "deploy:dev:v3-engine": "yarn codegen && yarn require-low-gas goerli && NODE_ENV=dev yarn hardhat run --network goerli scripts/engine/V3/generic-engine-deployer.ts",
+    "deploy:dev-arbitrum:v3-engine": "yarn codegen && yarn require-low-gas arbitrum-goerli && NODE_ENV=arbitrum-dev yarn hardhat run --network arbitrum-goerli scripts/engine/V3/generic-engine-deployer.ts",
+    "deploy:staging-arbitrum:v3-engine": "yarn codegen && yarn require-low-gas arbitrum-goerli && NODE_ENV=arbitrum-staging yarn hardhat run --network arbitrum-goerli scripts/engine/V3/generic-engine-deployer.ts",
+    "deploy:arbitrum:v3-engine": "yarn codegen && yarn require-low-gas arbitrum && NODE_ENV=arbitrum yarn hardhat run --network arbitrum scripts/engine/V3/generic-engine-deployer.ts",
+    "deploy:staging:v3-engine": "yarn codegen && yarn require-low-gas goerli && NODE_ENV=staging yarn hardhat run --network goerli scripts/engine/V3/generic-engine-deployer.ts",
+    "deploy:mainnet:v3-engine": "yarn codegen && yarn require-low-gas mainnet && NODE_ENV=mainnet yarn hardhat run --network mainnet scripts/engine/V3/generic-engine-deployer.ts",
+    "deploy:goerli:minter": "yarn require-low-gas goerli && yarn hardhat run --network goerli scripts/minter-deployments/V3/generic-minter-deployer-v3core.ts",
+    "deploy:mainnet:minter": "yarn require-low-gas mainnet && yarn hardhat run --network mainnet scripts/minter-deployments/V3/generic-minter-deployer-v3core.ts",
+    "deploy:shared-randomizer:goerli": "yarn require-low-gas goerli && yarn hardhat run --network goerli scripts/randomizer-deployments/shared-randomizer-deployer.ts",
+    "deploy:shared-randomizer:mainnet": "yarn require-low-gas mainnet && yarn hardhat run --network mainnet scripts/randomizer-deployments/shared-randomizer-deployer.ts",
+    "deploy:shared-randomizer:arbitrum-goerli": "yarn require-low-gas arbitrum-goerli && yarn hardhat run --network arbitrum-goerli scripts/randomizer-deployments/shared-randomizer-deployer.ts",
+    "deploy:shared-randomizer:arbitrum": "yarn require-low-gas arbitrum && yarn hardhat run --network arbitrum scripts/randomizer-deployments/shared-randomizer-deployer.ts",
+    "deploy:shared-minter-filter:goerli": "yarn require-low-gas goerli && yarn hardhat run --network goerli scripts/minter-filter-deployments/shared-minter-filter-deployer.ts",
+    "deploy:shared-minter-filter:mainnet": "yarn require-low-gas mainnet && yarn hardhat run --network mainnet scripts/minter-filter-deployments/shared-minter-filter-deployer.ts",
+    "deploy:shared-minter-filter:arbitrum-goerli": "yarn require-low-gas arbitrum-goerli && yarn hardhat run --network arbitrum-goerli scripts/minter-filter-deployments/shared-minter-filter-deployer.ts",
+    "deploy:shared-minter-filter:arbitrum": "yarn require-low-gas arbitrum && yarn hardhat run --network arbitrum scripts/minter-filter-deployments/shared-minter-filter-deployer.ts",
+    "deploy:shared-shared-minters:goerli": "yarn require-low-gas goerli && yarn hardhat run --network goerli scripts/minter-deployments/shared-minters-deployer.ts",
+    "deploy:shared-shared-minters:mainnet": "yarn require-low-gas mainnet && yarn hardhat run --network mainnet scripts/minter-deployments/shared-minters-deployer.ts",
+    "deploy:shared-shared-minters:arbitrum-goerli": "yarn require-low-gas arbitrum-goerli && yarn hardhat run --network arbitrum-goerli scripts/minter-deployments/shared-minters-deployer.ts",
+    "deploy:shared-shared-minters:arbitrum": "yarn require-low-gas arbitrum && yarn hardhat run --network arbitrum scripts/minter-deployments/shared-minters-deployer.ts",
+    "require-low-gas": "yarn hardhat run scripts/require-low-gas.ts --network",
+    "pre-commit": "yarn lint"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "^3.245.0",
-    "@aws-sdk/credential-providers": "^3.245.0",
-    "@defi-wonderland/smock": "^2.3.4",
+    "@aws-sdk/client-s3": "^3.398.0",
+    "@aws-sdk/credential-providers": "^3.398.0",
+    "@defi-wonderland/smock": "^2.3.5",
     "@gnosis.pm/safe-contracts": "^1.3.0",
     "@gnosis.pm/safe-core-sdk": "^2.1.0",
     "@gnosis.pm/safe-core-sdk-types": "^1.7.0",
     "@gnosis.pm/safe-ethers-lib": "1.1.0",
     "@gnosis.pm/safe-service-client": "^1.4.0",
-    "@graphql-codegen/cli": "^3.0.0",
-    "@graphql-codegen/typescript": "^3.0.0",
-    "@graphql-codegen/typescript-document-nodes": "^3.0.0",
-    "@graphql-codegen/typescript-operations": "^3.0.0",
-    "@graphql-codegen/typescript-urql": "^3.7.3",
     "@nomicfoundation/hardhat-network-helpers": "^1.0.8",
     "@nomiclabs/hardhat-ethers": "^2.2.1",
     "@nomiclabs/hardhat-etherscan": "^3.1.4",
@@ -54,39 +59,42 @@
     "@nomiclabs/hardhat-truffle5": "^2.0.7",
     "@nomiclabs/hardhat-waffle": "^2.0.3",
     "@nomiclabs/hardhat-web3": "^2.0.0",
-    "@openzeppelin/hardhat-upgrades": "^1.22.0",
+    "@openzeppelin/hardhat-upgrades": "^1.28.0",
     "@openzeppelin/test-helpers": "^0.5.16",
-    "@remix-project/remixd": "^0.6.12",
-    "@typechain/ethers-v5": "^6.0.5",
-    "@types/jest": "^29.4.0",
+    "@remix-project/remixd": "^0.6.17",
+    "@typechain/ethers-v5": "^11.1.1",
+    "@types/jest": "^29.5.4",
     "@types/mocha": "^10.0.1",
     "@types/prompt": "^1.1.5",
-    "@typescript-eslint/eslint-plugin": "^5.48.0",
-    "@typescript-eslint/parser": "^5.48.0",
-    "aws-sdk-client-mock": "^2.1.1",
+    "@typescript-eslint/eslint-plugin": "^6.4.1",
+    "@typescript-eslint/parser": "^6.4.1",
+    "aws-sdk-client-mock": "^3.0.0",
     "chai": "^4.3.7",
     "coveralls": "^3.1.1",
-    "dotenv": "^16.0.3",
-    "eslint": "^8.31.0",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.46.0",
+    "eslint-config-custom": "*",
     "eslint-plugin-mocha": "^10.1.0",
+    "eslint-plugin-prettier": "^5.0.0",
     "ethereum-waffle": "^4.0.10",
     "ethers": "^5.7.2",
-    "hardhat": "^2.12.5",
-    "hardhat-contract-sizer": "^2.6.1",
+    "hardhat": "^2.17.1",
+    "hardhat-contract-sizer": "^2.10.0",
     "hardhat-docgen": "^1.3.0",
     "hardhat-gas-reporter": "^1.0.9",
     "husky": "^8.0.3",
     "istanbul-combine": "^0.3.0",
     "keccak256": "^1.0.6",
     "merkletreejs": "^0.3.9",
-    "prettier": "^2.8.1",
+    "prettier": "^3.0.2",
     "prettier-plugin-solidity": "^1.1.1",
     "prompt": "^1.3.0",
     "prompt-sync": "^4.2.0",
-    "solidity-coverage": "^0.8.0",
+    "solidity-coverage": "^0.8.4",
     "ts-node": "^9.1.1",
-    "typechain": "^4.0.3",
-    "typescript": "^5.0.2"
+    "tsconfig": "*",
+    "typechain": "^8.3.1",
+    "typescript": "^5.2.2"
   },
   "author": "Art Blocks, Inc",
   "license": "LGPL-3.0-only",
@@ -95,8 +103,8 @@
     "@openzeppelin-4.5/contracts": "npm:@openzeppelin/contracts@4.5.0",
     "@openzeppelin-4.7/contracts": "npm:@openzeppelin/contracts@4.7.1",
     "@openzeppelin-4.8/contracts-upgradeable": "npm:@openzeppelin/contracts-upgradeable@4.8.0",
-    "@urql/exchange-retry": "^1.0.0",
-    "graphql": "^16.6.0",
-    "urql": "^3.0.3"
+    "@urql/exchange-retry": "^1.2.0",
+    "graphql": "^16.8.0",
+    "urql": "^4.0.5"
   }
 }

package/.env.example

@@ -1,17 +0,0 @@
-MAINNET_JSON_RPC_PROVIDER_URL=
-GOERLI_JSON_RPC_PROVIDER_URL=
-PALM_MAINNET_JSON_RPC_PROVIDER_URL=
-PALM_TESTNET_JSON_RPC_PROVIDER_URL=
-MAINNET_PRIVATE_KEY=
-TESTNET_PRIVATE_KEY=
-ETHERSCAN_API_KEY=
-AWS_ACCESS_KEY_ID=
-AWS_SECRET_ACCESS_KEY=
-COINMARKETCAP_API_KEY=
-# The following are only required if using Art Blocks Deployment Scripts
-GRAPHQL_API_ENDPOINT_DEV=
-HASURA_ADMIN_SECRET_DEV=
-GRAPHQL_API_ENDPOINT_STAGING=
-HASURA_ADMIN_SECRET_STAGING=
-GRAPHQL_API_ENDPOINT_MAINNET=
-HASURA_ADMIN_SECRET_MAINNET=

package/LICENSE

@@ -1,165 +0,0 @@
-                   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.