@superfluid-finance/sdk-core 0.1.1-dev.fa49a94.0 → 0.2.1-dev.64549c3.0

package/dist/module/validation.d.ts

@@ -6,3 +6,4 @@ export declare const validateIndexRequest: (filter: IIndexRequestFilter) => void
 export declare const validateIndexSubscriptionRequest: (filter: IIndexSubscriptionRequestFilter) => void;
 export declare const validateStreamRequest: (filter: IStreamRequestFilter) => void;
 export declare const validateAccountTokenSnapshotRequest: (filter: IAccountTokenSnapshotFilter) => void;
+//# sourceMappingURL=validation.d.ts.map

package/dist/module/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/validation.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,2BAA2B,EAC3B,mBAAmB,EACnB,+BAA+B,EAC/B,oBAAoB,EACpB,wBAAwB,EAC3B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,YAAY,EAAE,MAAM,GAAG,CAAC;AA+FjC,eAAO,MAAM,yBAAyB,4CAErC,CAAC;AACF,eAAO,MAAM,oBAAoB,gCAEhC,CAAC;AACF,eAAO,MAAM,oBAAoB,uCAEhC,CAAC;AACF,eAAO,MAAM,gCAAgC,mDAE5C,CAAC;AACF,eAAO,MAAM,qBAAqB,wCAEjC,CAAC;AACF,eAAO,MAAM,mCAAmC,+CAK3C,CAAC"}

package/dist/module/validation.js

@@ -0,0 +1,92 @@
+import Ajv from "ajv";
+import { ethers } from "ethers";
+import SFError from "./SFError";
+const ajv = new Ajv();
+ajv.addFormat("addressOrEmpty", {
+    type: "string",
+    validate: (x) => x === "" || ethers.utils.isAddress(x),
+});
+ajv.addFormat("stringNumber", {
+    type: "string",
+    validate: (x) => !isNaN(Number(x)),
+});
+// Schemas
+const superTokenRequestSchema = {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        isListed: { type: "boolean", nullable: true },
+    },
+};
+const eventRequestSchema = {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        account: { type: "string", format: "addressOrEmpty", nullable: true },
+        timestamp_gt: {
+            type: "number",
+            nullable: true,
+        },
+    },
+};
+const indexRequestSchema = {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        indexId: { type: "string", format: "stringNumber", nullable: true },
+        publisher: { type: "string", format: "addressOrEmpty", nullable: true },
+        token: { type: "string", format: "addressOrEmpty", nullable: true },
+    },
+};
+const accountTokenSnapshotRequestSchema = {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        account: {
+            type: "string",
+            format: "addressOrEmpty",
+            nullable: true,
+        },
+        token: { type: "string", format: "addressOrEmpty", nullable: true },
+    },
+};
+const indexSubscriptionRequestSchema = {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        subscriber: {
+            type: "string",
+            format: "stringNumber",
+            nullable: true,
+        },
+        approved: { type: "boolean", nullable: true },
+    },
+};
+const streamRequestSchema = {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        sender: { type: "string", format: "addressOrEmpty", nullable: true },
+        receiver: { type: "string", format: "addressOrEmpty", nullable: true },
+        token: { type: "string", format: "addressOrEmpty", nullable: true },
+    },
+};
+function wrapValidationWithCustomError(validateFunction) {
+    return (filter) => {
+        if (!validateFunction(filter)) {
+            throw new SFError({
+                type: "INVALID_OBJECT",
+                customMessage: "Invalid Filter Object",
+                errorObject: validateFunction.errors,
+            });
+        }
+    };
+}
+// Validate functions
+export const validateSuperTokenRequest = wrapValidationWithCustomError(ajv.compile(superTokenRequestSchema));
+export const validateEventRequest = wrapValidationWithCustomError(ajv.compile(eventRequestSchema));
+export const validateIndexRequest = wrapValidationWithCustomError(ajv.compile(indexRequestSchema));
+export const validateIndexSubscriptionRequest = wrapValidationWithCustomError(ajv.compile(indexSubscriptionRequestSchema));
+export const validateStreamRequest = wrapValidationWithCustomError(ajv.compile(streamRequestSchema));
+export const validateAccountTokenSnapshotRequest = wrapValidationWithCustomError(ajv.compile(accountTokenSnapshotRequestSchema));
+//# sourceMappingURL=validation.js.map

