@across-protocol/sdk 3.0.0

package/dist/esm/lpFeeCalculator/rateModel.js

@@ -0,0 +1,138 @@
+import { ethers } from "ethers";
+import { isDefined } from "../utils";
+var expectedRateModelKeys = ["UBar", "R0", "R1", "R2"];
+var RateModelDictionary = /** @class */ (function () {
+    function RateModelDictionary() {
+        this.rateModelDictionary = {};
+    }
+    RateModelDictionary.prototype._throwIfNotInitialized = function () {
+        if (Object.keys(this.rateModelDictionary).length == 0)
+            throw new Error("RateModelUtility method called before updating rate model dictionary!");
+    };
+    RateModelDictionary.prototype.updateWithEvents = function (rateModelEvents) {
+        this.rateModelDictionary = createRateModelEventDictionary(rateModelEvents);
+    };
+    /**
+     * Return the rate model for L1 token set at the block height.
+     * @param l1Token L1 token address to get rate model for.
+     * @param blockNumber Block height to get rate model for.
+     * @returns Rate model object.
+     */
+    RateModelDictionary.prototype.getRateModelForBlockNumber = function (l1Token, blockNumber) {
+        this._throwIfNotInitialized();
+        var l1TokenNormalized = ethers.utils.getAddress(l1Token);
+        if (!this.rateModelDictionary[l1TokenNormalized] || this.rateModelDictionary[l1TokenNormalized].length === 0)
+            throw new Error("No updated rate model events for L1 token: ".concat(l1TokenNormalized));
+        if (!blockNumber) {
+            // If block number is undefined, use latest updated rate model.
+            return parseAndReturnRateModelFromString(this.rateModelDictionary[l1TokenNormalized].slice(-1)[0].rateModel);
+        }
+        else {
+            var firstEventBlockNumber = this.rateModelDictionary[l1TokenNormalized][0].blockNumber;
+            if (blockNumber < firstEventBlockNumber) {
+                throw new Error("Block number #".concat(blockNumber, " is before first UpdatedRateModel event block ").concat(firstEventBlockNumber));
+            }
+            // We're looking for the latest rate model update that occurred at or before the block number.
+            // Rate model events are inserted into the array from oldest at index 0 to newest at index length-1, so we'll
+            // reverse the array so it goes from newest at index 0 to oldest at index length-1, and then find the first event
+            // who's block number is less than or equal to the target block number.
+            var rateModel = this.rateModelDictionary[l1TokenNormalized]
+                .slice()
+                .reverse() // reverse() modifies memory in place so create a copy first.
+                .find(function (event) { return event.blockNumber <= blockNumber; });
+            if (!rateModel)
+                throw new Error("No updated rate model events before block #".concat(blockNumber, " for L1 token: ").concat(l1TokenNormalized));
+            return parseAndReturnRateModelFromString(rateModel === null || rateModel === void 0 ? void 0 : rateModel.rateModel);
+        }
+    };
+    /**
+     * @notice Return all L1 tokens that had a rate model associated with it at the block number.
+     * @param blockNumber Returns l1 tokens that were mapped to a rate model at this block height. If undefined,
+     * this function will return all L1 tokens that have a block number as of the latest block height.
+     * @returns array of L1 token addresses.
+     */
+    RateModelDictionary.prototype.getL1TokensFromRateModel = function (blockNumber) {
+        var _this = this;
+        if (blockNumber === void 0) { blockNumber = undefined; }
+        this._throwIfNotInitialized();
+        return Object.keys(this.rateModelDictionary)
+            .map(function (l1Token) {
+            var l1TokenNormalized = ethers.utils.getAddress(l1Token);
+            // Check that there is at least one UpdatedRateModel event before the provided block number, otherwise
+            // this L1 token didn't exist in the RateModel at the block height and we shouldn't include it in the returned
+            // array.
+            if (!blockNumber ||
+                _this.rateModelDictionary[l1TokenNormalized].find(function (event) { return event.blockNumber <= blockNumber; }))
+                return ethers.utils.getAddress(l1Token);
+            else
+                return null;
+        })
+            .filter(isDefined);
+    };
+    return RateModelDictionary;
+}());
+export { RateModelDictionary };
+/**
+ * Helper method that returns parsed rate model from string, or throws.
+ * @param rateModelString Stringified rate model to parse.
+ * @returns Rate model object. Must conform to `expectedRateModelKeys` format.
+ */
+export var parseAndReturnRateModelFromString = function (rateModelString) {
+    var rateModelFromEvent = JSON.parse(rateModelString);
+    // Rate model must contain the exact same keys in `expectedRateModelKeys`.
+    for (var _i = 0, expectedRateModelKeys_1 = expectedRateModelKeys; _i < expectedRateModelKeys_1.length; _i++) {
+        var key = expectedRateModelKeys_1[_i];
+        if (!Object.keys(rateModelFromEvent).includes(key)) {
+            throw new Error("Rate model does not contain all expected keys. Expected keys: [".concat(expectedRateModelKeys, "], actual keys: [").concat(Object.keys(rateModelFromEvent), "]"));
+        }
+    }
+    for (var _a = 0, _b = Object.keys(rateModelFromEvent); _a < _b.length; _a++) {
+        var key = _b[_a];
+        if (!expectedRateModelKeys.includes(key)) {
+            throw new Error("Rate model contains unexpected keys. Expected keys: [".concat(expectedRateModelKeys, "], actual keys: [").concat(Object.keys(rateModelFromEvent), "]"));
+        }
+    }
+    return {
+        UBar: rateModelFromEvent.UBar,
+        R0: rateModelFromEvent.R0,
+        R1: rateModelFromEvent.R1,
+        R2: rateModelFromEvent.R2,
+    };
+};
+/**
+ * Given an unsorted array of updated rate model events, return a dictionary mapping token addresses to sorted
+ * rate model events. This method is used internally to enforce chronological sorting of events and mapping rate models
+ * to token addresses.
+ * @param rateModelEvents Unsorted updated rate model events, each of which contains a token address, the stringified
+ * rate model for that token, and the block height of the update.
+ * @returns Dictionary mapping token addresses to chronologically sorted rate model updates.
+ */
+var createRateModelEventDictionary = function (rateModelEvents) {
+    var updatedRateModelEventsForToken = {};
+    // Sort events in-place from oldest to newest:
+    rateModelEvents.sort(function (a, b) {
+        if (a.blockNumber !== b.blockNumber) {
+            return a.blockNumber - b.blockNumber;
+        }
+        if (a.transactionIndex !== b.transactionIndex) {
+            return a.transactionIndex - b.transactionIndex;
+        }
+        return a.logIndex - b.logIndex;
+    });
+    for (var _i = 0, rateModelEvents_1 = rateModelEvents; _i < rateModelEvents_1.length; _i++) {
+        var updatedRateModelEvent = rateModelEvents_1[_i];
+        // The contract enforces that all rate models are mapped to addresses, therefore we do not need to check that
+        // `l1Token` is a valid address.
+        var l1TokenNormalized = ethers.utils.getAddress(updatedRateModelEvent.l1Token);
+        if (!updatedRateModelEventsForToken[l1TokenNormalized])
+            updatedRateModelEventsForToken[l1TokenNormalized] = [];
+        // We assume that events are returned from oldest to newest, so we can simply push events into the array and
+        // and maintain their time order.
+        updatedRateModelEventsForToken[l1TokenNormalized].push({
+            blockNumber: updatedRateModelEvent.blockNumber,
+            rateModel: updatedRateModelEvent.rateModel,
+        });
+    }
+    return updatedRateModelEventsForToken;
+};
+//# sourceMappingURL=rateModel.js.map

