@superfluid-finance/sdk-core 1.0.1-dev.0846cd5.0

package/dist/umd/utils.d.ts

@@ -0,0 +1,89 @@
+import { JsonFragment } from "@ethersproject/abi";
+import { ethers } from "ethers";
+import { IIndexSubscription } from "./interfaces";
+/**
+ * @dev Checks if address is a valid ethereum address and normalizes so it can be used by both subgraph and web3.
+ * @param address
+ * @returns The normalized address.
+ */
+export declare const normalizeAddress: (address?: string | undefined) => string;
+export declare const isNullOrEmpty: (str: string | null | undefined) => boolean;
+/**
+ * @dev Removes the 8-character signature hash from `callData`.
+ * @param callData
+ * @returns function parameters
+ */
+export declare const removeSigHashFromCallData: (callData: string) => string;
+/**
+ * @dev A wrapper function for getting the ethers TransactionDescription object given fragments (e.g. ABI), callData and the value amount sent.
+ * @param fragments ABI
+ * @param data callData of a function
+ * @param value amount of ether sent
+ * @returns ethers.TransactionDescription object
+ */
+export declare const getTransactionDescription: (fragments: string | readonly (string | ethers.utils.Fragment | JsonFragment)[], data: string, value?: string | undefined) => ethers.utils.TransactionDescription;
+/**
+ * @dev Gets the per second flow rate given an `amountPerYear` value.
+ * @param amountPerYear the amount you want to stream per year
+ * @returns flow rate per second
+ */
+export declare const getPerSecondFlowRateByYear: (amountPerYear: string) => string;
+/**
+ * @dev Gets the per second flow rate given an `amountPerMonth` value.
+ * @param amountPerMonth the amount you want to stream per month
+ * @returns flow rate per second
+ */
+export declare const getPerSecondFlowRateByMonth: (amountPerMonth: string) => string;
+/**
+ * @dev Gets the per second flow rate given an `amountPerDay` value.
+ * @param amountPerDay the amount you want to stream per day
+ * @returns flow rate per second
+ */
+export declare const getPerSecondFlowRateByDay: (amountPerDay: string) => string;
+/**
+ * @dev The formula for calculating the flowed amount since updated using Subgraph data.
+ * @param netFlowRate the net flow rate of the user
+ * @param currentTimestamp the current timestamp
+ * @param updatedAtTimestamp the updated at timestamp of the `AccountTokenSnapshot` entity
+ * @returns the flowed amount since the updatedAt timestamp
+ */
+export declare const flowedAmountSinceUpdatedAt: ({ netFlowRate, currentTimestamp, updatedAtTimestamp, }: {
+    netFlowRate: string;
+    currentTimestamp: string;
+    updatedAtTimestamp: string;
+}) => number;
+/**
+ * @dev The formula for calculating the total amount distributed to the subscriber (pending or received).
+ * @param indexSubscriptions the index subscriptions of a single token from an account.
+ * @returns the total amount received since updated at (both pending and actually distributed)
+ */
+export declare const subscriptionTotalAmountDistributedSinceUpdated: (indexSubscriptions: IIndexSubscription[]) => number;
+/**
+ * @dev The formula for calculating the total amount received (approved subscriptions).
+ * @param indexSubscriptions the index subscriptions of a single token from an account.
+ * @returns the total amount received since updated at (actually distributed into wallet)
+ */
+export declare const subscriptionTotalAmountReceivedSinceUpdated: (indexSubscriptions: IIndexSubscription[]) => number;
+/**
+ * @dev The formula for calculating the total amount that is claimable.
+ * @param indexSubscriptions the index subscriptions of a single token from an account.
+ * @returns the total amount that can be claimed since updated at
+ */
+export declare const subscriptionTotalAmountClaimableSinceUpdatedAt: (indexSubscriptions: IIndexSubscription[]) => number;
+export declare const getStringCurrentTimeInSeconds: () => number;
+export declare const getSanitizedTimestamp: (timestamp: ethers.BigNumberish) => Date;
+/**
+ * @dev The formula for calculating the balance until updated at of a user (claimable + received tokens from index)
+ * @param currentBalance the current balance until updated at from the `AccountTokenSnapshot` entity
+ * @param netFlowRate the net flow rate of the user
+ * @param currentTimestamp the current timestamp
+ * @param updatedAtTimestamp the updated at timestamp of the `AccountTokenSnapshot` entity
+ * @returns the balance since the updated at timestamp
+ */
+export declare const getBalance: ({ currentBalance, netFlowRate, currentTimestamp, updatedAtTimestamp, indexSubscriptions, }: {
+    currentBalance: string;
+    netFlowRate: string;
+    currentTimestamp: string;
+    updatedAtTimestamp: string;
+    indexSubscriptions: IIndexSubscription[];
+}) => number;