package/dist/module/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,GAAyC,MAAM,KAAK,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,OAAO,MAAM,WAAW,CAAC;AAWhC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;AACtB,GAAG,CAAC,SAAS,CAAC,gBAAgB,EAAE;IAC5B,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;CACjE,CAAC,CAAC;AACH,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE;IAC1B,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC7C,CAAC,CAAC;AAEH,UAAU;AACV,MAAM,uBAAuB,GAA6C;IACtE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;KAChD;CACJ,CAAC;AACF,MAAM,kBAAkB,GAAiC;IACrD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE;QACrE,YAAY,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACjB;KACJ;CACJ,CAAC;AAEF,MAAM,kBAAkB,GAAwC;IAC5D,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE;QACnE,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE;QACvE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE;KACtE;CACJ,CAAC;AAEF,MAAM,iCAAiC,GACnC;IACI,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,gBAAgB;YACxB,QAAQ,EAAE,IAAI;SACjB;QACD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE;KACtE;CACJ,CAAC;AAEN,MAAM,8BAA8B,GAChC;IACI,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,cAAc;YACtB,QAAQ,EAAE,IAAI;SACjB;QACD,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;KAChD;CACJ,CAAC;AAEN,MAAM,mBAAmB,GAAyC;IAC9D,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE;QACpE,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE;QACtE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE;KACtE;CACJ,CAAC;AAEF,SAAS,6BAA6B,CAClC,gBAAqC;IAErC,OAAO,CAAC,MAAS,EAAE,EAAE;QACjB,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;YAC3B,MAAM,IAAI,OAAO,CAAC;gBACd,IAAI,EAAE,gBAAgB;gBACtB,aAAa,EAAE,uBAAuB;gBACtC,WAAW,EAAE,gBAAgB,CAAC,MAAM;aACvC,CAAC,CAAC;SACN;IACL,CAAC,CAAC;AACN,CAAC;AAED,qBAAqB;AACrB,MAAM,CAAC,MAAM,yBAAyB,GAAG,6BAA6B,CAClE,GAAG,CAAC,OAAO,CAA2B,uBAAuB,CAAC,CACjE,CAAC;AACF,MAAM,CAAC,MAAM,oBAAoB,GAAG,6BAA6B,CAC7D,GAAG,CAAC,OAAO,CAAe,kBAAkB,CAAC,CAChD,CAAC;AACF,MAAM,CAAC,MAAM,oBAAoB,GAAG,6BAA6B,CAC7D,GAAG,CAAC,OAAO,CAAsB,kBAAkB,CAAC,CACvD,CAAC;AACF,MAAM,CAAC,MAAM,gCAAgC,GAAG,6BAA6B,CACzE,GAAG,CAAC,OAAO,CAAkC,8BAA8B,CAAC,CAC/E,CAAC;AACF,MAAM,CAAC,MAAM,qBAAqB,GAAG,6BAA6B,CAC9D,GAAG,CAAC,OAAO,CAAuB,mBAAmB,CAAC,CACzD,CAAC;AACF,MAAM,CAAC,MAAM,mCAAmC,GAC5C,6BAA6B,CACzB,GAAG,CAAC,OAAO,CACP,iCAAiC,CACpC,CACJ,CAAC"}

package/package.json

