@superfluid-finance/sdk-core 0.3.3-dev.a92870f.0 → 0.3.3-dev.bd59c6c.0

package/dist/main/{Token.js → ERC20Token.js}

@@ -8,11 +8,11 @@ const Operation_1 = __importDefault(require("./Operation"));
 const SFError_1 = require("./SFError");
 const ERC20WithTokenInfo_json_1 = __importDefault(require("./abi/ERC20WithTokenInfo.json"));
 const utils_1 = require("./utils");
-class Token {
+class ERC20Token {
     constructor(address) {
-        // ERC20 Token Contract Read Functions
+        /** ### ERC20 Token Contract Read Functions ### */
         /**
-         * @dev Returns the allowance the `owner` has granted the `spender`.
+         * 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
@@ -22,7 +22,7 @@ class Token {
             const normalizedOwner = (0, utils_1.normalizeAddress)(owner);
             const normalizedSpender = (0, utils_1.normalizeAddress)(spender);
             try {
-                const allowance = await this.tokenContract
+                const allowance = await this.contract
                     .connect(providerOrSigner)
                     .allowance(normalizedOwner, normalizedSpender);
                 return allowance.toString();
@@ -36,7 +36,7 @@ class Token {
             }
         };
         /**
-         * @dev Returns the ERC20 balanceOf the `account`, this can't be negative and will just display 0.
+         * 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`
@@ -44,7 +44,7 @@ class Token {
         this.balanceOf = async ({ account, providerOrSigner, }) => {
             try {
                 const normalizedAccount = (0, utils_1.normalizeAddress)(account);
-                const balanceOf = await this.tokenContract
+                const balanceOf = await this.contract
                     .connect(providerOrSigner)
                     .balanceOf(normalizedAccount);
                 return balanceOf.toString();
@@ -58,15 +58,13 @@ class Token {
             }
         };
         /**
-         * @dev Returns the token name
+         * 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();
+                const name = await this.contract.connect(providerOrSigner).name();
                 return name;
             }
             catch (err) {
@@ -78,13 +76,13 @@ class Token {
             }
         };
         /**
-         * @dev Returns the token symbol
+         * 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
+                const symbol = await this.contract
                     .connect(providerOrSigner)
                     .symbol();
                 return symbol;
@@ -98,13 +96,13 @@ class Token {
             }
         };
         /**
-         * @dev Returns the total supply of the token.
+         * 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
+                const totalSupply = await this.contract
                     .connect(providerOrSigner)
                     .totalSupply();
                 return totalSupply.toString();
@@ -117,50 +115,48 @@ class Token {
                 });
             }
         };
-        // ERC20 Token Contract Write Functions
+        /** ### ERC20 Token Contract Write Functions ### */
         /**
-         * @dev Approve `receiver` to spend `amount` tokens.
+         * 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 = (0, utils_1.normalizeAddress)(receiver);
-            const txn = this.tokenContract.populateTransaction.approve(normalizedReceiver, amount, overrides || {});
+        this.approve = (params) => {
+            const normalizedReceiver = (0, utils_1.normalizeAddress)(params.receiver);
+            const txn = this.contract.populateTransaction.approve(normalizedReceiver, params.amount, params.overrides || {});
             return new Operation_1.default(txn, "ERC20_APPROVE");
         };
         /**
-         * @dev Transfer `receiver` `amount` tokens.
+         * 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 = (0, utils_1.normalizeAddress)(receiver);
-            const txn = this.tokenContract.populateTransaction.transfer(normalizedReceiver, amount, overrides || {});
+        this.transfer = (params) => {
+            const normalizedReceiver = (0, utils_1.normalizeAddress)(params.receiver);
+            const txn = this.contract.populateTransaction.transfer(normalizedReceiver, params.amount, params.overrides || {});
             return new Operation_1.default(txn, "UNSUPPORTED");
         };
         /**
-         * @dev Transfer from `sender` to `receiver` `amount` tokens.
+         * 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 = (0, utils_1.normalizeAddress)(sender);
-            const normalizedReceiver = (0, utils_1.normalizeAddress)(receiver);
-            const txn = this.tokenContract.populateTransaction.transferFrom(normalizedSender, normalizedReceiver, amount, overrides || {});
+        this.transferFrom = (params) => {
+            const normalizedSender = (0, utils_1.normalizeAddress)(params.sender);
+            const normalizedReceiver = (0, utils_1.normalizeAddress)(params.receiver);
+            const txn = this.contract.populateTransaction.transferFrom(normalizedSender, normalizedReceiver, params.amount, params.overrides || {});
             return new Operation_1.default(txn, "ERC20_TRANSFER_FROM");
         };
         this.address = address;
-    }
-    get tokenContract() {
-        return new ethers_1.ethers.Contract(this.address, ERC20WithTokenInfo_json_1.default.abi);
+        this.contract = new ethers_1.ethers.Contract(this.address, ERC20WithTokenInfo_json_1.default.abi);
     }
 }
-exports.default = Token;
-//# sourceMappingURL=Token.js.map
+exports.default = ERC20Token;
+//# sourceMappingURL=ERC20Token.js.map

package/dist/main/ERC20Token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ERC20Token.js","sourceRoot":"","sources":["../../src/ERC20Token.ts"],"names":[],"mappings":";;;;;AAAA,mCAAgC;AAEhC,4DAAoC;AACpC,uCAAoC;AACpC,4FAAkE;AAGlE,mCAA2C;AAE3C,MAAqB,UAAU;IAI3B,YAAY,OAAe;QAQ3B,kDAAkD;QAElD;;;;;;WAMG;QACH,cAAS,GAAG,KAAK,EAAE,EACf,KAAK,EACL,OAAO,EACP,gBAAgB,GAKnB,EAAmB,EAAE;YAClB,MAAM,eAAe,GAAG,IAAA,wBAAgB,EAAC,KAAK,CAAC,CAAC;YAChD,MAAM,iBAAiB,GAAG,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;YACpD,IAAI;gBACA,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ;qBAChC,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,iBAAO,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,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;gBACpD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ;qBAChC,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,iBAAO,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,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE,CAAC;gBAClE,OAAO,IAAI,CAAC;aACf;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,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,QAAQ;qBAC7B,OAAO,CAAC,gBAAgB,CAAC;qBACzB,MAAM,EAAE,CAAC;gBACd,OAAO,MAAM,CAAC;aACjB;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,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,QAAQ;qBAClC,OAAO,CAAC,gBAAgB,CAAC;qBACzB,WAAW,EAAE,CAAC;gBACnB,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;aACjC;YAAC,OAAO,GAAG,EAAE;gBACV,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,iBAAiB;oBACvB,aAAa,EAAE,wCAAwC;oBACvD,WAAW,EAAE,GAAG;iBACnB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QAEF,mDAAmD;QAEnD;;;;;;WAMG;QACH,YAAO,GAAG,CAAC,MAA6B,EAAa,EAAE;YACnD,MAAM,kBAAkB,GAAG,IAAA,wBAAgB,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC7D,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,OAAO,CACjD,kBAAkB,EAClB,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,SAAS,IAAI,EAAE,CACzB,CAAC;YACF,OAAO,IAAI,mBAAS,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;QAC/C,CAAC,CAAC;QAEF;;;;;;WAMG;QACH,aAAQ,GAAG,CAAC,MAA6B,EAAa,EAAE;YACpD,MAAM,kBAAkB,GAAG,IAAA,wBAAgB,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC7D,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,QAAQ,CAClD,kBAAkB,EAClB,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,SAAS,IAAI,EAAE,CACzB,CAAC;YACF,OAAO,IAAI,mBAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF;;;;;;;WAOG;QACH,iBAAY,GAAG,CAAC,MAA2B,EAAa,EAAE;YACtD,MAAM,gBAAgB,GAAG,IAAA,wBAAgB,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACzD,MAAM,kBAAkB,GAAG,IAAA,wBAAgB,EAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC7D,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,YAAY,CACtD,gBAAgB,EAChB,kBAAkB,EAClB,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,SAAS,IAAI,EAAE,CACzB,CAAC;YACF,OAAO,IAAI,mBAAS,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;QACrD,CAAC,CAAC;QAjME,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAM,CAAC,QAAQ,CAC/B,IAAI,CAAC,OAAO,EACZ,iCAAqB,CAAC,GAAG,CACN,CAAC;IAC5B,CAAC;CA6LJ;AAvMD,6BAuMC"}

package/dist/main/Framework.d.ts

@@ -4,12 +4,13 @@ import { ethers } from "ethers";
 import Web3 from "web3";
 import BatchCall from "./BatchCall";
 import ConstantFlowAgreementV1 from "./ConstantFlowAgreementV1";
+import Governance from "./Governance";
 import Host from "./Host";
 import InstantDistributionAgreementV1 from "./InstantDistributionAgreementV1";
 import Operation from "./Operation";
 import Query from "./Query";
-import SuperToken from "./SuperToken";
-import { IConfig, ISignerConstructorOptions } from "./interfaces";
+import SuperToken, { NativeAssetSuperToken, PureSuperToken, WrapperSuperToken } from "./SuperToken";
+import { IConfig, IContracts, ISignerConstructorOptions } from "./interfaces";
 import { DataMode } from "./types";
 declare type SupportedProvider = ethers.providers.Provider | (typeof ethers & HardhatEthersHelpers) | Web3;
 export interface IFrameworkOptions {
@@ -31,19 +32,21 @@ export interface IFrameworkSettings {
     config: IConfig;
 }
 /**
- * @dev Superfluid Framework Class
+ * Superfluid Framework Class
  * @description The entrypoint for the SDK-core, `create` an instance of this for full functionality.
  */
 export default class Framework {
     readonly userInputOptions: IFrameworkOptions;
     settings: IFrameworkSettings;
+    contracts: IContracts;
     cfaV1: ConstantFlowAgreementV1;
+    governance: Governance;
     host: Host;
     idaV1: InstantDistributionAgreementV1;
     query: Query;
     private constructor();
     /**
-     * @dev Creates the Framework object based on user provided `options`.
+     * Creates the Framework object based on user provided `options`.
      * @param options.chainId the chainId of your desired network (e.g. 137 = matic)
      * @param options.customSubgraphQueriesEndpoint your custom subgraph endpoint
      * @param options.dataMode the data mode you'd like the framework to use (SUBGRAPH_ONLY, SUBGRAPH_WEB3, WEB3_ONLY)
@@ -55,7 +58,7 @@ export default class Framework {
      */
     static create: (options: IFrameworkOptions) => Promise<Framework>;
     /**
-     * @dev Create a signer which can be used to sign transactions.
+     * Create a signer which can be used to sign transactions.
      * @param options.web3Provider a Web3Provider object (e.g. client side - metamask, web3modal)
      * @param options.provider an ethers Provider object (e.g. via Hardhat ethers)
      * @param options.privateKey a test account private key
@@ -64,17 +67,41 @@ export default class Framework {
      */
     createSigner: (options: ISignerConstructorOptions) => Signer;
     /**
-     * @dev Create a `BatchCall` class from the `Framework`.
+     * Create a `BatchCall` class from the `Framework`.
      * @param operations the list of operations to execute
      * @returns `BatchCall` class
      */
     batchCall: (operations: Operation[]) => BatchCall;
     /**
-     * @dev Load a `SuperToken` class from the `Framework`.
+     * Loads `NativeAssetSuperToken` class from the `Framework`. Will throw if token is not NativeAssetSuperToken.
+     * @param tokenAddressOrSymbol
+     * @returns `NativeAssetSuperToken` class
+     */
+    loadNativeAssetSuperToken: (tokenAddressOrSymbol: string) => Promise<NativeAssetSuperToken>;
+    /**
+     * Loads `PureSuperToken` class from the `Framework`. Will throw if token is not PureSuperToken.
+     * @param tokenAddressOrSymbol
+     * @returns `PureSuperToken` class
+     */
+    loadPureSuperToken: (tokenAddressOrSymbol: string) => Promise<PureSuperToken>;
+    /**
+     * Loads `WrapperSuperToken` class from the `Framework`. Will throw if token is not WrapperSuperToken.
+     * @param tokenAddressOrSymbol
+     * @returns `WrapperSuperToken` class
+     */
+    loadWrapperSuperToken: (tokenAddressOrSymbol: string) => Promise<WrapperSuperToken>;
+    /**
+     * Loads `SuperToken` class from the `Framework`. Use this when you're unsure of the token type.
      * @param tokenAddressOrSymbol the `SuperToken` address or symbol (if symbol, it must be on the resolver)
      * @returns `SuperToken` class
      */
     loadSuperToken: (tokenAddressOrSymbol: string) => Promise<SuperToken>;
+    /**
+     * Try to get the token address given an address (returns if valid) or the token symbol via the resolver.
+     * @param tokenAddressOrSymbol
+     * @returns token address
+     */
+    private _tryGetTokenAddress;
 }
 export {};
 //# sourceMappingURL=Framework.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Framework.d.ts","sourceRoot":"","sources":["../../src/Framework.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,8BAA8B,MAAM,kCAAkC,CAAC;AAC9E,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,OAAO,UAAU,MAAM,cAAc,CAAC;AAStC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAElE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGnC,aAAK,iBAAiB,GAChB,MAAM,CAAC,SAAS,CAAC,QAAQ,GACzB,CAAC,OAAO,MAAM,GAAG,oBAAoB,CAAC,GACtC,IAAI,CAAC;AAIX,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,EAAE,iBAAiB,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B,EAAE,MAAM,CAAC;IACtC,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;IACpC,MAAM,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,QAAQ,CAAC,gBAAgB,EAAE,iBAAiB,CAAC;IAC7C,QAAQ,EAAE,kBAAkB,CAAC;IAE7B,KAAK,EAAE,uBAAuB,CAAC;IAC/B,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,8BAA8B,CAAC;IACtC,KAAK,EAAE,KAAK,CAAC;IAEb,OAAO;IAiBP;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,YAAmB,iBAAiB,wBA+F/C;IAEF;;;;;;;OAOG;IACH,YAAY,YAAa,yBAAyB,KAAG,MAAM,CAqCzD;IAEF;;;;OAIG;IACH,SAAS,eAAgB,SAAS,EAAE,eAKlC;IAEF;;;;OAIG;IACH,cAAc,yBACY,MAAM,KAC7B,QAAQ,UAAU,CAAC,CAqCpB;CACL"}
+{"version":3,"file":"Framework.d.ts","sourceRoot":"","sources":["../../src/Framework.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,uBAAuB,MAAM,2BAA2B,CAAC;AAChE,OAAO,UAAU,MAAM,cAAc,CAAC;AACtC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,8BAA8B,MAAM,kCAAkC,CAAC;AAC9E,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B,OAAO,UAAU,EAAE,EACf,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EACpB,MAAM,cAAc,CAAC;AAStB,OAAO,EACH,OAAO,EACP,UAAU,EAEV,yBAAyB,EAC5B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGnC,aAAK,iBAAiB,GAChB,MAAM,CAAC,SAAS,CAAC,QAAQ,GACzB,CAAC,OAAO,MAAM,GAAG,oBAAoB,CAAC,GACtC,IAAI,CAAC;AAIX,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,EAAE,iBAAiB,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B,EAAE,MAAM,CAAC;IACtC,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;IACpC,MAAM,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,QAAQ,CAAC,gBAAgB,EAAE,iBAAiB,CAAC;IAC7C,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,SAAS,EAAE,UAAU,CAAC;IAEtB,KAAK,EAAE,uBAAuB,CAAC;IAC/B,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,8BAA8B,CAAC;IACtC,KAAK,EAAE,KAAK,CAAC;IAEb,OAAO;IAiCP;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,YAAmB,iBAAiB,wBAwG/C;IAEF;;;;;;;OAOG;IACH,YAAY,YAAa,yBAAyB,KAAG,MAAM,CAqCzD;IAEF;;;;OAIG;IACH,SAAS,eAAgB,SAAS,EAAE,eAKlC;IAEF;;;;OAIG;IACH,yBAAyB,yBACC,MAAM,KAC7B,QAAQ,qBAAqB,CAAC,CAa/B;IAEF;;;;OAIG;IACH,kBAAkB,yBACQ,MAAM,KAC7B,QAAQ,cAAc,CAAC,CAaxB;IAEF;;;;OAIG;IACH,qBAAqB,yBACK,MAAM,KAC7B,QAAQ,iBAAiB,CAAC,CAY3B;IAEF;;;;OAIG;IACH,cAAc,yBACY,MAAM,KAC7B,QAAQ,UAAU,CAAC,CAMpB;IAEF;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CAiCzB;CACL"}

package/dist/main/Framework.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ethers_1 = require("ethers");
 const BatchCall_1 = __importDefault(require("./BatchCall"));
 const ConstantFlowAgreementV1_1 = __importDefault(require("./ConstantFlowAgreementV1"));
+const Governance_1 = __importDefault(require("./Governance"));
 const Host_1 = __importDefault(require("./Host"));
 const InstantDistributionAgreementV1_1 = __importDefault(require("./InstantDistributionAgreementV1"));
 const Query_1 = __importDefault(require("./Query"));
@@ -18,13 +19,13 @@ const constants_1 = require("./constants");
 const frameworkHelpers_1 = require("./frameworkHelpers");
 const utils_1 = require("./utils");
 /**
- * @dev Superfluid Framework Class
+ * Superfluid Framework Class
  * @description The entrypoint for the SDK-core, `create` an instance of this for full functionality.
  */
 class Framework {
     constructor(options, settings) {
         /**
-         * @dev Create a signer which can be used to sign transactions.
+         * Create a signer which can be used to sign transactions.
          * @param options.web3Provider a Web3Provider object (e.g. client side - metamask, web3modal)
          * @param options.provider an ethers Provider object (e.g. via Hardhat ethers)
          * @param options.privateKey a test account private key
@@ -65,7 +66,7 @@ class Framework {
             });
         };
         /**
-         * @dev Create a `BatchCall` class from the `Framework`.
+         * Create a `BatchCall` class from the `Framework`.
          * @param operations the list of operations to execute
          * @returns `BatchCall` class
          */
@@ -76,15 +77,78 @@ class Framework {
             });
         };
         /**
-         * @dev Load a `SuperToken` class from the `Framework`.
+         * Loads `NativeAssetSuperToken` class from the `Framework`. Will throw if token is not NativeAssetSuperToken.
+         * @param tokenAddressOrSymbol
+         * @returns `NativeAssetSuperToken` class
+         */
+        this.loadNativeAssetSuperToken = async (tokenAddressOrSymbol) => {
+            const superToken = await this.loadSuperToken(tokenAddressOrSymbol);
+            // The NativeAssetSuperToken class should have the nativeTokenSymbol property
+            const isNativeAssetSuperToken = !!superToken.nativeTokenSymbol;
+            if (!isNativeAssetSuperToken) {
+                throw new SFError_1.SFError({
+                    type: "SUPERTOKEN_INITIALIZATION",
+                    customMessage: "The token is not a native asset supertoken.",
+                });
+            }
+            return superToken;
+        };
+        /**
+         * Loads `PureSuperToken` class from the `Framework`. Will throw if token is not PureSuperToken.
+         * @param tokenAddressOrSymbol
+         * @returns `PureSuperToken` class
+         */
+        this.loadPureSuperToken = async (tokenAddressOrSymbol) => {
+            const superToken = await this.loadSuperToken(tokenAddressOrSymbol);
+            // The PureSuperToken class should not have the downgrade (and upgrade) function
+            // we can just check if downgrade doesn't exist
+            const isPureSuperToken = !!superToken.downgrade === false;
+            if (!isPureSuperToken) {
+                throw new SFError_1.SFError({
+                    type: "SUPERTOKEN_INITIALIZATION",
+                    customMessage: "The token is not a pure supertoken.",
+                });
+            }
+            return superToken;
+        };
+        /**
+         * Loads `WrapperSuperToken` class from the `Framework`. Will throw if token is not WrapperSuperToken.
+         * @param tokenAddressOrSymbol
+         * @returns `WrapperSuperToken` class
+         */
+        this.loadWrapperSuperToken = async (tokenAddressOrSymbol) => {
+            const superToken = await this.loadSuperToken(tokenAddressOrSymbol);
+            // The WrapperSuperToken class should have the underlyingToken property
+            const isWrapperSuperToken = !!superToken.underlyingToken;
+            if (!isWrapperSuperToken) {
+                throw new SFError_1.SFError({
+                    type: "SUPERTOKEN_INITIALIZATION",
+                    customMessage: "The token is not a wrapper supertoken.",
+                });
+            }
+            return superToken;
+        };
+        /**
+         * Loads `SuperToken` class from the `Framework`. Use this when you're unsure of the token type.
          * @param tokenAddressOrSymbol the `SuperToken` address or symbol (if symbol, it must be on the resolver)
          * @returns `SuperToken` class
          */
         this.loadSuperToken = async (tokenAddressOrSymbol) => {
-            let address;
-            const isValidAddress = ethers_1.ethers.utils.isAddress(tokenAddressOrSymbol);
-            if (isValidAddress) {
-                address = tokenAddressOrSymbol;
+            const address = await this._tryGetTokenAddress(tokenAddressOrSymbol);
+            return await SuperToken_1.default.create({
+                ...this.settings,
+                address,
+            });
+        };
+        /**
+         * Try to get the token address given an address (returns if valid) or the token symbol via the resolver.
+         * @param tokenAddressOrSymbol
+         * @returns token address
+         */
+        this._tryGetTokenAddress = async (tokenAddressOrSymbol) => {
+            const isInputValidAddress = ethers_1.ethers.utils.isAddress(tokenAddressOrSymbol);
+            if (isInputValidAddress) {
+                return tokenAddressOrSymbol;
             }
             else {
                 try {
@@ -93,8 +157,7 @@ class Framework {
                         "." +
                         tokenAddressOrSymbol;
                     const resolver = new ethers_1.ethers.Contract(this.settings.config.resolverAddress, IResolver_json_1.default.abi, this.settings.provider);
-                    const tokenAddress = await resolver.get(superTokenKey);
-                    address = tokenAddress;
+                    return await resolver.get(superTokenKey);
                 }
                 catch (err) {
                     throw new SFError_1.SFError({
@@ -106,27 +169,32 @@ class Framework {
                     });
                 }
             }
-            return await SuperToken_1.default.create({
-                ...this.settings,
-                address,
-            });
         };
         this.userInputOptions = options;
         this.settings = settings;
         this.cfaV1 = new ConstantFlowAgreementV1_1.default({
             config: this.settings.config,
         });
+        this.governance = new Governance_1.default(this.settings.config.governanceAddress, this.settings.config.hostAddress);
         this.host = new Host_1.default(this.settings.config.hostAddress);
         this.idaV1 = new InstantDistributionAgreementV1_1.default({
             config: this.settings.config,
         });
         this.query = new Query_1.default(this.settings);
+        const resolver = new ethers_1.ethers.Contract(this.settings.config.resolverAddress, IResolver_json_1.default.abi);
+        this.contracts = {
+            cfaV1: this.cfaV1.contract,
+            governance: this.governance.contract,
+            host: this.host.contract,
+            idaV1: this.idaV1.contract,
+            resolver,
+        };
     }
 }
 exports.default = Framework;
 _a = Framework;
 /**
- * @dev Creates the Framework object based on user provided `options`.
+ * Creates the Framework object based on user provided `options`.
  * @param options.chainId the chainId of your desired network (e.g. 137 = matic)
  * @param options.customSubgraphQueriesEndpoint your custom subgraph endpoint
  * @param options.dataMode the data mode you'd like the framework to use (SUBGRAPH_ONLY, SUBGRAPH_WEB3, WEB3_ONLY)
@@ -173,6 +241,7 @@ Framework.create = async (options) => {
             subgraphAPIEndpoint: "",
             resolverAddress: "",
             networkName: "",
+            nativeTokenSymbol: "",
         };
         const resolverAddress = options.resolverAddress
             ? options.resolverAddress
@@ -181,6 +250,9 @@ Framework.create = async (options) => {
         const superfluidLoaderAddress = await resolver.get("SuperfluidLoader-v1");
         const superfluidLoader = new ethers_1.ethers.Contract(superfluidLoaderAddress, SuperfluidLoader_json_1.default.abi, provider);
         const framework = await superfluidLoader.loadFramework(releaseVersion);
+        const governanceAddress = await new Host_1.default(framework.superfluid).contract
+            .connect(provider)
+            .getGovernance();
         const settings = {
             chainId,
             customSubgraphQueriesEndpoint,
@@ -193,6 +265,7 @@ Framework.create = async (options) => {
                 hostAddress: framework.superfluid,
                 cfaV1Address: framework.agreementCFAv1,
                 idaV1Address: framework.agreementIDAv1,
+                governanceAddress,
             },
         };
         return new Framework(options, settings);

package/dist/main/Framework.js.map

@@ -1 +1 @@
-{"version":3,"file":"Framework.js","sourceRoot":"","sources":["../../src/Framework.ts"],"names":[],"mappings":";;;;;;AAEA,mCAAgC;AAGhC,4DAAoC;AACpC,wFAAgE;AAChE,kDAA0B;AAC1B,sGAA8E;AAE9E,oDAA4B;AAC5B,uCAAoC;AACpC,8DAAsC;AACtC,0EAAgD;AAChD,wFAA8D;AAC9D,2CAAgF;AAChF,yDAI4B;AAI5B,mCAA2D;AA6B3D;;;GAGG;AACH,MAAqB,SAAS;IAS1B,YACI,OAA0B,EAC1B,QAA4B;QA2HhC;;;;;;;WAOG;QACH,iBAAY,GAAG,CAAC,OAAkC,EAAU,EAAE;YAC1D,IACI,CAAC,OAAO,CAAC,UAAU;gBACnB,CAAC,OAAO,CAAC,QAAQ;gBACjB,CAAC,OAAO,CAAC,MAAM;gBACf,CAAC,OAAO,CAAC,YAAY,EACvB;gBACE,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,eAAe;oBACrB,aAAa,EACT,qDAAqD;iBAC5D,CAAC,CAAC;aACN;YAED,2BAA2B;YAC3B,IAAI,OAAO,CAAC,UAAU,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;oBACnB,MAAM,IAAI,iBAAO,CAAC;wBACd,IAAI,EAAE,eAAe;wBACrB,aAAa,EACT,oDAAoD;qBAC3D,CAAC,CAAC;iBACN;gBACD,OAAO,IAAI,eAAM,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;aAClE;iBAAM,IAAI,OAAO,CAAC,MAAM,EAAE;gBACvB,OAAO,OAAO,CAAC,MAAM,CAAC;aACzB;YACD,oCAAoC;iBAC/B,IAAI,OAAO,CAAC,YAAY,EAAE;gBAC3B,OAAO,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;aAC3C;YAED,0BAA0B;YAC1B,MAAM,IAAI,iBAAO,CAAC;gBACd,IAAI,EAAE,eAAe;gBACrB,aAAa,EAAE,gDAAgD;aAClE,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;WAIG;QACH,cAAS,GAAG,CAAC,UAAuB,EAAE,EAAE;YACpC,OAAO,IAAI,mBAAS,CAAC;gBACjB,UAAU;gBACV,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW;aAChD,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;WAIG;QACH,mBAAc,GAAG,KAAK,EAClB,oBAA4B,EACT,EAAE;YACrB,IAAI,OAAO,CAAC;YACZ,MAAM,cAAc,GAAG,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;YAEpE,IAAI,cAAc,EAAE;gBAChB,OAAO,GAAG,oBAAoB,CAAC;aAClC;iBAAM;gBACH,IAAI;oBACA,MAAM,aAAa,GACf,cAAc;wBACd,IAAI,CAAC,QAAQ,CAAC,sBAAsB;wBACpC,GAAG;wBACH,oBAAoB,CAAC;oBAEzB,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,QAAQ,CAChC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,EACpC,wBAAY,CAAC,GAAG,EAChB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CACZ,CAAC;oBACf,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;oBACvD,OAAO,GAAG,YAAY,CAAC;iBAC1B;gBAAC,OAAO,GAAG,EAAE;oBACV,MAAM,IAAI,iBAAO,CAAC;wBACd,IAAI,EAAE,2BAA2B;wBACjC,aAAa,EACT,8DAA8D;4BAC9D,oBAAoB;4BACpB,qBAAqB;wBACzB,WAAW,EAAE,GAAG;qBACnB,CAAC,CAAC;iBACN;aACJ;YAED,OAAO,MAAM,oBAAU,CAAC,MAAM,CAAC;gBAC3B,GAAG,IAAI,CAAC,QAAQ;gBAChB,OAAO;aACV,CAAC,CAAC;QACP,CAAC,CAAC;QAhOE,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAuB,CAAC;YACrC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,wCAA8B,CAAC;YAC5C,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;;AAxBL,4BA8OC;;AApNG;;;;;;;;;;GAUG;AACI,gBAAM,GAAG,KAAK,EAAE,OAA0B,EAAE,EAAE;IACjD,IAAA,sDAAmC,EAAC;QAChC,GAAG,OAAO;QACV,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,eAAe;QAC7C,sBAAsB,EAAE,OAAO,CAAC,sBAAsB,IAAI,IAAI;KACjE,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,IAAA,iCAAc,EAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,OAAO,GACT,OAAO,CAAC,OAAO,IAAI,mCAAuB,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;IACjE,MAAM,cAAc,GAAG,OAAO,CAAC,sBAAsB,IAAI,IAAI,CAAC;IAE9D,gDAAgD;IAChD,MAAM,6BAA6B,GAC/B,OAAO,CAAC,QAAQ,KAAK,WAAW;QAC5B,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,OAAO,CAAC,6BAA6B;YACrC,IAAA,6CAA0B,EAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,QAAQ,GAAG,IAAA,wBAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC;QAC/C,CAAC,CAAC,OAAO,CAAC,QAAQ;QAClB,CAAC,CAAC,IAAA,sBAAc,EAAC,OAAO,CAAC,QAAQ,CAAC;YAClC,CAAC,CAAC,kDAAkD;gBAClD,6CAA6C;gBAC7C,mBAAmB;gBACnB,IAAI,eAAM,CAAC,SAAS,CAAC,YAAY,CAC7B,OAAO,CAAC,QAAQ,CAAC,eAEsB,CAC1C;YACH,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAEhC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;IAC5C,IAAI,OAAO,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,IAAI,IAAI,EAAE;QAChD,MAAM,IAAI,iBAAO,CAAC;YACd,IAAI,EAAE,kBAAkB;YACxB,aAAa,EACT,oCAAoC;gBACpC,OAAO,CAAC,OAAO;gBACf,oCAAoC;gBACpC,OAAO;SACd,CAAC,CAAC;KACN;IAED,IAAI;QACA,MAAM,YAAY,GAAG,oCAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI;YAC1D,mBAAmB,EAAE,EAAE;YACvB,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,EAAE;SAClB,CAAC;QACF,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe;YAC3C,CAAC,CAAC,OAAO,CAAC,eAAe;YACzB,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC;QACnC,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,QAAQ,CAChC,eAAe,EACf,wBAAY,CAAC,GAAG,EAChB,QAAQ,CACE,CAAC;QAEf,MAAM,uBAAuB,GAAG,MAAM,QAAQ,CAAC,GAAG,CAC9C,qBAAqB,CACxB,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,eAAM,CAAC,QAAQ,CACxC,uBAAuB,EACvB,+BAAmB,CAAC,GAAG,EACvB,QAAQ,CACS,CAAC;QAEtB,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,aAAa,CAClD,cAAc,CACjB,CAAC;QAEF,MAAM,QAAQ,GAAuB;YACjC,OAAO;YACP,6BAA6B;YAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,eAAe;YAC7C,sBAAsB,EAAE,OAAO,CAAC,sBAAsB,IAAI,IAAI;YAC9D,QAAQ;YACR,WAAW;YACX,MAAM,EAAE;gBACJ,eAAe;gBACf,WAAW,EAAE,SAAS,CAAC,UAAU;gBACjC,YAAY,EAAE,SAAS,CAAC,cAAc;gBACtC,YAAY,EAAE,SAAS,CAAC,cAAc;aACzC;SACJ,CAAC;QAEF,OAAO,IAAI,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;KAC3C;IAAC,OAAO,GAAG,EAAE;QACV,MAAM,IAAI,iBAAO,CAAC;YACd,IAAI,EAAE,0BAA0B;YAChC,aAAa,EAAE,+CAA+C;YAC9D,WAAW,EAAE,GAAG;SACnB,CAAC,CAAC;KACN;AACL,CAAE,CAAA"}
+{"version":3,"file":"Framework.js","sourceRoot":"","sources":["../../src/Framework.ts"],"names":[],"mappings":";;;;;;AAEA,mCAAgC;AAGhC,4DAAoC;AACpC,wFAAgE;AAChE,8DAAsC;AACtC,kDAA0B;AAC1B,sGAA8E;AAE9E,oDAA4B;AAC5B,uCAAoC;AACpC,8DAIsB;AACtB,0EAAgD;AAChD,wFAA8D;AAC9D,2CAAgF;AAChF,yDAI4B;AAS5B,mCAA2D;AA6B3D;;;GAGG;AACH,MAAqB,SAAS;IAW1B,YACI,OAA0B,EAC1B,QAA4B;QAoJhC;;;;;;;WAOG;QACH,iBAAY,GAAG,CAAC,OAAkC,EAAU,EAAE;YAC1D,IACI,CAAC,OAAO,CAAC,UAAU;gBACnB,CAAC,OAAO,CAAC,QAAQ;gBACjB,CAAC,OAAO,CAAC,MAAM;gBACf,CAAC,OAAO,CAAC,YAAY,EACvB;gBACE,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,eAAe;oBACrB,aAAa,EACT,qDAAqD;iBAC5D,CAAC,CAAC;aACN;YAED,2BAA2B;YAC3B,IAAI,OAAO,CAAC,UAAU,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;oBACnB,MAAM,IAAI,iBAAO,CAAC;wBACd,IAAI,EAAE,eAAe;wBACrB,aAAa,EACT,oDAAoD;qBAC3D,CAAC,CAAC;iBACN;gBACD,OAAO,IAAI,eAAM,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;aAClE;iBAAM,IAAI,OAAO,CAAC,MAAM,EAAE;gBACvB,OAAO,OAAO,CAAC,MAAM,CAAC;aACzB;YACD,oCAAoC;iBAC/B,IAAI,OAAO,CAAC,YAAY,EAAE;gBAC3B,OAAO,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;aAC3C;YAED,0BAA0B;YAC1B,MAAM,IAAI,iBAAO,CAAC;gBACd,IAAI,EAAE,eAAe;gBACrB,aAAa,EAAE,gDAAgD;aAClE,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;WAIG;QACH,cAAS,GAAG,CAAC,UAAuB,EAAE,EAAE;YACpC,OAAO,IAAI,mBAAS,CAAC;gBACjB,UAAU;gBACV,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW;aAChD,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;WAIG;QACH,8BAAyB,GAAG,KAAK,EAC7B,oBAA4B,EACE,EAAE;YAChC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;YAEnE,6EAA6E;YAC7E,MAAM,uBAAuB,GAAG,CAAC,CAAE,UAAkB,CAAC,iBAAiB,CAAC;YAExE,IAAI,CAAC,uBAAuB,EAAE;gBAC1B,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,2BAA2B;oBACjC,aAAa,EAAE,6CAA6C;iBAC/D,CAAC,CAAC;aACN;YACD,OAAO,UAAmC,CAAC;QAC/C,CAAC,CAAC;QAEF;;;;WAIG;QACH,uBAAkB,GAAG,KAAK,EACtB,oBAA4B,EACL,EAAE;YACzB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;YAEnE,gFAAgF;YAChF,+CAA+C;YAC/C,MAAM,gBAAgB,GAAG,CAAC,CAAE,UAAkB,CAAC,SAAS,KAAK,KAAK,CAAC;YACnE,IAAI,CAAC,gBAAgB,EAAE;gBACnB,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,2BAA2B;oBACjC,aAAa,EAAE,qCAAqC;iBACvD,CAAC,CAAC;aACN;YACD,OAAO,UAA4B,CAAC;QACxC,CAAC,CAAC;QAEF;;;;WAIG;QACH,0BAAqB,GAAG,KAAK,EACzB,oBAA4B,EACF,EAAE;YAC5B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;YAEnE,uEAAuE;YACvE,MAAM,mBAAmB,GAAG,CAAC,CAAE,UAAkB,CAAC,eAAe,CAAC;YAClE,IAAI,CAAC,mBAAmB,EAAE;gBACtB,MAAM,IAAI,iBAAO,CAAC;oBACd,IAAI,EAAE,2BAA2B;oBACjC,aAAa,EAAE,wCAAwC;iBAC1D,CAAC,CAAC;aACN;YACD,OAAO,UAA+B,CAAC;QAC3C,CAAC,CAAC;QAEF;;;;WAIG;QACH,mBAAc,GAAG,KAAK,EAClB,oBAA4B,EACT,EAAE;YACrB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;YACrE,OAAO,MAAM,oBAAU,CAAC,MAAM,CAAC;gBAC3B,GAAG,IAAI,CAAC,QAAQ;gBAChB,OAAO;aACV,CAAC,CAAC;QACP,CAAC,CAAC;QAEF;;;;WAIG;QACK,wBAAmB,GAAG,KAAK,EAC/B,oBAA4B,EACb,EAAE;YACjB,MAAM,mBAAmB,GACrB,eAAM,CAAC,KAAK,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;YAEjD,IAAI,mBAAmB,EAAE;gBACrB,OAAO,oBAAoB,CAAC;aAC/B;iBAAM;gBACH,IAAI;oBACA,MAAM,aAAa,GACf,cAAc;wBACd,IAAI,CAAC,QAAQ,CAAC,sBAAsB;wBACpC,GAAG;wBACH,oBAAoB,CAAC;oBAEzB,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,QAAQ,CAChC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,EACpC,wBAAY,CAAC,GAAG,EAChB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CACZ,CAAC;oBACf,OAAO,MAAM,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;iBAC5C;gBAAC,OAAO,GAAG,EAAE;oBACV,MAAM,IAAI,iBAAO,CAAC;wBACd,IAAI,EAAE,2BAA2B;wBACjC,aAAa,EACT,8DAA8D;4BAC9D,oBAAoB;4BACpB,qBAAqB;wBACzB,WAAW,EAAE,GAAG;qBACnB,CAAC,CAAC;iBACN;aACJ;QACL,CAAC,CAAC;QAnUE,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAuB,CAAC;YACrC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAU,CAC5B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,iBAAiB,EACtC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CACnC,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,wCAA8B,CAAC;YAC5C,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;SAC/B,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,QAAQ,CAChC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,EACpC,wBAAY,CAAC,GAAG,CACN,CAAC;QAEf,IAAI,CAAC,SAAS,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;YAC1B,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ;YACpC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ;YACxB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ;YAC1B,QAAQ;SACX,CAAC;IACN,CAAC;;AA1CL,4BAmVC;;AAvSG;;;;;;;;;;GAUG;AACI,gBAAM,GAAG,KAAK,EAAE,OAA0B,EAAE,EAAE;IACjD,IAAA,sDAAmC,EAAC;QAChC,GAAG,OAAO;QACV,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,eAAe;QAC7C,sBAAsB,EAAE,OAAO,CAAC,sBAAsB,IAAI,IAAI;KACjE,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,IAAA,iCAAc,EAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,OAAO,GACT,OAAO,CAAC,OAAO,IAAI,mCAAuB,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;IACjE,MAAM,cAAc,GAAG,OAAO,CAAC,sBAAsB,IAAI,IAAI,CAAC;IAE9D,gDAAgD;IAChD,MAAM,6BAA6B,GAC/B,OAAO,CAAC,QAAQ,KAAK,WAAW;QAC5B,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,OAAO,CAAC,6BAA6B;YACrC,IAAA,6CAA0B,EAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,QAAQ,GAAG,IAAA,wBAAgB,EAAC,OAAO,CAAC,QAAQ,CAAC;QAC/C,CAAC,CAAC,OAAO,CAAC,QAAQ;QAClB,CAAC,CAAC,IAAA,sBAAc,EAAC,OAAO,CAAC,QAAQ,CAAC;YAClC,CAAC,CAAC,kDAAkD;gBAClD,6CAA6C;gBAC7C,mBAAmB;gBACnB,IAAI,eAAM,CAAC,SAAS,CAAC,YAAY,CAC7B,OAAO,CAAC,QAAQ,CAAC,eAEsB,CAC1C;YACH,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAEhC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,CAAC;IAC5C,IAAI,OAAO,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,IAAI,IAAI,EAAE;QAChD,MAAM,IAAI,iBAAO,CAAC;YACd,IAAI,EAAE,kBAAkB;YACxB,aAAa,EACT,oCAAoC;gBACpC,OAAO,CAAC,OAAO;gBACf,oCAAoC;gBACpC,OAAO;SACd,CAAC,CAAC;KACN;IAED,IAAI;QACA,MAAM,YAAY,GAAkB,oCAAwB,CAAC,GAAG,CAC5D,OAAO,CACV,IAAI;YACD,mBAAmB,EAAE,EAAE;YACvB,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,EAAE;YACf,iBAAiB,EAAE,EAAE;SACxB,CAAC;QACF,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe;YAC3C,CAAC,CAAC,OAAO,CAAC,eAAe;YACzB,CAAC,CAAC,YAAY,CAAC,eAAe,CAAC;QACnC,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,QAAQ,CAChC,eAAe,EACf,wBAAY,CAAC,GAAG,EAChB,QAAQ,CACE,CAAC;QAEf,MAAM,uBAAuB,GAAG,MAAM,QAAQ,CAAC,GAAG,CAC9C,qBAAqB,CACxB,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,eAAM,CAAC,QAAQ,CACxC,uBAAuB,EACvB,+BAAmB,CAAC,GAAG,EACvB,QAAQ,CACS,CAAC;QAEtB,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,aAAa,CAClD,cAAc,CACjB,CAAC;QACF,MAAM,iBAAiB,GAAG,MAAM,IAAI,cAAI,CACpC,SAAS,CAAC,UAAU,CACvB,CAAC,QAAQ;aACL,OAAO,CAAC,QAAQ,CAAC;aACjB,aAAa,EAAE,CAAC;QAErB,MAAM,QAAQ,GAAuB;YACjC,OAAO;YACP,6BAA6B;YAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,eAAe;YAC7C,sBAAsB,EAAE,OAAO,CAAC,sBAAsB,IAAI,IAAI;YAC9D,QAAQ;YACR,WAAW;YACX,MAAM,EAAE;gBACJ,eAAe;gBACf,WAAW,EAAE,SAAS,CAAC,UAAU;gBACjC,YAAY,EAAE,SAAS,CAAC,cAAc;gBACtC,YAAY,EAAE,SAAS,CAAC,cAAc;gBACtC,iBAAiB;aACpB;SACJ,CAAC;QAEF,OAAO,IAAI,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;KAC3C;IAAC,OAAO,GAAG,EAAE;QACV,MAAM,IAAI,iBAAO,CAAC;YACd,IAAI,EAAE,0BAA0B;YAChC,aAAa,EAAE,+CAA+C;YAC9D,WAAW,EAAE,GAAG;SACnB,CAAC,CAAC;KACN;AACL,CAAE,CAAA"}

package/dist/main/Governance.d.ts

@@ -0,0 +1,40 @@
+import { IGetGovernanceParametersParams, IWeb3GovernanceParams } from "./interfaces";
+import { SuperfluidGovernanceII } from "./typechain/SuperfluidGovernanceII";
+export default class Governance {
+    contract: SuperfluidGovernanceII;
+    hostAddress: string;
+    constructor(govAddress: string, hostAddress: string);
+    /**
+     * Returns the 3Ps config for the specified token (or default) - the liquidation period and patrician period
+     * @see https://docs.superfluid.finance/superfluid/sentinels/liquidations-and-toga
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @param token specified governance parameter token
+     * @returns {Object} liquidationPeriod and patricianPeriod as strings
+     */
+    getPPPConfig: ({ providerOrSigner, token, }: IGetGovernanceParametersParams) => Promise<{
+        liquidationPeriod: string;
+        patricianPeriod: string;
+    }>;
+    /**
+     * Returns the reward address for the specified token (or default)
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @param token specified governance parameter token
+     * @returns {string} the reward address
+     */
+    getRewardAddress: ({ providerOrSigner, token, }: IGetGovernanceParametersParams) => Promise<string>;
+    /**
+     * Returns the minimum deposit for the specified token (or default)
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @param token specified governance parameter token
+     * @returns {string} minimum deposit
+     */
+    getMinimumDeposit: ({ providerOrSigner, token, }: IGetGovernanceParametersParams) => Promise<string>;
+    /**
+     * Returns the relevant governance parameters
+     * @param providerOrSigner a provider or signer for executing a web3 call
+     * @param token specified governance parameter token
+     * @returns {Object} liquidationPeriod, patricianPeriod, rewardAddress and minimumDeposit
+     */
+    getGovernanceParameters: ({ providerOrSigner, token, }: IGetGovernanceParametersParams) => Promise<IWeb3GovernanceParams>;
+}
+//# sourceMappingURL=Governance.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Governance.d.ts","sourceRoot":"","sources":["../../src/Governance.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,8BAA8B,EAC9B,qBAAqB,EACxB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,MAAM,CAAC,OAAO,OAAO,UAAU;IAC3B,QAAQ,EAAE,sBAAsB,CAAC;IACjC,WAAW,EAAE,MAAM,CAAC;gBAER,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAQnD;;;;;;OAMG;IACH,YAAY,iCAGT,8BAA8B;;;OAQ/B;IAEF;;;;;OAKG;IACH,gBAAgB,iCAGb,8BAA8B,qBAI/B;IAEF;;;;;OAKG;IACH,iBAAiB,iCAGd,8BAA8B,qBAK/B;IAEF;;;;;OAKG;IACH,uBAAuB,iCAGpB,8BAA8B,KAAG,QAAQ,qBAAqB,CAAC,CAqBhE;CACL"}

package/dist/main/Governance.js

@@ -0,0 +1,82 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ethers_1 = require("ethers");
+const SuperfluidGovernanceII_json_1 = __importDefault(require("./abi/SuperfluidGovernanceII.json"));
+class Governance {
+    constructor(govAddress, hostAddress) {
+        /**
+         * Returns the 3Ps config for the specified token (or default) - the liquidation period and patrician period
+         * @see https://docs.superfluid.finance/superfluid/sentinels/liquidations-and-toga
+         * @param providerOrSigner a provider or signer for executing a web3 call
+         * @param token specified governance parameter token
+         * @returns {Object} liquidationPeriod and patricianPeriod as strings
+         */
+        this.getPPPConfig = async ({ providerOrSigner, token = ethers_1.ethers.constants.AddressZero, }) => {
+            const { liquidationPeriod, patricianPeriod } = await this.contract
+                .connect(providerOrSigner)
+                .getPPPConfig(this.hostAddress, token);
+            return {
+                liquidationPeriod: liquidationPeriod.toString(),
+                patricianPeriod: patricianPeriod.toString(),
+            };
+        };
+        /**
+         * Returns the reward address for the specified token (or default)
+         * @param providerOrSigner a provider or signer for executing a web3 call
+         * @param token specified governance parameter token
+         * @returns {string} the reward address
+         */
+        this.getRewardAddress = async ({ providerOrSigner, token = ethers_1.ethers.constants.AddressZero, }) => {
+            return await this.contract
+                .connect(providerOrSigner)
+                .getRewardAddress(this.hostAddress, token);
+        };
+        /**
+         * Returns the minimum deposit for the specified token (or default)
+         * @param providerOrSigner a provider or signer for executing a web3 call
+         * @param token specified governance parameter token
+         * @returns {string} minimum deposit
+         */
+        this.getMinimumDeposit = async ({ providerOrSigner, token = ethers_1.ethers.constants.AddressZero, }) => {
+            const superTokenMinimumDeposit = await this.contract
+                .connect(providerOrSigner)
+                .getSuperTokenMinimumDeposit(this.hostAddress, token);
+            return superTokenMinimumDeposit.toString();
+        };
+        /**
+         * Returns the relevant governance parameters
+         * @param providerOrSigner a provider or signer for executing a web3 call
+         * @param token specified governance parameter token
+         * @returns {Object} liquidationPeriod, patricianPeriod, rewardAddress and minimumDeposit
+         */
+        this.getGovernanceParameters = async ({ providerOrSigner, token = ethers_1.ethers.constants.AddressZero, }) => {
+            const pppPromise = this.getPPPConfig({ providerOrSigner, token });
+            const rewardPromose = this.getRewardAddress({
+                providerOrSigner,
+                token,
+            });
+            const minimumDepositPromise = this.getMinimumDeposit({
+                providerOrSigner,
+                token,
+            });
+            const data = await Promise.all([
+                pppPromise,
+                rewardPromose,
+                minimumDepositPromise,
+            ]);
+            return {
+                liquidationPeriod: data[0].liquidationPeriod,
+                patricianPeriod: data[0].patricianPeriod,
+                rewardAddress: data[1],
+                minimumDeposit: data[2],
+            };
+        };
+        this.contract = new ethers_1.ethers.Contract(govAddress, SuperfluidGovernanceII_json_1.default.abi);
+        this.hostAddress = hostAddress;
+    }
+}
+exports.default = Governance;
+//# sourceMappingURL=Governance.js.map

package/dist/main/Governance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Governance.js","sourceRoot":"","sources":["../../src/Governance.ts"],"names":[],"mappings":";;;;;AAAA,mCAAgC;AAEhC,oGAA0E;AAO1E,MAAqB,UAAU;IAI3B,YAAY,UAAkB,EAAE,WAAmB;QAQnD;;;;;;WAMG;QACH,iBAAY,GAAG,KAAK,EAAE,EAClB,gBAAgB,EAChB,KAAK,GAAG,eAAM,CAAC,SAAS,CAAC,WAAW,GACP,EAAE,EAAE;YACjC,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,QAAQ;iBAC7D,OAAO,CAAC,gBAAgB,CAAC;iBACzB,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YAC3C,OAAO;gBACH,iBAAiB,EAAE,iBAAiB,CAAC,QAAQ,EAAE;gBAC/C,eAAe,EAAE,eAAe,CAAC,QAAQ,EAAE;aAC9C,CAAC;QACN,CAAC,CAAC;QAEF;;;;;WAKG;QACH,qBAAgB,GAAG,KAAK,EAAE,EACtB,gBAAgB,EAChB,KAAK,GAAG,eAAM,CAAC,SAAS,CAAC,WAAW,GACP,EAAE,EAAE;YACjC,OAAO,MAAM,IAAI,CAAC,QAAQ;iBACrB,OAAO,CAAC,gBAAgB,CAAC;iBACzB,gBAAgB,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC,CAAC;QAEF;;;;;WAKG;QACH,sBAAiB,GAAG,KAAK,EAAE,EACvB,gBAAgB,EAChB,KAAK,GAAG,eAAM,CAAC,SAAS,CAAC,WAAW,GACP,EAAE,EAAE;YACjC,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC,QAAQ;iBAC/C,OAAO,CAAC,gBAAgB,CAAC;iBACzB,2BAA2B,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YAC1D,OAAO,wBAAwB,CAAC,QAAQ,EAAE,CAAC;QAC/C,CAAC,CAAC;QAEF;;;;;WAKG;QACH,4BAAuB,GAAG,KAAK,EAAE,EAC7B,gBAAgB,EAChB,KAAK,GAAG,eAAM,CAAC,SAAS,CAAC,WAAW,GACP,EAAkC,EAAE;YACjE,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAC;YAClE,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC;gBACxC,gBAAgB;gBAChB,KAAK;aACR,CAAC,CAAC;YACH,MAAM,qBAAqB,GAAG,IAAI,CAAC,iBAAiB,CAAC;gBACjD,gBAAgB;gBAChB,KAAK;aACR,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBAC3B,UAAU;gBACV,aAAa;gBACb,qBAAqB;aACxB,CAAC,CAAC;YACH,OAAO;gBACH,iBAAiB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,iBAAiB;gBAC5C,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe;gBACxC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;gBACtB,cAAc,EAAE,IAAI,CAAC,CAAC,CAAC;aAC1B,CAAC;QACN,CAAC,CAAC;QAxFE,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAM,CAAC,QAAQ,CAC/B,UAAU,EACV,qCAAyB,CAAC,GAAG,CACN,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACnC,CAAC;CAoFJ;AA9FD,6BA8FC"}

package/dist/main/Host.d.ts

@@ -2,14 +2,14 @@ import { ethers } from "ethers";
 import Operation from "./Operation";
 import { Superfluid } from "./typechain";
 /**
- * @dev Host Helper Class
+ * Host Helper Class
  * @description A helper class which can be used as a standalone class to populate call agreement transactions.
  */
 export default class Host {
-    hostContract: Superfluid;
+    contract: Superfluid;
     constructor(hostAddress: string);
     /**
-     * @dev Creates an Operation of the `callAgreement` function on the host contract.
+     * Creates an Operation of the `callAgreement` function on the host contract.
      * @param agreementAddress the agreement address (cfa or ida address)
      * @param callData the encoded callData for the function
      * @param userData any additional user data

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

@@ -1 +1 @@
-{"version":3,"file":"Host.d.ts","sourceRoot":"","sources":["../../src/Host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAa,MAAM,QAAQ,CAAC;AAE3C,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IACrB,YAAY,EAAE,UAAU,CAAC;gBAEb,WAAW,EAAE,MAAM;IAO/B;;;;;;;OAOG;IACH,0CAA0C,qBACpB,MAAM,YACd,MAAM,YACN,MAAM,GAAG,SAAS;;uBAE7B,SAAS,CAQV;CACL"}
+{"version":3,"file":"Host.d.ts","sourceRoot":"","sources":["../../src/Host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAa,MAAM,QAAQ,CAAC;AAE3C,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IACrB,QAAQ,EAAE,UAAU,CAAC;gBAET,WAAW,EAAE,MAAM;IAO/B;;;;;;;OAOG;IACH,0CAA0C,qBACpB,MAAM,YACd,MAAM,YACN,MAAM,GAAG,SAAS;;uBAE7B,SAAS,CAQV;CACL"}