@across-protocol/sdk 3.0.0

package/dist/esm/interfaces/Error.d.ts

@@ -0,0 +1,5 @@
+export type EthersError = Error & {
+    code: string;
+    reason: string;
+    error?: Error;
+};

package/dist/esm/interfaces/Error.js

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

package/dist/esm/interfaces/Error.js.map

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

package/dist/esm/interfaces/HubPool.d.ts

@@ -0,0 +1,98 @@
+import { BigNumber } from "ethers";
+import { SortableEvent } from "./Common";
+export interface PoolRebalanceLeaf {
+    chainId: number;
+    groupIndex: number;
+    bundleLpFees: BigNumber[];
+    netSendAmounts: BigNumber[];
+    runningBalances: BigNumber[];
+    leafId: number;
+    l1Tokens: string[];
+}
+export interface RelayerRefundLeaf {
+    amountToReturn: BigNumber;
+    chainId: number;
+    refundAmounts: BigNumber[];
+    leafId: number;
+    l2TokenAddress: string;
+    refundAddresses: string[];
+}
+export interface ProposedRootBundle extends SortableEvent {
+    challengePeriodEndTimestamp: number;
+    poolRebalanceLeafCount: number;
+    bundleEvaluationBlockNumbers: BigNumber[];
+    poolRebalanceRoot: string;
+    relayerRefundRoot: string;
+    slowRelayRoot: string;
+    proposer: string;
+}
+export type RealizedLpFee = {
+    quoteBlock: number;
+    realizedLpFeePct: BigNumber;
+};
+export type ProposedRootBundleStringified = Omit<ProposedRootBundle, "bundleEvaluationBlockNumbers"> & {
+    bundleEvaluationBlockNumbers: string[];
+};
+export interface CancelledRootBundle extends SortableEvent {
+    disputer: string;
+    requestTime: number;
+}
+export interface DisputedRootBundle extends SortableEvent {
+    disputer: string;
+    requestTime: number;
+}
+export interface ExecutedRootBundle extends SortableEvent {
+    chainId: number;
+    bundleLpFees: BigNumber[];
+    netSendAmounts: BigNumber[];
+    runningBalances: BigNumber[];
+    incentiveBalances: BigNumber[];
+    leafId: number;
+    l1Tokens: string[];
+    proof: string[];
+}
+export type ExecutedRootBundleStringified = Omit<ExecutedRootBundle, "bundleLpFees" | "netSendAmounts" | "runningBalances" | "incentiveBalances"> & {
+    bundleLpFees: string[];
+    netSendAmounts: string[];
+    runningBalances: string[];
+    incentiveBalances: string[];
+};
+export type TokenRunningBalance = {
+    runningBalance: BigNumber;
+    incentiveBalance: BigNumber;
+};
+export interface RelayerRefundLeafWithGroup extends RelayerRefundLeaf {
+    groupIndex: number;
+}
+export interface L1Token {
+    address: string;
+    symbol: string;
+    decimals: number;
+}
+export interface LpToken {
+    lastLpFeeUpdate: number;
+    liquidReserves: BigNumber;
+}
+export interface CrossChainContractsSet extends SortableEvent {
+    l2ChainId: number;
+    spokePool: string;
+}
+export interface DestinationTokenWithBlock extends SortableEvent {
+    l2Token: string;
+    l1Token: string;
+}
+export interface SetPoolRebalanceRoot extends SortableEvent {
+    destinationChainId: number;
+    l1Token: string;
+    destinationToken: string;
+}
+export interface PendingRootBundle {
+    poolRebalanceRoot: string;
+    relayerRefundRoot: string;
+    slowRelayRoot: string;
+    proposer: string;
+    unclaimedPoolRebalanceLeafCount: number;
+    challengePeriodEndTimestamp: number;
+    bundleEvaluationBlockNumbers: number[];
+    proposalBlockNumber?: number;
+}

package/dist/esm/interfaces/HubPool.js

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

package/dist/esm/interfaces/HubPool.js.map

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

package/dist/esm/interfaces/SpokePool.d.ts