@@ -1,31 +1,40 @@
 {
     "name": "@superfluid-finance/sdk-core",
-    "version": "0.1.1-dev.fa49a94.0",
+    "version": "0.2.1-dev.64549c3.0",
     "description": "SDK Core for building with Superfluid Protocol",
     "homepage": "https://github.com/superfluid-finance/protocol-monorepo/tree/dev/packages/sdk-core#readme",
     "repository": "github:superfluid-finance/protocol-monorepo",
     "license": "MIT",
     "main": "dist/main/index.js",
     "module": "dist/module/index.js",
-    "types": "dist/main/index.d.ts",
+    "types": "dist/module/index.d.ts",
     "files": [
-        "dist/**/*.js",
-        "dist/**/*.d.ts"
+        "dist/main",
+        "dist/module",
+        "dist/index.umd.js",
+        "CHANGELOG.md",
+        "LICENSE",
+        "README.md"
     ],
     "scripts": {
-        "build": "yarn generate-abi-files && yarn generate-web3-types && yarn generate-graphql-types && rm -rf dist && rollup --config rollup.config.ts --configPlugin typescript",
+        "build": "yarn generate-abi-files && yarn generate-web3-types && yarn generate-graphql-types && rm -rf dist && run-p build:*",
+        "build:main": "tsc -p tsconfig.json",
+        "build:module": "tsc -p tsconfig.module.json",
+        "build:umd": "mkdir -p dist && browserify src/index.ts -s sdkCore -p [ tsify --noImplicitAny ] > dist/index.umd.js",
         "testenv:start": "tasks/testenv-ctl.sh start",
         "testenv:stop": "tasks/testenv-ctl.sh stop",
         "pretest": "yarn testenv:start",
-        "test": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter=html --reporter=lcov --reporter=json npx hardhat test --network localhost",
+        "test": "nyc --reporter=html --reporter=lcov --reporter=json npx hardhat test --network localhost --tsconfig \"tsconfig.test.json\"",
         "posttest": "yarn testenv:stop",
         "check-updates": "ncu --target minor --dep prod,dev",
-        "doc:html": "typedoc --out build/docs --entryPoints ./src/index.ts",
+        "doc:html": "typedoc --out dist/docs --entryPoints ./src/index.ts",
         "lint": "run-s lint:*",
-        "lint:prettier": "prettier \"src/**/*.ts\" --write",
-        "lint:lint": "eslint src --ext .ts --fix",
-        "pre-commit": "run-s pre-commit:*",
-        "pre-commit:lint": "echo no pre-commit currently",
+        "lint:prettier": "prettier \"src/**/*.ts\" --list-different",
+        "lint:eslint": "eslint src --ext .ts",
+        "fix": "run-s fix:*",
+        "fix:prettier": "yarn lint:prettier --write",
+        "fix:eslint": "yarn lint:eslint --fix",
+        "pre-commit": "run-s lint:*",
         "generate-abi-files": "rm -rf src/abi && mkdir src/abi && tasks/build-abi-json.sh",
         "generate-web3-types": "typechain --target=ethers-v5 --out-dir=./src/typechain \"./src/abi/**/*.json\"",
         "generate-graphql-types": "graphql-codegen --config subgraph-codegen.yml"
@@ -34,49 +43,54 @@
         "url": "https://github.com/superfluid-finance/protocol-monorepo/issues"
     },
     "dependencies": {
-        "@ethersproject/providers": "^5.5.0",
+        "@ethersproject/providers": "^5.5.1",
         "ajv": "^8.8.2",
-        "ethers": "^5.5.1",
-        "graphql-request": "^3.7.0"
+        "browserify": "^17.0.0",
+        "ethers": "^5.5.2",
+        "graphql-request": "^3.7.0",
+        "tsify": "^5.0.4"
     },
     "devDependencies": {
-        "@graphql-codegen/cli": "2.3.0",
-        "@graphql-codegen/introspection": "2.1.0",
-        "@graphql-codegen/near-operation-file-preset": "^2.2.2",
-        "@graphql-codegen/typed-document-node": "^2.2.1",
-        "@graphql-codegen/typescript": "2.4.1",
-        "@graphql-codegen/typescript-operations": "2.2.1",
-        "@nomiclabs/hardhat-ethers": "^2.0.2",
+        "@graphql-codegen/cli": "2.3.1",
+        "@graphql-codegen/introspection": "2.1.1",
+        "@graphql-codegen/near-operation-file-preset": "^2.2.3",
+        "@graphql-codegen/typed-document-node": "^2.2.2",
+        "@graphql-codegen/typescript": "2.4.2",
+        "@graphql-codegen/typescript-operations": "2.2.2",
+        "@nomiclabs/hardhat-ethers": "^2.0.3",
         "@nomiclabs/hardhat-waffle": "^2.0.1",
         "@nomiclabs/hardhat-web3": "^2.0.0",
-        "@rollup/plugin-json": "^4.1.0",
-        "@rollup/plugin-typescript": "^8.3.0",
         "@typechain/ethers-v5": "^8.0.5",
-        "@typechain/hardhat": "^3.0.0",
-        "@types/chai": "^4.2.22",
+        "@typechain/hardhat": "^3.1.0",
+        "@types/chai": "^4.3.0",
         "@types/mocha": "^9.0.0",
-        "@types/node": "^16.11.10",
-        "@typescript-eslint/eslint-plugin": "^5.6.0",
-        "@typescript-eslint/parser": "^5.6.0",
+        "@types/node": "^17.0.7",
+        "@typescript-eslint/eslint-plugin": "^5.8.1",
+        "@typescript-eslint/parser": "^5.8.1",
         "chai": "^4.3.4",
         "chai-ethers": "^0.0.1",
         "coveralls": "^3.1.1",
         "dotenv": "^10.0.0",
-        "eslint": "^8.4.0",
+        "eslint": "^8.6.0",
         "eslint-config-prettier": "^8.3.0",
         "eslint-plugin-eslint-comments": "^3.2.0",
-        "eslint-plugin-import": "^2.25.3",
+        "eslint-plugin-import": "^2.25.4",
         "ethereum-waffle": "^3.4.0",
-        "hardhat": "^2.7.0",
+        "hardhat": "^2.8.0",
         "mocha": "^9.1.3",
+        "npm-run-all": "^4.1.5",
         "nyc": "^15.1.0",
-        "rollup": "^2.60.1",
+        "rollup": "^2.62.0",
         "ts-node": "^10.4.0",
-        "typechain": "^6.0.4",
+        "typechain": "^6.1.0",
         "typedoc": "^0.22.10",
-        "typescript": "^4.5.2"
+        "typescript": "^4.5.4",
+        "web3": "^1.6.1"
     },
     "resolutions": {
         "graphql": "^16.0.0"
+    },
+    "engines": {
+        "node": ">=12"
     }
 }

