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

package/dist/main/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/main/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/main/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/main/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/main/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/main/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 {};

package/dist/main/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/main/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/main/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>;