package/dist/esm/lpFeeCalculator/rateModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rateModel.js","sourceRoot":"","sources":["../../../src/lpFeeCalculator/rateModel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAwBrC,IAAM,qBAAqB,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAEzD;IAAA;QACS,wBAAmB,GAA8B,EAAE,CAAC;IA4E7D,CAAC;IA1ES,oDAAsB,GAA9B;QACE,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,IAAI,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;IAC7F,CAAC;IAED,8CAAgB,GAAhB,UAAiB,eAAiC;QAChD,IAAI,CAAC,mBAAmB,GAAG,8BAA8B,CAAC,eAAe,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;OAKG;IACH,wDAA0B,GAA1B,UAA2B,OAAe,EAAE,WAAoB;QAC9D,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,IAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE3D,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,MAAM,KAAK,CAAC;YAC1G,MAAM,IAAI,KAAK,CAAC,qDAA8C,iBAAiB,CAAE,CAAC,CAAC;QAErF,IAAI,CAAC,WAAW,EAAE;YAChB,+DAA+D;YAC/D,OAAO,iCAAiC,CAAC,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;SAC9G;aAAM;YACL,IAAM,qBAAqB,GAAG,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;YACzF,IAAI,WAAW,GAAG,qBAAqB,EAAE;gBACvC,MAAM,IAAI,KAAK,CACb,wBAAiB,WAAW,2DAAiD,qBAAqB,CAAE,CACrG,CAAC;aACH;YAED,8FAA8F;YAC9F,6GAA6G;YAC7G,iHAAiH;YACjH,uEAAuE;YACvE,IAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC;iBAC1D,KAAK,EAAE;iBACP,OAAO,EAAE,CAAC,6DAA6D;iBACvE,IAAI,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,WAAW,IAAI,WAAW,EAAhC,CAAgC,CAAC,CAAC;YAErD,IAAI,CAAC,SAAS;gBACZ,MAAM,IAAI,KAAK,CAAC,qDAA8C,WAAW,4BAAkB,iBAAiB,CAAE,CAAC,CAAC;YAClH,OAAO,iCAAiC,CAAC,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,SAAS,CAAC,CAAC;SAChE;IACH,CAAC;IAED;;;;;OAKG;IACH,sDAAwB,GAAxB,UAAyB,WAA2C;QAApE,iBAkBC;QAlBwB,4BAAA,EAAA,uBAA2C;QAClE,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAE9B,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC;aACzC,GAAG,CAAC,UAAC,OAAO;YACX,IAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAE3D,sGAAsG;YACtG,8GAA8G;YAC9G,SAAS;YACT,IACE,CAAC,WAAW;gBACZ,KAAI,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,UAAC,KAAK,IAAK,OAAA,KAAK,CAAC,WAAW,IAAI,WAAW,EAAhC,CAAgC,CAAC;gBAE7F,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;;gBACrC,OAAO,IAAI,CAAC;QACnB,CAAC,CAAC;aACD,MAAM,CAAC,SAAS,CAAC,CAAC;IACvB,CAAC;IACH,0BAAC;AAAD,CAAC,AA7ED,IA6EC;;AAED;;;;GAIG;AACH,MAAM,CAAC,IAAM,iCAAiC,GAAG,UAAC,eAAuB;IACvE,IAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAEvD,0EAA0E;IAC1E,KAAkB,UAAqB,EAArB,+CAAqB,EAArB,mCAAqB,EAArB,IAAqB,EAAE;QAApC,IAAM,GAAG,8BAAA;QACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAClD,MAAM,IAAI,KAAK,CACb,yEAAkE,qBAAqB,8BAAoB,MAAM,CAAC,IAAI,CACpH,kBAAkB,CACnB,MAAG,CACL,CAAC;SACH;KACF;IAED,KAAkB,UAA+B,EAA/B,KAAA,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAA/B,cAA+B,EAA/B,IAA+B,EAAE;QAA9C,IAAM,GAAG,SAAA;QACZ,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACxC,MAAM,IAAI,KAAK,CACb,+DAAwD,qBAAqB,8BAAoB,MAAM,CAAC,IAAI,CAC1G,kBAAkB,CACnB,MAAG,CACL,CAAC;SACH;KACF;IAED,OAAO;QACL,IAAI,EAAE,kBAAkB,CAAC,IAAI;QAC7B,EAAE,EAAE,kBAAkB,CAAC,EAAE;QACzB,EAAE,EAAE,kBAAkB,CAAC,EAAE;QACzB,EAAE,EAAE,kBAAkB,CAAC,EAAE;KAC1B,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,IAAM,8BAA8B,GAAG,UAAC,eAAiC;IACvE,IAAM,8BAA8B,GAA8B,EAAE,CAAC;IAErE,8CAA8C;IAC9C,eAAe,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW,EAAE;YACnC,OAAO,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;SACtC;QAED,IAAI,CAAC,CAAC,gBAAgB,KAAK,CAAC,CAAC,gBAAgB,EAAE;YAC7C,OAAO,CAAC,CAAC,gBAAgB,GAAG,CAAC,CAAC,gBAAgB,CAAC;SAChD;QAED,OAAO,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,KAAoC,UAAe,EAAf,mCAAe,EAAf,6BAAe,EAAf,IAAe,EAAE;QAAhD,IAAM,qBAAqB,wBAAA;QAC9B,6GAA6G;QAC7G,gCAAgC;QAChC,IAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QACjF,IAAI,CAAC,8BAA8B,CAAC,iBAAiB,CAAC;YAAE,8BAA8B,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC;QAE/G,4GAA4G;QAC5G,iCAAiC;QACjC,8BAA8B,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC;YACrD,WAAW,EAAE,qBAAqB,CAAC,WAAW;YAC9C,SAAS,EAAE,qBAAqB,CAAC,SAAS;SAC3C,CAAC,CAAC;KACJ;IAED,OAAO,8BAA8B,CAAC;AACxC,CAAC,CAAC"}