package/dist/umd/BatchCall.d.ts

@@ -1,53 +0,0 @@
-import { ethers } from "ethers";
-import Host from "./Host";
-import Operation from "./Operation";
-import { IConfig } from "./interfaces";
-interface IBatchCallOptions {
-    config: IConfig;
-    operations: ReadonlyArray<Operation>;
-}
-interface OperationStruct {
-    readonly operationType: number;
-    readonly target: string;
-    readonly data: string;
-}
-/**
- * @dev BatchCall Helper Class
- * @description A helper class to create `BatchCall` objects which can be executed.
- */
-export default class BatchCall {
-    options: IBatchCallOptions;
-    host: Host;
-    constructor(options: IBatchCallOptions);
-    /**
-     * @dev Gets the call agreement function arguments.
-     * @param callData callData of the function
-     * @returns {ethers.utils.Result} call agreement function arguments
-     */
-    getCallAgreementFunctionArgs: (callData: string) => ethers.utils.Result;
-    /**
-     * @dev Given an `Operation` object, gets the `OperationStruct` object.
-     * @param operation an `Operation` object
-     * @param index the index of the `Operation` in the batchCall
-     * @returns {Promise<OperationStruct>} OperationStruct object for batchCall
-     */
-    getOperationStruct: (operation: Operation, index: number) => Promise<OperationStruct>;
-    /**
-     * @dev Gets an array of `OperationStruct` objects to be passed to batchCall.
-     * @returns {Promise<OperationStruct>[]} array of operation struct promises
-     */
-    get getOperationStructArrayPromises(): Promise<OperationStruct>[];
-    /**
-     * @dev Executes a batch call given the operations on this class.
-     * @param signer the signer of the transaction
-     * @returns {Promise<ethers.ContractTransaction>} ContractTransaction object
-     */
-    exec: (signer: ethers.Signer) => Promise<ethers.ContractTransaction>;
-    /**
-     * @dev Executes a forward batch call given the operations on this class.
-     * @param signer the signer of the transaction
-     * @returns {Promise<ethers.ContractTransaction>} ContractTransaction object
-     */
-    execForward: (signer: ethers.Signer) => Promise<ethers.ContractTransaction>;
-}
-export {};

package/dist/umd/ConstantFlowAgreementV1.d.ts

