@superfluid-finance/sdk-core 0.1.1-dev.8caff13.0 → 0.1.1-dev.b8d3bbf.0

package/dist/module/SuperToken.js

@@ -0,0 +1,390 @@
+var _a;
+import { ethers } from "ethers";
+import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
+import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
+import Operation from "./Operation";
+import SFError from "./SFError";
+import Token from "./Token";
+import SuperTokenABI from "./abi/SuperToken.json";
+import { networkNameToChainIdMap } from "./constants";
+import { getNetworkName } from "./frameworkHelpers";
+import { getSanitizedTimestamp, getStringCurrentTimeInSeconds, normalizeAddress, } from "./utils";
+/**
+ * @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 {
+    constructor(options, settings) {
+        // initialize ERC20 token functions here
+        super(settings.address);
+        // SuperToken Contract Read Functions
+        /**
+         * @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
+         */
+        this.realtimeBalanceOf = async ({ providerOrSigner, account, timestamp = getStringCurrentTimeInSeconds(), }) => {
+            const normalizedAccount = normalizeAddress(account);
+            try {
+                const realtimeBalanceOf = await this.superTokenContract
+                    .connect(providerOrSigner)
+                    .realtimeBalanceOf(normalizedAccount, timestamp);
+                return {
+                    availableBalance: realtimeBalanceOf.availableBalance.toString(),
+                    deposit: realtimeBalanceOf.deposit.toString(),
+                    owedDeposit: realtimeBalanceOf.owedDeposit.toString(),
+                    timestamp: getSanitizedTimestamp(timestamp),
+                };
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "SUPERTOKEN_READ",
+                    customMessage: "There was an error getting realtimeBalanceOf",
+                    errorObject: err,
+                });
+            }
+        };
+        // SuperToken Contract Write Functions
+        /**
+         * @dev Downgrade `amount` SuperToken's.
+         * @param amount The amount to be downgraded.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.downgrade = ({ amount, overrides, }) => {
+            const txn = this.superTokenContract.populateTransaction.downgrade(amount, overrides || {});
+            return new Operation(txn, "SUPERTOKEN_DOWNGRADE");
+        };
+        /**
+         * @dev Upgrade `amount` SuperToken's.
+         * @param amount The amount to be upgraded.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.upgrade = ({ amount, overrides, }) => {
+            const txn = this.superTokenContract.populateTransaction.upgrade(amount, overrides || {});
+            return new Operation(txn, "SUPERTOKEN_UPGRADE");
+        };
+        // CFA Read Functions
+        /**
+         * @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
+         */
+        this.getFlow = async ({ sender, receiver, providerOrSigner, }) => {
+            return await this.cfaV1.getFlow({
+                superToken: this.settings.address,
+                sender,
+                receiver,
+                providerOrSigner,
+            });
+        };
+        /**
+         * @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
+         */
+        this.getAccountFlowInfo = async ({ account, providerOrSigner, }) => {
+            return await this.cfaV1.getAccountFlowInfo({
+                superToken: this.settings.address,
+                account,
+                providerOrSigner,
+            });
+        };
+        /**
+         * @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
+         */
+        this.getNetFlow = async ({ account, providerOrSigner, }) => {
+            return await this.cfaV1.getNetFlow({
+                superToken: this.settings.address,
+                account,
+                providerOrSigner,
+            });
+        };
+        // CFA Write Functions
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.createFlow = ({ sender, receiver, flowRate, userData, overrides, }) => {
+            return this.cfaV1.createFlow({
+                flowRate,
+                receiver,
+                sender,
+                superToken: this.settings.address,
+                userData,
+                overrides,
+            });
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.updateFlow = ({ sender, receiver, flowRate, userData, overrides, }) => {
+            return this.cfaV1.updateFlow({
+                flowRate,
+                receiver,
+                sender,
+                superToken: this.settings.address,
+                userData,
+                overrides,
+            });
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.deleteFlow = ({ sender, receiver, userData, overrides, }) => {
+            return this.cfaV1.deleteFlow({
+                superToken: this.settings.address,
+                sender,
+                receiver,
+                userData,
+                overrides,
+            });
+        };
+        // IDA Read Functions
+        /**
+         * @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
+         */
+        this.getSubscription = async ({ publisher, indexId, subscriber, providerOrSigner, }) => {
+            return await this.idaV1.getSubscription({
+                superToken: this.settings.address,
+                publisher,
+                indexId,
+                subscriber,
+                providerOrSigner,
+            });
+        };
+        /**
+         * @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
+         */
+        this.getIndex = async ({ publisher, indexId, providerOrSigner, }) => {
+            return await this.idaV1.getIndex({
+                superToken: this.settings.address,
+                publisher,
+                indexId,
+                providerOrSigner,
+            });
+        };
+        // IDA Write Functions
+        /**
+         * @dev Creates an IDA Index.
+         * @param indexId The id of the index.
+         * @param userData Extra user data provided.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.createIndex = ({ indexId, userData, overrides, }) => {
+            return this.idaV1.createIndex({
+                indexId,
+                superToken: this.settings.address,
+                userData,
+                overrides,
+            });
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.distribute = ({ indexId, amount, userData, overrides, }) => {
+            return this.idaV1.distribute({
+                indexId,
+                amount,
+                superToken: this.settings.address,
+                userData,
+                overrides,
+            });
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @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.
+         */
+        this.updateIndexValue = ({ indexId, indexValue, userData, overrides, }) => {
+            return this.idaV1.updateIndexValue({
+                indexId,
+                indexValue,
+                superToken: this.settings.address,
+                userData,
+                overrides,
+            });
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.updateSubscriptionUnits = ({ indexId, subscriber, units, userData, overrides, }) => {
+            return this.idaV1.updateSubscriptionUnits({
+                indexId,
+                superToken: this.settings.address,
+                subscriber,
+                units,
+                userData,
+                overrides,
+            });
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.approveSubscription = ({ indexId, publisher, userData, overrides, }) => {
+            return this.idaV1.approveSubscription({
+                indexId,
+                superToken: this.settings.address,
+                publisher,
+                userData,
+                overrides,
+            });
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.revokeSubscription = ({ indexId, publisher, userData, overrides, }) => {
+            return this.idaV1.revokeSubscription({
+                indexId,
+                superToken: this.settings.address,
+                publisher,
+                userData,
+                overrides,
+            });
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.deleteSubscription = ({ indexId, subscriber, publisher, userData, overrides, }) => {
+            return this.idaV1.deleteSubscription({
+                indexId,
+                superToken: this.settings.address,
+                subscriber,
+                publisher,
+                userData,
+                overrides,
+            });
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.claim = ({ indexId, subscriber, publisher, userData, overrides, }) => {
+            return this.idaV1.claim({
+                indexId,
+                superToken: this.settings.address,
+                subscriber,
+                publisher,
+                userData,
+                overrides,
+            });
+        };
+        this.options = options;
+        this.settings = settings;
+        this.cfaV1 = new ConstantFlowAgreementV1({
+            config: this.settings.config,
+        });
+        this.idaV1 = new InstantDistributionAgreementV1({
+            config: this.settings.config,
+        });
+        this.underlyingToken = new Token(settings.underlyingTokenAddress);
+    }
+    get superTokenContract() {
+        return new ethers.Contract(this.settings.address, SuperTokenABI.abi);
+    }
+}
+_a = SuperToken;
+SuperToken.create = async (options) => {
+    if (!options.chainId && !options.networkName) {
+        throw new SFError({
+            type: "SUPERTOKEN_INITIALIZATION",
+            customMessage: "You must input chainId or networkName.",
+        });
+    }
+    const networkName = getNetworkName(options);
+    const chainId = options.chainId || networkNameToChainIdMap.get(networkName);
+    try {
+        const superToken = new ethers.Contract(options.address, SuperTokenABI.abi);
+        const underlyingTokenAddress = await superToken
+            .connect(options.provider)
+            .getUnderlyingToken();
+        const settings = {
+            address: options.address,
+            config: options.config,
+            chainId,
+            networkName,
+            underlyingTokenAddress,
+        };
+        return new SuperToken(options, settings);
+    }
+    catch (err) {
+        throw new SFError({
+            type: "SUPERTOKEN_INITIALIZATION",
+            customMessage: "There was an error initializing the SuperToken",
+            errorObject: err,
+        });
+    }
+};
+//# sourceMappingURL=SuperToken.js.map

package/dist/module/SuperToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SuperToken.js","sourceRoot":"","sources":["../../src/SuperToken.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAa,MAAM,QAAQ,CAAC;AAE3C,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,8BAA8B,MAAM,kCAAkC,CAAC;AAC9E,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAuBpD,OAAO,EACH,qBAAqB,EACrB,6BAA6B,EAC7B,gBAAgB,GACnB,MAAM,SAAS,CAAC;AAkBjB;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,KAAK;IAOzC,YAAoB,OAAsB,EAAE,QAAwB;QAChE,wCAAwC;QACxC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAuD5B,qCAAqC;QAErC;;;;;;WAMG;QACH,sBAAiB,GAAG,KAAK,EAAE,EACvB,gBAAgB,EAChB,OAAO,EACP,SAAS,GAAG,6BAA6B,EAAE,GACpB,EAAmC,EAAE;YAC5D,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI;gBACA,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,kBAAkB;qBAClD,OAAO,CAAC,gBAAgB,CAAC;qBACzB,iBAAiB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;gBACrD,OAAO;oBACH,gBAAgB,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,QAAQ,EAAE;oBAC/D,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,QAAQ,EAAE;oBAC7C,WAAW,EAAE,iBAAiB,CAAC,WAAW,CAAC,QAAQ,EAAE;oBACrD,SAAS,EAAE,qBAAqB,CAAC,SAAS,CAAC;iBAC9C,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,iBAAiB;oBACvB,aAAa,EAAE,8CAA8C;oBAC7D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,sCAAsC;QAEtC;;;;;WAKG;QACH,cAAS,GAAG,CAAC,EACT,MAAM,EACN,SAAS,GAIZ,EAAa,EAAE;YACZ,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,SAAS,CAC7D,MAAM,EACN,SAAS,IAAI,EAAE,CAClB,CAAC;YACF,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,sBAAsB,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF;;;;;WAKG;QACH,YAAO,GAAG,CAAC,EACP,MAAM,EACN,SAAS,GAIZ,EAAa,EAAE;YACZ,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,OAAO,CAC3D,MAAM,EACN,SAAS,IAAI,EAAE,CAClB,CAAC;YACF,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC;QACpD,CAAC,CAAC;QAEF,qBAAqB;QAErB;;;;;;WAMG;QACH,YAAO,GAAG,KAAK,EAAE,EACb,MAAM,EACN,QAAQ,EACR,gBAAgB,GACO,EAA0B,EAAE;YACnD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;gBAC5B,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,MAAM;gBACN,QAAQ;gBACR,gBAAgB;aACnB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;WAKG;QACH,uBAAkB,GAAG,KAAK,EAAE,EACxB,OAAO,EACP,gBAAgB,GACW,EAA0B,EAAE;YACvD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;gBACvC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,OAAO;gBACP,gBAAgB;aACnB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;WAKG;QACH,eAAU,GAAG,KAAK,EAAE,EAChB,OAAO,EACP,gBAAgB,GACW,EAAmB,EAAE;YAChD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBAC/B,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,OAAO;gBACP,gBAAgB;aACnB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,sBAAsB;QAEtB;;;;;;;;WAQG;QACH,eAAU,GAAG,CAAC,EACV,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,SAAS,GACiB,EAAa,EAAE;YACzC,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBACzB,QAAQ;gBACR,QAAQ;gBACR,MAAM;gBACN,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,eAAU,GAAG,CAAC,EACV,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,SAAS,GACiB,EAAa,EAAE;YACzC,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBACzB,QAAQ;gBACR,QAAQ;gBACR,MAAM;gBACN,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,eAAU,GAAG,CAAC,EACV,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,SAAS,GACiB,EAAa,EAAE;YACzC,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBACzB,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,MAAM;gBACN,QAAQ;gBACR,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,qBAAqB;QAErB;;;;;;;WAOG;QACH,oBAAe,GAAG,KAAK,EAAE,EACrB,SAAS,EACT,OAAO,EACP,UAAU,EACV,gBAAgB,GACe,EAA8B,EAAE;YAC/D,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC;gBACpC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,SAAS;gBACT,OAAO;gBACP,UAAU;gBACV,gBAAgB;aACnB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;WAMG;QACH,aAAQ,GAAG,KAAK,EAAE,EACd,SAAS,EACT,OAAO,EACP,gBAAgB,GACQ,EAAuB,EAAE;YACjD,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;gBAC7B,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,SAAS;gBACT,OAAO;gBACP,gBAAgB;aACnB,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,sBAAsB;QAEtB;;;;;;WAMG;QACH,gBAAW,GAAG,CAAC,EACX,OAAO,EACP,QAAQ,EACR,SAAS,GACc,EAAa,EAAE;YACtC,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;gBAC1B,OAAO;gBACP,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,eAAU,GAAG,CAAC,EACV,OAAO,EACP,MAAM,EACN,QAAQ,EACR,SAAS,GACiB,EAAa,EAAE;YACzC,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;gBACzB,OAAO;gBACP,MAAM;gBACN,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,qBAAgB,GAAG,CAAC,EAChB,OAAO,EACP,UAAU,EACV,QAAQ,EACR,SAAS,GACuB,EAAa,EAAE;YAC/C,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC;gBAC/B,OAAO;gBACP,UAAU;gBACV,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,4BAAuB,GAAG,CAAC,EACvB,OAAO,EACP,UAAU,EACV,KAAK,EACL,QAAQ,EACR,SAAS,GAC8B,EAAa,EAAE;YACtD,OAAO,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC;gBACtC,OAAO;gBACP,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,UAAU;gBACV,KAAK;gBACL,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,wBAAmB,GAAG,CAAC,EACnB,OAAO,EACP,SAAS,EACT,QAAQ,EACR,SAAS,GACyB,EAAa,EAAE;YACjD,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC;gBAClC,OAAO;gBACP,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,SAAS;gBACT,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,uBAAkB,GAAG,CAAC,EAClB,OAAO,EACP,SAAS,EACT,QAAQ,EACR,SAAS,GACyB,EAAa,EAAE;YACjD,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;gBACjC,OAAO;gBACP,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,SAAS;gBACT,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,uBAAkB,GAAG,CAAC,EAClB,OAAO,EACP,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACa,EAAa,EAAE;YACrC,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;gBACjC,OAAO;gBACP,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,UAAU;gBACV,SAAS;gBACT,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,UAAK,GAAG,CAAC,EACL,OAAO,EACP,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACa,EAAa,EAAE;YACrC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;gBACpB,OAAO;gBACP,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACjC,UAAU;gBACV,SAAS;gBACT,QAAQ;gBACR,SAAS;aACZ,CAAC,CAAC;QACP,CAAC,CAAC;QAnfE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,IAAI,uBAAuB,CAAC;YACrC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,8BAA8B,CAAC;YAC5C,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,eAAe,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IACtE,CAAC;IAqCD,IAAY,kBAAkB;QAC1B,OAAO,IAAI,MAAM,CAAC,QAAQ,CACtB,IAAI,CAAC,QAAQ,CAAC,OAAO,EACrB,aAAa,CAAC,GAAG,CACL,CAAC;IACrB,CAAC;;;AAxCM,iBAAM,GAAG,KAAK,EAAE,OAAsB,EAAE,EAAE;IAC7C,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;QAC1C,MAAM,IAAI,OAAO,CAAC;YACd,IAAI,EAAE,2BAA2B;YACjC,aAAa,EAAE,wCAAwC;SAC1D,CAAC,CAAC;KACN;IACD,MAAM,WAAW,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,OAAO,GACT,OAAO,CAAC,OAAO,IAAI,uBAAuB,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;IACjE,IAAI;QACA,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,QAAQ,CAClC,OAAO,CAAC,OAAO,EACf,aAAa,CAAC,GAAG,CACL,CAAC;QACjB,MAAM,sBAAsB,GAAG,MAAM,UAAU;aAC1C,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC;aACzB,kBAAkB,EAAE,CAAC;QAC1B,MAAM,QAAQ,GAAmB;YAC7B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO;YACP,WAAW;YACX,sBAAsB;SACzB,CAAC;QACF,OAAO,IAAI,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;KAC5C;IAAC,OAAO,GAAG,EAAE;QACV,MAAM,IAAI,OAAO,CAAC;YACd,IAAI,EAAE,2BAA2B;YACjC,aAAa,EAAE,gDAAgD;YAC/D,WAAW,EAAE,GAAG;SACnB,CAAC,CAAC;KACN;AACL,CAAE,CAAA"}

package/dist/module/Token.d.ts

@@ -55,22 +55,26 @@ export default class Token {
      * @dev Approve `receiver` to spend `amount` tokens.
      * @param receiver The receiver approved.
      * @param amount The amount approved.
+     * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    approve: ({ receiver, amount }: IBaseSuperTokenParams) => Operation;
+    approve: ({ receiver, amount, overrides, }: IBaseSuperTokenParams) => Operation;
     /**
      * @dev Transfer `receiver` `amount` tokens.
      * @param receiver The receiver of the transfer.
      * @param amount The amount to be transferred.
+     * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    transfer: ({ receiver, amount }: IBaseSuperTokenParams) => Operation;
+    transfer: ({ receiver, amount, overrides, }: 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.
+     * @param overrides ethers overrides object for more control over the transaction sent.
      * @returns {Operation} An instance of Operation which can be executed or batched.
      */
-    transferFrom: ({ sender, receiver, amount, }: ITransferFromParams) => Operation;
+    transferFrom: ({ sender, receiver, amount, overrides, }: ITransferFromParams) => Operation;
 }
+//# sourceMappingURL=Token.d.ts.map

package/dist/module/Token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Token.d.ts","sourceRoot":"","sources":["../../src/Token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,SAAS,MAAM,aAAa,CAAC;AAGpC,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAI1E,MAAM,CAAC,OAAO,OAAO,KAAK;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEb,OAAO,EAAE,MAAM;IAI3B,OAAO,KAAK,aAAa,GAKxB;IAID;;;;;;OAMG;IACH,SAAS;eAKE,MAAM;iBACJ,MAAM;0BACG,OAAO,SAAS,CAAC,QAAQ,GAAG,OAAO,MAAM;UAC3D,QAAQ,MAAM,CAAC,CAejB;IAEF;;;;;OAKG;IACH,SAAS;iBAII,MAAM;0BACG,OAAO,SAAS,CAAC,QAAQ,GAAG,OAAO,MAAM;UAC3D,QAAQ,MAAM,CAAC,CAcjB;IAEF;;;;OAIG;IACH,IAAI;0BAGkB,OAAO,SAAS,CAAC,QAAQ,GAAG,OAAO,MAAM;UAC3D,QAAQ,MAAM,CAAC,CAajB;IAEF;;;;OAIG;IACH,MAAM;0BAGgB,OAAO,SAAS,CAAC,QAAQ,GAAG,OAAO,MAAM;UAC3D,QAAQ,MAAM,CAAC,CAajB;IAEF;;;;OAIG;IACH,WAAW;0BAGW,OAAO,SAAS,CAAC,QAAQ,GAAG,OAAO,MAAM;UAC3D,QAAQ,MAAM,CAAC,CAajB;IAIF;;;;;;OAMG;IACH,OAAO,qCAIJ,qBAAqB,KAAG,SAAS,CAQlC;IAEF;;;;;;OAMG;IACH,QAAQ,qCAIL,qBAAqB,KAAG,SAAS,CAQlC;IAEF;;;;;;;OAOG;IACH,YAAY,6CAKT,mBAAmB,KAAG,SAAS,CAUhC;CACL"}

package/dist/module/Token.js

@@ -0,0 +1,160 @@
+import { ethers } from "ethers";
+import Operation from "./Operation";
+import SFError from "./SFError";
+import ERC20WithTokenInfoABI from "./abi/ERC20WithTokenInfo.json";
+import { normalizeAddress } from "./utils";
+export default class Token {
+    constructor(address) {
+        // ERC20 Token Contract Read Functions
+        /**
+         * @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
+         */
+        this.allowance = async ({ owner, spender, providerOrSigner, }) => {
+            const normalizedOwner = normalizeAddress(owner);
+            const normalizedSpender = normalizeAddress(spender);
+            try {
+                const allowance = await this.tokenContract
+                    .connect(providerOrSigner)
+                    .allowance(normalizedOwner, normalizedSpender);
+                return allowance.toString();
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "SUPERTOKEN_READ",
+                    customMessage: "There was an error getting allowance",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @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`
+         */
+        this.balanceOf = async ({ account, providerOrSigner, }) => {
+            try {
+                const normalizedAccount = normalizeAddress(account);
+                const balanceOf = await this.tokenContract
+                    .connect(providerOrSigner)
+                    .balanceOf(normalizedAccount);
+                return balanceOf.toString();
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "SUPERTOKEN_READ",
+                    customMessage: "There was an error getting balanceOf",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @dev Returns the token name
+         * @param providerOrSigner a provider or signer for executing a web3 call
+         * @returns {string} the token name
+         */
+        this.name = async ({ providerOrSigner, }) => {
+            try {
+                const name = await this.tokenContract
+                    .connect(providerOrSigner)
+                    .name();
+                return name;
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "SUPERTOKEN_READ",
+                    customMessage: "There was an error getting name",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @dev Returns the token symbol
+         * @param providerOrSigner a provider or signer for executing a web3 call
+         * @returns {string} the token symbol
+         */
+        this.symbol = async ({ providerOrSigner, }) => {
+            try {
+                const symbol = await this.tokenContract
+                    .connect(providerOrSigner)
+                    .symbol();
+                return symbol;
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "SUPERTOKEN_READ",
+                    customMessage: "There was an error getting symbol",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @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
+         */
+        this.totalSupply = async ({ providerOrSigner, }) => {
+            try {
+                const totalSupply = await this.tokenContract
+                    .connect(providerOrSigner)
+                    .totalSupply();
+                return totalSupply.toString();
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "SUPERTOKEN_READ",
+                    customMessage: "There was an error getting totalSupply",
+                    errorObject: err,
+                });
+            }
+        };
+        // ERC20 Token Contract Write Functions
+        /**
+         * @dev Approve `receiver` to spend `amount` tokens.
+         * @param receiver The receiver approved.
+         * @param amount The amount approved.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.approve = ({ receiver, amount, overrides, }) => {
+            const normalizedReceiver = normalizeAddress(receiver);
+            const txn = this.tokenContract.populateTransaction.approve(normalizedReceiver, amount, overrides || {});
+            return new Operation(txn, "ERC20_APPROVE");
+        };
+        /**
+         * @dev Transfer `receiver` `amount` tokens.
+         * @param receiver The receiver of the transfer.
+         * @param amount The amount to be transferred.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.transfer = ({ receiver, amount, overrides, }) => {
+            const normalizedReceiver = normalizeAddress(receiver);
+            const txn = this.tokenContract.populateTransaction.transfer(normalizedReceiver, amount, overrides || {});
+            return new Operation(txn, "UNSUPPORTED");
+        };
+        /**
+         * @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.
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} An instance of Operation which can be executed or batched.
+         */
+        this.transferFrom = ({ sender, receiver, amount, overrides, }) => {
+            const normalizedSender = normalizeAddress(sender);
+            const normalizedReceiver = normalizeAddress(receiver);
+            const txn = this.tokenContract.populateTransaction.transferFrom(normalizedSender, normalizedReceiver, amount, overrides || {});
+            return new Operation(txn, "ERC20_TRANSFER_FROM");
+        };
+        this.address = address;
+    }
+    get tokenContract() {
+        return new ethers.Contract(this.address, ERC20WithTokenInfoABI.abi);
+    }
+}
+//# sourceMappingURL=Token.js.map

package/dist/module/Token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Token.js","sourceRoot":"","sources":["../../src/Token.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,qBAAqB,MAAM,+BAA+B,CAAC;AAGlE,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,MAAM,CAAC,OAAO,OAAO,KAAK;IAGtB,YAAY,OAAe;QAW3B,sCAAsC;QAEtC;;;;;;WAMG;QACH,cAAS,GAAG,KAAK,EAAE,EACf,KAAK,EACL,OAAO,EACP,gBAAgB,GAKnB,EAAmB,EAAE;YAClB,MAAM,eAAe,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI;gBACA,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa;qBACrC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,SAAS,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;gBACnD,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;aAC/B;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,iBAAiB;oBACvB,aAAa,EAAE,sCAAsC;oBACrD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;;WAKG;QACH,cAAS,GAAG,KAAK,EAAE,EACf,OAAO,EACP,gBAAgB,GAInB,EAAmB,EAAE;YAClB,IAAI;gBACA,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;gBACpD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa;qBACrC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,SAAS,CAAC,iBAAiB,CAAC,CAAC;gBAClC,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;aAC/B;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,iBAAiB;oBACvB,aAAa,EAAE,sCAAsC;oBACrD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;WAIG;QACH,SAAI,GAAG,KAAK,EAAE,EACV,gBAAgB,GAGnB,EAAmB,EAAE;YAClB,IAAI;gBACA,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa;qBAChC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,IAAI,EAAE,CAAC;gBACZ,OAAO,IAAI,CAAC;aACf;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,iBAAiB;oBACvB,aAAa,EAAE,iCAAiC;oBAChD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;WAIG;QACH,WAAM,GAAG,KAAK,EAAE,EACZ,gBAAgB,GAGnB,EAAmB,EAAE;YAClB,IAAI;gBACA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa;qBAClC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,MAAM,EAAE,CAAC;gBACd,OAAO,MAAM,CAAC;aACjB;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,iBAAiB;oBACvB,aAAa,EAAE,mCAAmC;oBAClD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;WAIG;QACH,gBAAW,GAAG,KAAK,EAAE,EACjB,gBAAgB,GAGnB,EAAmB,EAAE;YAClB,IAAI;gBACA,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa;qBACvC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,WAAW,EAAE,CAAC;gBACnB,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;aACjC;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,iBAAiB;oBACvB,aAAa,EAAE,wCAAwC;oBACvD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,uCAAuC;QAEvC;;;;;;WAMG;QACH,YAAO,GAAG,CAAC,EACP,QAAQ,EACR,MAAM,EACN,SAAS,GACW,EAAa,EAAE;YACnC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACtD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,OAAO,CACtD,kBAAkB,EAClB,MAAM,EACN,SAAS,IAAI,EAAE,CAClB,CAAC;YACF,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;QAC/C,CAAC,CAAC;QAEF;;;;;;WAMG;QACH,aAAQ,GAAG,CAAC,EACR,QAAQ,EACR,MAAM,EACN,SAAS,GACW,EAAa,EAAE;YACnC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACtD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,QAAQ,CACvD,kBAAkB,EAClB,MAAM,EACN,SAAS,IAAI,EAAE,CAClB,CAAC;YACF,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,iBAAY,GAAG,CAAC,EACZ,MAAM,EACN,QAAQ,EACR,MAAM,EACN,SAAS,GACS,EAAa,EAAE;YACjC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAClD,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACtD,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,YAAY,CAC3D,gBAAgB,EAChB,kBAAkB,EAClB,MAAM,EACN,SAAS,IAAI,EAAE,CAClB,CAAC;YACF,OAAO,IAAI,SAAS,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;QACrD,CAAC,CAAC;QAnNE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,IAAY,aAAa;QACrB,OAAO,IAAI,MAAM,CAAC,QAAQ,CACtB,IAAI,CAAC,OAAO,EACZ,qBAAqB,CAAC,GAAG,CACN,CAAC;IAC5B,CAAC;CA4MJ"}