@superfluid-finance/sdk-core 0.5.1-dev.bba2a88.0 → 0.5.2-dev.f39efb8.0

package/CHANGELOG.md

@@ -5,24 +5,46 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+### Added
+- Support for `isNativeAssetSuperToken` property on SuperToken entity queries
+- `callAppAction` Operation creator added to `Host` class
+
+### Breaking
+- `BatchCall.getCallDataFunctionArgs` deprecates the old `BatchCall.getCallAgreementFunctionArgs`
+  - Migration:
+      - Replace `getCallAgreementFunctionArgs` with `getCallDataFunctionArgs` and pass in the fragment/ABI as the first argument, whilst keeping the same `callData` argument.
+- `Host.populateCallAgreementTxnAndReturnOperation` is replaced by `Host.callAgreement`
+  - Migration:
+      - Replace instances of `populateCallAgreementTxnAndReturnOperation` with `callAgreement`
+
+### Fixes
+- Handle `CALL_APP_ACTION` operation type correctly in SDK-Core when doing a batch call
+
+## [0.5.1] - 2022-07-26
+
+## Fixes
+- Patch fix serializeError strange serialization
+
 ## [0.5.0] - 2022-07-14
 
-## Added
+### Added
 - Support for SetEvent and Subgraph v1.4.4
+- `Framework.operation` method for easily creating `Operation` instances
 
-## Fixes
+### Fixes
 - Compile AJV validations to prevent unsafe-eval and did not allow SDK-Core usage inside Google Chrome extension due to unsafe-eval CSP
 
 ### Changed
 - `SFError` refactor to be more conventional. It inherits `Error` and uses `cause` to wrap internal errors.
 - Use `serialize-error` for serializing error object inside the message.
+- Export Operation & OperationType
 
 ### Breaking
 - `SFError.errorObject` renamed to `SFError.cause`
 
 ## [0.4.4] - 2022-06-30
 
-## Added
+### Added
 - Support for new event properties for Subgraph v1.4.1
 
 ### Breaking
@@ -167,7 +189,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
   - New `SuperToken` class with `SuperToken` CRUD functionality and an underlying `Token` class with basic `ERC20` functionality
   - New `BatchCall` class for creating and executing batch calls with supported `Operation's`
 
-[Unreleased]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.5.0...HEAD
+[Unreleased]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.5.1...HEAD
+[0.5.1]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.5.0...sdk-core%40v0.5.1
 [0.5.0]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.4.4...sdk-core%40v0.5.0
 [0.4.4]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.4.3...sdk-core%40v0.4.4
 [0.4.3]: https://github.com/superfluid-finance/protocol-monorepo/compare/sdk-core%40v0.4.2...sdk-core%40v0.4.3

package/dist/index.umd.js

