@artblocks/contracts 1.2.1 → 1.3.1

package/contracts/web3call/augment-hooks/InjectUSDCTotalSupply.sol

@@ -0,0 +1,69 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {AbstractPMPAugmentHook} from "./AbstractPMPAugmentHook.sol";
+
+import {IWeb3Call} from "../../interfaces/v0.8.x/IWeb3Call.sol";
+import {IERC20} from "@openzeppelin-5.0/contracts/interfaces/IERC20.sol";
+import {Strings} from "@openzeppelin-5.0/contracts/utils/Strings.sol";
+
+/**
+ * @title InjectUSDCTotalSupply
+ * @author Art Blocks Inc.
+ * @notice This hook appends the total supply of USDC, in wei, to a tokens PMPs.
+ */
+contract InjectUSDCTotalSupply is AbstractPMPAugmentHook {
+    using Strings for uint256;
+
+    address public immutable usdcAddress;
+
+    /**
+     * @notice Constructor.
+     * @param _usdcAddress The address of the USDC contract.
+     * For mainnet, this is 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48
+     */
+    constructor(address _usdcAddress) {
+        usdcAddress = _usdcAddress;
+    }
+
+    /**
+     * @notice Augment the token parameters for a given token.
+     * Appends the token owner's ETH balance into a tokens PMPs.
+     * @dev This hook is called when a token's PMPs are read.
+     * @dev This must return all desired tokenParams, not just additional data.
+     * @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
+        override
+        returns (IWeb3Call.TokenParam[] memory augmentedTokenParams)
+    {
+        // create a new tokenParam array with one extra element
+        uint256 originalLength = tokenParams.length;
+        uint256 newLength = originalLength + 1;
+        augmentedTokenParams = new IWeb3Call.TokenParam[](newLength);
+
+        // copy the original tokenParams into the new array
+        for (uint256 i = 0; i < originalLength; i++) {
+            augmentedTokenParams[i] = tokenParams[i];
+        }
+
+        // get + inject the total supply of USDC
+        uint256 totalSupplyUSDC = IERC20(usdcAddress).totalSupply();
+        augmentedTokenParams[originalLength] = IWeb3Call.TokenParam({
+            key: "totalSupplyUSDC",
+            value: totalSupplyUSDC.toString()
+        });
+
+        // return the augmented tokenParams
+        return augmentedTokenParams;
+    }
+}

package/contracts/web3call/configure-hooks/abstractPMPConfigureHook.sol

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+// Created By: Art Blocks Inc.
+
+pragma solidity ^0.8.0;
+
+import {IPMPConfigureHook} from "../../interfaces/v0.8.x/IPMPConfigureHook.sol";
+import {IWeb3Call} from "../../interfaces/v0.8.x/IWeb3Call.sol";
+import {IPMPV0} from "../../interfaces/v0.8.x/IPMPV0.sol";
+
+import {ERC165} from "@openzeppelin-5.0/contracts/utils/introspection/ERC165.sol";
+import {IERC165} from "@openzeppelin-5.0/contracts/interfaces/IERC165.sol";
+
+/**
+ * @title Abstract Web3Call contract
+ * @author Art Blocks Inc.
+ * @notice This abstract can be inherited by any contract that wants to implement the Web3Call interface.
+ * It indicates support for the IWeb3Call interface via ERC165 interface detection, and ensures that all
+ * child contracts implement the required IWeb3Call functions.
+ */
+abstract contract AbstractPMPConfigureHook is IPMPConfigureHook, ERC165 {
+    /**
+     * @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 virtual;
+
+    function supportsInterface(
+        bytes4 interfaceId
+    ) public view override(ERC165, IERC165) returns (bool) {
+        return
+            interfaceId == type(IPMPConfigureHook).interfaceId ||
+            super.supportsInterface(interfaceId);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artblocks/contracts",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Smart contracts used by Art Blocks",
   "files": [
     "/contracts/**/*.sol",
@@ -100,7 +100,7 @@
     "@types/mocha": "^10.0.8",
     "@types/prompt": "^1.1.8",
     "@typescript-eslint/eslint-plugin": "^7.13.0",
-    "@typescript-eslint/parser": "^7.13.0",
+    "@typescript-eslint/parser": "^8.17.0",
     "aws-sdk-client-mock": "^4.0.1",
     "chai": "^4.3.10",
     "coveralls": "^3.1.1",
@@ -116,7 +116,7 @@
     "husky": "^9.0.11",
     "istanbul-combine": "^0.3.0",
     "keccak256": "^1.0.6",
-    "merkletreejs": "^0.3.11",
+    "merkletreejs": "^0.4.1",
     "prettier": "^3.3.2",
     "prettier-plugin-solidity": "^1.3.1",
     "prompt": "^1.3.0",
@@ -137,10 +137,10 @@
     "@openzeppelin-4.7/contracts": "npm:@openzeppelin/contracts@4.7.1",
     "@openzeppelin-4.8/contracts-upgradeable": "npm:@openzeppelin/contracts-upgradeable@4.8.0",
     "@openzeppelin-5.0/contracts": "npm:@openzeppelin/contracts@5.0.1",
-    "@urql/exchange-retry": "^1.2.1",
+    "@urql/exchange-retry": "^1.3.0",
     "graphql": "^16.8.2",
     "scripty.sol": "2.1.1",
     "solady": "^0.0.181",
-    "urql": "^4.0.7"
+    "urql": "^4.2.1"
   }
 }