package/dist/esm/merkleDistributor/MerkleDistributor.d.ts

@@ -0,0 +1,20 @@
+import { DistributionRecipientsWithProofs, DistributionRecipient } from "./model";
+export declare class MerkleDistributor {
+    /**
+     * Generate the Merkle root and the proofs for a collection of recipients.
+     *
+     * @param recipients An object which describes the recipients
+     * @param windowIndex Parameter to specify an window index. This allows using the same smart contract for multiple token distributions.
+     */
+    static createMerkleDistributionProofs(recipients: DistributionRecipient[], windowIndex: number): {
+        recipientsWithProofs: DistributionRecipientsWithProofs;
+        merkleRoot: string;
+    };
+    /**
+     * Encode the account address, the amount and the account index into a Merkle Tree leaf.
+     * It is equivalent to Solidity's keccak256(abi.encode(account, amount))
+     * @param recipient The recipient of the token distribution
+     * @returns The Merkle Tree leaf
+     */
+    static createLeaf(recipient: DistributionRecipient): string;
+}

package/dist/esm/merkleDistributor/MerkleDistributor.js

@@ -0,0 +1,34 @@
+import { __assign } from "tslib";
+import { MerkleTree } from "@across-protocol/contracts/dist/utils/MerkleTree";
+import { ethers } from "ethers";
+var MerkleDistributor = /** @class */ (function () {
+    function MerkleDistributor() {
+    }
+    /**
+     * Generate the Merkle root and the proofs for a collection of recipients.
+     *
+     * @param recipients An object which describes the recipients
+     * @param windowIndex Parameter to specify an window index. This allows using the same smart contract for multiple token distributions.
+     */
+    MerkleDistributor.createMerkleDistributionProofs = function (recipients, windowIndex) {
+        var merkleTree = new MerkleTree(recipients, MerkleDistributor.createLeaf);
+        var recipientsWithProofs = recipients.reduce(function (acc, recipient) {
+            var _a;
+            return __assign(__assign({}, acc), (_a = {}, _a[recipient.account] = __assign(__assign({}, recipient), { proof: merkleTree.getHexProof(recipient), windowIndex: windowIndex }), _a));
+        }, {});
+        return { recipientsWithProofs: recipientsWithProofs, merkleRoot: merkleTree.getHexRoot() };
+    };
+    /**
+     * Encode the account address, the amount and the account index into a Merkle Tree leaf.
+     * It is equivalent to Solidity's keccak256(abi.encode(account, amount))
+     * @param recipient The recipient of the token distribution
+     * @returns The Merkle Tree leaf
+     */
+    MerkleDistributor.createLeaf = function (recipient) {
+        var account = recipient.account, amount = recipient.amount, accountIndex = recipient.accountIndex;
+        return ethers.utils.solidityKeccak256(["address", "uint256", "uint256"], [account, amount, accountIndex]);
+    };
+    return MerkleDistributor;
+}());
+export { MerkleDistributor };
+//# sourceMappingURL=MerkleDistributor.js.map

