[ETHEREUM-CONTRACTS/SDK-CORE/SUBGRAPH] Use more Typechain capabilities (

#1113) Provide end-consumer access to typechain files via ethereum-contracts as the origin source and also exported via sdk-core no more abi file imports, using typechain generated factories all around fix up lint scripts add typechain build pipeline in ethereum-contracts Co-authored-by: Daniel <tokdaniel4@gmail.com>
superfluid-finance · Oct 12, 2022 · 5713860 · 5713860
1 parent eef6e1f
commit 5713860
Show file tree

Hide file tree

Showing 43 changed files with 264 additions and 291 deletions.
diff --git a/.github/workflows/call.check-query-schema-against-subgraph.yml b/.github/workflows/call.check-query-schema-against-subgraph.yml
@@ -29,9 +29,7 @@ jobs:
         run: yarn install --frozen-lockfile
 
       - name: "Build contracts"
-        run: |
-          yarn build:contracts-truffle
-          yarn build:contracts-hardhat
+        run: yarn build
         working-directory: ./packages/ethereum-contracts
 
       - name: "Start hardhat node"

diff --git a/.github/workflows/call.setup-deploy-and-test-local-subgraph.yml b/.github/workflows/call.setup-deploy-and-test-local-subgraph.yml
@@ -32,9 +32,7 @@ jobs:
         run: yarn install --frozen-lockfile
 
       - name: "Build contracts"
-        run: |
-          yarn build:contracts-truffle
-          yarn build:contracts-hardhat
+        run: yarn build
         working-directory: ./packages/ethereum-contracts
 
       - name: "Start hardhat node"

diff --git a/.github/workflows/call.test-sdk-core.yml b/.github/workflows/call.test-sdk-core.yml
@@ -26,9 +26,7 @@ jobs:
         run: yarn install --frozen-lockfile
 
       - name: "Build contracts"
-        run: |
-          yarn build:contracts-truffle
-          yarn build:contracts-hardhat
+        run: yarn build
         working-directory: ./packages/ethereum-contracts
 
       - name: "Run test suite"

diff --git a/.github/workflows/call.test-subgraph-on-previous-sdk-core-versions.yml b/.github/workflows/call.test-subgraph-on-previous-sdk-core-versions.yml
@@ -37,9 +37,7 @@ jobs:
         run: yarn install --frozen-lockfile
 
       - name: "Build contracts"
-        run: |
-          yarn build:contracts-truffle
-          yarn build:contracts-hardhat
+        run: yarn build
         working-directory: ${{ env.contracts-working-directory }}
 
       - name: "Start hardhat node"

diff --git a/.github/workflows/handler.deploy-subgraph.yml b/.github/workflows/handler.deploy-subgraph.yml
@@ -36,9 +36,7 @@ jobs:
         run: yarn install --frozen-lockfile
 
       - name: "Build contracts"
-        run: |
-          yarn build:contracts-truffle
-          yarn build:contracts-hardhat
+        run: yarn build
         working-directory: ${{ env.contracts-working-directory }}
 
       - name: "Get ABI"

diff --git a/package.json b/package.json
@@ -64,7 +64,7 @@
         "truffle": "^5.5.28",
         "ts-node": "^10.8.2",
         "typechain": "^8.1.0",
-        "typedoc": "^0.23.12",
+        "typedoc": "^0.23.15",
         "typescript": "^4.7.4",
         "web3": "^1.7.5"
     },

diff --git a/packages/ethereum-contracts/CHANGELOG.md b/packages/ethereum-contracts/CHANGELOG.md
@@ -5,6 +5,17 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## Unreleased
 