@@ -0,0 +1,103 @@
+import { BigNumber } from "ethers";
+import { SortableEvent } from "./Common";
+import { FilledRelayEvent, FilledV3RelayEvent, FundsDepositedEvent, V3FundsDepositedEvent } from "../typechain";
+import { SpokePoolClient } from "../clients";
+import { RelayerRefundLeaf } from "./HubPool";
+export type { FilledRelayEvent, FilledV3RelayEvent, FundsDepositedEvent, V3FundsDepositedEvent };
+export interface RelayData {
+    originChainId: number;
+    depositor: string;
+    recipient: string;
+    depositId: number;
+    inputToken: string;
+    inputAmount: BigNumber;
+    outputToken: string;
+    outputAmount: BigNumber;
+    message: string;
+    fillDeadline: number;
+    exclusiveRelayer: string;
+    exclusivityDeadline: number;
+}
+export interface Deposit extends RelayData {
+    destinationChainId: number;
+    quoteTimestamp: number;
+    speedUpSignature?: string;
+    updatedRecipient?: string;
+    updatedOutputAmount?: BigNumber;
+    updatedMessage?: string;
+}
+export interface DepositWithBlock extends Deposit, SortableEvent {
+    quoteBlockNumber: number;
+}
+export declare enum FillStatus {
+    Unfilled = 0,
+    RequestedSlowFill = 1,
+    Filled = 2
+}
+export declare enum FillType {
+    FastFill = 0,
+    ReplacedSlowFill = 1,
+    SlowFill = 2
+}
+export interface RelayExecutionEventInfo {
+    updatedRecipient: string;
+    updatedOutputAmount: BigNumber;
+    updatedMessage: string;
+    fillType: FillType;
+}
+export interface Fill extends RelayData {
+    destinationChainId: number;
+    relayer: string;
+    repaymentChainId: number;
+    relayExecutionInfo: RelayExecutionEventInfo;
+}
+export interface FillWithBlock extends Fill, SortableEvent {
+}
+export interface SpeedUp {
+    depositor: string;
+    depositorSignature: string;
+    depositId: number;
+    originChainId: number;
+    updatedRecipient: string;
+    updatedOutputAmount: BigNumber;
+    updatedMessage: string;
+}
+export interface SlowFillRequest extends RelayData {
+    destinationChainId: number;
+}
+export interface SlowFillRequestWithBlock extends SlowFillRequest, SortableEvent {
+}
+export interface SlowFillLeaf {
+    relayData: RelayData;
+    chainId: number;
+    updatedOutputAmount: BigNumber;
+}
+export interface RootBundleRelay {
+    rootBundleId: number;
+    relayerRefundRoot: string;
+    slowRelayRoot: string;
+}
+export interface RootBundleRelayWithBlock extends RootBundleRelay, SortableEvent {
+}
+export interface RelayerRefundExecution extends RelayerRefundLeaf {
+    rootBundleId: number;
+}
+export interface RelayerRefundExecutionWithBlock extends RelayerRefundExecution, SortableEvent {
+}
+export interface Refund {
+    [refundAddress: string]: BigNumber;
+}
+export interface RunningBalances {
+    [repaymentChainId: number]: {
+        [l1TokenAddress: string]: BigNumber;
+    };
+}
+export interface TokensBridged extends SortableEvent {
+    amountToReturn: BigNumber;
+    chainId: number;
+    leafId: number;
+    l2TokenAddress: string;
+}
+export interface SpokePoolClientsByChain {
+    [chainId: number]: SpokePoolClient;
+}

package/dist/esm/interfaces/SpokePool.js

@@ -0,0 +1,13 @@
+export var FillStatus;
+(function (FillStatus) {
+    FillStatus[FillStatus["Unfilled"] = 0] = "Unfilled";
+    FillStatus[FillStatus["RequestedSlowFill"] = 1] = "RequestedSlowFill";
+    FillStatus[FillStatus["Filled"] = 2] = "Filled";
+})(FillStatus || (FillStatus = {}));
+export var FillType;
+(function (FillType) {
+    FillType[FillType["FastFill"] = 0] = "FastFill";
+    FillType[FillType["ReplacedSlowFill"] = 1] = "ReplacedSlowFill";
+    FillType[FillType["SlowFill"] = 2] = "SlowFill";
+})(FillType || (FillType = {}));
+//# sourceMappingURL=SpokePool.js.map