package/dist/esm/merkleDistributor/MerkleDistributor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MerkleDistributor.js","sourceRoot":"","sources":["../../../src/merkleDistributor/MerkleDistributor.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kDAAkD,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC;IAAA;IAgCA,CAAC;IA/BC;;;;;OAKG;IACI,gDAA8B,GAArC,UAAsC,UAAmC,EAAE,WAAmB;QAC5F,IAAM,UAAU,GAAG,IAAI,UAAU,CAAwB,UAAU,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACnG,IAAM,oBAAoB,GAAG,UAAU,CAAC,MAAM,CAAC,UAAC,GAAG,EAAE,SAAS;;YAC5D,6BACK,GAAG,gBACL,SAAS,CAAC,OAAO,0BACb,SAAS,KACZ,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,SAAS,CAAC,EACxC,WAAW,aAAA,UAEb;QACJ,CAAC,EAAE,EAAsC,CAAC,CAAC;QAC3C,OAAO,EAAE,oBAAoB,sBAAA,EAAE,UAAU,EAAE,UAAU,CAAC,UAAU,EAAE,EAAE,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACI,4BAAU,GAAjB,UAAkB,SAAgC;QACxC,IAAA,OAAO,GAA2B,SAAS,QAApC,EAAE,MAAM,GAAmB,SAAS,OAA5B,EAAE,YAAY,GAAK,SAAS,aAAd,CAAe;QACpD,OAAO,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IAC5G,CAAC;IACH,wBAAC;AAAD,CAAC,AAhCD,IAgCC"}

package/dist/esm/merkleDistributor/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./model";
+export * from "./MerkleDistributor";

package/dist/esm/merkleDistributor/index.js

@@ -0,0 +1,3 @@
+export * from "./model";
+export * from "./MerkleDistributor";
+//# sourceMappingURL=index.js.map

package/dist/esm/merkleDistributor/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/merkleDistributor/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC"}

package/dist/esm/merkleDistributor/model/Distribution.d.ts

@@ -0,0 +1,17 @@
+export type DistributionRecipientsWithProofs = {
+    [address: string]: DistributionRecipientWithProof;
+};
+export type DistributionRecipient = {
+    amount: string;
+    account: string;
+    accountIndex: number;
+    metadata: {
+        amountBreakdown: {
+            [name: string]: string;
+        };
+    };
+};
+export type DistributionRecipientWithProof = DistributionRecipient & {
+    windowIndex: number;
+    proof: string[];
+};