@@ -1,74 +0,0 @@
-import Host from "./Host";
-import Operation from "./Operation";
-import { IAgreementV1Options, ICreateFlowParams, IDeleteFlowParams, IGetAccountFlowInfoParams, IGetFlowParams, IUpdateFlowParams, IWeb3FlowInfo, IWeb3FlowInfoParams } from "./interfaces";
-/**
- * @dev Constant Flow Agreement V1 Helper Class
- * @description A helper class to interact with the CFAV1 contract.
- */
-export default class ConstantFlowAgreementV1 {
-    readonly options: IAgreementV1Options;
-    readonly host: Host;
-    constructor(options: IAgreementV1Options);
-    private get cfaContract();
-    /**
-     * @dev Get the details of a flow.
-     * @param superToken the superToken of the agreement
-     * @param sender the sender of the flow
-     * @param receiver the receiver of the flow
-     * @param providerOrSigner a provider or signer object
-     * @returns {Promise<IWeb3FlowInfo>} Web3 Flow info object
-     */
-    getFlow: ({ superToken, sender, receiver, providerOrSigner, }: IGetFlowParams) => Promise<IWeb3FlowInfo>;
-    /**
-     * @dev Get the flow info of an account (net flow).
-     * @param superToken the superToken of the agreement
-     * @param account the account we're querying
-     * @param providerOrSigner a provider or signer object
-     * @returns {Promise<IWeb3FlowInfo>} Web3 Flow info object
-     */
-    getAccountFlowInfo: ({ superToken, account, providerOrSigner, }: IGetAccountFlowInfoParams) => Promise<IWeb3FlowInfo>;
-    /**
-     * @dev Get the net flow of an account.
-     * @param superToken the superToken of the agreement
-     * @param account the account we're querying
-     * @param providerOrSigner a provider or signer object
-     * @returns {Promise<string>} Web3 Flow info object
-     */
-    getNetFlow: ({ superToken, account, providerOrSigner, }: IGetAccountFlowInfoParams) => Promise<string>;
-    /**
-     * @dev Create a flow.
-     * @param flowRate The specified flow rate.
-     * @param receiver The receiver of the flow.
-     * @param superToken The token to be flowed.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    createFlow: ({ flowRate, receiver, superToken, userData, }: ICreateFlowParams) => Operation;
-    /**
-     * @dev Update a flow.
-     * @param flowRate The specified flow rate.
-     * @param receiver The receiver of the flow.
-     * @param superToken The token to be flowed.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    updateFlow: ({ flowRate, receiver, superToken, userData, }: IUpdateFlowParams) => Operation;
-    /**
-     * @dev Delete a flow.
-     * @param superToken The token to be flowed.
-     * @param sender The sender of the flow.
-     * @param receiver The receiver of the flow.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    deleteFlow: ({ superToken, sender, receiver, userData, }: IDeleteFlowParams) => Operation;
-    /**
-     * @dev Sanitizes flow info, converting BigNumber to string.
-     * @param timestamp last updated timestamp of flow
-     * @param flowRate the current flow rate
-     * @param deposit the deposit amount
-     * @param owedDeposit any owed depsit
-     * @returns {IWeb3FlowInfo} sanitized web3 flow info
-     */
-    _sanitizeflowInfo: ({ timestamp, flowRate, deposit, owedDeposit, }: IWeb3FlowInfoParams) => IWeb3FlowInfo;
-}

package/dist/umd/Framework.d.ts