package/dist/esm/interfaces/SpokePool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpokePool.js","sourceRoot":"","sources":["../../../src/interfaces/SpokePool.ts"],"names":[],"mappings":"AAoCA,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,mDAAY,CAAA;IACZ,qEAAiB,CAAA;IACjB,+CAAM,CAAA;AACR,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB;AAED,MAAM,CAAN,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,+CAAY,CAAA;IACZ,+DAAgB,CAAA;IAChB,+CAAQ,CAAA;AACV,CAAC,EAJW,QAAQ,KAAR,QAAQ,QAInB"}

package/dist/esm/interfaces/TypedData.d.ts

@@ -0,0 +1,19 @@
+export interface MessageTypeProperty {
+    name: string;
+    type: string;
+}
+export interface MessageTypes {
+    [additionalProperties: string]: MessageTypeProperty[];
+}
+export interface TypedMessage<T extends MessageTypes> {
+    types: T;
+    primaryType: keyof T;
+    domain: {
+        name?: string;
+        version?: string;
+        chainId?: number;
+        verifyingContract?: string;
+        salt?: ArrayBuffer;
+    };
+    message: Record<string, unknown>;
+}

package/dist/esm/interfaces/TypedData.js

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

package/dist/esm/interfaces/TypedData.js.map

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

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

@@ -0,0 +1,8 @@
+export * from "./Common";
+export * from "./ConfigStore";
+export * from "./HubPool";
+export * from "./SpokePool";
+export * from "./Bridge";
+export * from "./Error";
+export * from "./TypedData";
+export * from "./CachingMechanism";

package/dist/esm/interfaces/index.js

@@ -0,0 +1,9 @@
+export * from "./Common";
+export * from "./ConfigStore";
+export * from "./HubPool";
+export * from "./SpokePool";
+export * from "./Bridge";
+export * from "./Error";
+export * from "./TypedData";
+export * from "./CachingMechanism";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC"}

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

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

package/dist/esm/lpFeeCalculator/index.js

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

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

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

package/dist/esm/lpFeeCalculator/lpFeeCalculator.d.ts

