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

package/dist/umd/SuperToken.d.ts

@@ -0,0 +1,191 @@
+import { ethers } from "ethers";
+import { IConfig, IRealtimeBalanceOfParams, ISuperTokenBaseIDAParams, ISuperTokenCreateFlowParams, ISuperTokenDeleteFlowParams, ISuperTokenDistributeParams, ISuperTokenGetFlowInfoParams, ISuperTokenGetFlowParams, ISuperTokenGetIndexParams, ISuperTokenGetSubscriptionParams, ISuperTokenPublisherOperationParams, ISuperTokenPubSubParams, ISuperTokenUpdateFlowParams, ISuperTokenUpdateIndexValueParams, ISuperTokenUpdateSubscriptionUnitsParams, IWeb3FlowInfo, IWeb3Index, IWeb3RealTimeBalanceOf, IWeb3Subscription } from "./interfaces";
+import Operation from "./Operation";
+import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
+import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
+import Token from "./Token";
+export interface ITokenSettings {
+    readonly address: string;
+    readonly config: IConfig;
+    readonly chainId: number;
+    readonly networkName: string;
+    readonly underlyingTokenAddress: string;
+}
+export interface ITokenOptions {
+    readonly address: string;
+    readonly config: IConfig;
+    readonly provider: ethers.providers.Provider;
+    readonly chainId?: number;
+    readonly networkName?: string;
+}
+/**
+ * @dev SuperToken Helper Class
+ * @description A helper class to create `SuperToken` objects which can interact with the `SuperToken` contract as well as the CFAV1 and IDAV1 contracts of the desired `SuperToken`.
+ */
+export default class SuperToken extends Token {
+    readonly options: ITokenOptions;
+    readonly settings: ITokenSettings;
+    readonly cfaV1: ConstantFlowAgreementV1;
+    readonly idaV1: InstantDistributionAgreementV1;
+    readonly underlyingToken: Token;
+    private constructor();
+    static create: (options: ITokenOptions) => Promise<SuperToken>;
+    private get superTokenContract();
+    /**
+     * @dev Returns the real time balance of `address`.
+     * @param account the target address
+     * @param timestamp the timestamp you'd like to see the data
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @returns {Promise<IWeb3RealTimeBalanceOf>} real time balance of data
+     */
+    realtimeBalanceOf: ({ providerOrSigner, account, timestamp, }: IRealtimeBalanceOfParams) => Promise<IWeb3RealTimeBalanceOf>;
+    /**
+     * @dev Downgrade `amount` SuperToken's.
+     * @param amount The amount to be downgraded.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    downgrade: ({ amount }: {
+        amount: string;
+    }) => Operation;
+    /**
+     * @dev Upgrade `amount` SuperToken's.
+     * @param amount The amount to be upgraded.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    upgrade: ({ amount }: {
+        amount: string;
+    }) => Operation;
+    /**
+     * @dev Get the details of a flow.
+     * @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: ({ sender, receiver, providerOrSigner, }: ISuperTokenGetFlowParams) => Promise<IWeb3FlowInfo>;
+    /**
+     * @dev Get the flow info of an account (net flow).
+     * @param account the account we're querying
+     * @param providerOrSigner a provider or signer object
+     * @returns {Promise<IWeb3FlowInfo>} Web3 Flow info object
+     */
+    getAccountFlowInfo: ({ account, providerOrSigner, }: ISuperTokenGetFlowInfoParams) => Promise<IWeb3FlowInfo>;
+    /**
+     * @dev Get the net flow of an account.
+     * @param account the account we're querying
+     * @param providerOrSigner a provider or signer object
+     * @returns {Promise<string>} Web3 Flow info object
+     */
+    getNetFlow: ({ account, providerOrSigner, }: ISuperTokenGetFlowInfoParams) => Promise<string>;
+    /**
+     * @dev Create a flow of the token of this class.
+     * @param sender The sender of the flow.
+     * @param receiver The receiver of the flow.
+     * @param flowRate The specified flow rate.
+     * @param userData Extra user data provided.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    createFlow: ({ sender, receiver, flowRate, userData, }: ISuperTokenCreateFlowParams) => Operation;
+    /**
+     * @dev Update a flow of the token of this class.
+     * @param sender The sender of the flow.
+     * @param receiver The receiver of the flow.
+     * @param flowRate The specified flow rate.
+     * @param userData Extra user data provided.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    updateFlow: ({ sender, receiver, flowRate, userData, }: ISuperTokenUpdateFlowParams) => Operation;
+    /**
+     * @dev Delete a flow of the token of this class.
+     * @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: ({ sender, receiver, userData, }: ISuperTokenDeleteFlowParams) => Operation;
+    /**
+     * @dev Get the details of a `Subscription`.
+     * @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: ({ publisher, indexId, subscriber, providerOrSigner, }: ISuperTokenGetSubscriptionParams) => Promise<IWeb3Subscription>;
+    /**
+     * @dev Get the details of an `Index`.
+     * @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: ({ publisher, indexId, providerOrSigner, }: ISuperTokenGetIndexParams) => Promise<IWeb3Index>;
+    /**
+     * @dev Creates an IDA Index.
+     * @param indexId The id of the index.
+     * @param userData Extra user data provided.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    createIndex: ({ indexId, userData, }: ISuperTokenBaseIDAParams) => Operation;
+    /**
+     * @dev Distributes `amount` of token to an index
+     * @param indexId The id of the index.
+     * @param amount The amount of tokens to be distributed.
+     * @param userData Extra user data provided.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    distribute: ({ indexId, amount, userData, }: ISuperTokenDistributeParams) => Operation;
+    /**
+     * @dev Updates the `IndexValue` field of an index.
+     * @param indexId The id of the index.
+     * @param indexValue The new indexValue.
+     * @param userData Extra user data provided.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     *
+     * NOTE: It has the same effect as `distribute`, but is closer to the low level data structure of the index.
+     */
+    updateIndexValue: ({ indexId, indexValue, userData, }: ISuperTokenUpdateIndexValueParams) => Operation;
+    /**
+     * @dev Updates the `units` allocated to a Subscription.
+     * @param indexId The id 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, subscriber, units, userData, }: ISuperTokenUpdateSubscriptionUnitsParams) => 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 publisher The publisher address whose subscription you want to approve.
+     * @param userData Extra user data provided.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    approveSubscription: ({ indexId, publisher, userData, }: ISuperTokenPublisherOperationParams) => Operation;
+    /**
+     * @dev Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributes.
+     * @param indexId The id of the index.
+     * @param publisher The index publisher address you want to revoke for the subscriber.
+     * @param userData Extra user data provided.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    revokeSubscription: ({ indexId, publisher, userData, }: ISuperTokenPublisherOperationParams) => Operation;
+    /**
+     * @dev Deletes a Subscription by setting the `units` allocated to the Subscriber to 0.
+     * @param indexId The id of the index.
+     * @param subscriber The subscriber address whose subscription you want to delete.
+     * @param publisher The publisher address of the index you are targeting.
+     * @param userData Extra user data provided.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    deleteSubscription: ({ indexId, subscriber, publisher, userData, }: ISuperTokenPubSubParams) => Operation;
+    /**
+     * @dev Claims any pending tokens allocated to the Subscription (unapproved).
+     * @param indexId The id of the index.
+     * @param subscriber The subscriber address who you are claiming for.
+     * @param publisher The publisher address of the index you are targeting.
+     * @param userData Extra user data provided.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    claim: ({ indexId, subscriber, publisher, userData, }: ISuperTokenPubSubParams) => Operation;
+}

package/dist/umd/Token.d.ts

@@ -0,0 +1,76 @@
+import { ethers } from "ethers";
+import { IBaseSuperTokenParams, ITransferFromParams } from "./interfaces";
+import Operation from "./Operation";
+export default class Token {
+    readonly address: string;
+    constructor(address: string);
+    private get tokenContract();
+    /**
+     * @dev Returns the allowance the `owner` has granted the `spender`.
+     * @param owner the owner who has allotted the allowance
+     * @param spender the spender who has received the allowance
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @returns {Promise<string>} the allowance amount
+     */
+    allowance: ({ owner, spender, providerOrSigner, }: {
+        owner: string;
+        spender: string;
+        providerOrSigner: ethers.providers.Provider | ethers.Signer;
+    }) => Promise<string>;
+    /**
+     * @dev Returns the ERC20 balanceOf the `account`, this can't be negative and will just display 0.
+     * @param account the account you would like to query
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @returns {Promise<string>} the token balance of `account`
+     */
+    balanceOf: ({ account, providerOrSigner, }: {
+        account: string;
+        providerOrSigner: ethers.providers.Provider | ethers.Signer;
+    }) => Promise<string>;
+    /**
+     * @dev Returns the token name
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @returns {string} the token name
+     */
+    name: ({ providerOrSigner, }: {
+        providerOrSigner: ethers.providers.Provider | ethers.Signer;
+    }) => Promise<string>;
+    /**
+     * @dev Returns the token symbol
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @returns {string} the token symbol
+     */
+    symbol: ({ providerOrSigner, }: {
+        providerOrSigner: ethers.providers.Provider | ethers.Signer;
+    }) => Promise<string>;
+    /**
+     * @dev Returns the total supply of the token.
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @returns {Promise<string>} the total supply of the token
+     */
+    totalSupply: ({ providerOrSigner, }: {
+        providerOrSigner: ethers.providers.Provider | ethers.Signer;
+    }) => Promise<string>;
+    /**
+     * @dev Approve `receiver` to spend `amount` tokens.
+     * @param receiver The receiver approved.
+     * @param amount The amount approved.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    approve: ({ receiver, amount }: IBaseSuperTokenParams) => Operation;
+    /**
+     * @dev Transfer `receiver` `amount` tokens.
+     * @param receiver The receiver of the transfer.
+     * @param amount The amount to be transferred.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    transfer: ({ receiver, amount }: IBaseSuperTokenParams) => Operation;
+    /**
+     * @dev Transfer from `sender` to `receiver` `amount` tokens.
+     * @param sender The sender of the transfer.
+     * @param receiver The receiver of the transfer.
+     * @param amount The amount to be transferred.
+     * @returns {Operation} An instance of Operation which can be executed or batched.
+     */
+    transferFrom: ({ sender, receiver, amount, }: ITransferFromParams) => Operation;
+}