@@ -1,75 +0,0 @@
-import { Signer } from "@ethersproject/abstract-signer";
-import { ethers } from "ethers";
-import BatchCall from "./BatchCall";
-import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
-import Host from "./Host";
-import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
-import Operation from "./Operation";
-import Query from "./Query";
-import SuperToken from "./SuperToken";
-import { IConfig, ISignerConstructorOptions } from "./interfaces";
-import { DataMode } from "./types";
-export interface IFrameworkOptions {
-    chainId?: number;
-    customSubgraphQueriesEndpoint?: string;
-    dataMode?: DataMode;
-    networkName?: string;
-    resolverAddress?: string;
-    protocolReleaseVersion?: string;
-    provider: ethers.providers.Provider;
-}
-export interface IFrameworkSettings {
-    chainId: number;
-    customSubgraphQueriesEndpoint: string;
-    dataMode: DataMode;
-    networkName: string;
-    protocolReleaseVersion: string;
-    provider: ethers.providers.Provider;
-    config: IConfig;
-}
-/**
- * @dev Superfluid Framework Class
- * @description The entrypoint for the SDK-core, `create` an instance of this for full functionality.
- */
-export default class Framework {
-    readonly userInputOptions: IFrameworkOptions;
-    settings: IFrameworkSettings;
-    cfaV1: ConstantFlowAgreementV1;
-    host: Host;
-    idaV1: InstantDistributionAgreementV1;
-    query: Query;
-    private constructor();
-    /**
-     * @dev Creates the Framework object based on user provided `options`.
-     * @param options.chainId the chainId of your desired network (e.g. 137 = matic)
-     * @param options.customSubgraphQueriesEndpoint your custom subgraph endpoint
-     * @param options.dataMode the data mode you'd like the framework to use (SUBGRAPH_ONLY, SUBGRAPH_WEB3, WEB3_ONLY)
-     * @param options.networkName the desired network (e.g. "matic", "rinkeby", etc.)
-     * @param options.resolverAddress a custom resolver address (advanced use for testing)
-     * @param options.protocolReleaseVersion a custom release version (advanced use for testing)
-     * @param options.provider a provider object necessary for initializing the framework
-     * @returns `Framework` class
-     */
-    static create: (options: IFrameworkOptions) => Promise<Framework>;
-    /**
-     * @dev Create a signer which can be used to sign transactions.
-     * @param options.web3Provider a Web3Provider object (e.g. client side - metamask, web3modal)
-     * @param options.provider an ethers Provider object (e.g. via Hardhat ethers)
-     * @param options.privateKey a test account private key
-     * @param options.signer a signer object (e.g. ethers.Wallet instance)
-     * @returns `ethers.Signer` object
-     */
-    createSigner: (options: ISignerConstructorOptions) => Signer;
-    /**
-     * @dev Create a `BatchCall` class from the `Framework`.
-     * @param operations the list of operations to execute
-     * @returns `BatchCall` class
-     */
-    batchCall: (operations: Operation[]) => BatchCall;
-    /**
-     * @dev Load a `SuperToken` class from the `Framework`.
-     * @param address the `SuperToken` address
-     * @returns `SuperToken` class
-     */
-    loadSuperToken: (address: string) => Promise<SuperToken>;
-}

package/dist/umd/Host.d.ts

@@ -1,18 +0,0 @@
-import Operation from "./Operation";
-import { Superfluid } from "./typechain";
-/**
- * @dev Host Helper Class
- * @description A helper class which can be used as a standalone class to populate call agreement transactions.
- */
-export default class Host {
-    hostContract: Superfluid;
-    constructor(hostAddress: string);
-    /**
-     * @dev Creates an Operation of the `callAgreement` function on the host contract.
-     * @param agreementAddress the agreement address (cfa or ida address)
-     * @param callData the encoded callData for the function
-     * @param userData any additional user data
-     * @returns {Operation} an `Operation` class
-     */
-    populateCallAgreementTxnAndReturnOperation: (agreementAddress: string, callData: string, userData: string | undefined) => Operation;
-}

package/dist/umd/InstantDistributionAgreementV1.d.ts