@@ -0,0 +1,66 @@
+import { BigNumberish, BN } from "../utils";
+export interface RateModel {
+    UBar: BigNumberish;
+    R0: BigNumberish;
+    R1: BigNumberish;
+    R2: BigNumberish;
+}
+export declare function truncate18DecimalBN(input: BN, digits: number): BN;
+export declare class LPFeeCalculator {
+    private readonly rateModel;
+    constructor(rateModel: RateModel);
+    /**
+     * Compute area under curve of the piece-wise linear rate model.
+     * @param rateModel Rate model to be used in this calculation.
+     * @param utilization The current utilization of the pool.
+     * @returns The area under the curve of the piece-wise linear rate model.
+     */
+    calculateAreaUnderRateCurve(utilization: BN): BN;
+    /**
+     * Calculate the instantaneous rate for a 0 sized deposit (infinitesimally small).
+     * @param utilization The current utilization of the pool.
+     * @returns The instantaneous rate for a 0 sized deposit.
+     */
+    calculateInstantaneousRate(utilization: BigNumberish): BN;
+    /**
+     * Calculate the realized LP Fee Percent for a given rate model, utilization before and after the deposit.
+     * @param rateModel Rate model to be used in this calculation.
+     * @param utilizationBeforeDeposit The utilization of the pool before the deposit.
+     * @param utilizationAfterDeposit The utilization of the pool after the deposit.
+     * @param truncateDecimals Whether to truncate the decimals to 6.
+     * @returns The realized LP fee percent.
+     */
+    calculateRealizedLpFeePct(utilizationBeforeDeposit: BigNumberish, utilizationAfterDeposit: BigNumberish, truncateDecimals?: boolean): BN;
+    /**
+     * Calculate the realized yearly LP Fee APY Percent for a given rate model, utilization before and after the deposit.
+     * @param rateModel Rate model to be used in this calculation.
+     * @param utilizationBeforeDeposit The utilization of the pool before the deposit.
+     * @param utilizationAfterDeposit The utilization of the pool after the deposit.
+     * @returns The realized LP fee APY percent.
+     */
+    calculateApyFromUtilization(utilizationBeforeDeposit: BN, utilizationAfterDeposit: BN): BN;
+}
+/**
+ * Calculate the instantaneous rate for a 0 sized deposit (infinitesimally small).
+ * @param rateModel Rate model to be used in this calculation.
+ * @param utilization The current utilization of the pool.
+ * @returns The instantaneous rate for a 0 sized deposit.
+ */
+export declare function calculateInstantaneousRate(rateModel: RateModel, utilization: BigNumberish): BN;
+/**
+ * Calculate the realized yearly LP Fee APY Percent for a given rate model, utilization before and after the deposit.
+ * @param rateModel Rate model to be used in this calculation.
+ * @param utilizationBeforeDeposit The utilization of the pool before the deposit.
+ * @param utilizationAfterDeposit The utilization of the pool after the deposit.
+ * @returns The realized LP fee APY percent.
+ */
+export declare function calculateApyFromUtilization(rateModel: RateModel, utilizationBeforeDeposit: BN, utilizationAfterDeposit: BN): BN;
+/**
+ * Calculate the realized LP Fee Percent for a given rate model, utilization before and after the deposit.
+ * @param rateModel Rate model to be used in this calculation.
+ * @param utilizationBeforeDeposit The utilization of the pool before the deposit.
+ * @param utilizationAfterDeposit The utilization of the pool after the deposit.
+ * @param truncateDecimals Whether to truncate the decimals to 6.
+ * @returns The realized LP fee percent.
+ */
+export declare function calculateRealizedLpFeePct(rateModel: RateModel, utilizationBeforeDeposit: BigNumberish, utilizationAfterDeposit: BigNumberish, truncateDecimals?: boolean): BN;

package/dist/esm/lpFeeCalculator/lpFeeCalculator.js