package/dist/umd/constants.d.ts

@@ -0,0 +1,10 @@
+import { IResolverData } from "./interfaces";
+export declare const MONTHS_PER_YEAR = 12;
+export declare const DAYS_PER_MONTH = 30;
+export declare const HOURS_PER_DAY = 24;
+export declare const MINUTES_PER_HOUR = 60;
+export declare const SECONDS_PER_MINUTE = 60;
+export declare const chainIds: number[];
+export declare const networkNames: string[];
+export declare const chainIdToDataMap: Map<number, IResolverData>;
+export declare const networkNameToChainIdMap: Map<string, number>;

package/dist/umd/events.d.ts

@@ -0,0 +1,254 @@
+export declare type EventBase = {
+    blockNumber: number;
+    transactionHash: string;
+    timestamp: number;
+};
+export interface IEventFilter {
+    readonly account?: string;
+    readonly timestamp_gte?: number;
+}
+export declare type AccountEvents = FlowUpdatedEvent | IndexCreatedEvent | IndexDistributionClaimedEvent | IndexSubscribedEvent | IndexUnitsUpdatedEvent | IndexUnsubscribedEvent | IndexUpdatedEvent | TokenDowngradedEvent | TransferEvent | TokenUpgradedEvent | SubscriptionApprovedEvent | SubscriptionDistributionClaimedEvent | SubscriptionRevokedEvent | SubscriptionUnitsUpdatedEvent;
+export declare type OtherEvents = AgreementClassRegisteredEvent | AgreementClassUpdatedEvent | AgreementLiquidatedByEvent | AppRegisteredEvent | BurnedEvent | CFAv1LiquidationPeriodChangedEvent | ConfigChangedEvent | CustomSuperTokenCreatedEvent | GovernanceReplacedEvent | JailEvent | MintedEvent | RewardAddressChangedEvent | RoleAdminChangedEvent | RoleGrantedEvent | RoleRevokedEvent | SentEvent | SuperTokenCreatedEvent | SuperTokenFactoryUpdatedEvent | SuperTokenLogicCreatedEvent | SuperTokenLogicUpdatedEvent | TrustedForwarderChangedEvent;
+export declare type AllEvents = AccountEvents | OtherEvents;
+export interface FlowUpdatedEvent extends EventBase {
+    name: "FlowUpdated";
+    token: string;
+    sender: string;
+    receiver: string;
+    flowRate: string;
+}
+export interface IndexCreatedEvent extends EventBase {
+    name: "IndexCreated";
+    token: string;
+    publisher: string;
+    indexId: string;
+    userData: string;
+}
+export interface IndexDistributionClaimedEvent extends EventBase {
+    name: "IndexDistributionClaimed";
+    token: string;
+    publisher: string;
+    indexId: string;
+    subscriber: string;
+    amount: string;
+}
+export interface IndexSubscribedEvent extends EventBase {
+    name: "IndexSubscribed";
+    token: string;
+    publisher: string;
+    indexId: string;
+    subscriber: string;
+}
+export interface IndexUnitsUpdatedEvent extends EventBase {
+    name: "IndexUnitsUpdated";
+    token: string;
+    publisher: string;
+    indexId: string;
+    subscriber: string;
+    units: string;
+    userData: string;
+    oldUnits: string;
+}
+export interface IndexUnsubscribedEvent extends EventBase {
+    name: "IndexUnsubscribed";
+    token: string;
+    publisher: string;
+    indexId: string;
+    subscriber: string;
+    userData: string;
+}
+export interface IndexUpdatedEvent extends EventBase {
+    name: "IndexUpdated";
+    token: string;
+    publisher: string;
+    indexId: string;
+    oldIndexValue: string;
+    newIndexValue: string;
+    totalUnitsPending: string;
+    totalUnitsApproved: string;
+    userData: string;
+}
+export interface TokenDowngradedEvent extends EventBase {
+    name: "TokenDowngraded";
+    token: string;
+    amount: string;
+    account: string;
+}
+export interface TokenUpgradedEvent extends EventBase {
+    name: "TokenUpgraded";
+    token: string;
+    amount: string;
+    account: string;
+}
+export interface TransferEvent extends EventBase {
+    name: "Transfer";
+    from: string;
+    to: string;
+    value: string;
+    token: string;
+}
+export interface AgreementClassRegisteredEvent extends EventBase {
+    name: "AgreementClassRegistered";
+    agreementType: string;
+    code: string;
+}
+export interface AgreementClassUpdatedEvent extends EventBase {
+    name: "AgreementClassUpdated";
+    agreementType: string;
+    code: string;
+}
+export interface AgreementLiquidatedByEvent extends EventBase {
+    name: "AgreementLiquidatedBy";
+    agreementClass: string;
+    agreementId: string;
+    bailoutAmount: string;
+    bondAccount: string;
+    liquidatorAccount: string;
+    penaltyAccount: string;
+    rewardAmount: string;
+    token: string;
+}
+export interface AppRegisteredEvent extends EventBase {
+    name: "AppRegistered";
+    app: string;
+}
+export interface BurnedEvent extends EventBase {
+    name: "Burned";
+    amount: string;
+    data: string;
+    from: string;
+    operator: string;
+    operatorData: string;
+}
+export interface CFAv1LiquidationPeriodChangedEvent extends EventBase {
+    name: "CFAv1LiquidationPeriodChanged";
+    host: string;
+    isSet: boolean;
+    liquidationPeriod: number;
+    superToken: string;
+}
+export interface ConfigChangedEvent extends EventBase {
+    name: "ConfigChanged";
+    host: string;
+    isSet: boolean;
+    key: string;
+    superToken: string;
+    value: string;
+}
+export interface CustomSuperTokenCreatedEvent extends EventBase {
+    name: "CustomSuperTokenCreated";
+    token: string;
+}
+export interface GovernanceReplacedEvent extends EventBase {
+    name: "GovernanceReplaced";
+    oldGovernance: string;
+    newGovernance: string;
+}
+export interface JailEvent extends EventBase {
+    name: "Jail";
+    app: string;
+    reason: string;
+}
+export interface MintedEvent extends EventBase {
+    name: "Minted";
+    operator: string;
+    to: string;
+    amount: string;
+    data: string;
+    operatorData: string;
+}
+export interface RewardAddressChangedEvent extends EventBase {
+    name: "RewardAddressChanged";
+    host: string;
+    superToken: string;
+    isSet: boolean;
+    rewardAddress: string;
+}
+export interface RoleAdminChangedEvent extends EventBase {
+    name: "RoleAdminChanged";
+    role: string;
+    previousAdminRole: string;
+    newAdminRole: string;
+}
+export interface RoleGrantedEvent extends EventBase {
+    name: "RoleGranted";
+    role: string;
+    account: string;
+    sender: string;
+}
+export interface RoleRevokedEvent extends EventBase {
+    name: "RoleRevoked";
+    role: string;
+    account: string;
+    sender: string;
+}
+export interface SentEvent extends EventBase {
+    name: "Sent";
+    operator: string;
+    to: string;
+    amount: string;
+    data: string;
+    operatorData: string;
+}
+export interface SubscriptionApprovedEvent extends EventBase {
+    name: "SubscriptionApproved";
+    token: string;
+    subscriber: string;
+    publisher: string;
+    indexId: string;
+    userData: string;
+    subscription: string;
+}
+export interface SubscriptionDistributionClaimedEvent extends EventBase {
+    name: "SubscriptionDistributionClaimed";
+    token: string;
+    subscriber: string;
+    publisher: string;
+    indexId: string;
+    amount: string;
+    subscription: string;
+}
+export interface SubscriptionRevokedEvent extends EventBase {
+    name: "SubscriptionRevoked";
+    token: string;
+    subscriber: string;
+    publisher: string;
+    indexId: string;
+    userData: string;
+    subscription: string;
+}
+export interface SubscriptionUnitsUpdatedEvent extends EventBase {
+    name: "SubscriptionUnitsUpdated";
+    token: string;
+    subscriber: string;
+    publisher: string;
+    indexId: string;
+    units: string;
+    userData: string;
+    subscription: string;
+}
+export interface SuperTokenCreatedEvent extends EventBase {
+    name: "SuperTokenCreated";
+    token: string;
+}
+export interface SuperTokenFactoryUpdatedEvent extends EventBase {
+    name: "SuperTokenFactoryUpdated";
+    newFactory: string;
+}
+export interface SuperTokenLogicCreatedEvent extends EventBase {
+    name: "SuperTokenLogicCreated";
+    tokenLogic: string;
+}
+export interface SuperTokenLogicUpdatedEvent extends EventBase {
+    name: "SuperTokenLogicUpdated";
+    token: string;
+    code: string;
+}
+export interface TrustedForwarderChangedEvent extends EventBase {
+    name: "TrustedForwarderChanged";
+    host: string;
+    superToken: string;
+    isSet: boolean;
+    forwarder: string;
+    enabled: boolean;
+}