@@ -1,107 +0,0 @@
-import Host from "./Host";
-import Operation from "./Operation";
-import { IAgreementV1Options, IBaseIDAParams, IBaseSubscriptionParams, IDistributeParams, IGetIndexParams, IGetSubscriptionParams, IUpdateIndexValueParams, IUpdateSubscriptionUnitsParams, IWeb3Index, IWeb3Subscription } from "./interfaces";
-/**
- * @dev Instant Distribution Agreement V1 Helper Class
- * @description A helper class to interact with the IDAV1 contract.
- */
-export default class InstantDistributionAgreementV1 {
-    readonly options: IAgreementV1Options;
-    readonly host: Host;
-    constructor(options: IAgreementV1Options);
-    private get idaContract();
-    /**
-     * @dev Get the details of a `Subscription`.
-     * @param superToken the superToken of the agreement
-     * @param publisher the address of the publisher of the index
-     * @param indexId the index id
-     * @param subscriber the subscriber's address
-     * @param providerOrSigner a provider or signer object
-     * @returns {Promise<IWeb3Subscription>} Web3 Subscription object
-     */
-    getSubscription: ({ superToken, publisher, indexId, subscriber, providerOrSigner, }: IGetSubscriptionParams) => Promise<IWeb3Subscription>;
-    /**
-     * @dev Get the details of an `Index`.
-     * @param superToken the superToken of the agreement
-     * @param publisher the address of the publisher of the index
-     * @param indexId the index id
-     * @param providerOrSigner a provider or signer object
-     * @returns {Promise<IWeb3Index>} Web3 Index object
-     */
-    getIndex: ({ superToken, publisher, indexId, providerOrSigner, }: IGetIndexParams) => Promise<IWeb3Index>;
-    /**
-     * @dev Creates an IDA Index.
-     * @param indexId The id of the index.
-     * @param superToken The address of the `index` superToken.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    createIndex: ({ indexId, superToken, userData, }: IBaseIDAParams) => Operation;
-    /**
-     * @dev Distributes `amount` of `superToken` to an index
-     * @param indexId The id of the index.
-     * @param amount The amount of `superToken` to be distributed.
-     * @param superToken The superToken to be distributed.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    distribute: ({ indexId, amount, superToken, userData, }: IDistributeParams) => Operation;
-    /**
-     * @dev Updates the `indexValue` of an index.
-     * @description NOTE: It has the same effect as `distribute`, but is closer to the low level data structure of the index.
-     * @param indexId The id of the index.
-     * @param indexValue The new indexValue.
-     * @param superToken The superToken to be distributed.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    updateIndexValue: ({ indexId, indexValue, superToken, userData, }: IUpdateIndexValueParams) => Operation;
-    /**
-     * @dev Updates the `units` allocated to a Subscription.
-     * @param indexId The id of the index.
-     * @param superToken The superToken of the index.
-     * @param subscriber The subscriber address whose units you want to update.
-     * @param units The amount of units you want to update to.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    updateSubscriptionUnits: ({ indexId, superToken, subscriber, units, userData, }: IUpdateSubscriptionUnitsParams) => Operation;
-    /**
-     * @dev Approves a Subscription, so the Subscriber won't need to claim tokens when the Publisher distributes.
-     * @param indexId The id of the index.
-     * @param superToken The superToken of the index.
-     * @param publisher The publisher of the index you want to approve.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    approveSubscription: ({ indexId, superToken, publisher, userData, }: IBaseIDAParams) => Operation;
-    /**
-     * @dev Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributres.
-     * @param indexId The id of the index.
-     * @param superToken The superToken of the index.
-     * @param subscriber The subscriber address whose subscription you want to revoke.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    revokeSubscription: ({ indexId, superToken, publisher, userData, }: IBaseIDAParams) => Operation;
-    /**
-     * @dev Deletes a Subscription by setting the `units` allocated to the Subscriber to 0.
-     * @param indexId The id of the index.
-     * @param superToken The superToken of the index.
-     * @param subscriber The subscriber address whose subscription you want to delete.
-     * @param publisher The publisher address of the index you are targetting.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    deleteSubscription: ({ indexId, superToken, subscriber, publisher, userData, }: IBaseSubscriptionParams) => Operation;
-    /**
-     * @dev Claims any pending tokens allocated to the Subscription (unapproved).
-     * @param indexId The id of the index.
-     * @param superToken The superToken of the index.
-     * @param subscriber The subscriber address whose subscription you want to delete.
-     * @param publisher The publisher address of the index you are targetting.
-     * @param userData Extra user data provided.
-     * @returns {Operation} An instance of Operation which can be executed or batched.
-     */
-    claim: ({ indexId, superToken, subscriber, publisher, userData, }: IBaseSubscriptionParams) => Operation;
-}

package/dist/umd/Operation.d.ts