@@ -73869,11 +73869,12 @@ const operationTypeStringToTypeMap = new Map([
 class BatchCall {
     constructor(options) {
         /**
-         * Gets the call agreement function arguments.
-         * @param callData callData of the function
+         * Gets function arguments given an ABI and callData.
+         * @param abi the abi fragments of a contract/function
+         * @param callData call data of the function
          * @returns {ethers.utils.Result} call agreement function arguments
          */
-        this.getCallAgreementFunctionArgs = (callData) => (0, utils_1.getTransactionDescription)(Superfluid_json_1.default.abi, callData).args;
+        this.getCallDataFunctionArgs = (abi, callData) => (0, utils_1.getTransactionDescription)(abi, callData).args;
         /**
          * Given an `Operation` object, gets the `OperationStruct` object.
          * @param operation an `Operation` object
@@ -73896,12 +73897,10 @@ class BatchCall {
                     message: "The transaction is missing the to or data property.",
                 });
             }
-            // Handles the Superfluid Call Agreement
-            // The only operation which has a target that is not the
-            // same as the to property of the transaction.
+            const encoder = ethers_1.ethers.utils.defaultAbiCoder;
+            // Handles Superfluid.callAgreement
             if (operation.type === "SUPERFLUID_CALL_AGREEMENT") {
-                const encoder = ethers_1.ethers.utils.defaultAbiCoder;
-                const functionArgs = this.getCallAgreementFunctionArgs(populatedTransaction.data);
+                const functionArgs = this.getCallDataFunctionArgs(Superfluid_json_1.default.abi, populatedTransaction.data);
                 const data = encoder.encode(["bytes", "bytes"], [functionArgs["callData"], functionArgs["userData"]]);
                 return {
                     operationType,
@@ -73909,7 +73908,16 @@ class BatchCall {
                     data,
                 };
             }
-            // Handles other cases which are not call agreeement operation
+            // Handles Superfluid.callAppAction
+            if (operation.type === "CALL_APP_ACTION") {
+                const functionArgs = this.getCallDataFunctionArgs(Superfluid_json_1.default.abi, populatedTransaction.data);
+                return {
+                    operationType,
+                    target: functionArgs["app"],
+                    data: functionArgs["callData"],
+                };
+            }
+            // Handles remaining ERC20/SuperToken Operations
             return {
                 operationType,
                 target: populatedTransaction.to,
@@ -74135,7 +74143,7 @@ class ConstantFlowAgreementV1 {
                 params.flowRate,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * Update a flow.
@@ -74155,7 +74163,7 @@ class ConstantFlowAgreementV1 {
                 params.flowRate,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * Delete a flow.
@@ -74176,7 +74184,7 @@ class ConstantFlowAgreementV1 {
                 normalizedReceiver,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * Create a flow as an operator
@@ -74199,7 +74207,7 @@ class ConstantFlowAgreementV1 {
                 params.flowRate,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * Update a flow as an operator.
@@ -74222,7 +74230,7 @@ class ConstantFlowAgreementV1 {
                 params.flowRate,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * Delete a flow as an operator.
@@ -74238,7 +74246,7 @@ class ConstantFlowAgreementV1 {
             const normalizedSender = (0, utils_1.normalizeAddress)(params.sender);
             const normalizedReceiver = (0, utils_1.normalizeAddress)(params.receiver);
             const callData = cfaInterface.encodeFunctionData("deleteFlowByOperator", [normalizedToken, normalizedSender, normalizedReceiver, "0x"]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
         };
         /** ### Private Functions ### */
         /**
@@ -74246,7 +74254,7 @@ class ConstantFlowAgreementV1 {
          * @param timestamp last updated timestamp of flow
          * @param flowRate the current flow rate
          * @param deposit the deposit amount
-         * @param owedDeposit any owed depsit
+         * @param owedDeposit any owed deposit
          * @returns {IWeb3FlowInfo} sanitized web3 flow info
          */
         this._sanitizeFlowInfo = (params) => {
@@ -74308,7 +74316,7 @@ class ConstantFlowAgreementV1 {
             params.flowRateAllowance,
             "0x",
         ]);
-        return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
+        return this.host.callAgreement(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
     }
     /**
      * Give flow operator full control - max flow rate and create/update/delete permissions.
@@ -74321,7 +74329,7 @@ class ConstantFlowAgreementV1 {
         const normalizedToken = (0, utils_1.normalizeAddress)(params.superToken);
         const normalizedFlowOperator = (0, utils_1.normalizeAddress)(params.flowOperator);
         const callData = cfaInterface.encodeFunctionData("authorizeFlowOperatorWithFullControl", [normalizedToken, normalizedFlowOperator, "0x"]);
-        return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
+        return this.host.callAgreement(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
     }
     /**
      * Revoke flow operator control - set flow rate to 0 with no permissions.
@@ -74334,7 +74342,7 @@ class ConstantFlowAgreementV1 {
         const normalizedToken = (0, utils_1.normalizeAddress)(params.superToken);
         const normalizedFlowOperator = (0, utils_1.normalizeAddress)(params.flowOperator);
         const callData = cfaInterface.encodeFunctionData("revokeFlowOperatorWithFullControl", [normalizedToken, normalizedFlowOperator, "0x"]);
-        return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
+        return this.host.callAgreement(this.options.config.cfaV1Address, callData, params.userData, params.overrides);
     }
 }
 exports.default = ConstantFlowAgreementV1;
@@ -74515,6 +74523,7 @@ const ConstantFlowAgreementV1_1 = __importDefault(require("./ConstantFlowAgreeme
 const Governance_1 = __importDefault(require("./Governance"));
 const Host_1 = __importDefault(require("./Host"));
 const InstantDistributionAgreementV1_1 = __importDefault(require("./InstantDistributionAgreementV1"));
+const Operation_1 = __importDefault(require("./Operation"));
 const Query_1 = __importDefault(require("./Query"));
 const SFError_1 = require("./SFError");
 const SuperToken_1 = __importDefault(require("./SuperToken"));
@@ -74581,6 +74590,15 @@ class Framework {
                 hostAddress: this.settings.config.hostAddress,
             });
         };
+        /**
+         * Create an `Operation` class from the `Framework`.
+         * @param txn the populated transaction to execute
+         * @param type the operation type
+         * @returns `Operation` class
+         */
+        this.operation = (txn, type) => {
+            return new Operation_1.default(txn, type);
+        };
         /**
          * Loads `NativeAssetSuperToken` class from the `Framework`. Will throw if token is not NativeAssetSuperToken.
          * @param tokenAddressOrSymbol
@@ -74777,7 +74795,7 @@ Framework.create = async (options) => {
     }
 };
 
-},{"./BatchCall":312,"./ConstantFlowAgreementV1":313,"./Governance":316,"./Host":317,"./InstantDistributionAgreementV1":318,"./Query":320,"./SFError":321,"./SuperToken":322,"./abi/IResolver.json":326,"./abi/SuperfluidLoader.json":331,"./constants":333,"./frameworkHelpers":336,"./utils":382,"ethers":148}],316:[function(require,module,exports){
+},{"./BatchCall":312,"./ConstantFlowAgreementV1":313,"./Governance":316,"./Host":317,"./InstantDistributionAgreementV1":318,"./Operation":319,"./Query":320,"./SFError":321,"./SuperToken":322,"./abi/IResolver.json":326,"./abi/SuperfluidLoader.json":331,"./constants":333,"./frameworkHelpers":336,"./utils":382,"ethers":148}],316:[function(require,module,exports){
 "use strict";
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -74834,7 +74852,7 @@ class Governance {
          */
         this.getGovernanceParameters = async ({ providerOrSigner, token = ethers_1.ethers.constants.AddressZero, }) => {
             const pppPromise = this.getPPPConfig({ providerOrSigner, token });
-            const rewardPromose = this.getRewardAddress({
+            const rewardPromise = this.getRewardAddress({
                 providerOrSigner,
                 token,
             });
@@ -74844,7 +74862,7 @@ class Governance {
             });
             const data = await Promise.all([
                 pppPromise,
-                rewardPromose,
+                rewardPromise,
                 minimumDepositPromise,
             ]);
             return {
@@ -74883,10 +74901,21 @@ class Host {
          * @param overrides ethers overrides object for more control over the transaction sent.
          * @returns {Operation} an `Operation` class
          */
-        this.populateCallAgreementTxnAndReturnOperation = (agreementAddress, callData, userData, overrides) => {
+        this.callAgreement = (agreementAddress, callData, userData, overrides) => {
             const txn = this.contract.populateTransaction.callAgreement(agreementAddress, callData, userData || "0x", overrides || {});
             return new Operation_1.default(txn, "SUPERFLUID_CALL_AGREEMENT");
         };
+        /**
+         * Creates an Operation of the `callAppAction` function on the host contract.
+         * @param app the address of the Super App you are calling
+         * @param callData the encoded callData for the function
+         * @param overrides ethers overrides object for more control over the transaction sent.
+         * @returns {Operation} an `Operation` class
+         */
+        this.callAppAction = (app, callData, overrides) => {
+            const txn = this.contract.populateTransaction.callAppAction(app, callData, overrides || {});
+            return new Operation_1.default(txn, "CALL_APP_ACTION");
+        };
         this.contract = new ethers_1.ethers.Contract(hostAddress, Superfluid_json_1.default.abi);
     }
 }
@@ -74989,7 +75018,7 @@ class InstantDistributionAgreementV1 {
                 params.indexId,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * Distributes `amount` of `superToken` to an index
@@ -75008,7 +75037,7 @@ class InstantDistributionAgreementV1 {
                 params.amount,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * Updates the `indexValue` of an index.
@@ -75028,7 +75057,7 @@ class InstantDistributionAgreementV1 {
                 params.indexValue,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * Updates the `units` allocated to a Subscription.
@@ -75050,7 +75079,7 @@ class InstantDistributionAgreementV1 {
                 params.units,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * Approves a Subscription, so the Subscriber won't need to claim tokens when the Publisher distributes.
@@ -75065,10 +75094,10 @@ class InstantDistributionAgreementV1 {
             const normalizedPublisher = (0, utils_1.normalizeAddress)(params.publisher);
             const normalizedToken = (0, utils_1.normalizeAddress)(params.superToken);
             const callData = idaInterface.encodeFunctionData("approveSubscription", [normalizedToken, normalizedPublisher, params.indexId, "0x"]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
-         * Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributres.
+         * Revokes a Subscription, so the Subscriber will need to claim tokens when the Publisher distributes.
          * @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.
@@ -75085,14 +75114,14 @@ class InstantDistributionAgreementV1 {
                 params.indexId,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * 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 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.
@@ -75108,14 +75137,14 @@ class InstantDistributionAgreementV1 {
                 normalizedSubscriber,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         /**
          * 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 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.
@@ -75131,7 +75160,7 @@ class InstantDistributionAgreementV1 {
                 normalizedSubscriber,
                 "0x",
             ]);
-            return this.host.populateCallAgreementTxnAndReturnOperation(this.options.config.idaV1Address, callData, params.userData, params.overrides);
+            return this.host.callAgreement(this.options.config.idaV1Address, callData, params.userData, params.overrides);
         };
         this.options = options;
         this.host = new Host_1.default(options.config.hostAddress);
@@ -75154,7 +75183,7 @@ class Operation {
         /**
          * 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
+         * @param signer The signer of the transaction
          * @returns {ethers.providers.TransactionResponse} A TransactionResponse object which can be awaited
          */
         this.exec = async (signer) => {
@@ -75191,7 +75220,7 @@ class Operation {
         };
         /**
          * Signs the populated transaction via the provided signer (what you intend on sending to the network).
-         * @param signer The signer of the transacation
+         * @param signer The signer of the transaction
          * @returns {Promise<string>} Fully serialized, signed transaction
          */
         this.getSignedTransaction = async (signer) => {
@@ -75211,7 +75240,7 @@ class Operation {
         /**
          * 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
+         * @param signer The signer of the transaction
          * @returns {Promise<string>} The transaction hash of the transaction
          */
         this.getTransactionHash = async (signer) => {
@@ -75525,15 +75554,25 @@ const errorTypeToTitleMap = new Map([
     ["UNCLEAN_PERMISSIONS", "Unclean Permissions"],
     ["NEGATIVE_FLOW_ALLOWANCE", "Negative Flow Rate Allowance"],
 ]);
+// NOTE: this is a temporary solution to fix serializeError
+// which throws a weird JSON error
+const stringifyCause = (cause) => {
+    try {
+        return JSON.stringify((0, serialize_error_1.serializeError)(cause), null, 2);
+    }
+    catch (err) {
+        return JSON.stringify(cause, null, 2);
+    }
+};
 class SFError extends Error {
     constructor({ type, message, cause }) {
         const fullMessage = `${errorTypeToTitleMap.get(type)} Error: ${message}${cause
             ? `
-Caused by: ${JSON.stringify((0, serialize_error_1.serializeError)(cause), null, 2)}`
+Caused by: ${stringifyCause(cause)}`
             : ""}`;
         super(fullMessage, cause
             ? {
-                cause: cause, // Currently "unknown" is not compatible with "cause" (because it expectes "Error" and that's why we cast) but this was recently changed and merged to also allow "unknown": https://github.com/microsoft/TypeScript/pull/49639
+                cause: cause, // Currently "unknown" is not compatible with "cause" (because it expects "Error" and that's why we cast) but this was recently changed and merged to also allow "unknown": https://github.com/microsoft/TypeScript/pull/49639
             }
             : {});
         // Fallback back environments where `Error.cause` is now yet natively supported
@@ -84376,7 +84415,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WrapperSuperToken = exports.SuperToken = exports.Query = exports.PureSuperToken = exports.NativeAssetSuperToken = exports.InstantDistributionAgreementV1 = exports.Host = exports.Governance = exports.Framework = exports.ERC20Token = exports.ConstantFlowAgreementV1 = exports.BatchCall = void 0;
+exports.WrapperSuperToken = exports.SuperToken = exports.Query = exports.PureSuperToken = exports.NativeAssetSuperToken = exports.InstantDistributionAgreementV1 = exports.Host = exports.Governance = exports.Framework = exports.ERC20Token = exports.ConstantFlowAgreementV1 = exports.BatchCall = exports.Operation = void 0;
 __exportStar(require("./subgraph/schema.generated"), exports);
 const BatchCall_1 = __importDefault(require("./BatchCall"));
 exports.BatchCall = BatchCall_1.default;
@@ -84392,6 +84431,8 @@ const Host_1 = __importDefault(require("./Host"));
 exports.Host = Host_1.default;
 const InstantDistributionAgreementV1_1 = __importDefault(require("./InstantDistributionAgreementV1"));
 exports.InstantDistributionAgreementV1 = InstantDistributionAgreementV1_1.default;
+const Operation_1 = __importDefault(require("./Operation"));
+exports.Operation = Operation_1.default;
 const Query_1 = __importDefault(require("./Query"));
 exports.Query = Query_1.default;
 const SuperToken_1 = __importStar(require("./SuperToken"));
@@ -84426,7 +84467,7 @@ __exportStar(require("./subgraph/mappedSubgraphTypes"), exports);
 __exportStar(require("./SFError"), exports);
 __exportStar(require("./subgraph/subgraphQueryHandler"), exports);
 
-},{"./BatchCall":312,"./ConstantFlowAgreementV1":313,"./ERC20Token":314,"./Framework":315,"./Governance":316,"./Host":317,"./InstantDistributionAgreementV1":318,"./Query":320,"./SFError":321,"./SuperToken":322,"./constants":333,"./events":335,"./interfaces":338,"./ordering":340,"./pagination":341,"./subgraph/entities/account/account":343,"./subgraph/entities/accountTokenSnapshot/accountTokenSnapshot":345,"./subgraph/entities/accountTokenSnapshotLog/accountTokenSnapshotLog":347,"./subgraph/entities/index/index":349,"./subgraph/entities/indexSubscription/indexSubscription":351,"./subgraph/entities/stream/stream":353,"./subgraph/entities/streamPeriod/streamPeriod":355,"./subgraph/entities/token/token":357,"./subgraph/entities/tokenStatistic/tokenStatistic":359,"./subgraph/entities/tokenStatisticLog/tokenStatisticLog":361,"./subgraph/events/events":364,"./subgraph/events/flowUpdatedEvent":365,"./subgraph/events/indexUpdatedEvent":366,"./subgraph/events/subscriptionUnitsUpdatedEvents":367,"./subgraph/events/transferEvents":368,"./subgraph/mappedSubgraphTypes":369,"./subgraph/meta/meta":371,"./subgraph/schema.generated":379,"./subgraph/subgraphQueryHandler":380,"./types":381,"./utils":382}],338:[function(require,module,exports){
+},{"./BatchCall":312,"./ConstantFlowAgreementV1":313,"./ERC20Token":314,"./Framework":315,"./Governance":316,"./Host":317,"./InstantDistributionAgreementV1":318,"./Operation":319,"./Query":320,"./SFError":321,"./SuperToken":322,"./constants":333,"./events":335,"./interfaces":338,"./ordering":340,"./pagination":341,"./subgraph/entities/account/account":343,"./subgraph/entities/accountTokenSnapshot/accountTokenSnapshot":345,"./subgraph/entities/accountTokenSnapshotLog/accountTokenSnapshotLog":347,"./subgraph/entities/index/index":349,"./subgraph/entities/indexSubscription/indexSubscription":351,"./subgraph/entities/stream/stream":353,"./subgraph/entities/streamPeriod/streamPeriod":355,"./subgraph/entities/token/token":357,"./subgraph/entities/tokenStatistic/tokenStatistic":359,"./subgraph/entities/tokenStatisticLog/tokenStatisticLog":361,"./subgraph/events/events":364,"./subgraph/events/flowUpdatedEvent":365,"./subgraph/events/indexUpdatedEvent":366,"./subgraph/events/subscriptionUnitsUpdatedEvents":367,"./subgraph/events/transferEvents":368,"./subgraph/mappedSubgraphTypes":369,"./subgraph/meta/meta":371,"./subgraph/schema.generated":379,"./subgraph/subgraphQueryHandler":380,"./types":381,"./utils":382}],338:[function(require,module,exports){
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 

package/dist/main/BatchCall.d.ts

@@ -1,3 +1,4 @@
+import { JsonFragment } from "@ethersproject/abi";
 import { ethers } from "ethers";
 import Host from "./Host";
 import Operation from "./Operation";
@@ -19,11 +20,12 @@ export default class BatchCall {
     host: Host;
     constructor(options: IBatchCallOptions);
     /**
-     * Gets the call agreement function arguments.
-     * @param callData callData of the function
+     * Gets function arguments given an ABI and callData.
+     * @param abi the abi fragments of a contract/function
+     * @param callData call data of the function
      * @returns {ethers.utils.Result} call agreement function arguments
      */
-    getCallAgreementFunctionArgs: (callData: string) => ethers.utils.Result;
+    getCallDataFunctionArgs: (abi: string | readonly (string | ethers.utils.Fragment | JsonFragment)[], callData: string) => ethers.utils.Result;
     /**
      * Given an `Operation` object, gets the `OperationStruct` object.
      * @param operation an `Operation` object

package/dist/main/BatchCall.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BatchCall.d.ts","sourceRoot":"","sources":["../../src/BatchCall.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,SAA4B,MAAM,aAAa,CAAC;AAKvD,UAAU,iBAAiB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;CACxC;AAED,UAAU,eAAe;IACrB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB;AAWD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,IAAI,EAAE,IAAI,CAAC;gBAEC,OAAO,EAAE,iBAAiB;IAKtC;;;;OAIG;IACH,4BAA4B,aAAc,MAAM,KAAG,OAAO,KAAK,CAAC,MAAM,CACN;IAEhE;;;;;OAKG;IACH,kBAAkB,cACH,SAAS,SACb,MAAM,KACd,QAAQ,eAAe,CAAC,CA4CzB;IAEF;;;OAGG;IACH,IAAI,+BAA+B,IAAI,OAAO,CAAC,eAAe,CAAC,EAAE,CAIhE;IAED;;;;OAIG;IACH,IAAI,WACQ,OAAO,MAAM,KACtB,QAAQ,OAAO,mBAAmB,CAAC,CAepC;IAKF;;;;OAIG;IACH,WAAW,WACC,OAAO,MAAM,KACtB,QAAQ,OAAO,mBAAmB,CAAC,CAepC;CACL"}
+{"version":3,"file":"BatchCall.d.ts","sourceRoot":"","sources":["../../src/BatchCall.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,SAA4B,MAAM,aAAa,CAAC;AAKvD,UAAU,iBAAiB;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;CACxC;AAED,UAAU,eAAe;IACrB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB;AAWD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,OAAO,EAAE,iBAAiB,CAAC;IAC3B,IAAI,EAAE,IAAI,CAAC;gBAEC,OAAO,EAAE,iBAAiB;IAKtC;;;;;OAKG;IACH,uBAAuB,QAEb,MAAM,GACN,SAAS,CAAC,MAAM,GAAG,OAAO,KAAK,CAAC,QAAQ,GAAG,YAAY,CAAC,EAAE,YACtD,MAAM,KACjB,OAAO,KAAK,CAAC,MAAM,CAAkD;IAExE;;;;;OAKG;IACH,kBAAkB,cACH,SAAS,SACb,MAAM,KACd,QAAQ,eAAe,CAAC,CA0DzB;IAEF;;;OAGG;IACH,IAAI,+BAA+B,IAAI,OAAO,CAAC,eAAe,CAAC,EAAE,CAIhE;IAED;;;;OAIG;IACH,IAAI,WACQ,OAAO,MAAM,KACtB,QAAQ,OAAO,mBAAmB,CAAC,CAepC;IAKF;;;;OAIG;IACH,WAAW,WACC,OAAO,MAAM,KACtB,QAAQ,OAAO,mBAAmB,CAAC,CAepC;CACL"}

package/dist/main/BatchCall.js

@@ -23,11 +23,12 @@ const operationTypeStringToTypeMap = new Map([
 class BatchCall {
     constructor(options) {
         /**
-         * Gets the call agreement function arguments.
-         * @param callData callData of the function
+         * Gets function arguments given an ABI and callData.
+         * @param abi the abi fragments of a contract/function
+         * @param callData call data of the function
          * @returns {ethers.utils.Result} call agreement function arguments
          */
-        this.getCallAgreementFunctionArgs = (callData) => (0, utils_1.getTransactionDescription)(Superfluid_json_1.default.abi, callData).args;
+        this.getCallDataFunctionArgs = (abi, callData) => (0, utils_1.getTransactionDescription)(abi, callData).args;
         /**
          * Given an `Operation` object, gets the `OperationStruct` object.
          * @param operation an `Operation` object
@@ -50,12 +51,10 @@ class BatchCall {
                     message: "The transaction is missing the to or data property.",
                 });
             }
-            // Handles the Superfluid Call Agreement
-            // The only operation which has a target that is not the
-            // same as the to property of the transaction.
+            const encoder = ethers_1.ethers.utils.defaultAbiCoder;
+            // Handles Superfluid.callAgreement
             if (operation.type === "SUPERFLUID_CALL_AGREEMENT") {
-                const encoder = ethers_1.ethers.utils.defaultAbiCoder;
-                const functionArgs = this.getCallAgreementFunctionArgs(populatedTransaction.data);
+                const functionArgs = this.getCallDataFunctionArgs(Superfluid_json_1.default.abi, populatedTransaction.data);
                 const data = encoder.encode(["bytes", "bytes"], [functionArgs["callData"], functionArgs["userData"]]);
                 return {
                     operationType,
@@ -63,7 +62,16 @@ class BatchCall {
                     data,
                 };
             }
-            // Handles other cases which are not call agreeement operation
+            // Handles Superfluid.callAppAction
+            if (operation.type === "CALL_APP_ACTION") {
+                const functionArgs = this.getCallDataFunctionArgs(Superfluid_json_1.default.abi, populatedTransaction.data);
+                return {
+                    operationType,
+                    target: functionArgs["app"],
+                    data: functionArgs["callData"],
+                };
+            }
+            // Handles remaining ERC20/SuperToken Operations
             return {
                 operationType,
                 target: populatedTransaction.to,

package/dist/main/BatchCall.js.map

@@ -1 +1 @@
-{"version":3,"file":"BatchCall.js","sourceRoot":"","sources":["../../src/BatchCall.ts"],"names":[],"mappings":";;;;;AAAA,mCAAgC;AAEhC,kDAA0B;AAE1B,uCAAoC;AACpC,4EAAkD;AAClD,mCAA+E;AAa/E,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAwB;IAChE,CAAC,eAAe,EAAE,CAAC,CAAC;IACpB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC1B,CAAC,oBAAoB,EAAE,GAAG,CAAC;IAC3B,CAAC,sBAAsB,EAAE,GAAG,CAAC;IAC7B,CAAC,2BAA2B,EAAE,GAAG,CAAC;IAClC,CAAC,iBAAiB,EAAE,GAAG,CAAC;CAC3B,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAqB,SAAS;IAI1B,YAAY,OAA0B;QAKtC;;;;WAIG;QACH,iCAA4B,GAAG,CAAC,QAAgB,EAAuB,EAAE,CACrE,IAAA,iCAAyB,EAAC,yBAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC;QAEhE;;;;;WAKG;QACH,uBAAkB,GAAG,KAAK,EACtB,SAAoB,EACpB,KAAa,EACW,EAAE;YAC1B,MAAM,aAAa,GAAG,4BAA4B,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACvE,MAAM,oBAAoB,GAAG,MAAM,SAAS,CAAC,0BAA0B,CAAC;YACxE,IAAI,CAAC,aAAa,EAAE;gBAChB,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,uBAAuB;oBAC7B,OAAO,EAAE,yBAAyB,GAAG,KAAK,GAAG,kBAAkB;iBAClE,CAAC,CAAC;aACN;YAED,0BAA0B;YAC1B,IAAI,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE;gBACxD,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,gCAAgC;oBACtC,OAAO,EAAE,qDAAqD;iBACjE,CAAC,CAAC;aACN;YAED,wCAAwC;YACxC,wDAAwD;YACxD,8CAA8C;YAC9C,IAAI,SAAS,CAAC,IAAI,KAAK,2BAA2B,EAAE;gBAChD,MAAM,OAAO,GAAG,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC;gBAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,4BAA4B,CAClD,oBAAoB,CAAC,IAAI,CAC5B,CAAC;gBACF,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CACvB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClB,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CACvD,CAAC;gBAEF,OAAO;oBACH,aAAa;oBACb,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC;oBACtC,IAAI;iBACP,CAAC;aACL;YAED,8DAA8D;YAC9D,OAAO;gBACH,aAAa;gBACb,MAAM,EAAE,oBAAoB,CAAC,EAAE;gBAC/B,IAAI,EAAE,IAAA,iCAAyB,EAAC,oBAAoB,CAAC,IAAI,CAAC;aAC7D,CAAC;QACN,CAAC,CAAC;QAYF;;;;WAIG;QACH,SAAI,GAAG,KAAK,EACR,MAAqB,EACc,EAAE;YACrC,IAAI;gBACA,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,IAAI,CAAC,+BAA+B,CACvC,CAAC;gBACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ;qBAC1B,OAAO,CAAC,MAAM,CAAC;qBACf,SAAS,CAAC,oBAAoB,CAAC,CAAC;aACxC;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EAAE,+CAA+C;oBACxD,KAAK,EAAE,GAAG;iBACb,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,0BAA0B;QAC1B,oEAAoE;QACpE,6CAA6C;QAC7C;;;;WAIG;QACH,gBAAW,GAAG,KAAK,EACf,MAAqB,EACc,EAAE;YACrC,IAAI;gBACA,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,IAAI,CAAC,+BAA+B,CACvC,CAAC;gBACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ;qBAC1B,OAAO,CAAC,MAAM,CAAC;qBACf,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;aAC/C;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EAAE,+CAA+C;oBACxD,KAAK,EAAE,GAAG;iBACb,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QA9HE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAiED;;;OAGG;IACH,IAAI,+BAA+B;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACxC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAChC,CAAC;IACN,CAAC;CAoDJ;AApID,4BAoIC"}
+{"version":3,"file":"BatchCall.js","sourceRoot":"","sources":["../../src/BatchCall.ts"],"names":[],"mappings":";;;;;AACA,mCAAgC;AAEhC,kDAA0B;AAE1B,uCAAoC;AACpC,4EAAkD;AAClD,mCAA+E;AAa/E,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAwB;IAChE,CAAC,eAAe,EAAE,CAAC,CAAC;IACpB,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC1B,CAAC,oBAAoB,EAAE,GAAG,CAAC;IAC3B,CAAC,sBAAsB,EAAE,GAAG,CAAC;IAC7B,CAAC,2BAA2B,EAAE,GAAG,CAAC;IAClC,CAAC,iBAAiB,EAAE,GAAG,CAAC;CAC3B,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAqB,SAAS;IAI1B,YAAY,OAA0B;QAKtC;;;;;WAKG;QACH,4BAAuB,GAAG,CACtB,GAEgE,EAChE,QAAgB,EACG,EAAE,CAAC,IAAA,iCAAyB,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC;QAExE;;;;;WAKG;QACH,uBAAkB,GAAG,KAAK,EACtB,SAAoB,EACpB,KAAa,EACW,EAAE;YAC1B,MAAM,aAAa,GAAG,4BAA4B,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACvE,MAAM,oBAAoB,GAAG,MAAM,SAAS,CAAC,0BAA0B,CAAC;YACxE,IAAI,CAAC,aAAa,EAAE;gBAChB,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,uBAAuB;oBAC7B,OAAO,EAAE,yBAAyB,GAAG,KAAK,GAAG,kBAAkB;iBAClE,CAAC,CAAC;aACN;YAED,0BAA0B;YAC1B,IAAI,CAAC,oBAAoB,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE;gBACxD,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,gCAAgC;oBACtC,OAAO,EAAE,qDAAqD;iBACjE,CAAC,CAAC;aACN;YAED,MAAM,OAAO,GAAG,eAAM,CAAC,KAAK,CAAC,eAAe,CAAC;YAE7C,mCAAmC;YACnC,IAAI,SAAS,CAAC,IAAI,KAAK,2BAA2B,EAAE;gBAChD,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAC7C,yBAAa,CAAC,GAAG,EACjB,oBAAoB,CAAC,IAAI,CAC5B,CAAC;gBACF,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CACvB,CAAC,OAAO,EAAE,OAAO,CAAC,EAClB,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CACvD,CAAC;gBAEF,OAAO;oBACH,aAAa;oBACb,MAAM,EAAE,YAAY,CAAC,gBAAgB,CAAC;oBACtC,IAAI;iBACP,CAAC;aACL;YAED,mCAAmC;YACnC,IAAI,SAAS,CAAC,IAAI,KAAK,iBAAiB,EAAE;gBACtC,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAC7C,yBAAa,CAAC,GAAG,EACjB,oBAAoB,CAAC,IAAI,CAC5B,CAAC;gBAEF,OAAO;oBACH,aAAa;oBACb,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC;oBAC3B,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC;iBACjC,CAAC;aACL;YAED,gDAAgD;YAChD,OAAO;gBACH,aAAa;gBACb,MAAM,EAAE,oBAAoB,CAAC,EAAE;gBAC/B,IAAI,EAAE,IAAA,iCAAyB,EAAC,oBAAoB,CAAC,IAAI,CAAC;aAC7D,CAAC;QACN,CAAC,CAAC;QAYF;;;;WAIG;QACH,SAAI,GAAG,KAAK,EACR,MAAqB,EACc,EAAE;YACrC,IAAI;gBACA,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,IAAI,CAAC,+BAA+B,CACvC,CAAC;gBACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ;qBAC1B,OAAO,CAAC,MAAM,CAAC;qBACf,SAAS,CAAC,oBAAoB,CAAC,CAAC;aACxC;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EAAE,+CAA+C;oBACxD,KAAK,EAAE,GAAG;iBACb,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,0BAA0B;QAC1B,oEAAoE;QACpE,6CAA6C;QAC7C;;;;WAIG;QACH,gBAAW,GAAG,KAAK,EACf,MAAqB,EACc,EAAE;YACrC,IAAI;gBACA,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,IAAI,CAAC,+BAA+B,CACvC,CAAC;gBACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ;qBAC1B,OAAO,CAAC,MAAM,CAAC;qBACf,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;aAC/C;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EAAE,+CAA+C;oBACxD,KAAK,EAAE,GAAG;iBACb,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAjJE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAoFD;;;OAGG;IACH,IAAI,+BAA+B;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACxC,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAChC,CAAC;IACN,CAAC;CAoDJ;AAvJD,4BAuJC"}

package/dist/main/ConstantFlowAgreementV1.d.ts

@@ -151,7 +151,7 @@ export default class ConstantFlowAgreementV1 {
      * @param timestamp last updated timestamp of flow
      * @param flowRate the current flow rate
      * @param deposit the deposit amount
-     * @param owedDeposit any owed depsit
+     * @param owedDeposit any owed deposit
      * @returns {IWeb3FlowInfo} sanitized web3 flow info
      */
     _sanitizeFlowInfo: (params: IWeb3FlowInfoParams) => IWeb3FlowInfo;