@superfluid-finance/sdk-core 0.1.1-dev.fa49a94.0 → 0.2.1-dev.64549c3.0

package/dist/module/InstantDistributionAgreementV1.js

@@ -0,0 +1,243 @@
+import { ethers } from "ethers";
+import Host from "./Host";
+import SFError from "./SFError";
+import IInstantDistributionAgreementV1ABI from "./abi/IInstantDistributionAgreementV1.json";
+import { normalizeAddress } from "./utils";
+const idaInterface = new ethers.utils.Interface(IInstantDistributionAgreementV1ABI.abi);
+/**
+ * @dev Instant Distribution Agreement V1 Helper Class
+ * @description A helper class to interact with the IDAV1 contract.
+ */
+export default class InstantDistributionAgreementV1 {
+    constructor(options) {
+        // IDA Read Functions
+        /**
+         * @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
+         */
+        this.getSubscription = async ({ superToken, publisher, indexId, subscriber, providerOrSigner, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedPublisher = normalizeAddress(publisher);
+            const normalizedSubscriber = normalizeAddress(subscriber);
+            try {
+                const subscription = await this.idaContract
+                    .connect(providerOrSigner)
+                    .getSubscription(normalizedToken, normalizedPublisher, indexId, normalizedSubscriber);
+                return {
+                    exist: subscription.exist,
+                    approved: subscription.approved,
+                    units: subscription.units.toString(),
+                    pendingDistribution: subscription.pendingDistribution.toString(),
+                };
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "IDAV1_READ",
+                    customMessage: "There was an error getting the subscription",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @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
+         */
+        this.getIndex = async ({ superToken, publisher, indexId, providerOrSigner, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedPublisher = normalizeAddress(publisher);
+            try {
+                const index = await this.idaContract
+                    .connect(providerOrSigner)
+                    .getIndex(normalizedToken, normalizedPublisher, indexId);
+                return {
+                    exist: index.exist,
+                    indexValue: index.indexValue.toString(),
+                    totalUnitsApproved: index.totalUnitsApproved.toString(),
+                    totalUnitsPending: index.totalUnitsPending.toString(),
+                };
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "IDAV1_READ",
+                    customMessage: "There was an error getting the index",
+                    errorObject: err,
+                });
+            }
+        };
+        // IDA Write Functions
+        /**
+         * @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.
+         * @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, superToken, userData, overrides, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const callData = idaInterface.encodeFunctionData("createIndex", [
+                normalizedToken,
+                indexId,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+        };
+        /**
+         * @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.
+         * @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, superToken, userData, overrides, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const callData = idaInterface.encodeFunctionData("distribute", [
+                normalizedToken,
+                indexId,
+                amount,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+        };
+        /**
+         * @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.
+         * @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.updateIndexValue = ({ indexId, indexValue, superToken, userData, overrides, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const callData = idaInterface.encodeFunctionData("updateIndex", [
+                normalizedToken,
+                indexId,
+                indexValue,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+        };
+        /**
+         * @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.
+         * @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, superToken, subscriber, units, userData, overrides, }) => {
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedSubscriber = normalizeAddress(subscriber);
+            const callData = idaInterface.encodeFunctionData("updateSubscription", [
+                normalizedToken,
+                indexId,
+                normalizedSubscriber,
+                units,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, 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 superToken The superToken of the index.
+         * @param publisher The publisher of the index 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, superToken, publisher, userData, overrides, }) => {
+            const normalizedPublisher = normalizeAddress(publisher);
+            const normalizedToken = normalizeAddress(superToken);
+            const callData = idaInterface.encodeFunctionData("approveSubscription", [normalizedToken, normalizedPublisher, indexId, "0x"]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+        };
+        /**
+         * @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.
+         * @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, superToken, publisher, userData, overrides, }) => {
+            const normalizedPublisher = normalizeAddress(publisher);
+            const normalizedToken = normalizeAddress(superToken);
+            const callData = idaInterface.encodeFunctionData("revokeSubscription", [
+                normalizedToken,
+                normalizedPublisher,
+                indexId,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+        };
+        /**
+         * @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.
+         * @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, superToken, subscriber, publisher, userData, overrides, }) => {
+            const normalizedPublisher = normalizeAddress(publisher);
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedSubscriber = normalizeAddress(subscriber);
+            const callData = idaInterface.encodeFunctionData("deleteSubscription", [
+                normalizedToken,
+                normalizedPublisher,
+                indexId,
+                normalizedSubscriber,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+        };
+        /**
+         * @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.
+         * @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, superToken, subscriber, publisher, userData, overrides, }) => {
+            const normalizedPublisher = normalizeAddress(publisher);
+            const normalizedToken = normalizeAddress(superToken);
+            const normalizedSubscriber = normalizeAddress(subscriber);
+            const callData = idaInterface.encodeFunctionData("claim", [
+                normalizedToken,
+                normalizedPublisher,
+                indexId,
+                normalizedSubscriber,
+                "0x",
+            ]);
+            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, userData, overrides);
+        };
+        this.options = options;
+        this.host = new Host(options.config.hostAddress);
+    }
+    get idaContract() {
+        return new ethers.Contract(this.options.config.idaV1Address, IInstantDistributionAgreementV1ABI.abi);
+    }
+}
+//# sourceMappingURL=InstantDistributionAgreementV1.js.map

package/dist/module/InstantDistributionAgreementV1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InstantDistributionAgreementV1.js","sourceRoot":"","sources":["../../src/InstantDistributionAgreementV1.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,kCAAkC,MAAM,4CAA4C,CAAC;AAiB5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3C,kCAAkC,CAAC,GAAG,CACzC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,8BAA8B;IAI/C,YAAY,OAA4B;QAYxC,qBAAqB;QAErB;;;;;;;;WAQG;QACH,oBAAe,GAAG,KAAK,EAAE,EACrB,UAAU,EACV,SAAS,EACT,OAAO,EACP,UAAU,EACV,gBAAgB,GACK,EAA8B,EAAE;YACrD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1D,IAAI;gBACA,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,WAAW;qBACtC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,eAAe,CACZ,eAAe,EACf,mBAAmB,EACnB,OAAO,EACP,oBAAoB,CACvB,CAAC;gBAEN,OAAO;oBACH,KAAK,EAAE,YAAY,CAAC,KAAK;oBACzB,QAAQ,EAAE,YAAY,CAAC,QAAQ;oBAC/B,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,QAAQ,EAAE;oBACpC,mBAAmB,EACf,YAAY,CAAC,mBAAmB,CAAC,QAAQ,EAAE;iBAClD,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,YAAY;oBAClB,aAAa,EAAE,6CAA6C;oBAC5D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,aAAQ,GAAG,KAAK,EAAE,EACd,UAAU,EACV,SAAS,EACT,OAAO,EACP,gBAAgB,GACF,EAAuB,EAAE;YACvC,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,IAAI;gBACA,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW;qBAC/B,OAAO,CAAC,gBAAgB,CAAC;qBACzB,QAAQ,CAAC,eAAe,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;gBAC7D,OAAO;oBACH,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE;oBACvC,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE;oBACvD,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,CAAC,QAAQ,EAAE;iBACxD,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,YAAY;oBAClB,aAAa,EAAE,sCAAsC;oBACrD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,sBAAsB;QAEtB;;;;;;;WAOG;QACH,gBAAW,GAAG,CAAC,EACX,OAAO,EACP,UAAU,EACV,QAAQ,EACR,SAAS,GACQ,EAAa,EAAE;YAChC,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,aAAa,EAAE;gBAC5D,eAAe;gBACf,OAAO;gBACP,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,eAAU,GAAG,CAAC,EACV,OAAO,EACP,MAAM,EACN,UAAU,EACV,QAAQ,EACR,SAAS,GACO,EAAa,EAAE;YAC/B,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,YAAY,EAAE;gBAC3D,eAAe;gBACf,OAAO;gBACP,MAAM;gBACN,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,qBAAgB,GAAG,CAAC,EAChB,OAAO,EACP,UAAU,EACV,UAAU,EACV,QAAQ,EACR,SAAS,GACa,EAAa,EAAE;YACrC,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,aAAa,EAAE;gBAC5D,eAAe;gBACf,OAAO;gBACP,UAAU;gBACV,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,4BAAuB,GAAG,CAAC,EACvB,OAAO,EACP,UAAU,EACV,UAAU,EACV,KAAK,EACL,QAAQ,EACR,SAAS,GACoB,EAAa,EAAE;YAC5C,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,oBAAoB,EAAE;gBACnE,eAAe;gBACf,OAAO;gBACP,oBAAoB;gBACpB,KAAK;gBACL,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,wBAAmB,GAAG,CAAC,EACnB,OAAO,EACP,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACgB,EAAa,EAAE;YACxC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAC5C,qBAAqB,EACrB,CAAC,eAAe,EAAE,mBAAmB,EAAE,OAAO,EAAE,IAAI,CAAC,CACxD,CAAC;YAEF,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;WAQG;QACH,uBAAkB,GAAG,CAAC,EAClB,OAAO,EACP,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACe,EAAa,EAAE;YACvC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,oBAAoB,EAAE;gBACnE,eAAe;gBACf,mBAAmB;gBACnB,OAAO;gBACP,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,uBAAkB,GAAG,CAAC,EAClB,OAAO,EACP,UAAU,EACV,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACe,EAAa,EAAE;YACvC,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,oBAAoB,EAAE;gBACnE,eAAe;gBACf,mBAAmB;gBACnB,OAAO;gBACP,oBAAoB;gBACpB,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,UAAK,GAAG,CAAC,EACL,OAAO,EACP,UAAU,EACV,UAAU,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACE,EAAa,EAAE;YAC1B,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;YACxD,MAAM,eAAe,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YACrD,MAAM,oBAAoB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAC1D,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC,OAAO,EAAE;gBACtD,eAAe;gBACf,mBAAmB;gBACnB,OAAO;gBACP,oBAAoB;gBACpB,IAAI;aACP,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,IAAI,CAAC,0CAA0C,CACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,QAAQ,EACR,QAAQ,EACR,SAAS,CACZ,CAAC;QACN,CAAC,CAAC;QAzWE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC;IAED,IAAY,WAAW;QACnB,OAAO,IAAI,MAAM,CAAC,QAAQ,CACtB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,EAChC,kCAAkC,CAAC,GAAG,CACN,CAAC;IACzC,CAAC;CAiWJ"}

package/dist/module/Operation.d.ts

@@ -36,3 +36,4 @@ export default class Operation {
      */
     getTransactionHash: (signer: ethers.Signer) => Promise<string>;
 }
+//# sourceMappingURL=Operation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Operation.d.ts","sourceRoot":"","sources":["../../src/Operation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAIhC,oBAAY,aAAa,GACnB,aAAa,GACb,eAAe,GACf,qBAAqB,GACrB,oBAAoB,GACpB,sBAAsB,GACtB,2BAA2B,GAC3B,iBAAiB,CAAC;AAExB;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,QAAQ,CAAC,0BAA0B,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAC1E,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;gBAGzB,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,EACzC,IAAI,EAAE,aAAa;IAMvB;;;;;OAKG;IACH,IAAI,WACQ,OAAO,MAAM,KACtB,QAAQ,OAAO,SAAS,CAAC,mBAAmB,CAAC,CAY9C;IAEF;;;;OAIG;IACH,8BAA8B,WAClB,OAAO,MAAM,KACtB,QAAQ,kBAAkB,CAAC,CAY5B;IACF;;;;OAIG;IACH,oBAAoB,WAAkB,OAAO,MAAM,KAAG,QAAQ,MAAM,CAAC,CAenE;IAEF;;;;;OAKG;IACH,kBAAkB,WAAkB,OAAO,MAAM,KAAG,QAAQ,MAAM,CAAC,CAGjE;CACL"}

package/dist/module/Operation.js

@@ -0,0 +1,80 @@
+import { ethers } from "ethers";
+import SFError from "./SFError";
+/**
+ * @dev Operation Helper Class
+ * @description A helper class to create `Operation` objects which can be executed or batched.
+ */
+export default class Operation {
+    constructor(txn, type) {
+        /**
+         * @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
+         */
+        this.exec = async (signer) => {
+            try {
+                const populatedTransaction = await this.getPopulatedTransactionRequest(signer);
+                return await signer.sendTransaction(populatedTransaction);
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "EXECUTE_TRANSACTION",
+                    customMessage: "There was an error executing the transaction",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @dev Get the populated transaction by awaiting `populateTransactionPromise`.
+         * @description Note that we need to populate the txn with the signer.
+         * @returns {Promise<TransactionRequest>}
+         */
+        this.getPopulatedTransactionRequest = async (signer) => {
+            try {
+                const prePopulated = await this.populateTransactionPromise;
+                return await signer.populateTransaction(prePopulated);
+            }
+            catch (err) {
+                /* istanbul ignore next */
+                throw new SFError({
+                    type: "POPULATE_TRANSACTION",
+                    customMessage: "There was an error populating the transaction",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @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
+         */
+        this.getSignedTransaction = async (signer) => {
+            try {
+                const populatedTransaction = await this.getPopulatedTransactionRequest(signer);
+                const signedTxn = await signer.signTransaction(populatedTransaction);
+                return signedTxn;
+            }
+            catch (err) {
+                throw new SFError({
+                    type: "SIGN_TRANSACTION",
+                    customMessage: "There was an error signing the transaction",
+                    errorObject: err,
+                });
+            }
+        };
+        /**
+         * @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
+         */
+        this.getTransactionHash = async (signer) => {
+            const signedTxn = await this.getSignedTransaction(signer);
+            return ethers.utils.keccak256(signedTxn);
+        };
+        this.populateTransactionPromise = txn;
+        this.type = type;
+    }
+}
+//# sourceMappingURL=Operation.js.map

package/dist/module/Operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Operation.js","sourceRoot":"","sources":["../../src/Operation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,OAAO,MAAM,WAAW,CAAC;AAWhC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAI1B,YACI,GAAyC,EACzC,IAAmB;QAMvB;;;;;WAKG;QACH,SAAI,GAAG,KAAK,EACR,MAAqB,EACwB,EAAE;YAC/C,IAAI;gBACA,MAAM,oBAAoB,GACtB,MAAM,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;gBACtD,OAAO,MAAM,MAAM,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;aAC7D;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,qBAAqB;oBAC3B,aAAa,EAAE,8CAA8C;oBAC7D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;WAIG;QACH,mCAA8B,GAAG,KAAK,EAClC,MAAqB,EACM,EAAE;YAC7B,IAAI;gBACA,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC;gBAC3D,OAAO,MAAM,MAAM,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;aACzD;YAAC,OAAO,GAAG,EAAE;gBACV,0BAA0B;gBAC1B,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,sBAAsB;oBAC5B,aAAa,EAAE,+CAA+C;oBAC9D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QACF;;;;WAIG;QACH,yBAAoB,GAAG,KAAK,EAAE,MAAqB,EAAmB,EAAE;YACpE,IAAI;gBACA,MAAM,oBAAoB,GACtB,MAAM,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;gBACtD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,eAAe,CAC1C,oBAAoB,CACvB,CAAC;gBACF,OAAO,SAAS,CAAC;aACpB;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,OAAO,CAAC;oBACd,IAAI,EAAE,kBAAkB;oBACxB,aAAa,EAAE,4CAA4C;oBAC3D,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF;;;;;WAKG;QACH,uBAAkB,GAAG,KAAK,EAAE,MAAqB,EAAmB,EAAE;YAClE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAC1D,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7C,CAAC,CAAC;QA7EE,IAAI,CAAC,0BAA0B,GAAG,GAAG,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;CA4EJ"}

package/dist/module/Query.d.ts

@@ -29,3 +29,4 @@ export default class Query {
     listEvents: (filter: IEventFilter, paging?: Paging, ordering?: Ordering<Event_OrderBy>) => Promise<PagedResult<AllEvents>>;
     on(callback: (events: AllEvents[], unsubscribe: () => void) => void, ms: number, account?: string, timeout?: number): () => void;
 }
+//# sourceMappingURL=Query.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Query.d.ts","sourceRoot":"","sources":["../../src/Query.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EACH,2BAA2B,EAC3B,MAAM,EACN,mBAAmB,EACnB,kBAAkB,EAClB,+BAA+B,EAC/B,0BAA0B,EAC1B,YAAY,EACZ,OAAO,EACP,oBAAoB,EACpB,WAAW,EACX,wBAAwB,EAC3B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAIH,WAAW,EACX,MAAM,EAET,MAAM,cAAc,CAAC;AAgCtB,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,aAAa,EACb,yBAAyB,EACzB,cAAc,EACd,aAAa,EAChB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAUnC,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC;IAC/C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,KAAK;IACtB,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,CAAC,cAAc,CAAiB;gBAE3B,OAAO,EAAE,aAAa;IAOlC;;;OAGG;IACH,cAAc,gDACW,MAAM,8CAW7B;IAEF,kBAAkB,WACN,wBAAwB,WACxB,MAAM,aACJ,SAAS,aAAa,CAAC,KAIlC,QAAQ,YAAY,WAAW,CAAC,CAAC,CAkClC;IAEF,WAAW,WACC,mBAAmB,WACnB,MAAM,aACJ,SAAS,aAAa,CAAC,KAIlC,QAAQ,YAAY,MAAM,CAAC,CAAC,CA2C7B;IAEF,sBAAsB,WACV,+BAA+B,WAC/B,MAAM,aACJ,SAAS,yBAAyB,CAAC,KAI9C,QAAQ,YAAY,kBAAkB,CAAC,CAAC,CAiDzC;IAEF,WAAW,WACC,oBAAoB,WACpB,MAAM,aACJ,SAAS,cAAc,CAAC,KAInC,QAAQ,YAAY,OAAO,CAAC,CAAC,CAiD9B;IAEF,6BAA6B,WACjB,2BAA2B,WAC3B,MAAM,aACJ,SAAS,4BAA4B,CAAC,KAIjD,QAAQ,YAAY,0BAA0B,CAAC,CAAC,CA2CjD;IAEF,UAAU,WACE,YAAY,WACZ,MAAM,aACJ,SAAS,aAAa,CAAC,KAIlC,QAAQ,YAAY,SAAS,CAAC,CAAC,CA+BhC;IAKF,EAAE,CACE,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,MAAM,IAAI,KAAK,IAAI,EAChE,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,GACjB,MAAM,IAAI;CAgEhB"}