package/dist/umd/frameworkHelpers.d.ts

@@ -0,0 +1,20 @@
+import { IFrameworkOptions } from "./Framework";
+export declare const validateFrameworkConstructorOptions: (options: IFrameworkOptions) => void;
+/**
+ * @dev options.networkName is casted as not null as we check to ensure chainId or networkName is not null.
+ * @param options
+ * @returns SubgraphQueriesEndpoint which is a custom endpoint or based on selected network
+ */
+export declare const getSubgraphQueriesEndpoint: (options: IFrameworkOptions) => string;
+interface INetworkNameParams {
+    readonly chainId?: number;
+    readonly networkName?: string;
+}
+/**
+ * @dev We check that the user has input a networkName or chainId and that they are both supported.
+ * @param options.chainId the chainId of the desired network
+ * @param options.networkName the name of the desired network
+ * @returns the network name
+ */
+export declare const getNetworkName: (options: INetworkNameParams) => string;
+export {};

package/dist/umd/index.d.ts

@@ -0,0 +1,19 @@
+import Framework from "./Framework";
+import SuperToken from "./SuperToken";
+import Query from "./Query";
+import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
+import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
+import Host from "./Host";
+import BatchCall from "./BatchCall";
+export * from "./interfaces";
+export * from "./utils";
+export * from "./pagination";
+export * from "./events";
+export * from "./types";
+export { Framework };
+export { SuperToken };
+export { Query };
+export { ConstantFlowAgreementV1 };
+export { InstantDistributionAgreementV1 };
+export { Host };
+export { BatchCall };