+### Added
+
+- CFA Hooks added (#1099)
+- typechain types are provided to all consumers (#1113)
+- `SuperfluidFrameworkDeployer.sol` create Native Asset and Pure Super Tokens functionality added (#1104)
+- `TestResolver` added to allow `SuperfluidFrameworkDeployer` contract to grant admin permissions to its deployer (#1104)
+
+### Fixes
+
+- CFA Agreement forwarder delete flow fix to allow receivers to delete flow (#1094)
+
 ## [v.1.4.1] - 2022-09-20
 
 ### Added

diff --git a/packages/ethereum-contracts/package.json b/packages/ethereum-contracts/package.json
@@ -20,7 +20,8 @@
         "/build/contracts-sizes.txt",
         "/build/abi.js",
         "scripts/**/*",
-        "utils/**/*"
+        "utils/**/*",
+        "/build/typechain/**/*"
     ],
     "scripts": {
         "dev": "tasks/dev.sh",
@@ -32,6 +33,7 @@
         "build:contracts": "rm -f build/contracts/*;yarn build:contracts-truffle",
         "build:contracts-truffle": "yarn run-truffle compile",
         "build:contracts-hardhat": "yarn run-hardhat compile",
+        "build:typechain": "tsc -p tsconfig.typechain.json",
         "build:contracts-size": "tasks/print-contract-sizes.sh | tee build/contracts-sizes.txt",
         "testenv:start": "test/testenv-ctl.sh start",
         "testenv:stop": "test/testenv-ctl.sh stop",
@@ -48,7 +50,8 @@
         "posttest": "yarn testenv:stop",
         "lint": "run-s lint:*",
         "lint:sol": "solhint -w 0 contracts/*.sol contracts/*/*.sol && echo '✔  Your .sol files look good.'",
-        "lint:js-eslint": "eslint . --max-warnings=0 --report-unused-disable-directives && echo '✔  Your .js files look good.'",
+        "lint-js": "eslint test -c .eslintrc.json --ext .js",
+        "lint:js-eslint": "yarn lint-js --max-warnings=0 --report-unused-disable-directives && echo '✔  Your .js files look good.'",
         "lint-ts": "eslint test -c .eslintrc.ts.json --ext .ts",
         "lint:ts-eslint": "yarn lint-ts --max-warnings=0 --report-unused-disable-directives && echo '✔  Your .ts files look good.'",
         "fix": "run-s fix:*",

diff --git a/packages/ethereum-contracts/test/TestEnvironment.ts b/packages/ethereum-contracts/test/TestEnvironment.ts
@@ -6,7 +6,12 @@ import {artifacts, assert, ethers, expect, network, web3} from "hardhat";
 import _ from "lodash";
 import Web3 from "web3";
 
-import {ISuperToken, SuperTokenMock, TestToken} from "../typechain-types";
+import {
+    ISuperToken,
+    ISuperToken__factory,
+    SuperTokenMock,
+    TestToken,
+} from "../typechain-types";
 
 import {VerifyOptions} from "./contracts/agreements/Agreement.types";
 import AgreementHelper from "./contracts/agreements/AgreementHelper";
@@ -27,7 +32,6 @@ const {web3tx, wad4human} = require("@decentral.ee/web3-helpers");
 const SuperfluidSDK = require("@superfluid-finance/js-sdk");
 const traveler = require("ganache-time-traveler");
 
-const ISuperTokenArtifact = require("../artifacts/contracts/interfaces/superfluid/ISuperToken.sol/ISuperToken.json");
 const deployFramework = require("../scripts/deploy-framework");
 const deploySuperToken = require("../scripts/deploy-super-token");
 const deployTestToken = require("../scripts/deploy-test-token");
@@ -292,7 +296,7 @@ export default class TestEnvironment {
             )),
             (this.contracts.ISuperToken = new ethers.Contract(
                 "ISuperToken",
-                ISuperTokenArtifact.abi,
+                ISuperToken__factory.abi,
                 signer
             ) as ISuperToken),
             (this.contracts.resolver = await ethers.getContractAt(

diff --git a/packages/ethereum-contracts/test/contracts/superfluid/SuperToken.NonStandard.test.ts b/packages/ethereum-contracts/test/contracts/superfluid/SuperToken.NonStandard.test.ts
@@ -1,12 +1,12 @@
 import {SignerWithAddress} from "@nomiclabs/hardhat-ethers/signers";
 import {artifacts, assert, ethers, expect, web3} from "hardhat";
 
-import SuperTokenArtifact from "../../../artifacts/contracts/superfluid/SuperToken.sol/SuperToken.json";
 import {
     CustomSuperTokenMock,
     MockSmartWallet,
     SuperfluidMock,
     SuperToken,
+    SuperToken__factory,
     SuperTokenMock,
     TestToken,
 } from "../../../typechain-types";
@@ -46,7 +46,7 @@ describe("SuperToken's Non Standard Functions", function () {
         bobSigner = await ethers.getSigner(bob);
         superTokenContract = new ethers.Contract(
             "SuperToken",
-            SuperTokenArtifact.abi,
+            SuperToken__factory.abi,
             aliceSigner
         ) as SuperToken;
     });

diff --git a/packages/ethereum-contracts/test/contracts/tokens/SETH.test.ts b/packages/ethereum-contracts/test/contracts/tokens/SETH.test.ts
@@ -1,8 +1,7 @@
 import {assert} from "chai";
 import {artifacts, ethers, web3} from "hardhat";
 
-import SuperTokenArtifact from "../../../artifacts/contracts/superfluid/SuperToken.sol/SuperToken.json";
-import {ISETH} from "../../../typechain-types";
+import {ISETH, SuperToken__factory} from "../../../typechain-types";
 import TestEnvironment from "../../TestEnvironment";
 import {expectCustomError} from "../../utils/expectRevert";
 
@@ -119,7 +118,7 @@ describe("Super ETH (SETH) Contract", function () {
         });
         const superTokenContract = new ethers.Contract(
             "SuperToken",
-            SuperTokenArtifact.abi,
+            SuperToken__factory.abi,
             aliceSigner
         );
         await expectCustomError(

diff --git a/packages/ethereum-contracts/tsconfig.typechain.json b/packages/ethereum-contracts/tsconfig.typechain.json
@@ -0,0 +1,15 @@
+{
+    "extends": "./tsconfig",
+    "compilerOptions": {
+        "target": "ES2019",
+        "outDir": "build/typechain",
+        "moduleResolution": "node",
+        "module": "CommonJS",
+        "declaration": true,
+        "declarationMap": true,
+        "sourceMap": true
+    },
+    "files": [],
+    "include": ["typechain-types"],
+    "exclude": ["node_modules/**"]
+}
diff --git a/packages/sdk-core/CHANGELOG.md b/packages/sdk-core/CHANGELOG.md
@@ -5,6 +5,16 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+### Breaking
+
+- Creating `BatchCall` class directly requires `providerOrSigner` property now
+  - Migration: pass a signer or provider object for `providerOrSigner` if creating `BatchCall` class directly
+  > NOTE: This does not impact you if you are creating `BatchCall`'s via the `Framework` class
+
+### Added
+
+-   typechain files consumed from `@superfluid-finance/ethereum-contracts` and exported from SDK-Core
+
 ## [0.5.6] - 2022-09-07
 ### Fixes
 - Correct `subgraphAPIEndpoint` in `getResolverData`

diff --git a/packages/sdk-core/package.json b/packages/sdk-core/package.json
@@ -29,11 +29,11 @@
         "testenv:stop": "tasks/testenv-ctl.sh stop",
         "pretest": "yarn testenv:start",
         "test": "hardhat test --network localhost --tsconfig \"tsconfig.test.json\"",
-        "dev": "nodemon -e ts -i src/typechain -x hardhat test --network localhost --tsconfig \"tsconfig.test.json\"",
+        "dev": "nodemon -e ts -x hardhat test --network localhost --tsconfig \"tsconfig.test.json\"",
         "test-coverage": "nyc --reporter=html --reporter=lcov --reporter=json yarn test",
         "posttest": "yarn testenv:stop",
         "check-updates": "ncu --target minor --dep prod,dev",
-        "doc:html": "typedoc --out dist/docs --entryPoints ./src/index.ts && copyfiles -f ./sf-logo.png ./dist/docs/",
+        "doc:html": "typedoc --entryPointStrategy expand ./src --options ./typedoc.js && copyfiles -f ./sf-logo.png ./dist/docs/",
         "lint": "run-s lint:*",
         "lint:eslint": "eslint src --ext .ts",
         "fix": "run-s fix:*",
@@ -42,8 +42,6 @@
         "set-default-subgraph-release-tag": "node scripts/setDefaultSubgraphReleaseTag.js",
         "start-node": "hardhat node",
         "generate": "run-s generate:*",
-        "generate:abi-files": "rm -rf src/abi && mkdir -p src/abi && tasks/build-abi-json.sh",
-        "generate:web3-types": "typechain --target=ethers-v5 --out-dir=./src/typechain \"./src/abi/**/*.json\"",
         "generate:ajv-validations": "ts-node scripts/ajv.ts",
         "generate:graphql-types": "graphql-codegen --config subgraph-codegen.yml",
         "generate-graphql-schema": "yarn generate-graphql-schema:v1",
@@ -57,6 +55,7 @@
         "url": "https://github.com/superfluid-finance/protocol-monorepo/issues"
     },
     "dependencies": {
+        "@superfluid-finance/ethereum-contracts": "1.4.1",
         "@superfluid-finance/metadata": "git+https://github.com/superfluid-finance/metadata.git",
         "browserify": "^17.0.0",
         "graphql-request": "^4.3.0",
@@ -71,7 +70,6 @@
         "@graphql-codegen/typescript": "^2.7.3",
         "@graphql-codegen/typescript-operations": "^2.5.3",
         "@graphql-typed-document-node/core": "^3.1.1",
-        "@superfluid-finance/ethereum-contracts": "1.4.1",
         "ajv": "^8.11.0",
         "get-graphql-schema": "^2.1.2",
         "mocha": "^10.0.0"

diff --git a/packages/sdk-core/src/BatchCall.ts b/packages/sdk-core/src/BatchCall.ts
@@ -1,15 +1,16 @@
 import { JsonFragment } from "@ethersproject/abi";
+import { Superfluid__factory } from "@superfluid-finance/ethereum-contracts/build/typechain";
 import { ethers } from "ethers";
 
 import Host from "./Host";
 import Operation, { OperationType } from "./Operation";
 import { SFError } from "./SFError";
-import SuperfluidABI from "./abi/Superfluid.json";
 import { getTransactionDescription, removeSigHashFromCallData } from "./utils";
 
 interface IBatchCallOptions {
     hostAddress: string;
     operations: ReadonlyArray<Operation>;
+    providerOrSigner: ethers.providers.Provider | ethers.Signer;
 }
 
 interface OperationStruct {
@@ -85,7 +86,7 @@ export default class BatchCall {
         // Handles Superfluid.callAgreement
         if (operation.type === "SUPERFLUID_CALL_AGREEMENT") {
             const functionArgs = this.getCallDataFunctionArgs(
-                SuperfluidABI.abi,
+                Superfluid__factory.abi,
                 populatedTransaction.data
             );
             const data = encoder.encode(
@@ -103,7 +104,7 @@ export default class BatchCall {
         // Handles Superfluid.callAppAction
         if (operation.type === "CALL_APP_ACTION") {
             const functionArgs = this.getCallDataFunctionArgs(
-                SuperfluidABI.abi,
+                Superfluid__factory.abi,
                 populatedTransaction.data
             );