package/dist/umd/validation.d.ts

@@ -0,0 +1,8 @@
+import { IEventFilter } from ".";
+import { IAccountTokenSnapshotFilter, IIndexRequestFilter, IIndexSubscriptionRequestFilter, IStreamRequestFilter, ISuperTokenRequestFilter } from "./interfaces";
+export declare const validateSuperTokenRequest: (filter: ISuperTokenRequestFilter) => void;
+export declare const validateEventRequest: (filter: IEventFilter) => void;
+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;

package/package.json

@@ -0,0 +1,76 @@
+{
+    "name": "@superfluid-finance/sdk-core",
+    "version": "1.0.1-dev.0846cd5.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",
+    "files": [
+        "dist/**/*.js",
+        "dist/**/*.d.ts"
+    ],
+    "scripts": {
+        "build": "yarn generate-abi-files && yarn generate-web3-types && rm -rf dist && rollup --config rollup.config.ts --configPlugin typescript",
+        "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",
+        "posttest": "yarn testenv:stop",
+        "doc:html": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs",
+        "fix": "run-s fix:*",
+        "fix:prettier": "prettier \"src/**/*.ts\" --write",
+        "fix:lint": "eslint src --ext .ts --fix",
+        "lint": "echo linting",
+        "pre-commit": "run-s pre-commit:*",
+        "pre-commit:lint": "echo no pre-commit currently",
+        "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 && yarn run fix"
+    },
+    "bugs": {
+        "url": "https://github.com/superfluid-finance/protocol-monorepo/issues"
+    },
+    "dependencies": {
+        "@ethersproject/providers": "^5.5.0",
+        "@rollup/plugin-json": "^4.1.0",
+        "ajv": "^8.6.3",
+        "ethers": "^5.5.1",
+        "graphql-request": "^3.6.1"
+    },
+    "devDependencies": {
+        "@graphql-codegen/cli": "2.2.2",
+        "@graphql-codegen/introspection": "2.1.0",
+        "@graphql-codegen/near-operation-file-preset": "^1.18.1",
+        "@graphql-codegen/typed-document-node": "^2.2.0",
+        "@graphql-codegen/typescript": "2.3.0",
+        "@graphql-codegen/typescript-operations": "2.2.0",
+        "@nomiclabs/hardhat-ethers": "^2.0.2",
+        "@nomiclabs/hardhat-waffle": "^2.0.1",
+        "@nomiclabs/hardhat-web3": "^2.0.0",
+        "@rollup/plugin-typescript": "^8.3.0",
+        "@typechain/ethers-v5": "^8.0.0",
+        "@typechain/hardhat": "^3.0.0",
+        "@types/chai": "^4.2.22",
+        "@types/mocha": "^9.0.0",
+        "@types/node": "^16.11.6",
+        "chai": "^4.3.4",
+        "chai-ethers": "^0.0.1",
+        "coveralls": "^3.1.1",
+        "dotenv": "^10.0.0",
+        "ethereum-waffle": "^3.4.0",
+        "hardhat": "^2.6.7",
+        "mocha": "^9.1.3",
+        "nyc": "^15.1.0",
+        "rollup": "^2.58.0",
+        "ts-node": "^10.4.0",
+        "typechain": "^6.0.0",
+        "typedoc": "^0.22.6",
+        "typescript": "^4.4.4"
+    },
+    "resolutions": {
+        "graphql": "16.0.0"
+    }
+}