package/dist/esm/merkleDistributor/model/Distribution.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Distribution.js.map

package/dist/esm/merkleDistributor/model/Distribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Distribution.js","sourceRoot":"","sources":["../../../../src/merkleDistributor/model/Distribution.ts"],"names":[],"mappings":""}

package/dist/esm/merkleDistributor/model/index.d.ts

@@ -0,0 +1 @@
+export * from "./Distribution";

package/dist/esm/merkleDistributor/model/index.js

@@ -0,0 +1,2 @@
+export * from "./Distribution";
+//# sourceMappingURL=index.js.map

package/dist/esm/merkleDistributor/model/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/merkleDistributor/model/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC"}

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type":"module","sideEffects":false}

package/dist/esm/pool/TransactionManager.d.ts

@@ -0,0 +1,12 @@
+import { Signer } from "ethers";
+import { TransactionRequest, TransactionReceipt } from "@ethersproject/abstract-provider";
+type Config = {
+    confirmations?: number;
+};
+export type Emit = (event: string, key: string, data: TransactionReceipt | string | TransactionRequest | Error) => void;
+declare const _default: (config: Config, signer: Signer, emit?: Emit) => {
+    request: (unsignedTx: TransactionRequest) => string;
+    isMined: (key: string) => TransactionReceipt | undefined;
+    update: () => Promise<void>;
+};
+export default _default;

package/dist/esm/pool/TransactionManager.js

@@ -0,0 +1,122 @@
+import { __awaiter, __generator } from "tslib";
+import assert from "assert";
+function makeKey(tx) {
+    return JSON.stringify(Object.entries(tx).map(function (_a) {
+        var key = _a[0], value = _a[1];
+        return [key, (value || "").toString()];
+    }));
+}
+export default (function (config, signer, emit) {
+    if (emit === void 0) { emit = function () { return null; }; }
+    assert(signer.provider, "signer requires a provider, use signer.connect(provider)");
+    var _a = config.confirmations, confirmations = _a === void 0 ? 3 : _a;
+    var requests = new Map();
+    var submissions = new Map();
+    var mined = new Map();
+    function request(unsignedTx) {
+        // this no longer calls signer.populateTransaction, to allow metamask to fill in missing details instead
+        // use overrides if you want to manually fill in other tx details, including the overrides.customData field.
+        var populated = unsignedTx;
+        var key = makeKey(populated);
+        assert(!requests.has(key), "Transaction already in progress");
+        requests.set(key, populated);
+        return key;
+    }
+    function processRequest(key) {
+        return __awaiter(this, void 0, void 0, function () {
+            var request, sent, err_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        request = requests.get(key);
+                        assert(request, "invalid request");
+                        // always delete request, it should only be submitted once
+                        requests.delete(key);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, signer.sendTransaction(request)];
+                    case 2:
+                        sent = _a.sent();
+                        submissions.set(key, sent.hash);
+                        emit("submitted", key, sent.hash);
+                        return [3 /*break*/, 4];
+                    case 3:
+                        err_1 = _a.sent();
+                        emit("error", key, err_1);
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    }
+    function processSubmission(key) {
+        return __awaiter(this, void 0, void 0, function () {
+            var hash, receipt;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        hash = submissions.get(key);
+                        assert(hash, "invalid submission");
+                        assert(signer.provider, "signer requires a provider, use signer.connect(provider)");
+                        return [4 /*yield*/, signer.provider.getTransactionReceipt(hash).catch(function () { return undefined; })];
+                    case 1:
+                        receipt = _a.sent();
+                        if (receipt == null)
+                            return [2 /*return*/];
+                        if (receipt.confirmations < confirmations)
+                            return [2 /*return*/];
+                        submissions.delete(key);
+                        mined.set(key, receipt);
+                        emit("mined", key, receipt);
+                        return [2 /*return*/];
+                }
+            });
+        });
+    }
+    function isMined(key) {
+        return mined.get(key);
+    }
+    function update() {
+        return __awaiter(this, void 0, void 0, function () {
+            var _i, _a, key, _b, _c, key;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        _i = 0, _a = Object.keys(requests);
+                        _d.label = 1;
+                    case 1:
+                        if (!(_i < _a.length)) return [3 /*break*/, 4];
+                        key = _a[_i];
+                        return [4 /*yield*/, processRequest(key)];
+                    case 2:
+                        _d.sent();
+                        _d.label = 3;
+                    case 3:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 4:
+                        _b = 0, _c = Object.keys(submissions);
+                        _d.label = 5;
+                    case 5:
+                        if (!(_b < _c.length)) return [3 /*break*/, 8];
+                        key = _c[_b];
+                        return [4 /*yield*/, processSubmission(key)];
+                    case 6:
+                        _d.sent();
+                        _d.label = 7;
+                    case 7:
+                        _b++;
+                        return [3 /*break*/, 5];
+                    case 8: return [2 /*return*/];
+                }
+            });
+        });
+    }
+    return {
+        request: request,
+        isMined: isMined,
+        update: update,
+    };
+});
+//# sourceMappingURL=TransactionManager.js.map

