@superfluid-finance/sdk-core 1.0.1-dev.ac1b585.0

package/dist/module/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/module/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/dist/umd/BatchCall.d.ts

@@ -0,0 +1,53 @@
+import { ethers } from "ethers";
+import Host from "./Host";
+import { IConfig } from "./interfaces";
+import Operation from "./Operation";
+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

@@ -0,0 +1,74 @@
+import { IAgreementV1Options, ICreateFlowParams, IDeleteFlowParams, IUpdateFlowParams, IGetFlowParams, IGetAccountFlowInfoParams, IWeb3FlowInfoParams, IWeb3FlowInfo } from "./interfaces";
+import Operation from "./Operation";
+import Host from "./Host";
+/**
+ * @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

@@ -0,0 +1,75 @@
+import { ethers } from "ethers";
+import { Signer } from "@ethersproject/abstract-signer";
+import { IConfig, ISignerConstructorOptions } from "./interfaces";
+import { DataMode } from "./types";
+import BatchCall from "./BatchCall";
+import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
+import Host from "./Host";
+import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
+import SuperToken from "./SuperToken";
+import Query from "./Query";
+import Operation from "./Operation";
+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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,107 @@
+import { IAgreementV1Options, IBaseIDAParams, IBaseSubscriptionParams, IDistributeParams, IGetIndexParams, IGetSubscriptionParams, IUpdateIndexValueParams, IUpdateSubscriptionUnitsParams, IWeb3Index, IWeb3Subscription } from "./interfaces";
+import Operation from "./Operation";
+import Host from "./Host";
+/**
+ * @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

@@ -0,0 +1,38 @@
+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

@@ -0,0 +1,24 @@
+import { IAccountTokenSnapshotFilter, IIndex, IIndexRequestFilter, IIndexSubscription, IIndexSubscriptionRequestFilter, ILightAccountTokenSnapshot, IStream, IStreamRequestFilter, ISuperToken, ISuperTokenRequestFilter } from "./interfaces";
+import { DataMode } from "./types";
+import { PagedResult, Paging } from "./pagination";
+import { AccountEvents, AllEvents, IEventFilter } from "./events";
+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);
+    listAllSuperTokens: (filter: ISuperTokenRequestFilter, paging?: Paging) => Promise<PagedResult<ISuperToken>>;
+    listIndexes: (filter: IIndexRequestFilter, paging?: Paging) => Promise<PagedResult<IIndex>>;
+    listIndexSubscriptions: (filter: IIndexSubscriptionRequestFilter, paging?: Paging) => Promise<PagedResult<IIndexSubscription>>;
+    listStreams: (filter: IStreamRequestFilter, paging?: Paging) => Promise<PagedResult<IStream>>;
+    listUserInteractedSuperTokens: (filter: IAccountTokenSnapshotFilter, paging?: Paging) => Promise<PagedResult<ILightAccountTokenSnapshot>>;
+    listEvents: (filter: IEventFilter, paging?: Paging) => Promise<PagedResult<AllEvents>>;
+    on(callback: (events: AccountEvents[], unsubscribe: () => void) => void, ms: number, account: string, timeout?: number): () => void;
+}

package/dist/umd/SFError.d.ts

@@ -0,0 +1,13 @@
+declare type ErrorType = "FRAMEWORK_INITIALIZATION" | "SUPERTOKEN_INITIALIZATION" | "CREATE_SIGNER" | "SUPERTOKEN_READ" | "SUBGRAPH_ERROR" | "CFAV1_READ" | "IDAV1_READ" | "INVALID_ADDRESS" | "INVALID_OBJECT" | "EXECUTE_TRANSACTION" | "POPULATE_TRANSACTION" | "SIGN_TRANSACTION" | "UNSUPPORTED_OPERATION" | "MISSING_TRANSACTION_PROPERTIES" | "BATCH_CALL_ERROR" | "NETWORK_MISMATCH" | "UNSUPPORTED_WEB_3_ONLY";
+interface ISFErrorProps {
+    type: ErrorType;
+    customMessage: string;
+    errorObject?: any;
+}
+export default class SFError {
+    readonly type: ErrorType;
+    readonly message: string;
+    readonly errorObject?: any;
+    constructor(props: ISFErrorProps);
+}
+export {};