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

package/dist/module/interfaces.d.ts

@@ -0,0 +1,309 @@
+import { ethers } from "ethers";
+export interface IAccountTokenSnapshotFilter {
+    readonly account?: string;
+    readonly token?: string;
+}
+export interface IAccountEventsFilter {
+    readonly account: string;
+    readonly timestamp_gte: number;
+}
+export interface IIndexRequestFilter {
+    readonly indexId?: string;
+    readonly publisher?: string;
+    readonly token?: string;
+}
+export interface IStreamRequestFilter {
+    readonly sender?: string;
+    readonly receiver?: string;
+    readonly token?: string;
+}
+export interface IIndexSubscriptionRequestFilter {
+    readonly subscriber?: string;
+    readonly approved?: boolean;
+}
+export interface ISuperTokenRequestFilter {
+    readonly isListed?: boolean;
+}
+export interface ISuperTokenModifyFlowParams {
+    readonly flowRate?: string;
+    readonly receiver: string;
+    readonly sender?: string;
+    readonly userData?: string;
+}
+export interface ISuperTokenCreateFlowParams extends ISuperTokenModifyFlowParams {
+    readonly flowRate: string;
+    readonly sender: string;
+}
+export interface ISuperTokenUpdateFlowParams extends ISuperTokenCreateFlowParams {
+}
+export interface ISuperTokenDeleteFlowParams extends ISuperTokenModifyFlowParams {
+    readonly sender: string;
+}
+export interface ISuperTokenBaseIDAParams {
+    readonly indexId: string;
+    readonly userData?: string;
+}
+export interface ISuperTokenGetSubscriptionParams {
+    readonly indexId: string;
+    readonly publisher: string;
+    readonly subscriber: string;
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+}
+export interface ISuperTokenGetIndexParams {
+    readonly indexId: string;
+    readonly publisher: string;
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+}
+export interface ISuperTokenPublisherParams extends ISuperTokenBaseIDAParams {
+    readonly publisher: string;
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+}
+export interface ISuperTokenPubSubParams {
+    readonly indexId: string;
+    readonly userData?: string;
+    readonly publisher: string;
+    readonly subscriber: string;
+}
+export interface ISuperTokenPublisherOperationParams {
+    readonly indexId: string;
+    readonly publisher: string;
+    readonly userData?: string;
+}
+export interface ISuperTokenDistributeParams {
+    readonly indexId: string;
+    readonly userData?: string;
+    readonly amount: string;
+}
+export interface ISuperTokenUpdateIndexValueParams {
+    readonly indexId: string;
+    readonly userData?: string;
+    readonly indexValue: string;
+}
+export interface ISuperTokenUpdateSubscriptionUnitsParams {
+    readonly indexId: string;
+    readonly subscriber: string;
+    readonly userData?: string;
+    readonly units: string;
+}
+export interface IModifyFlowParams {
+    readonly receiver: string;
+    readonly superToken: string;
+    readonly flowRate?: string;
+    readonly sender?: string;
+    readonly userData?: string;
+}
+export interface ICreateFlowParams extends IModifyFlowParams {
+    readonly flowRate: string;
+}
+export interface IUpdateFlowParams extends ICreateFlowParams {
+}
+export interface IDeleteFlowParams extends IModifyFlowParams {
+    readonly sender: string;
+}
+export interface IRealtimeBalanceOfParams {
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+    readonly account: string;
+    readonly timestamp?: number;
+}
+export interface IBaseSuperTokenParams {
+    readonly receiver: string;
+    readonly amount: string;
+}
+export interface ITransferFromParams {
+    readonly sender: string;
+    readonly receiver: string;
+    readonly amount: string;
+}
+export interface ISuperTokenGetFlowParams {
+    readonly sender: string;
+    readonly receiver: string;
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+}
+export interface ISuperTokenGetFlowInfoParams {
+    readonly account: string;
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+}
+export interface IGetFlowParams {
+    readonly superToken: string;
+    readonly sender: string;
+    readonly receiver: string;
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+}
+export interface IGetAccountFlowInfoParams {
+    readonly superToken: string;
+    readonly account: string;
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+}
+export interface IBaseIDAParams {
+    readonly indexId: string;
+    readonly superToken: string;
+    readonly publisher?: string;
+    readonly userData?: string;
+}
+export interface IBaseSubscriptionParams extends IBaseIDAParams {
+    readonly subscriber: string;
+}
+export interface IGetSubscriptionParams extends IBaseIDAParams {
+    readonly publisher: string;
+    readonly subscriber: string;
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+}
+export interface IGetIndexParams extends IBaseIDAParams {
+    readonly publisher: string;
+    readonly providerOrSigner: ethers.providers.Provider | ethers.Signer;
+}
+export interface IDistributeParams extends IBaseIDAParams {
+    readonly amount: string;
+}
+export interface IUpdateIndexValueParams extends IBaseIDAParams {
+    readonly indexValue: string;
+}
+export interface IUpdateSubscriptionUnitsParams extends IBaseSubscriptionParams {
+    readonly units: string;
+}
+export interface IApproveSubscriptionParams extends IBaseSubscriptionParams {
+    readonly publisher: string;
+}
+export interface IRevokeSubscriptionParams extends IBaseSubscriptionParams {
+    readonly publisher: string;
+}
+export interface ILightEntity {
+    readonly id: string;
+}
+export interface IEventEntityBase {
+    readonly id: string;
+    readonly blockNumber: number;
+    readonly timestamp: number;
+    readonly transactionHash: string;
+}
+export interface IFlowUpdatedEvent extends IEventEntityBase {
+    readonly token: string;
+    readonly sender: string;
+    readonly receiver: string;
+    readonly flowRate: string;
+    readonly totalSenderFlowRate: string;
+    readonly totalReceiverFlowRate: string;
+    readonly userData: string;
+    readonly oldFlowRate: string;
+    readonly type: number;
+    readonly totalAmountStreamedUntilTimestamp: string;
+}
+export interface IHOLEntityBase {
+    readonly id: string;
+    readonly createdAtTimestamp: number;
+    readonly createdAtBlockNumber: number;
+}
+export interface IHOLUpdateable extends IHOLEntityBase {
+    readonly updatedAtTimestamp: number;
+    readonly updatedAtBlockNumber: number;
+}
+export interface IIndex extends IHOLUpdateable {
+    readonly indexId: string;
+    readonly indexValue: string;
+    readonly totalSubscriptionsWithUnits: number;
+    readonly totalUnitsPending: string;
+    readonly totalUnitsApproved: string;
+    readonly totalUnits: string;
+    readonly totalAmountDistributedUntilUpdatedAt: string;
+    readonly token: ISuperToken;
+    readonly publisher: string;
+}
+export interface IIndexSubscription extends IHOLUpdateable {
+    readonly subscriber: string;
+    readonly approved: boolean;
+    readonly units: string;
+    readonly totalAmountReceivedUntilUpdatedAt: string;
+    readonly indexValueUntilUpdatedAt: string;
+    readonly index: IIndexSubscriptionIndex;
+}
+export interface IIndexSubscriptionIndex {
+    readonly id: string;
+    readonly indexId: string;
+    readonly indexValue: string;
+    readonly token: ISuperToken;
+}
+export interface IStream extends IHOLUpdateable {
+    readonly currentFlowRate: string;
+    readonly streamedUntilUpdatedAt: string;
+    readonly token: ISuperToken;
+    readonly sender: string;
+    readonly receiver: string;
+    readonly flowUpdatedEvents: IStreamFlowUpdatedEvent[];
+}
+export interface IStreamFlowUpdatedEvent extends IFlowUpdatedEvent {
+}
+export interface ISuperToken extends IHOLEntityBase {
+    readonly name: string;
+    readonly symbol: string;
+    readonly isListed: boolean;
+    readonly underlyingAddress: string;
+}
+export interface IAggregateEntityBase {
+    readonly id: string;
+    readonly updatedAtTimestamp: number;
+    readonly updatedAtBlockNumber: number;
+}
+export interface ILightAccountTokenSnapshot extends IAggregateEntityBase {
+    readonly totalNumberOfActiveStreams: number;
+    readonly totalNumberOfClosedStreams: number;
+    readonly totalSubscriptionsWithUnits: number;
+    readonly totalApprovedSubscriptions: number;
+    readonly balanceUntilUpdatedAt: string;
+    readonly totalNetFlowRate: string;
+    readonly totalInflowRate: string;
+    readonly totalOutflowRate: string;
+    readonly totalAmountStreamedUntilUpdatedAt: string;
+    readonly totalAmountTransferredUntilUpdatedAt: string;
+    readonly account: string;
+    readonly token: ISuperToken;
+}
+export interface IResolverData {
+    readonly subgraphAPIEndpoint: string;
+    readonly networkName: string;
+    readonly resolverAddress: string;
+}
+export interface ISignerConstructorOptions {
+    readonly web3Provider?: ethers.providers.Web3Provider;
+    readonly provider?: ethers.providers.Provider;
+    readonly privateKey?: string;
+    readonly signer?: ethers.Signer;
+}
+export interface IConfig {
+    readonly hostAddress: string;
+    readonly superTokenFactoryAddress: string;
+    readonly cfaV1Address: string;
+    readonly idaV1Address: string;
+}
+export interface IAgreementV1Options {
+    readonly config: IConfig;
+}
+export interface IWeb3RealTimeBalanceOf {
+    readonly availableBalance: string;
+    readonly deposit: string;
+    readonly owedDeposit: string;
+    readonly timestamp: Date;
+}
+export interface IWeb3Subscription {
+    readonly exist: boolean;
+    readonly approved: boolean;
+    readonly units: string;
+    readonly pendingDistribution: string;
+}
+export interface IWeb3Index {
+    readonly exist: boolean;
+    readonly indexValue: string;
+    readonly totalUnitsApproved: string;
+    readonly totalUnitsPending: string;
+}
+export interface IWeb3FlowInfoParams {
+    readonly timestamp: ethers.BigNumber;
+    readonly flowRate: ethers.BigNumber;
+    readonly deposit: ethers.BigNumber;
+    readonly owedDeposit: ethers.BigNumber;
+}
+export interface IWeb3FlowInfo {
+    readonly timestamp: Date;
+    readonly flowRate: string;
+    readonly deposit: string;
+    readonly owedDeposit: string;
+}