package/dist/esm/pool/TransactionManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransactionManager.js","sourceRoot":"","sources":["../../../src/pool/TransactionManager.ts"],"names":[],"mappings":";AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAI5B,SAAS,OAAO,CAAC,EAAsB;IACrC,OAAO,IAAI,CAAC,SAAS,CACnB,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,UAAC,EAAY;YAAX,GAAG,QAAA,EAAE,KAAK,QAAA;QACjC,OAAO,CAAC,GAAG,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACzC,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAMD,gBAAe,UAAC,MAAc,EAAE,MAAc,EAAE,IAAuB;IAAvB,qBAAA,EAAA,qBAAmB,OAAA,IAAI,EAAJ,CAAI;IACrE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,0DAA0D,CAAC,CAAC;IAC5E,IAAA,KAAsB,MAAM,cAAX,EAAjB,aAAa,mBAAG,CAAC,KAAA,CAAY;IACrC,IAAM,QAAQ,GAAG,IAAI,GAAG,EAA8B,CAAC;IACvD,IAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC9C,IAAM,KAAK,GAAG,IAAI,GAAG,EAA8B,CAAC;IACpD,SAAS,OAAO,CAAC,UAA8B;QAC7C,wGAAwG;QACxG,4GAA4G;QAC5G,IAAM,SAAS,GAAG,UAAU,CAAC;QAC7B,IAAM,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/B,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,iCAAiC,CAAC,CAAC;QAC9D,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC7B,OAAO,GAAG,CAAC;IACb,CAAC;IACD,SAAe,cAAc,CAAC,GAAW;;;;;;wBACjC,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;wBAClC,MAAM,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;wBACnC,0DAA0D;wBAC1D,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;;;;wBAEN,qBAAM,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,EAAA;;wBAA5C,IAAI,GAAG,SAAqC;wBAClD,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;wBAChC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;;;;wBAElC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,KAAY,CAAC,CAAC;;;;;;KAEpC;IACD,SAAe,iBAAiB,CAAC,GAAW;;;;;;wBACpC,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;wBAClC,MAAM,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;wBACnC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,0DAA0D,CAAC,CAAC;wBAEpE,qBAAM,MAAM,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,cAAM,OAAA,SAAS,EAAT,CAAS,CAAC,EAAA;;wBAAlF,OAAO,GAAG,SAAwE;wBACxF,IAAI,OAAO,IAAI,IAAI;4BAAE,sBAAO;wBAC5B,IAAI,OAAO,CAAC,aAAa,GAAG,aAAa;4BAAE,sBAAO;wBAClD,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBACxB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;wBACxB,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;;;;;KAC7B;IACD,SAAS,OAAO,CAAC,GAAW;QAC1B,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IACD,SAAe,MAAM;;;;;;8BACoB,EAArB,KAAA,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;;;6BAArB,CAAA,cAAqB,CAAA;wBAA5B,GAAG;wBACZ,qBAAM,cAAc,CAAC,GAAG,CAAC,EAAA;;wBAAzB,SAAyB,CAAC;;;wBADV,IAAqB,CAAA;;;8BAGG,EAAxB,KAAA,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;;;6BAAxB,CAAA,cAAwB,CAAA;wBAA/B,GAAG;wBACZ,qBAAM,iBAAiB,CAAC,GAAG,CAAC,EAAA;;wBAA5B,SAA4B,CAAC;;;wBADb,IAAwB,CAAA;;;;;;KAG3C;IACD,OAAO;QACL,OAAO,SAAA;QACP,OAAO,SAAA;QACP,MAAM,QAAA;KACP,CAAC;AACJ,CAAC,EAAC"}

package/dist/esm/pool/index.d.ts

@@ -0,0 +1 @@
+export * from "./poolClient";

package/dist/esm/pool/index.js

@@ -0,0 +1,2 @@
+export * from "./poolClient";
+//# sourceMappingURL=index.js.map

package/dist/esm/pool/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/pool/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/esm/pool/poolClient.d.ts