@@ -1,38 +0,0 @@
-import { TransactionRequest } from "@ethersproject/abstract-provider";
-import { ethers } from "ethers";
-export declare type OperationType = "UNSUPPORTED" | "ERC20_APPROVE" | "ERC20_TRANSFER_FROM" | "SUPERTOKEN_UPGRADE" | "SUPERTOKEN_DOWNGRADE" | "SUPERFLUID_CALL_AGREEMENT" | "CALL_APP_ACTION";
-/**
- * @dev Operation Helper Class
- * @description A helper class to create `Operation` objects which can be executed or batched.
- */
-export default class Operation {
-    readonly populateTransactionPromise: Promise<ethers.PopulatedTransaction>;
-    readonly type: OperationType;
-    constructor(txn: Promise<ethers.PopulatedTransaction>, type: OperationType);
-    /**
-     * @dev Executes the operation via the provided signer.
-     * @description Populates all fields of the transaction, signs it and sends it to the network.
-     * @param signer The signer of the transacation
-     * @returns {ethers.providers.TransactionResponse} A TransactionResponse object which can be awaited
-     */
-    exec: (signer: ethers.Signer) => Promise<ethers.providers.TransactionResponse>;
-    /**
-     * @dev Get the populated transaction by awaiting `populateTransactionPromise`.
-     * @description Note that we need to populate the txn with the signer.
-     * @returns {Promise<TransactionRequest>}
-     */
-    getPopulatedTransactionRequest: (signer: ethers.Signer) => Promise<TransactionRequest>;
-    /**
-     * @dev Signs the populated transaction via the provided signer (what you intend on sending to the network).
-     * @param signer The signer of the transacation
-     * @returns {Promise<string>} Fully serialized, signed transaction
-     */
-    getSignedTransaction: (signer: ethers.Signer) => Promise<string>;
-    /**
-     * @dev Gets the transaction hash of the transaction.
-     * @description Calculates this by getting the keccak256 hash of the signedTxn.
-     * @param signer The signer of the transacation
-     * @returns {Promise<string>} The transaction hash of the transaction
-     */
-    getTransactionHash: (signer: ethers.Signer) => Promise<string>;
-}

package/dist/umd/Query.d.ts

@@ -1,31 +0,0 @@
-import { AllEvents, IEventFilter } from "./events";
-import { IAccountTokenSnapshotFilter, IIndex, IIndexRequestFilter, IIndexSubscription, IIndexSubscriptionRequestFilter, ILightAccountTokenSnapshot, ILightEntity, IStream, IStreamRequestFilter, ISuperToken, ISuperTokenRequestFilter } from "./interfaces";
-import { Ordering } from "./ordering";
-import { PagedResult, Paging } from "./pagination";
-import { AccountTokenSnapshot_OrderBy, Event_OrderBy, Index_OrderBy, IndexSubscription_OrderBy, Stream_OrderBy, Token_OrderBy } from "./subgraph/schema.generated";
-import { DataMode } from "./types";
-export interface IQueryOptions {
-    readonly customSubgraphQueriesEndpoint: string;
-    readonly dataMode: DataMode;
-}
-/**
- * @dev Query Helper Class
- * @description A helper class to create `Query` objects which can be used to query different data.
- */
-export default class Query {
-    options: IQueryOptions;
-    private subgraphClient;
-    constructor(options: IQueryOptions);
-    /**
-     * A recursive function to fetch all possible results of a paged query.
-     * @param pagedQuery A paginated query that takes {@link Paging} as input.
-     */
-    listAllResults: <T extends ILightEntity>(pagedQuery: (paging: Paging) => Promise<PagedResult<T>>) => Promise<T[]>;
-    listAllSuperTokens: (filter: ISuperTokenRequestFilter, paging?: Paging, ordering?: Ordering<Token_OrderBy>) => Promise<PagedResult<ISuperToken>>;
-    listIndexes: (filter: IIndexRequestFilter, paging?: Paging, ordering?: Ordering<Index_OrderBy>) => Promise<PagedResult<IIndex>>;
-    listIndexSubscriptions: (filter: IIndexSubscriptionRequestFilter, paging?: Paging, ordering?: Ordering<IndexSubscription_OrderBy>) => Promise<PagedResult<IIndexSubscription>>;
-    listStreams: (filter: IStreamRequestFilter, paging?: Paging, ordering?: Ordering<Stream_OrderBy>) => Promise<PagedResult<IStream>>;
-    listUserInteractedSuperTokens: (filter: IAccountTokenSnapshotFilter, paging?: Paging, ordering?: Ordering<AccountTokenSnapshot_OrderBy>) => Promise<PagedResult<ILightAccountTokenSnapshot>>;
-    listEvents: (filter: IEventFilter, paging?: Paging, ordering?: Ordering<Event_OrderBy>) => Promise<PagedResult<AllEvents>>;
-    on(callback: (events: AllEvents[], unsubscribe: () => void) => void, ms: number, account?: string, timeout?: number): () => void;
-}