package/dist/module/mapGetAllEventsQueryEvents.d.ts

@@ -0,0 +1,3 @@
+import * as events from "./events";
+import { GetAllEventsQuery } from "./subgraph/queries/getAllEvents.generated";
+export declare const mapGetAllEventsQueryEvents: (queryResponse: GetAllEventsQuery) => events.AllEvents[];

package/dist/module/pagination.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @dev Paging Helper Class
+ */
+export declare class Paging {
+    readonly skip: number;
+    readonly take: number;
+    constructor({ skip, take }?: {
+        skip?: number | undefined;
+        take?: number | undefined;
+    });
+    /**
+     * @dev Used to determine whether there is another page for pagination.
+     * @returns the user's specified `take` plus one
+     */
+    takePlusOne(): number;
+}
+/**
+ * @dev PagedResult Interface
+ */
+export interface PagedResult<T> {
+    readonly hasNextPage: boolean;
+    readonly skip: number;
+    readonly take: number;
+    readonly data: T[];
+}
+export declare const createPagedResult: <T>(dataPlusOne: T[], paging: Paging) => PagedResult<T>;
+/**
+ * @dev Gets the next page given the skip/take used to initialize the `PagedResult` interface.
+ * @returns the `Paging` class with the next page
+ */
+export declare const nextPage: (paging: Paging) => Paging;