@@ -0,0 +1,242 @@
+import * as uma from "@uma/sdk";
+import { BigNumberish } from "../utils";
+import { Signer, BigNumber } from "ethers";
+import type { Overrides } from "@ethersproject/contracts";
+import { TransactionRequest, TransactionReceipt, Log } from "@ethersproject/abstract-provider";
+import { Provider, Block } from "@ethersproject/providers";
+import { hubPool } from "../contracts";
+import { AcceleratingDistributor, MerkleDistributor } from "../typechain";
+export type { Provider };
+export type Awaited<T> = T extends PromiseLike<infer U> ? U : T;
+export type Config = {
+    chainId?: number;
+    hubPoolAddress: string;
+    acceleratingDistributorAddress: string;
+    merkleDistributorAddress: string;
+    wethAddress: string;
+    configStoreAddress: string;
+    confirmations?: number;
+    blockDelta?: number;
+    hasArchive?: boolean;
+    hubPoolStartBlock?: number;
+};
+export type Dependencies = {
+    provider: Provider;
+};
+export type StakeData = {
+    cumulativeBalance: BigNumber;
+    amountAirdropped: BigNumber;
+};
+export type Pool = {
+    address: string;
+    totalPoolSize: string;
+    l1Token: string;
+    lpToken: string;
+    liquidReserves: string;
+    exchangeRateCurrent: string;
+    exchangeRatePrevious: string;
+    estimatedApy: string;
+    estimatedApr: string;
+    blocksElapsed: number;
+    secondsElapsed: number;
+    utilizedReserves: string;
+    projectedApr: string;
+    liquidityUtilizationCurrent: string;
+};
+export type User = {
+    address: string;
+    poolAddress: string;
+    lpTokens: string;
+    positionValue: string;
+    totalDeposited: string;
+    feesEarned: string;
+};
+export type Transaction = {
+    id: string;
+    state: "requested" | "submitted" | "mined" | "error";
+    toAddress: string;
+    fromAddress: string;
+    type: "Add Liquidity" | "Remove Liquidity";
+    description: string;
+    request?: TransactionRequest;
+    hash?: string;
+    receipt?: TransactionReceipt;
+    error?: Error;
+};
+export type Token = {
+    decimals: string;
+    symbol: string;
+    name: string;
+};
+export type State = {
+    pools: Record<string, Pool>;
+    users: Record<string, Record<string, User>>;
+    transactions: Record<string, Transaction>;
+    error?: Error;
+};
+export type EmitState = (path: string[], data: Pool | User | Transaction | Error) => void;
+export type PooledToken = {
+    lpToken: string;
+    isEnabled: boolean;
+    lastLpFeeUpdate: number;
+    utilizedReserves: BigNumber;
+    liquidReserves: BigNumber;
+    undistributedLpFees: BigNumber;
+};
+type EventIdParams = {
+    blockNumber: number;
+    transactionIndex: number;
+    logIndex: number;
+};
+export declare class PoolEventState {
+    private contract;
+    private startBlock;
+    private seen;
+    private iface;
+    private events;
+    constructor(contract: hubPool.Instance, startBlock?: number);
+    private makeId;
+    hasEvent(params: EventIdParams): boolean;
+    private addEvent;
+    private filterSeen;
+    private processEvent;
+    private processEvents;
+    read(endBlock: number, l1TokenAddress?: string, userAddress?: string): Promise<hubPool.EventState>;
+    makeEventFromLog: (log: Log) => uma.SerializableEvent;
+    getL1TokenFromReceipt(receipt: TransactionReceipt): string;
+    readTxReceipt(receipt: TransactionReceipt): hubPool.EventState;
+}
+declare class UserState {
+    private contract;
+    private userAddress;
+    private startBlock;
+    private acceleratingDistributorContractAddress;
+    private seen;
+    private events;
+    constructor(contract: uma.clients.erc20.Instance, userAddress: string, startBlock?: number, acceleratingDistributorContractAddress?: string);
+    private makeId;
+    hasEvent(params: EventIdParams): boolean;
+    private addEvent;
+    private filterSeen;
+    /**
+     * readEvents. Fetch and cache events for the user.
+     *
+     * @param {number} endBlock
+     */
+    readEvents(endBlock: number): Promise<uma.clients.erc20.Transfer[]>;
+    /**
+     * read. Reads the state for the user, building state from events as well as contract calls.
+     *
+     * @param {number} endBlock
+     */
+    read(endBlock: number): Promise<{
+        transferEvents: import("@uma/contracts-frontend").TypedEventEthers<[string, string, uma.oracle.types.ethers.BigNumber] & {
+            from: string;
+            to: string;
+            value: uma.oracle.types.ethers.BigNumber;
+        }>[];
+        balanceTransferred: string;
+        address: string;
+        balanceOf: uma.oracle.types.ethers.BigNumber;
+    }>;
+}
+export declare function calculateRemoval(amountWei: BigNumber, percentWei: BigNumber): {
+    recieve: string;
+    remain: string;
+};
+export declare function previewRemoval(values: {
+    positionValue: BigNumberish;
+    feesEarned: BigNumberish;
+    totalDeposited: BigNumberish;
+}, percentFloat: number): {
+    position: {
+        recieve: string;
+        remain: string;
+    };
+    fees: {
+        recieve: string;
+        remain: string;
+    };
+    total: {
+        recieve: string;
+        remain: string;
+    };
+};
+export declare class ReadPoolClient {
+    private address;
+    private provider;
+    private poolState;
+    private contract;
+    constructor(address: string, provider: Provider);
+    read(tokenAddress: string, latestBlock: number): Promise<{
+        lpToken: string;
+        isEnabled: boolean;
+        lastLpFeeUpdate: number;
+        utilizedReserves: uma.oracle.types.ethers.BigNumber;
+        liquidReserves: uma.oracle.types.ethers.BigNumber;
+        undistributedLpFees: uma.oracle.types.ethers.BigNumber;
+        address: string;
+        l1Token: string;
+        latestBlock: number;
+        previousBlock: number | undefined;
+        exchangeRatePrevious: uma.oracle.types.ethers.BigNumber;
+        exchangeRateCurrent: uma.oracle.types.ethers.BigNumber;
+        liquidityUtilizationCurrent: uma.oracle.types.ethers.BigNumber;
+    }>;
+}
+export declare function validateWithdraw(pool: Pool, user: User, lpTokenAmount: BigNumberish): {
+    lpTokenAmount: uma.oracle.types.ethers.BigNumberish;
+    l1TokensToReturn: string;
+};
+export declare class Client {
+    readonly config: Config;
+    readonly deps: Dependencies;
+    private emit;
+    private transactionManagers;
+    private hubPool;
+    private acceleratingDistributor;
+    private merkleDistributor;
+    readonly state: State;
+    private poolEvents;
+    private erc20s;
+    private intervalStarted;
+    private configStoreClient;
+    private exchangeRateTable;
+    private userServices;
+    constructor(config: Config, deps: Dependencies, emit: EmitState);
+    getOrCreateErc20Contract(address: string): uma.clients.erc20.Instance;
+    getOrCreatePoolContract(): hubPool.Instance;
+    createHubPoolContract(signerOrProvider: Signer | Provider): hubPool.Instance;
+    private getOrCreatePoolEvents;
+    createAcceleratingDistributorContract(signerOrProvider: Signer | Provider): AcceleratingDistributor;
+    createMerkleDistributorContract(signerOrProvider: Signer | Provider): MerkleDistributor;
+    getOrCreateAcceleratingDistributorContract(): AcceleratingDistributor;
+    getOrCreateMerkleDistributorContract(): MerkleDistributor;
+    private getOrCreateUserService;
+    private updateExchangeRateTable;
+    resolveStakingData(lpToken: string, l1TokenAddress: string, userState: Awaited<ReturnType<UserState["read"]>>): Promise<StakeData>;
+    calculateLpTransferValue(l1TokenAddress: string, userState: Awaited<ReturnType<UserState["read"]>>): Promise<uma.oracle.types.ethers.BigNumber>;
+    private getOrCreateTransactionManager;
+    addEthLiquidity(signer: Signer, l1TokenAmount: BigNumberish, overrides?: Overrides): Promise<string>;
+    addTokenLiquidity(signer: Signer, l1Token: string, l1TokenAmount: BigNumberish, overrides?: Overrides): Promise<string>;
+    validateWithdraw(l1Token: string, userAddress: string, lpAmount: BigNumberish): Promise<{
+        lpTokenAmount: uma.oracle.types.ethers.BigNumberish;
+        l1TokensToReturn: string;
+    }>;
+    removeTokenLiquidity(signer: Signer, l1Token: string, lpTokenAmount: BigNumberish, overrides?: Overrides): Promise<string>;
+    removeEthliquidity(signer: Signer, lpTokenAmount: BigNumberish, overrides?: Overrides): Promise<string>;
+    getPoolState(l1TokenAddress: string): Pool;
+    hasPoolState(l1TokenAddress: string): boolean;
+    setUserState(l1TokenAddress: string, userAddress: string, state: User): User;
+    getUserState(l1TokenAddress: string, userAddress: string): User;
+    hasUserState(l1TokenAddress: string, userAddress: string): boolean;
+    hasTxState(id: string): boolean;
+    getTxState(id: string): Transaction;
+    private updateAndEmitUser;
+    private updateUserWithTransaction;
+    updateUser(userAddress: string, l1TokenAddress: string): Promise<void>;
+    updatePool(l1TokenAddress: string, overrideLatestBlock?: Block): Promise<void>;
+    updateTransactions(): Promise<void>;
+    startInterval(delayMs?: number): void;
+    stopInterval(): void;
+}