[SDK-CORE|SUBGRAPH] ERC20x peripherals

packages/ethereum-contracts/contracts/utils/SuperfluidFrameworkDeploymentSteps.sol

@@ -54,6 +54,9 @@ contract SuperfluidFrameworkDeploymentSteps {
         InstantDistributionAgreementV1 ida;
         IDAv1Library.InitData idaLib;
         SuperTokenFactory superTokenFactory;
+        ISuperToken superTokenLogic;
+        ConstantOutflowNFT constantOutflowNFT;
+        ConstantInflowNFT constantInflowNFT;
         TestResolver resolver;
         SuperfluidLoader superfluidLoader;
         CFAv1Forwarder cfaV1Forwarder;
@@ -306,6 +309,9 @@ contract SuperfluidFrameworkDeploymentSteps {
             ida: idaV1,
             idaLib: IDAv1Library.InitData(host, idaV1),
             superTokenFactory: superTokenFactory,
+            superTokenLogic: superTokenLogic,
+            constantOutflowNFT: constantOutflowNFT,
+            constantInflowNFT: constantInflowNFT,
             resolver: testResolver,
             superfluidLoader: superfluidLoader,
             cfaV1Forwarder: cfaV1Forwarder,

packages/ethereum-contracts/dev-scripts/run-deploy-contracts-and-token.js

@@ -5,6 +5,7 @@ deployContractsAndToken()
     .then(async ({deployer, tokenDeploymentOutput}) => {
         const frameworkAddresses = await deployer.getFramework();
 
+
         const deploymentOutput = {
             network: "mainnet",
             testNetwork: "hardhat",
@@ -17,6 +18,8 @@ deployContractsAndToken()
             nativeAssetSuperTokenAddress:
                 tokenDeploymentOutput.nativeAssetSuperTokenData
                     .nativeAssetSuperTokenAddress,
+            constantOutflowNFTAddress: frameworkAddresses.constantOutflowNFT,
+            constantInflowNFTAddress: frameworkAddresses.constantInflowNFT,
         };
 
         // create json output

packages/ethereum-contracts/test/foundry/SuperfluidFrameworkDeployer.t.sol

@@ -2,12 +2,7 @@
 pragma solidity 0.8.19;
 
 import { FoundrySuperfluidTester } from "./FoundrySuperfluidTester.sol";
-import {
-    IPureSuperToken,
-    ISETH,
-    TestToken,
-    SuperToken
-} from "../../contracts/utils/SuperfluidFrameworkDeployer.sol";
+import { IPureSuperToken, ISETH, TestToken, SuperToken } from "../../contracts/utils/SuperfluidFrameworkDeployer.sol";
 import { SuperfluidLoader } from "../../contracts/utils/SuperfluidLoader.sol";
 
 contract SuperfluidFrameworkDeployerTest is FoundrySuperfluidTester {
@@ -19,13 +14,18 @@ contract SuperfluidFrameworkDeployerTest is FoundrySuperfluidTester {
         assertTrue(address(sf.cfa) != address(0), "SFDeployer: cfa not deployed");
         assertTrue(address(sf.ida) != address(0), "SFDeployer: ida not deployed");
         assertTrue(address(sf.superTokenFactory) != address(0), "SFDeployer: superTokenFactory not deployed");
+        assertTrue(address(sf.superTokenLogic) != address(0), "SFDeployer: superTokenLogic not deployed");
+        assertTrue(address(sf.constantOutflowNFT) != address(0), "SFDeployer: constantOutflowNFT not deployed");
+        assertTrue(address(sf.constantInflowNFT) != address(0), "SFDeployer: constantInflowNFT not deployed");
         assertTrue(address(sf.resolver) != address(0), "SFDeployer: resolver not deployed");
         assertTrue(address(sf.superfluidLoader) != address(0), "SFDeployer: superfluidLoader not deployed");
         assertTrue(address(sf.cfaV1Forwarder) != address(0), "SFDeployer: cfaV1Forwarder not deployed");
     }
 
     function testResolverGetsGovernance() public {
-        assertEq(sf.resolver.get("TestGovernance.test"), address(sf.governance), "SFDeployer: governance not registered");
+        assertEq(
+            sf.resolver.get("TestGovernance.test"), address(sf.governance), "SFDeployer: governance not registered"
+        );
     }
 
     function testResolverGetsHost() public {
@@ -74,7 +74,8 @@ contract SuperfluidFrameworkDeployerTest is FoundrySuperfluidTester {
         assertEq(_superToken.symbol(), string.concat(_symbol, "x"), "SFDeployer: Super token symbol not properly set");
 
         // assert proper resolver listing for underlying and wrapper super token
-        address resolverUnderlyingTokenAddress = sf.resolver.get(string.concat("tokens.test.", underlyingToken.symbol()));
+        address resolverUnderlyingTokenAddress =
+            sf.resolver.get(string.concat("tokens.test.", underlyingToken.symbol()));
         assertEq(
             resolverUnderlyingTokenAddress,
             address(underlyingToken),
@@ -94,7 +95,8 @@ contract SuperfluidFrameworkDeployerTest is FoundrySuperfluidTester {
         );
 
         // assert proper resolver listing
-        address resolverTokenAddress = sf.resolver.get(string.concat("supertokens.test.", nativeAssetSuperToken.symbol()));
+        address resolverTokenAddress =
+            sf.resolver.get(string.concat("supertokens.test.", nativeAssetSuperToken.symbol()));
         assertEq(
             resolverTokenAddress,
             address(nativeAssetSuperToken),

packages/sdk-core/CHANGELOG.md

@@ -5,6 +5,9 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+### Added
+- Support for `ConstantOutflowNFT` and `ConstantInflowNFT` functions
+
 ## [0.6.9] - 2023-09-11
 
 ### Added

packages/sdk-core/src/ConstantInflowNFT.ts

@@ -0,0 +1,18 @@
+import { ethers } from "ethers";
+
+import FlowNFTBase from "./FlowNFTBase";
+import {
+    ConstantInflowNFT__factory,
+    IConstantInflowNFT,
+} from "./typechain-types";
+
+export default class ConstantInflowNFT extends FlowNFTBase {
+    override readonly contract: IConstantInflowNFT;
+    constructor(address: string) {
+        super(address);
+        this.contract = new ethers.Contract(
+            address,
+            ConstantInflowNFT__factory.abi
+        ) as IConstantInflowNFT;
+    }
+}

packages/sdk-core/src/ConstantOutflowNFT.ts

@@ -0,0 +1,18 @@
+import { ethers } from "ethers";
+
+import FlowNFTBase from "./FlowNFTBase";
+import {
+    ConstantOutflowNFT__factory,
+    IConstantOutflowNFT,
+} from "./typechain-types";
+
+export default class ConstantOutflowNFT extends FlowNFTBase {
+    override readonly contract: IConstantOutflowNFT;
+    constructor(address: string) {
+        super(address);
+        this.contract = new ethers.Contract(
+            address,
+            ConstantOutflowNFT__factory.abi
+        ) as IConstantOutflowNFT;
+    }
+}

packages/sdk-core/src/ERC20Token.ts

@@ -2,7 +2,13 @@ import { ethers } from "ethers";
 
 import Operation from "./Operation";
 import { SFError } from "./SFError";
-import { IBaseSuperTokenParams, ITransferFromParams } from "./interfaces";
+import {
+    ERC20AllowanceParams,
+    ERC20BalanceOfParams,
+    IBaseSuperTokenParams,
+    ITransferFromParams,
+    ProviderOrSigner,
+} from "./interfaces";
 import { IERC20Metadata, IERC20Metadata__factory } from "./typechain-types";
 import { normalizeAddress } from "./utils";
 
@@ -32,11 +38,7 @@ export default class ERC20Token {
         owner,
         spender,
         providerOrSigner,
-    }: {
-        owner: string;
-        spender: string;
-        providerOrSigner: ethers.providers.Provider | ethers.Signer;
-    }): Promise<string> => {
+    }: ERC20AllowanceParams): Promise<string> => {
         const normalizedOwner = normalizeAddress(owner);
         const normalizedSpender = normalizeAddress(spender);
         try {
@@ -62,10 +64,7 @@ export default class ERC20Token {
     balanceOf = async ({
         account,
         providerOrSigner,
-    }: {
-        account: string;
-        providerOrSigner: ethers.providers.Provider | ethers.Signer;
-    }): Promise<string> => {
+    }: ERC20BalanceOfParams): Promise<string> => {
         try {
             const normalizedAccount = normalizeAddress(account);
             const balanceOf = await this.contract
@@ -89,7 +88,7 @@ export default class ERC20Token {
     name = async ({
         providerOrSigner,
     }: {
-        providerOrSigner: ethers.providers.Provider | ethers.Signer;
+        providerOrSigner: ProviderOrSigner;
     }): Promise<string> => {
         try {
             const name = await this.contract.connect(providerOrSigner).name();
@@ -111,7 +110,7 @@ export default class ERC20Token {
     symbol = async ({
         providerOrSigner,
     }: {
-        providerOrSigner: ethers.providers.Provider | ethers.Signer;
+        providerOrSigner: ProviderOrSigner;
     }): Promise<string> => {
         try {
             const symbol = await this.contract
@@ -135,7 +134,7 @@ export default class ERC20Token {
     totalSupply = async ({
         providerOrSigner,
     }: {
-        providerOrSigner: ethers.providers.Provider | ethers.Signer;
+        providerOrSigner: ProviderOrSigner;
     }): Promise<string> => {
         try {
             const totalSupply = await this.contract