package/dist/module/scripts/setup.d.ts

@@ -0,0 +1,22 @@
+import { IConstantFlowAgreementV1, IInstantDistributionAgreementV1, SuperToken, TestToken } from "../typechain";
+import { DataMode, Framework } from "..";
+export declare const RESOLVER_ADDRESS = "0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512";
+export declare const HARDHAT_PRIVATE_KEY = "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80";
+interface ISetupProps {
+    readonly amount?: string;
+    readonly dataMode?: DataMode;
+    readonly subgraphEndpoint?: string;
+}
+export declare const setup: (props: ISetupProps) => Promise<{
+    CFAV1: IConstantFlowAgreementV1;
+    IDAV1: IInstantDistributionAgreementV1;
+    frameworkClass: Framework;
+    Deployer: any;
+    Alpha: any;
+    Bravo: any;
+    Charlie: any;
+    SuperToken: SuperToken;
+    Token: TestToken;
+    SignerCount: number;
+}>;
+export {};

package/dist/module/subgraph/SubgraphClient.d.ts

@@ -0,0 +1,16 @@
+import { DocumentNode } from "graphql";
+declare type RequestDocument = string | DocumentNode;
+export declare type Variables = {
+    [key: string]: any;
+};
+export declare type BatchRequestDocument<V = Variables> = {
+    document: RequestDocument;
+    variables?: V;
+};
+export declare class SubgraphClient {
+    readonly subgraphUrl: string;
+    constructor(subgraphUrl: string);
+    request<T = any, V = Variables>(document: RequestDocument, variables?: V): Promise<T>;
+    batchRequests<T = any, V = Variables>(documents: BatchRequestDocument<V>[]): Promise<T>;
+}
+export {};

package/dist/module/subgraph/queries/getAccountTokenSnapshots.generated.d.ts

@@ -0,0 +1,41 @@
+import * as Types from "../schema.generated";
+import { TypedDocumentNode as DocumentNode } from "@graphql-typed-document-node/core";
+export declare type GetAccountTokenSnapshotsQueryVariables = Types.Exact<{
+    where: Types.AccountTokenSnapshot_Filter;
+    skip: Types.Scalars["Int"];
+    first: Types.Scalars["Int"];
+}>;
+export declare type GetAccountTokenSnapshotsQuery = {
+    result: Array<{
+        id: string;
+        updatedAtTimestamp: string;
+        updatedAtBlockNumber: string;
+        totalNumberOfActiveStreams: number;
+        totalNumberOfClosedStreams: number;
+        totalSubscriptionsWithUnits: number;
+        totalApprovedSubscriptions: number;
+        balanceUntilUpdatedAt: string;
+        totalNetFlowRate: string;
+        totalInflowRate: string;
+        totalOutflowRate: string;
+        totalAmountStreamedUntilUpdatedAt: string;
+        totalAmountTransferredUntilUpdatedAt: string;
+        account: {
+            id: string;
+        };
+        token: {
+            id: string;
+            createdAtTimestamp: string;
+            createdAtBlockNumber: string;
+            name: string;
+            symbol: string;
+            isListed: boolean;
+            underlyingAddress: string;
+        };
+    }>;
+};
+export declare const GetAccountTokenSnapshotsDocument: DocumentNode<GetAccountTokenSnapshotsQuery, Types.Exact<{
+    where: Types.AccountTokenSnapshot_Filter;
+    skip: Types.Scalars["Int"];
+    first: Types.Scalars["Int"];
+}>>;