@@ -0,0 +1,129 @@
+// This Util calculates the across realized LP fees. See https://gist.github.com/chrismaree/a713725e4fe96c531c42ed7b629d4a85
+// gist for a python implementation of the logic in this file. This implementation is designed to work with both web3.js
+// and ethers BNs in the main entry point function calculateRealizedLpFeePct.
+import Decimal from "decimal.js";
+import { toBN, toBNWei, fromWei, min, max, fixedPointAdjustment } from "../utils";
+// converts an APY rate to a one week rate. Uses the Decimal library to take a fractional exponent
+function convertApyToWeeklyFee(apy) {
+    // R_week = (1 + apy)^(1/52) - 1
+    var weeklyFeePct = Decimal.pow(new Decimal("1").plus(fromWei(apy)), new Decimal("1").dividedBy(new Decimal("52"))).minus(new Decimal("1"));
+    // Convert from decimal back to BN, scaled by 1e18.
+    return toBN(weeklyFeePct.times(fixedPointAdjustment.toString()).floor().toString());
+}
+export function truncate18DecimalBN(input, digits) {
+    var digitsToDrop = 18 - digits;
+    var multiplier = toBN(10).pow(digitsToDrop);
+    return input.div(multiplier).mul(multiplier);
+}
+var LPFeeCalculator = /** @class */ (function () {
+    function LPFeeCalculator(rateModel) {
+        this.rateModel = rateModel;
+    }
+    /**
+     * Compute area under curve of the piece-wise linear rate model.
+     * @param rateModel Rate model to be used in this calculation.
+     * @param utilization The current utilization of the pool.
+     * @returns The area under the curve of the piece-wise linear rate model.
+     */
+    LPFeeCalculator.prototype.calculateAreaUnderRateCurve = function (utilization) {
+        // Area under first piecewise component
+        var utilizationBeforeKink = min(utilization, this.rateModel.UBar);
+        var rectangle1Area = utilizationBeforeKink.mul(this.rateModel.R0).div(fixedPointAdjustment);
+        var triangle1Area = toBNWei("0.5")
+            .mul(this.calculateInstantaneousRate(utilizationBeforeKink).sub(this.rateModel.R0))
+            .mul(utilizationBeforeKink)
+            .div(fixedPointAdjustment)
+            .div(fixedPointAdjustment);
+        // Area under second piecewise component
+        var utilizationAfter = max(toBN("0"), utilization.sub(this.rateModel.UBar));
+        var rectangle2Area = utilizationAfter
+            .mul(toBN(this.rateModel.R0).add(this.rateModel.R1))
+            .div(fixedPointAdjustment);
+        var triangle2Area = toBNWei("0.5")
+            .mul(this.calculateInstantaneousRate(utilization).sub(toBN(this.rateModel.R0).add(this.rateModel.R1)))
+            .mul(utilizationAfter)
+            .div(fixedPointAdjustment)
+            .div(fixedPointAdjustment);
+        return rectangle1Area.add(triangle1Area).add(rectangle2Area).add(triangle2Area);
+    };
+    /**
+     * Calculate the instantaneous rate for a 0 sized deposit (infinitesimally small).
+     * @param utilization The current utilization of the pool.
+     * @returns The instantaneous rate for a 0 sized deposit.
+     */
+    LPFeeCalculator.prototype.calculateInstantaneousRate = function (utilization) {
+        // Assuming utilization >= 0, if UBar = 0 then the value beforeKink is 0 since min(>=0, 0) = 0.
+        var beforeKink = this.rateModel.UBar.toString() === "0"
+            ? toBN(0)
+            : min(utilization, this.rateModel.UBar).mul(this.rateModel.R1).div(this.rateModel.UBar);
+        var afterKink = max(toBN("0"), toBN(utilization).sub(this.rateModel.UBar))
+            .mul(this.rateModel.R2)
+            .div(toBNWei("1").sub(this.rateModel.UBar));
+        return toBN(this.rateModel.R0).add(beforeKink).add(afterKink);
+    };
+    /**
+     * Calculate the realized LP Fee Percent for a given rate model, utilization before and after the deposit.
+     * @param rateModel Rate model to be used in this calculation.
+     * @param utilizationBeforeDeposit The utilization of the pool before the deposit.
+     * @param utilizationAfterDeposit The utilization of the pool after the deposit.
+     * @param truncateDecimals Whether to truncate the decimals to 6.
+     * @returns The realized LP fee percent.
+     */
+    LPFeeCalculator.prototype.calculateRealizedLpFeePct = function (utilizationBeforeDeposit, utilizationAfterDeposit, truncateDecimals) {
+        if (truncateDecimals === void 0) { truncateDecimals = false; }
+        var apy = this.calculateApyFromUtilization(toBN(utilizationBeforeDeposit), toBN(utilizationAfterDeposit));
+        // ACROSS UMIP requires that the realized fee percent is floor rounded as decimal to 6 decimals.
+        return truncateDecimals ? truncate18DecimalBN(convertApyToWeeklyFee(apy), 6) : convertApyToWeeklyFee(apy);
+    };
+    /**
+     * Calculate the realized yearly LP Fee APY Percent for a given rate model, utilization before and after the deposit.
+     * @param rateModel Rate model to be used in this calculation.
+     * @param utilizationBeforeDeposit The utilization of the pool before the deposit.
+     * @param utilizationAfterDeposit The utilization of the pool after the deposit.
+     * @returns The realized LP fee APY percent.
+     */
+    LPFeeCalculator.prototype.calculateApyFromUtilization = function (utilizationBeforeDeposit, utilizationAfterDeposit) {
+        if (utilizationBeforeDeposit.eq(utilizationAfterDeposit))
+            return this.calculateInstantaneousRate(utilizationBeforeDeposit);
+        // Get the area of [0, utilizationBeforeDeposit] and [0, utilizationAfterDeposit]
+        var areaBeforeDeposit = this.calculateAreaUnderRateCurve(utilizationBeforeDeposit);
+        var areaAfterDeposit = this.calculateAreaUnderRateCurve(utilizationAfterDeposit);
+        var numerator = areaAfterDeposit.sub(areaBeforeDeposit);
+        var denominator = utilizationAfterDeposit.sub(utilizationBeforeDeposit);
+        return numerator.mul(fixedPointAdjustment).div(denominator);
+    };
+    return LPFeeCalculator;
+}());
+export { LPFeeCalculator };
+/**
+ * Calculate the instantaneous rate for a 0 sized deposit (infinitesimally small).
+ * @param rateModel Rate model to be used in this calculation.
+ * @param utilization The current utilization of the pool.
+ * @returns The instantaneous rate for a 0 sized deposit.
+ */
+export function calculateInstantaneousRate(rateModel, utilization) {
+    return new LPFeeCalculator(rateModel).calculateInstantaneousRate(utilization);
+}
+/**
+ * Calculate the realized yearly LP Fee APY Percent for a given rate model, utilization before and after the deposit.
+ * @param rateModel Rate model to be used in this calculation.
+ * @param utilizationBeforeDeposit The utilization of the pool before the deposit.
+ * @param utilizationAfterDeposit The utilization of the pool after the deposit.
+ * @returns The realized LP fee APY percent.
+ */
+export function calculateApyFromUtilization(rateModel, utilizationBeforeDeposit, utilizationAfterDeposit) {
+    return new LPFeeCalculator(rateModel).calculateApyFromUtilization(utilizationBeforeDeposit, utilizationAfterDeposit);
+}
+/**
+ * Calculate the realized LP Fee Percent for a given rate model, utilization before and after the deposit.
+ * @param rateModel Rate model to be used in this calculation.
+ * @param utilizationBeforeDeposit The utilization of the pool before the deposit.
+ * @param utilizationAfterDeposit The utilization of the pool after the deposit.
+ * @param truncateDecimals Whether to truncate the decimals to 6.
+ * @returns The realized LP fee percent.
+ */
+export function calculateRealizedLpFeePct(rateModel, utilizationBeforeDeposit, utilizationAfterDeposit, truncateDecimals) {
+    if (truncateDecimals === void 0) { truncateDecimals = false; }
+    return new LPFeeCalculator(rateModel).calculateRealizedLpFeePct(utilizationBeforeDeposit, utilizationAfterDeposit, truncateDecimals);
+}
+//# sourceMappingURL=lpFeeCalculator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"lpFeeCalculator.js","sourceRoot":"","sources":["../../../src/lpFeeCalculator/lpFeeCalculator.ts"],"names":[],"mappings":"AAAA,4HAA4H;AAC5H,wHAAwH;AACxH,6EAA6E;AAE7E,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,EAAoB,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAWpG,kGAAkG;AAClG,SAAS,qBAAqB,CAAC,GAAO;IACpC,gCAAgC;IAChC,IAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAC9B,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EACnC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAC9C,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAE1B,mDAAmD;IACnD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,oBAAoB,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;AACtF,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAS,EAAE,MAAc;IAC3D,IAAM,YAAY,GAAG,EAAE,GAAG,MAAM,CAAC;IACjC,IAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC9C,OAAO,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAC/C,CAAC;AAED;IACE,yBAA6B,SAAoB;QAApB,cAAS,GAAT,SAAS,CAAW;IAAG,CAAC;IAErD;;;;;OAKG;IACI,qDAA2B,GAAlC,UAAmC,WAAe;QAChD,uCAAuC;QACvC,IAAM,qBAAqB,GAAG,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpE,IAAM,cAAc,GAAG,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAC9F,IAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC;aACjC,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;aAClF,GAAG,CAAC,qBAAqB,CAAC;aAC1B,GAAG,CAAC,oBAAoB,CAAC;aACzB,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAE7B,wCAAwC;QACxC,IAAM,gBAAgB,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9E,IAAM,cAAc,GAAG,gBAAgB;aACpC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;aACnD,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAC7B,IAAM,aAAa,GAAG,OAAO,CAAC,KAAK,CAAC;aACjC,GAAG,CAAC,IAAI,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;aACrG,GAAG,CAAC,gBAAgB,CAAC;aACrB,GAAG,CAAC,oBAAoB,CAAC;aACzB,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAE7B,OAAO,cAAc,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAClF,CAAC;IAED;;;;OAIG;IACI,oDAA0B,GAAjC,UAAkC,WAAyB;QACzD,+FAA+F;QAC/F,IAAM,UAAU,GACd,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,GAAG;YACpC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACT,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5F,IAAM,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;aACzE,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;aACtB,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAE9C,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;OAOG;IACI,mDAAyB,GAAhC,UACE,wBAAsC,EACtC,uBAAqC,EACrC,gBAAwB;QAAxB,iCAAA,EAAA,wBAAwB;QAExB,IAAM,GAAG,GAAG,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAE5G,gGAAgG;QAChG,OAAO,gBAAgB,CAAC,CAAC,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAC5G,CAAC;IACD;;;;;;OAMG;IACI,qDAA2B,GAAlC,UAAmC,wBAA4B,EAAE,uBAA2B;QAC1F,IAAI,wBAAwB,CAAC,EAAE,CAAC,uBAAuB,CAAC;YACtD,OAAO,IAAI,CAAC,0BAA0B,CAAC,wBAAwB,CAAC,CAAC;QAEnE,iFAAiF;QACjF,IAAM,iBAAiB,GAAG,IAAI,CAAC,2BAA2B,CAAC,wBAAwB,CAAC,CAAC;QACrF,IAAM,gBAAgB,GAAG,IAAI,CAAC,2BAA2B,CAAC,uBAAuB,CAAC,CAAC;QAEnF,IAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAC1D,IAAM,WAAW,GAAG,uBAAuB,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QAC1E,OAAO,SAAS,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC9D,CAAC;IACH,sBAAC;AAAD,CAAC,AAxFD,IAwFC;;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,SAAoB,EAAE,WAAyB;IACxF,OAAO,IAAI,eAAe,CAAC,SAAS,CAAC,CAAC,0BAA0B,CAAC,WAAW,CAAC,CAAC;AAChF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B,CACzC,SAAoB,EACpB,wBAA4B,EAC5B,uBAA2B;IAE3B,OAAO,IAAI,eAAe,CAAC,SAAS,CAAC,CAAC,2BAA2B,CAAC,wBAAwB,EAAE,uBAAuB,CAAC,CAAC;AACvH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CACvC,SAAoB,EACpB,wBAAsC,EACtC,uBAAqC,EACrC,gBAAwB;IAAxB,iCAAA,EAAA,wBAAwB;IAExB,OAAO,IAAI,eAAe,CAAC,SAAS,CAAC,CAAC,yBAAyB,CAC7D,wBAAwB,EACxB,uBAAuB,EACvB,gBAAgB,CACjB,CAAC;AACJ,CAAC"}

package/dist/esm/lpFeeCalculator/rateModel.d.ts

@@ -0,0 +1,45 @@
+type RateModelEventsDictionary = {
+    [l1TokenAddress: string]: {
+        blockNumber: number;
+        rateModel: string;
+    }[];
+};
+export type RateModelEvent = {
+    blockNumber: number;
+    transactionIndex: number;
+    logIndex: number;
+    rateModel: string;
+    l1Token: string;
+};
+interface RateModel {
+    UBar: string;
+    R0: string;
+    R1: string;
+    R2: string;
+}
+export declare class RateModelDictionary {
+    rateModelDictionary: RateModelEventsDictionary;
+    private _throwIfNotInitialized;
+    updateWithEvents(rateModelEvents: RateModelEvent[]): void;
+    /**
+     * 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.
+     */
+    getRateModelForBlockNumber(l1Token: string, blockNumber?: number): 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.
+     */
+    getL1TokensFromRateModel(blockNumber?: number | undefined): string[];
+}
+/**
+ * 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 declare const parseAndReturnRateModelFromString: (rateModelString: string) => RateModel;
+export {};