diff --git a/docs/sdk/decimal.decimal.md b/docs/sdk/decimal.decimal.md deleted file mode 100644 index 55369c97c..000000000 --- a/docs/sdk/decimal.decimal.md +++ /dev/null @@ -1,55 +0,0 @@ - - -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) - -## Decimal class - -Fixed-point decimal bignumber with 18 digits of precision. - -Signature: - -```typescript -export declare class Decimal -``` - -## Remarks - -Used by Liquity libraries to precisely represent native currency (e.g. Ether), LUSD and LQTY amounts, as well as derived metrics like collateral ratios. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [finite](./decimal.decimal.finite.md) | | this \| undefined | | -| [HALF](./decimal.decimal.half.md) | static | [Decimal](./decimal.decimal.md) | | -| [infinite](./decimal.decimal.infinite.md) | | this \| undefined | | -| [INFINITY](./decimal.decimal.infinity.md) | static | [Decimal](./decimal.decimal.md) | | -| [isZero](./decimal.decimal.iszero.md) | | boolean | | -| [nonZero](./decimal.decimal.nonzero.md) | | this \| undefined | | -| [ONE](./decimal.decimal.one.md) | static | [Decimal](./decimal.decimal.md) | | -| [zero](./decimal.decimal.zero.md) | | this \| undefined | | -| [ZERO](./decimal.decimal.zero.md) | static | [Decimal](./decimal.decimal.md) | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [add(addend)](./decimal.decimal.add.md) | | | -| [div(divider)](./decimal.decimal.div.md) | | | -| [eq(that)](./decimal.decimal.eq.md) | | | -| [from(decimalish)](./decimal.decimal.from.md) | static | | -| [fromBigNumberString(bigNumberString)](./decimal.decimal.frombignumberstring.md) | static | | -| [gt(that)](./decimal.decimal.gt.md) | | | -| [gte(that)](./decimal.decimal.gte.md) | | | -| [lt(that)](./decimal.decimal.lt.md) | | | -| [lte(that)](./decimal.decimal.lte.md) | | | -| [max(a, b)](./decimal.decimal.max.md) | static | | -| [min(a, b)](./decimal.decimal.min.md) | static | | -| [mul(multiplier)](./decimal.decimal.mul.md) | | | -| [mulDiv(multiplier, divider)](./decimal.decimal.muldiv.md) | | | -| [pow(exponent)](./decimal.decimal.pow.md) | | | -| [prettify(precision)](./decimal.decimal.prettify.md) | | | -| [shorten()](./decimal.decimal.shorten.md) | | | -| [sub(subtrahend)](./decimal.decimal.sub.md) | | | -| [toString(precision)](./decimal.decimal.tostring.md) | | | - diff --git a/docs/sdk/decimal.md b/docs/sdk/decimal.md deleted file mode 100644 index b72442341..000000000 --- a/docs/sdk/decimal.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@liquity/decimal](./decimal.md) - -## decimal package - -## Classes - -| Class | Description | -| --- | --- | -| [Decimal](./decimal.decimal.md) | Fixed-point decimal bignumber with 18 digits of precision. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [Decimalish](./decimal.decimalish.md) | Types that can be converted into a Decimal. | - diff --git a/docs/sdk/index.md b/docs/sdk/index.md index cf12e5cd0..ca0268cfe 100644 --- a/docs/sdk/index.md +++ b/docs/sdk/index.md @@ -8,7 +8,6 @@ | Package | Description | | --- | --- | -| [@liquity/decimal](./decimal.md) | | | [@liquity/lib-base](./lib-base.md) | | | [@liquity/lib-ethers](./lib-ethers.md) | | diff --git a/docs/sdk/decimal.decimal.add.md b/docs/sdk/lib-base.decimal.add.md similarity index 54% rename from docs/sdk/decimal.decimal.add.md rename to docs/sdk/lib-base.decimal.add.md index 0cd9331b8..36d7f23ef 100644 --- a/docs/sdk/decimal.decimal.add.md +++ b/docs/sdk/lib-base.decimal.add.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [add](./decimal.decimal.add.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [add](./lib-base.decimal.add.md) ## Decimal.add() method @@ -14,9 +14,9 @@ add(addend: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| addend | [Decimalish](./decimal.decimalish.md) | | +| addend | [Decimalish](./lib-base.decimalish.md) | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/decimal.decimal.div.md b/docs/sdk/lib-base.decimal.div.md similarity index 54% rename from docs/sdk/decimal.decimal.div.md rename to docs/sdk/lib-base.decimal.div.md index 934a7d901..eec84f621 100644 --- a/docs/sdk/decimal.decimal.div.md +++ b/docs/sdk/lib-base.decimal.div.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [div](./decimal.decimal.div.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [div](./lib-base.decimal.div.md) ## Decimal.div() method @@ -14,9 +14,9 @@ div(divider: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| divider | [Decimalish](./decimal.decimalish.md) | | +| divider | [Decimalish](./lib-base.decimalish.md) | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/decimal.decimal.eq.md b/docs/sdk/lib-base.decimal.eq.md similarity index 59% rename from docs/sdk/decimal.decimal.eq.md rename to docs/sdk/lib-base.decimal.eq.md index 5168ea3a5..5f81eceab 100644 --- a/docs/sdk/decimal.decimal.eq.md +++ b/docs/sdk/lib-base.decimal.eq.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [eq](./decimal.decimal.eq.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [eq](./lib-base.decimal.eq.md) ## Decimal.eq() method @@ -14,7 +14,7 @@ eq(that: Decimalish): boolean; | Parameter | Type | Description | | --- | --- | --- | -| that | [Decimalish](./decimal.decimalish.md) | | +| that | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/decimal.decimal.finite.md b/docs/sdk/lib-base.decimal.finite.md similarity index 56% rename from docs/sdk/decimal.decimal.finite.md rename to docs/sdk/lib-base.decimal.finite.md index feede3c31..1b36a16a0 100644 --- a/docs/sdk/decimal.decimal.finite.md +++ b/docs/sdk/lib-base.decimal.finite.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [finite](./decimal.decimal.finite.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [finite](./lib-base.decimal.finite.md) ## Decimal.finite property diff --git a/docs/sdk/decimal.decimal.from.md b/docs/sdk/lib-base.decimal.from.md similarity index 55% rename from docs/sdk/decimal.decimal.from.md rename to docs/sdk/lib-base.decimal.from.md index 777510988..78c3916b1 100644 --- a/docs/sdk/decimal.decimal.from.md +++ b/docs/sdk/lib-base.decimal.from.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [from](./decimal.decimal.from.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [from](./lib-base.decimal.from.md) ## Decimal.from() method @@ -14,9 +14,9 @@ static from(decimalish: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| decimalish | [Decimalish](./decimal.decimalish.md) | | +| decimalish | [Decimalish](./lib-base.decimalish.md) | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/decimal.decimal.frombignumberstring.md b/docs/sdk/lib-base.decimal.frombignumberstring.md similarity index 63% rename from docs/sdk/decimal.decimal.frombignumberstring.md rename to docs/sdk/lib-base.decimal.frombignumberstring.md index 682d97757..8091756f4 100644 --- a/docs/sdk/decimal.decimal.frombignumberstring.md +++ b/docs/sdk/lib-base.decimal.frombignumberstring.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [fromBigNumberString](./decimal.decimal.frombignumberstring.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [fromBigNumberString](./lib-base.decimal.frombignumberstring.md) ## Decimal.fromBigNumberString() method @@ -18,5 +18,5 @@ static fromBigNumberString(bigNumberString: string): Decimal; Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/decimal.decimal.gt.md b/docs/sdk/lib-base.decimal.gt.md similarity index 59% rename from docs/sdk/decimal.decimal.gt.md rename to docs/sdk/lib-base.decimal.gt.md index e4c016ebc..e0639e1ce 100644 --- a/docs/sdk/decimal.decimal.gt.md +++ b/docs/sdk/lib-base.decimal.gt.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [gt](./decimal.decimal.gt.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [gt](./lib-base.decimal.gt.md) ## Decimal.gt() method @@ -14,7 +14,7 @@ gt(that: Decimalish): boolean; | Parameter | Type | Description | | --- | --- | --- | -| that | [Decimalish](./decimal.decimalish.md) | | +| that | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/decimal.decimal.gte.md b/docs/sdk/lib-base.decimal.gte.md similarity index 59% rename from docs/sdk/decimal.decimal.gte.md rename to docs/sdk/lib-base.decimal.gte.md index e362acdb2..2916c9032 100644 --- a/docs/sdk/decimal.decimal.gte.md +++ b/docs/sdk/lib-base.decimal.gte.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [gte](./decimal.decimal.gte.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [gte](./lib-base.decimal.gte.md) ## Decimal.gte() method @@ -14,7 +14,7 @@ gte(that: Decimalish): boolean; | Parameter | Type | Description | | --- | --- | --- | -| that | [Decimalish](./decimal.decimalish.md) | | +| that | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/decimal.decimal.half.md b/docs/sdk/lib-base.decimal.half.md similarity index 56% rename from docs/sdk/decimal.decimal.half.md rename to docs/sdk/lib-base.decimal.half.md index d7c9f7166..a97f30958 100644 --- a/docs/sdk/decimal.decimal.half.md +++ b/docs/sdk/lib-base.decimal.half.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [HALF](./decimal.decimal.half.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [HALF](./lib-base.decimal.half.md) ## Decimal.HALF property diff --git a/docs/sdk/decimal.decimal.infinite.md b/docs/sdk/lib-base.decimal.infinite.md similarity index 55% rename from docs/sdk/decimal.decimal.infinite.md rename to docs/sdk/lib-base.decimal.infinite.md index 8ce00ade8..42e0f1072 100644 --- a/docs/sdk/decimal.decimal.infinite.md +++ b/docs/sdk/lib-base.decimal.infinite.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [infinite](./decimal.decimal.infinite.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [infinite](./lib-base.decimal.infinite.md) ## Decimal.infinite property diff --git a/docs/sdk/decimal.decimal.infinity.md b/docs/sdk/lib-base.decimal.infinity.md similarity index 56% rename from docs/sdk/decimal.decimal.infinity.md rename to docs/sdk/lib-base.decimal.infinity.md index ab66ececc..4a77e77d7 100644 --- a/docs/sdk/decimal.decimal.infinity.md +++ b/docs/sdk/lib-base.decimal.infinity.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [INFINITY](./decimal.decimal.infinity.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [INFINITY](./lib-base.decimal.infinity.md) ## Decimal.INFINITY property diff --git a/docs/sdk/decimal.decimal.iszero.md b/docs/sdk/lib-base.decimal.iszero.md similarity index 54% rename from docs/sdk/decimal.decimal.iszero.md rename to docs/sdk/lib-base.decimal.iszero.md index f0dd5fcc5..f0ef23ad0 100644 --- a/docs/sdk/decimal.decimal.iszero.md +++ b/docs/sdk/lib-base.decimal.iszero.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [isZero](./decimal.decimal.iszero.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [isZero](./lib-base.decimal.iszero.md) ## Decimal.isZero property diff --git a/docs/sdk/decimal.decimal.lt.md b/docs/sdk/lib-base.decimal.lt.md similarity index 59% rename from docs/sdk/decimal.decimal.lt.md rename to docs/sdk/lib-base.decimal.lt.md index 78b09b264..a201d6ba0 100644 --- a/docs/sdk/decimal.decimal.lt.md +++ b/docs/sdk/lib-base.decimal.lt.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [lt](./decimal.decimal.lt.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [lt](./lib-base.decimal.lt.md) ## Decimal.lt() method @@ -14,7 +14,7 @@ lt(that: Decimalish): boolean; | Parameter | Type | Description | | --- | --- | --- | -| that | [Decimalish](./decimal.decimalish.md) | | +| that | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/decimal.decimal.lte.md b/docs/sdk/lib-base.decimal.lte.md similarity index 59% rename from docs/sdk/decimal.decimal.lte.md rename to docs/sdk/lib-base.decimal.lte.md index f27258e7c..c614ca635 100644 --- a/docs/sdk/decimal.decimal.lte.md +++ b/docs/sdk/lib-base.decimal.lte.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [lte](./decimal.decimal.lte.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [lte](./lib-base.decimal.lte.md) ## Decimal.lte() method @@ -14,7 +14,7 @@ lte(that: Decimalish): boolean; | Parameter | Type | Description | | --- | --- | --- | -| that | [Decimalish](./decimal.decimalish.md) | | +| that | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/decimal.decimal.max.md b/docs/sdk/lib-base.decimal.max.md similarity index 51% rename from docs/sdk/decimal.decimal.max.md rename to docs/sdk/lib-base.decimal.max.md index 6fea37a7d..4f80482d0 100644 --- a/docs/sdk/decimal.decimal.max.md +++ b/docs/sdk/lib-base.decimal.max.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [max](./decimal.decimal.max.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [max](./lib-base.decimal.max.md) ## Decimal.max() method @@ -14,10 +14,10 @@ static max(a: Decimalish, b: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| a | [Decimalish](./decimal.decimalish.md) | | -| b | [Decimalish](./decimal.decimalish.md) | | +| a | [Decimalish](./lib-base.decimalish.md) | | +| b | [Decimalish](./lib-base.decimalish.md) | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/lib-base.decimal.md b/docs/sdk/lib-base.decimal.md new file mode 100644 index 000000000..821adc31f --- /dev/null +++ b/docs/sdk/lib-base.decimal.md @@ -0,0 +1,55 @@ + + +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) + +## Decimal class + +Fixed-point decimal bignumber with 18 digits of precision. + +Signature: + +```typescript +export declare class Decimal +``` + +## Remarks + +Used by Liquity libraries to precisely represent native currency (e.g. Ether), LUSD and LQTY amounts, as well as derived metrics like collateral ratios. + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [finite](./lib-base.decimal.finite.md) | | this \| undefined | | +| [HALF](./lib-base.decimal.half.md) | static | [Decimal](./lib-base.decimal.md) | | +| [infinite](./lib-base.decimal.infinite.md) | | this \| undefined | | +| [INFINITY](./lib-base.decimal.infinity.md) | static | [Decimal](./lib-base.decimal.md) | | +| [isZero](./lib-base.decimal.iszero.md) | | boolean | | +| [nonZero](./lib-base.decimal.nonzero.md) | | this \| undefined | | +| [ONE](./lib-base.decimal.one.md) | static | [Decimal](./lib-base.decimal.md) | | +| [zero](./lib-base.decimal.zero.md) | | this \| undefined | | +| [ZERO](./lib-base.decimal.zero.md) | static | [Decimal](./lib-base.decimal.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [add(addend)](./lib-base.decimal.add.md) | | | +| [div(divider)](./lib-base.decimal.div.md) | | | +| [eq(that)](./lib-base.decimal.eq.md) | | | +| [from(decimalish)](./lib-base.decimal.from.md) | static | | +| [fromBigNumberString(bigNumberString)](./lib-base.decimal.frombignumberstring.md) | static | | +| [gt(that)](./lib-base.decimal.gt.md) | | | +| [gte(that)](./lib-base.decimal.gte.md) | | | +| [lt(that)](./lib-base.decimal.lt.md) | | | +| [lte(that)](./lib-base.decimal.lte.md) | | | +| [max(a, b)](./lib-base.decimal.max.md) | static | | +| [min(a, b)](./lib-base.decimal.min.md) | static | | +| [mul(multiplier)](./lib-base.decimal.mul.md) | | | +| [mulDiv(multiplier, divider)](./lib-base.decimal.muldiv.md) | | | +| [pow(exponent)](./lib-base.decimal.pow.md) | | | +| [prettify(precision)](./lib-base.decimal.prettify.md) | | | +| [shorten()](./lib-base.decimal.shorten.md) | | | +| [sub(subtrahend)](./lib-base.decimal.sub.md) | | | +| [toString(precision)](./lib-base.decimal.tostring.md) | | | + diff --git a/docs/sdk/decimal.decimal.min.md b/docs/sdk/lib-base.decimal.min.md similarity index 51% rename from docs/sdk/decimal.decimal.min.md rename to docs/sdk/lib-base.decimal.min.md index a9a9a1023..746564f34 100644 --- a/docs/sdk/decimal.decimal.min.md +++ b/docs/sdk/lib-base.decimal.min.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [min](./decimal.decimal.min.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [min](./lib-base.decimal.min.md) ## Decimal.min() method @@ -14,10 +14,10 @@ static min(a: Decimalish, b: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| a | [Decimalish](./decimal.decimalish.md) | | -| b | [Decimalish](./decimal.decimalish.md) | | +| a | [Decimalish](./lib-base.decimalish.md) | | +| b | [Decimalish](./lib-base.decimalish.md) | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/decimal.decimal.mul.md b/docs/sdk/lib-base.decimal.mul.md similarity index 54% rename from docs/sdk/decimal.decimal.mul.md rename to docs/sdk/lib-base.decimal.mul.md index b8b514b62..bf69f3cae 100644 --- a/docs/sdk/decimal.decimal.mul.md +++ b/docs/sdk/lib-base.decimal.mul.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [mul](./decimal.decimal.mul.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [mul](./lib-base.decimal.mul.md) ## Decimal.mul() method @@ -14,9 +14,9 @@ mul(multiplier: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| multiplier | [Decimalish](./decimal.decimalish.md) | | +| multiplier | [Decimalish](./lib-base.decimalish.md) | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/decimal.decimal.muldiv.md b/docs/sdk/lib-base.decimal.muldiv.md similarity index 50% rename from docs/sdk/decimal.decimal.muldiv.md rename to docs/sdk/lib-base.decimal.muldiv.md index fa67ad85b..8a6c7c161 100644 --- a/docs/sdk/decimal.decimal.muldiv.md +++ b/docs/sdk/lib-base.decimal.muldiv.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [mulDiv](./decimal.decimal.muldiv.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [mulDiv](./lib-base.decimal.muldiv.md) ## Decimal.mulDiv() method @@ -14,10 +14,10 @@ mulDiv(multiplier: Decimalish, divider: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| multiplier | [Decimalish](./decimal.decimalish.md) | | -| divider | [Decimalish](./decimal.decimalish.md) | | +| multiplier | [Decimalish](./lib-base.decimalish.md) | | +| divider | [Decimalish](./lib-base.decimalish.md) | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/decimal.decimal.nonzero.md b/docs/sdk/lib-base.decimal.nonzero.md similarity index 56% rename from docs/sdk/decimal.decimal.nonzero.md rename to docs/sdk/lib-base.decimal.nonzero.md index 21fe612b8..776523d23 100644 --- a/docs/sdk/decimal.decimal.nonzero.md +++ b/docs/sdk/lib-base.decimal.nonzero.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [nonZero](./decimal.decimal.nonzero.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [nonZero](./lib-base.decimal.nonzero.md) ## Decimal.nonZero property diff --git a/docs/sdk/decimal.decimal.one.md b/docs/sdk/lib-base.decimal.one.md similarity index 56% rename from docs/sdk/decimal.decimal.one.md rename to docs/sdk/lib-base.decimal.one.md index b2c0e8a95..03879cf4a 100644 --- a/docs/sdk/decimal.decimal.one.md +++ b/docs/sdk/lib-base.decimal.one.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [ONE](./decimal.decimal.one.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [ONE](./lib-base.decimal.one.md) ## Decimal.ONE property diff --git a/docs/sdk/decimal.decimal.pow.md b/docs/sdk/lib-base.decimal.pow.md similarity index 63% rename from docs/sdk/decimal.decimal.pow.md rename to docs/sdk/lib-base.decimal.pow.md index 12111a407..6b16f94c9 100644 --- a/docs/sdk/decimal.decimal.pow.md +++ b/docs/sdk/lib-base.decimal.pow.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [pow](./decimal.decimal.pow.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [pow](./lib-base.decimal.pow.md) ## Decimal.pow() method @@ -18,5 +18,5 @@ pow(exponent: number): Decimal; Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/decimal.decimal.prettify.md b/docs/sdk/lib-base.decimal.prettify.md similarity index 68% rename from docs/sdk/decimal.decimal.prettify.md rename to docs/sdk/lib-base.decimal.prettify.md index 5ec3d48b5..865c57485 100644 --- a/docs/sdk/decimal.decimal.prettify.md +++ b/docs/sdk/lib-base.decimal.prettify.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [prettify](./decimal.decimal.prettify.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [prettify](./lib-base.decimal.prettify.md) ## Decimal.prettify() method diff --git a/docs/sdk/decimal.decimal.shorten.md b/docs/sdk/lib-base.decimal.shorten.md similarity index 57% rename from docs/sdk/decimal.decimal.shorten.md rename to docs/sdk/lib-base.decimal.shorten.md index a94971e02..af78b619b 100644 --- a/docs/sdk/decimal.decimal.shorten.md +++ b/docs/sdk/lib-base.decimal.shorten.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [shorten](./decimal.decimal.shorten.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [shorten](./lib-base.decimal.shorten.md) ## Decimal.shorten() method diff --git a/docs/sdk/decimal.decimal.sub.md b/docs/sdk/lib-base.decimal.sub.md similarity index 54% rename from docs/sdk/decimal.decimal.sub.md rename to docs/sdk/lib-base.decimal.sub.md index ce7b9fb1e..07a1c9658 100644 --- a/docs/sdk/decimal.decimal.sub.md +++ b/docs/sdk/lib-base.decimal.sub.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [sub](./decimal.decimal.sub.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [sub](./lib-base.decimal.sub.md) ## Decimal.sub() method @@ -14,9 +14,9 @@ sub(subtrahend: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| subtrahend | [Decimalish](./decimal.decimalish.md) | | +| subtrahend | [Decimalish](./lib-base.decimalish.md) | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/decimal.decimal.tostring.md b/docs/sdk/lib-base.decimal.tostring.md similarity index 68% rename from docs/sdk/decimal.decimal.tostring.md rename to docs/sdk/lib-base.decimal.tostring.md index d94c6b177..806d91e6e 100644 --- a/docs/sdk/decimal.decimal.tostring.md +++ b/docs/sdk/lib-base.decimal.tostring.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [toString](./decimal.decimal.tostring.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [toString](./lib-base.decimal.tostring.md) ## Decimal.toString() method diff --git a/docs/sdk/decimal.decimal.zero.md b/docs/sdk/lib-base.decimal.zero.md similarity index 56% rename from docs/sdk/decimal.decimal.zero.md rename to docs/sdk/lib-base.decimal.zero.md index 4b5d91ba5..9f9675bd9 100644 --- a/docs/sdk/decimal.decimal.zero.md +++ b/docs/sdk/lib-base.decimal.zero.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimal](./decimal.decimal.md) > [ZERO](./decimal.decimal.zero.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimal](./lib-base.decimal.md) > [ZERO](./lib-base.decimal.zero.md) ## Decimal.ZERO property diff --git a/docs/sdk/decimal.decimalish.md b/docs/sdk/lib-base.decimalish.md similarity index 61% rename from docs/sdk/decimal.decimalish.md rename to docs/sdk/lib-base.decimalish.md index 7624b3240..d3cf8dbc6 100644 --- a/docs/sdk/decimal.decimalish.md +++ b/docs/sdk/lib-base.decimalish.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@liquity/decimal](./decimal.md) > [Decimalish](./decimal.decimalish.md) +[Home](./index.md) > [@liquity/lib-base](./lib-base.md) > [Decimalish](./lib-base.decimalish.md) ## Decimalish type @@ -11,5 +11,5 @@ Types that can be converted into a Decimal. ```typescript export declare type Decimalish = Decimal | number | string; ``` -References: [Decimal](./decimal.decimal.md) +References: [Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/lib-base.fees.borrowingrate.md b/docs/sdk/lib-base.fees.borrowingrate.md index b2273501f..d3d24da40 100644 --- a/docs/sdk/lib-base.fees.borrowingrate.md +++ b/docs/sdk/lib-base.fees.borrowingrate.md @@ -13,7 +13,7 @@ borrowingRate(): Decimal; ``` Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) ## Remarks diff --git a/docs/sdk/lib-base.fees.redemptionrate.md b/docs/sdk/lib-base.fees.redemptionrate.md index 6fbf21236..c6ff0a2de 100644 --- a/docs/sdk/lib-base.fees.redemptionrate.md +++ b/docs/sdk/lib-base.fees.redemptionrate.md @@ -16,11 +16,11 @@ redemptionRate(redeemedFractionOfSupply?: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| redeemedFractionOfSupply | [Decimalish](./decimal.decimalish.md) | the amount of LUSD being redeemed divided by the total supply | +| redeemedFractionOfSupply | [Decimalish](./lib-base.decimalish.md) | the amount of LUSD being redeemed divided by the total supply | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) ## Remarks diff --git a/docs/sdk/lib-base.frontendstatus.md b/docs/sdk/lib-base.frontendstatus.md index ff9e0539c..130cfedb5 100644 --- a/docs/sdk/lib-base.frontendstatus.md +++ b/docs/sdk/lib-base.frontendstatus.md @@ -16,11 +16,11 @@ export declare type FrontendStatus = { kickbackRate: Decimal; }; ``` -References: [Decimal](./decimal.decimal.md) +References: [Decimal](./lib-base.decimal.md) ## Remarks Returned by the [getFrontendStatus()](./lib-base.readableliquity.getfrontendstatus.md) function. -When `status` is `"registered"`, `kickbackRate` gives the frontend's kickback rate as a [Decimal](./decimal.decimal.md) between 0 and 1. +When `status` is `"registered"`, `kickbackRate` gives the frontend's kickback rate as a [Decimal](./lib-base.decimal.md) between 0 and 1. diff --git a/docs/sdk/lib-base.liquidationdetails.md b/docs/sdk/lib-base.liquidationdetails.md index 046e6ca32..7d19255b1 100644 --- a/docs/sdk/lib-base.liquidationdetails.md +++ b/docs/sdk/lib-base.liquidationdetails.md @@ -16,8 +16,8 @@ export interface LiquidationDetails | Property | Type | Description | | --- | --- | --- | -| [collateralGasCompensation](./lib-base.liquidationdetails.collateralgascompensation.md) | [Decimal](./decimal.decimal.md) | Amount of native currency (e.g. Ether) paid to the liquidator as gas compensation. | +| [collateralGasCompensation](./lib-base.liquidationdetails.collateralgascompensation.md) | [Decimal](./lib-base.decimal.md) | Amount of native currency (e.g. Ether) paid to the liquidator as gas compensation. | | [liquidatedAddresses](./lib-base.liquidationdetails.liquidatedaddresses.md) | string\[\] | Addresses whose Troves were liquidated by the transaction. | -| [lusdGasCompensation](./lib-base.liquidationdetails.lusdgascompensation.md) | [Decimal](./decimal.decimal.md) | Amount of LUSD paid to the liquidator as gas compensation. | +| [lusdGasCompensation](./lib-base.liquidationdetails.lusdgascompensation.md) | [Decimal](./lib-base.decimal.md) | Amount of LUSD paid to the liquidator as gas compensation. | | [totalLiquidated](./lib-base.liquidationdetails.totalliquidated.md) | [Trove](./lib-base.trove.md) | Total collateral liquidated and debt cleared by the transaction. | diff --git a/docs/sdk/lib-base.liquitystorebasestate.md b/docs/sdk/lib-base.liquitystorebasestate.md index 350f18e2e..5ae153525 100644 --- a/docs/sdk/lib-base.liquitystorebasestate.md +++ b/docs/sdk/lib-base.liquitystorebasestate.md @@ -16,20 +16,20 @@ export interface LiquityStoreBaseState | Property | Type | Description | | --- | --- | --- | -| [accountBalance](./lib-base.liquitystorebasestate.accountbalance.md) | [Decimal](./decimal.decimal.md) | User's native currency balance (e.g. Ether). | -| [collateralSurplusBalance](./lib-base.liquitystorebasestate.collateralsurplusbalance.md) | [Decimal](./decimal.decimal.md) | Amount of leftover collateral available for withdrawal to the user. | +| [accountBalance](./lib-base.liquitystorebasestate.accountbalance.md) | [Decimal](./lib-base.decimal.md) | User's native currency balance (e.g. Ether). | +| [collateralSurplusBalance](./lib-base.liquitystorebasestate.collateralsurplusbalance.md) | [Decimal](./lib-base.decimal.md) | Amount of leftover collateral available for withdrawal to the user. | | [fees](./lib-base.liquitystorebasestate.fees.md) | [Fees](./lib-base.fees.md) | Calculator for current fees. | | [frontend](./lib-base.liquitystorebasestate.frontend.md) | [FrontendStatus](./lib-base.frontendstatus.md) | Status of currently used frontend. | -| [lqtyBalance](./lib-base.liquitystorebasestate.lqtybalance.md) | [Decimal](./decimal.decimal.md) | User's LQTY token balance. | +| [lqtyBalance](./lib-base.liquitystorebasestate.lqtybalance.md) | [Decimal](./lib-base.decimal.md) | User's LQTY token balance. | | [lqtyStake](./lib-base.liquitystorebasestate.lqtystake.md) | [LQTYStake](./lib-base.lqtystake.md) | User's LQTY stake. | -| [lusdBalance](./lib-base.liquitystorebasestate.lusdbalance.md) | [Decimal](./decimal.decimal.md) | User's LUSD token balance. | -| [lusdInStabilityPool](./lib-base.liquitystorebasestate.lusdinstabilitypool.md) | [Decimal](./decimal.decimal.md) | Total amount of LUSD currently deposited in the Stability Pool. | +| [lusdBalance](./lib-base.liquitystorebasestate.lusdbalance.md) | [Decimal](./lib-base.decimal.md) | User's LUSD token balance. | +| [lusdInStabilityPool](./lib-base.liquitystorebasestate.lusdinstabilitypool.md) | [Decimal](./lib-base.decimal.md) | Total amount of LUSD currently deposited in the Stability Pool. | | [numberOfTroves](./lib-base.liquitystorebasestate.numberoftroves.md) | number | Number of Troves that are currently open. | | [ownFrontend](./lib-base.liquitystorebasestate.ownfrontend.md) | [FrontendStatus](./lib-base.frontendstatus.md) | Status of user's own frontend. | -| [price](./lib-base.liquitystorebasestate.price.md) | [Decimal](./decimal.decimal.md) | Current price of the native currency (e.g. Ether) in USD. | +| [price](./lib-base.liquitystorebasestate.price.md) | [Decimal](./lib-base.decimal.md) | Current price of the native currency (e.g. Ether) in USD. | | [stabilityDeposit](./lib-base.liquitystorebasestate.stabilitydeposit.md) | [StabilityDeposit](./lib-base.stabilitydeposit.md) | User's stability deposit. | | [total](./lib-base.liquitystorebasestate.total.md) | [Trove](./lib-base.trove.md) | Total collateral and debt in the Liquity system. | | [totalRedistributed](./lib-base.liquitystorebasestate.totalredistributed.md) | [Trove](./lib-base.trove.md) | Total collateral and debt per stake that has been liquidated through redistribution. | -| [totalStakedLQTY](./lib-base.liquitystorebasestate.totalstakedlqty.md) | [Decimal](./decimal.decimal.md) | Total amount of LQTY currently staked. | +| [totalStakedLQTY](./lib-base.liquitystorebasestate.totalstakedlqty.md) | [Decimal](./lib-base.decimal.md) | Total amount of LQTY currently staked. | | [troveBeforeRedistribution](./lib-base.liquitystorebasestate.trovebeforeredistribution.md) | [TroveWithPendingRedistribution](./lib-base.trovewithpendingredistribution.md) | User's Trove in its state after the last direct modification. | diff --git a/docs/sdk/lib-base.liquitystorederivedstate.md b/docs/sdk/lib-base.liquitystorederivedstate.md index 73a34c157..0aefc9325 100644 --- a/docs/sdk/lib-base.liquitystorederivedstate.md +++ b/docs/sdk/lib-base.liquitystorederivedstate.md @@ -16,7 +16,7 @@ export interface LiquityStoreDerivedState | Property | Type | Description | | --- | --- | --- | -| [borrowingRate](./lib-base.liquitystorederivedstate.borrowingrate.md) | [Decimal](./decimal.decimal.md) | Current borrowing rate. | -| [redemptionRate](./lib-base.liquitystorederivedstate.redemptionrate.md) | [Decimal](./decimal.decimal.md) | Current redemption rate. | +| [borrowingRate](./lib-base.liquitystorederivedstate.borrowingrate.md) | [Decimal](./lib-base.decimal.md) | Current borrowing rate. | +| [redemptionRate](./lib-base.liquitystorederivedstate.redemptionrate.md) | [Decimal](./lib-base.decimal.md) | Current redemption rate. | | [trove](./lib-base.liquitystorederivedstate.trove.md) | [Trove](./lib-base.trove.md) | Current state of user's Trove | diff --git a/docs/sdk/lib-base.lqtystake.apply.md b/docs/sdk/lib-base.lqtystake.apply.md index e0152e203..20a555b9a 100644 --- a/docs/sdk/lib-base.lqtystake.apply.md +++ b/docs/sdk/lib-base.lqtystake.apply.md @@ -16,11 +16,11 @@ apply(change: LQTYStakeChange | undefined): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| change | [LQTYStakeChange](./lib-base.lqtystakechange.md)<[Decimalish](./decimal.decimalish.md)> \| undefined | | +| change | [LQTYStakeChange](./lib-base.lqtystakechange.md)<[Decimalish](./lib-base.decimalish.md)> \| undefined | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) The new staked LQTY amount. diff --git a/docs/sdk/lib-base.lqtystake.md b/docs/sdk/lib-base.lqtystake.md index 79a809f57..e6f85db4c 100644 --- a/docs/sdk/lib-base.lqtystake.md +++ b/docs/sdk/lib-base.lqtystake.md @@ -22,10 +22,10 @@ The constructor for this class is marked as internal. Third-party code should no | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [collateralGain](./lib-base.lqtystake.collateralgain.md) | | [Decimal](./decimal.decimal.md) | Collateral gain available to withdraw. | +| [collateralGain](./lib-base.lqtystake.collateralgain.md) | | [Decimal](./lib-base.decimal.md) | Collateral gain available to withdraw. | | [isEmpty](./lib-base.lqtystake.isempty.md) | | boolean | | -| [lusdGain](./lib-base.lqtystake.lusdgain.md) | | [Decimal](./decimal.decimal.md) | LUSD gain available to withdraw. | -| [stakedLQTY](./lib-base.lqtystake.stakedlqty.md) | | [Decimal](./decimal.decimal.md) | The amount of LQTY that's staked. | +| [lusdGain](./lib-base.lqtystake.lusdgain.md) | | [Decimal](./lib-base.decimal.md) | LUSD gain available to withdraw. | +| [stakedLQTY](./lib-base.lqtystake.stakedlqty.md) | | [Decimal](./lib-base.decimal.md) | The amount of LQTY that's staked. | ## Methods diff --git a/docs/sdk/lib-base.lqtystake.whatchanged.md b/docs/sdk/lib-base.lqtystake.whatchanged.md index cd5b05b12..42344953c 100644 --- a/docs/sdk/lib-base.lqtystake.whatchanged.md +++ b/docs/sdk/lib-base.lqtystake.whatchanged.md @@ -16,11 +16,11 @@ whatChanged(thatStakedLQTY: Decimalish): LQTYStakeChange | undefined; | Parameter | Type | Description | | --- | --- | --- | -| thatStakedLQTY | [Decimalish](./decimal.decimalish.md) | | +| thatStakedLQTY | [Decimalish](./lib-base.decimalish.md) | | Returns: -[LQTYStakeChange](./lib-base.lqtystakechange.md)<[Decimal](./decimal.decimal.md)> \| undefined +[LQTYStakeChange](./lib-base.lqtystakechange.md)<[Decimal](./lib-base.decimal.md)> \| undefined An object representing the change, or `undefined` if the staked amounts are equal. diff --git a/docs/sdk/lib-base.md b/docs/sdk/lib-base.md index e9cf75c9a..dcb7a1be5 100644 --- a/docs/sdk/lib-base.md +++ b/docs/sdk/lib-base.md @@ -8,6 +8,7 @@ | Class | Description | | --- | --- | +| [Decimal](./lib-base.decimal.md) | Fixed-point decimal bignumber with 18 digits of precision. | | [Fees](./lib-base.fees.md) | Calculator for fees. | | [LiquityStore](./lib-base.liquitystore.md) | Abstract base class of Liquity data store implementations. | | [LQTYStake](./lib-base.lqtystake.md) | Represents a user's LQTY stake and accrued gains. | @@ -54,6 +55,7 @@ | Type Alias | Description | | --- | --- | +| [Decimalish](./lib-base.decimalish.md) | Types that can be converted into a Decimal. | | [FailedReceipt](./lib-base.failedreceipt.md) | Indicates that the transaction has been mined, but it failed. | | [FrontendStatus](./lib-base.frontendstatus.md) | Represents whether an address has been registered as a Liquity frontend. | | [LiquityReceipt](./lib-base.liquityreceipt.md) | One of either a [PendingReceipt](./lib-base.pendingreceipt.md), a [FailedReceipt](./lib-base.failedreceipt.md) or a [SuccessfulReceipt](./lib-base.successfulreceipt.md). | diff --git a/docs/sdk/lib-base.populatableliquity.adjusttrove.md b/docs/sdk/lib-base.populatableliquity.adjusttrove.md index f769a7af0..0a43273c6 100644 --- a/docs/sdk/lib-base.populatableliquity.adjusttrove.md +++ b/docs/sdk/lib-base.populatableliquity.adjusttrove.md @@ -16,7 +16,7 @@ adjustTrove(params: TroveAdjustmentParams): Promise<[Decimalish](./decimal.decimalish.md)> | Parameters of the adjustment. | +| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./lib-base.decimalish.md)> | Parameters of the adjustment. | Returns: diff --git a/docs/sdk/lib-base.populatableliquity.borrowlusd.md b/docs/sdk/lib-base.populatableliquity.borrowlusd.md index 9a58093c0..319074d24 100644 --- a/docs/sdk/lib-base.populatableliquity.borrowlusd.md +++ b/docs/sdk/lib-base.populatableliquity.borrowlusd.md @@ -16,7 +16,7 @@ borrowLUSD(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.depositcollateral.md b/docs/sdk/lib-base.populatableliquity.depositcollateral.md index aa5d1482a..0421ac52c 100644 --- a/docs/sdk/lib-base.populatableliquity.depositcollateral.md +++ b/docs/sdk/lib-base.populatableliquity.depositcollateral.md @@ -16,7 +16,7 @@ depositCollateral(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.depositlusdinstabilitypool.md b/docs/sdk/lib-base.populatableliquity.depositlusdinstabilitypool.md index 6e3cfd4cd..bfea18782 100644 --- a/docs/sdk/lib-base.populatableliquity.depositlusdinstabilitypool.md +++ b/docs/sdk/lib-base.populatableliquity.depositlusdinstabilitypool.md @@ -16,7 +16,7 @@ depositLUSDInStabilityPool(amount: Decimalish, frontendTag?: string): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.opentrove.md b/docs/sdk/lib-base.populatableliquity.opentrove.md index 225a62004..47518bfae 100644 --- a/docs/sdk/lib-base.populatableliquity.opentrove.md +++ b/docs/sdk/lib-base.populatableliquity.opentrove.md @@ -16,7 +16,7 @@ openTrove(params: TroveCreationParams): Promise<[Decimalish](./decimal.decimalish.md)> | How much to deposit and borrow. | +| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./lib-base.decimalish.md)> | How much to deposit and borrow. | Returns: diff --git a/docs/sdk/lib-base.populatableliquity.redeemlusd.md b/docs/sdk/lib-base.populatableliquity.redeemlusd.md index 4cfe9adb7..80146d879 100644 --- a/docs/sdk/lib-base.populatableliquity.redeemlusd.md +++ b/docs/sdk/lib-base.populatableliquity.redeemlusd.md @@ -16,7 +16,7 @@ redeemLUSD(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.registerfrontend.md b/docs/sdk/lib-base.populatableliquity.registerfrontend.md index 73e68bc6d..82414ac0d 100644 --- a/docs/sdk/lib-base.populatableliquity.registerfrontend.md +++ b/docs/sdk/lib-base.populatableliquity.registerfrontend.md @@ -16,7 +16,7 @@ registerFrontend(kickbackRate: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.repaylusd.md b/docs/sdk/lib-base.populatableliquity.repaylusd.md index 1e4fde48d..0b4d2067d 100644 --- a/docs/sdk/lib-base.populatableliquity.repaylusd.md +++ b/docs/sdk/lib-base.populatableliquity.repaylusd.md @@ -16,7 +16,7 @@ repayLUSD(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.sendlqty.md b/docs/sdk/lib-base.populatableliquity.sendlqty.md index cb69ac678..565bc36f1 100644 --- a/docs/sdk/lib-base.populatableliquity.sendlqty.md +++ b/docs/sdk/lib-base.populatableliquity.sendlqty.md @@ -17,7 +17,7 @@ sendLQTY(toAddress: string, amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.sendlusd.md b/docs/sdk/lib-base.populatableliquity.sendlusd.md index 0923e4298..6126fe8e3 100644 --- a/docs/sdk/lib-base.populatableliquity.sendlusd.md +++ b/docs/sdk/lib-base.populatableliquity.sendlusd.md @@ -17,7 +17,7 @@ sendLUSD(toAddress: string, amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.stakelqty.md b/docs/sdk/lib-base.populatableliquity.stakelqty.md index 06d79f469..f9fd07e64 100644 --- a/docs/sdk/lib-base.populatableliquity.stakelqty.md +++ b/docs/sdk/lib-base.populatableliquity.stakelqty.md @@ -16,7 +16,7 @@ stakeLQTY(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.unstakelqty.md b/docs/sdk/lib-base.populatableliquity.unstakelqty.md index ce9e5b7e5..1bfa1f3a9 100644 --- a/docs/sdk/lib-base.populatableliquity.unstakelqty.md +++ b/docs/sdk/lib-base.populatableliquity.unstakelqty.md @@ -16,7 +16,7 @@ unstakeLQTY(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.withdrawcollateral.md b/docs/sdk/lib-base.populatableliquity.withdrawcollateral.md index 448b45ff3..a03d3d9c1 100644 --- a/docs/sdk/lib-base.populatableliquity.withdrawcollateral.md +++ b/docs/sdk/lib-base.populatableliquity.withdrawcollateral.md @@ -16,7 +16,7 @@ withdrawCollateral(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.populatableliquity.withdrawlusdfromstabilitypool.md b/docs/sdk/lib-base.populatableliquity.withdrawlusdfromstabilitypool.md index 0cba9ef21..6a5060937 100644 --- a/docs/sdk/lib-base.populatableliquity.withdrawlusdfromstabilitypool.md +++ b/docs/sdk/lib-base.populatableliquity.withdrawlusdfromstabilitypool.md @@ -16,7 +16,7 @@ withdrawLUSDFromStabilityPool(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.readableliquity.getcollateralsurplusbalance.md b/docs/sdk/lib-base.readableliquity.getcollateralsurplusbalance.md index 798ebc34a..cb9af87cf 100644 --- a/docs/sdk/lib-base.readableliquity.getcollateralsurplusbalance.md +++ b/docs/sdk/lib-base.readableliquity.getcollateralsurplusbalance.md @@ -20,7 +20,7 @@ getCollateralSurplusBalance(address?: string): Promise; Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> ## Remarks diff --git a/docs/sdk/lib-base.readableliquity.getlqtybalance.md b/docs/sdk/lib-base.readableliquity.getlqtybalance.md index bb8ecfcde..25a7f0e4d 100644 --- a/docs/sdk/lib-base.readableliquity.getlqtybalance.md +++ b/docs/sdk/lib-base.readableliquity.getlqtybalance.md @@ -20,5 +20,5 @@ getLQTYBalance(address?: string): Promise; Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-base.readableliquity.getlusdbalance.md b/docs/sdk/lib-base.readableliquity.getlusdbalance.md index 96c4b9d06..3340d4875 100644 --- a/docs/sdk/lib-base.readableliquity.getlusdbalance.md +++ b/docs/sdk/lib-base.readableliquity.getlusdbalance.md @@ -20,5 +20,5 @@ getLUSDBalance(address?: string): Promise; Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-base.readableliquity.getlusdinstabilitypool.md b/docs/sdk/lib-base.readableliquity.getlusdinstabilitypool.md index ea2b390d5..e60f654b4 100644 --- a/docs/sdk/lib-base.readableliquity.getlusdinstabilitypool.md +++ b/docs/sdk/lib-base.readableliquity.getlusdinstabilitypool.md @@ -13,5 +13,5 @@ getLUSDInStabilityPool(): Promise; ``` Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-base.readableliquity.getprice.md b/docs/sdk/lib-base.readableliquity.getprice.md index e73c470cd..1fa031f01 100644 --- a/docs/sdk/lib-base.readableliquity.getprice.md +++ b/docs/sdk/lib-base.readableliquity.getprice.md @@ -13,5 +13,5 @@ getPrice(): Promise; ``` Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-base.readableliquity.gettotalstakedlqty.md b/docs/sdk/lib-base.readableliquity.gettotalstakedlqty.md index 7971c360f..e338a679d 100644 --- a/docs/sdk/lib-base.readableliquity.gettotalstakedlqty.md +++ b/docs/sdk/lib-base.readableliquity.gettotalstakedlqty.md @@ -13,5 +13,5 @@ getTotalStakedLQTY(): Promise; ``` Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-base.redemptiondetails.md b/docs/sdk/lib-base.redemptiondetails.md index 70b37a1ac..5d60f61b5 100644 --- a/docs/sdk/lib-base.redemptiondetails.md +++ b/docs/sdk/lib-base.redemptiondetails.md @@ -16,8 +16,8 @@ export interface RedemptionDetails | Property | Type | Description | | --- | --- | --- | -| [actualLUSDAmount](./lib-base.redemptiondetails.actuallusdamount.md) | [Decimal](./decimal.decimal.md) | Amount of LUSD that was actually redeemed by the transaction. | -| [attemptedLUSDAmount](./lib-base.redemptiondetails.attemptedlusdamount.md) | [Decimal](./decimal.decimal.md) | Amount of LUSD the redeemer tried to redeem. | -| [collateralTaken](./lib-base.redemptiondetails.collateraltaken.md) | [Decimal](./decimal.decimal.md) | Amount of collateral (e.g. Ether) taken from Troves by the transaction. | -| [fee](./lib-base.redemptiondetails.fee.md) | [Decimal](./decimal.decimal.md) | Amount of native currency (e.g. Ether) deducted as fee from collateral taken. | +| [actualLUSDAmount](./lib-base.redemptiondetails.actuallusdamount.md) | [Decimal](./lib-base.decimal.md) | Amount of LUSD that was actually redeemed by the transaction. | +| [attemptedLUSDAmount](./lib-base.redemptiondetails.attemptedlusdamount.md) | [Decimal](./lib-base.decimal.md) | Amount of LUSD the redeemer tried to redeem. | +| [collateralTaken](./lib-base.redemptiondetails.collateraltaken.md) | [Decimal](./lib-base.decimal.md) | Amount of collateral (e.g. Ether) taken from Troves by the transaction. | +| [fee](./lib-base.redemptiondetails.fee.md) | [Decimal](./lib-base.decimal.md) | Amount of native currency (e.g. Ether) deducted as fee from collateral taken. | diff --git a/docs/sdk/lib-base.sendableliquity.adjusttrove.md b/docs/sdk/lib-base.sendableliquity.adjusttrove.md index fe956f013..61fff3a54 100644 --- a/docs/sdk/lib-base.sendableliquity.adjusttrove.md +++ b/docs/sdk/lib-base.sendableliquity.adjusttrove.md @@ -16,7 +16,7 @@ adjustTrove(params: TroveAdjustmentParams): Promise<[Decimalish](./decimal.decimalish.md)> | Parameters of the adjustment. | +| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./lib-base.decimalish.md)> | Parameters of the adjustment. | Returns: diff --git a/docs/sdk/lib-base.sendableliquity.borrowlusd.md b/docs/sdk/lib-base.sendableliquity.borrowlusd.md index bc1f80899..8a02ed6af 100644 --- a/docs/sdk/lib-base.sendableliquity.borrowlusd.md +++ b/docs/sdk/lib-base.sendableliquity.borrowlusd.md @@ -16,7 +16,7 @@ borrowLUSD(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.depositcollateral.md b/docs/sdk/lib-base.sendableliquity.depositcollateral.md index 8e73048a8..4661ecfbd 100644 --- a/docs/sdk/lib-base.sendableliquity.depositcollateral.md +++ b/docs/sdk/lib-base.sendableliquity.depositcollateral.md @@ -16,7 +16,7 @@ depositCollateral(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.depositlusdinstabilitypool.md b/docs/sdk/lib-base.sendableliquity.depositlusdinstabilitypool.md index 413b07ff3..bd6afdc65 100644 --- a/docs/sdk/lib-base.sendableliquity.depositlusdinstabilitypool.md +++ b/docs/sdk/lib-base.sendableliquity.depositlusdinstabilitypool.md @@ -16,7 +16,7 @@ depositLUSDInStabilityPool(amount: Decimalish, frontendTag?: string): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.opentrove.md b/docs/sdk/lib-base.sendableliquity.opentrove.md index b9e3b4d64..dfd519c64 100644 --- a/docs/sdk/lib-base.sendableliquity.opentrove.md +++ b/docs/sdk/lib-base.sendableliquity.opentrove.md @@ -16,7 +16,7 @@ openTrove(params: TroveCreationParams): Promise<[Decimalish](./decimal.decimalish.md)> | How much to deposit and borrow. | +| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./lib-base.decimalish.md)> | How much to deposit and borrow. | Returns: diff --git a/docs/sdk/lib-base.sendableliquity.redeemlusd.md b/docs/sdk/lib-base.sendableliquity.redeemlusd.md index 9a70ac249..9a38fac39 100644 --- a/docs/sdk/lib-base.sendableliquity.redeemlusd.md +++ b/docs/sdk/lib-base.sendableliquity.redeemlusd.md @@ -16,7 +16,7 @@ redeemLUSD(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.registerfrontend.md b/docs/sdk/lib-base.sendableliquity.registerfrontend.md index e8a89718e..567899011 100644 --- a/docs/sdk/lib-base.sendableliquity.registerfrontend.md +++ b/docs/sdk/lib-base.sendableliquity.registerfrontend.md @@ -16,7 +16,7 @@ registerFrontend(kickbackRate: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.repaylusd.md b/docs/sdk/lib-base.sendableliquity.repaylusd.md index 99d3e9bed..e91eb8089 100644 --- a/docs/sdk/lib-base.sendableliquity.repaylusd.md +++ b/docs/sdk/lib-base.sendableliquity.repaylusd.md @@ -16,7 +16,7 @@ repayLUSD(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.sendlqty.md b/docs/sdk/lib-base.sendableliquity.sendlqty.md index 42aefd398..fff71f2e4 100644 --- a/docs/sdk/lib-base.sendableliquity.sendlqty.md +++ b/docs/sdk/lib-base.sendableliquity.sendlqty.md @@ -17,7 +17,7 @@ sendLQTY(toAddress: string, amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.sendlusd.md b/docs/sdk/lib-base.sendableliquity.sendlusd.md index ab105f5b6..4bdca421d 100644 --- a/docs/sdk/lib-base.sendableliquity.sendlusd.md +++ b/docs/sdk/lib-base.sendableliquity.sendlusd.md @@ -17,7 +17,7 @@ sendLUSD(toAddress: string, amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.stakelqty.md b/docs/sdk/lib-base.sendableliquity.stakelqty.md index f393f3014..de5ad54b9 100644 --- a/docs/sdk/lib-base.sendableliquity.stakelqty.md +++ b/docs/sdk/lib-base.sendableliquity.stakelqty.md @@ -16,7 +16,7 @@ stakeLQTY(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.unstakelqty.md b/docs/sdk/lib-base.sendableliquity.unstakelqty.md index ad24ccfdf..c8487cd26 100644 --- a/docs/sdk/lib-base.sendableliquity.unstakelqty.md +++ b/docs/sdk/lib-base.sendableliquity.unstakelqty.md @@ -16,7 +16,7 @@ unstakeLQTY(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.withdrawcollateral.md b/docs/sdk/lib-base.sendableliquity.withdrawcollateral.md index 457c0c599..aaedb5003 100644 --- a/docs/sdk/lib-base.sendableliquity.withdrawcollateral.md +++ b/docs/sdk/lib-base.sendableliquity.withdrawcollateral.md @@ -16,7 +16,7 @@ withdrawCollateral(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.sendableliquity.withdrawlusdfromstabilitypool.md b/docs/sdk/lib-base.sendableliquity.withdrawlusdfromstabilitypool.md index 4963d05b7..a7ffb3a86 100644 --- a/docs/sdk/lib-base.sendableliquity.withdrawlusdfromstabilitypool.md +++ b/docs/sdk/lib-base.sendableliquity.withdrawlusdfromstabilitypool.md @@ -16,7 +16,7 @@ withdrawLUSDFromStabilityPool(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.stabilitydeposit.apply.md b/docs/sdk/lib-base.stabilitydeposit.apply.md index 31cd8f323..29e6fdb51 100644 --- a/docs/sdk/lib-base.stabilitydeposit.apply.md +++ b/docs/sdk/lib-base.stabilitydeposit.apply.md @@ -16,11 +16,11 @@ apply(change: StabilityDepositChange | undefined): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| change | [StabilityDepositChange](./lib-base.stabilitydepositchange.md)<[Decimalish](./decimal.decimalish.md)> \| undefined | | +| change | [StabilityDepositChange](./lib-base.stabilitydepositchange.md)<[Decimalish](./lib-base.decimalish.md)> \| undefined | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) The new deposited LUSD amount. diff --git a/docs/sdk/lib-base.stabilitydeposit.md b/docs/sdk/lib-base.stabilitydeposit.md index 7aaf81805..e4b157366 100644 --- a/docs/sdk/lib-base.stabilitydeposit.md +++ b/docs/sdk/lib-base.stabilitydeposit.md @@ -20,11 +20,11 @@ The constructor for this class is marked as internal. Third-party code should no | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [collateralGain](./lib-base.stabilitydeposit.collateralgain.md) | | [Decimal](./decimal.decimal.md) | Amount of native currency (e.g. Ether) received in exchange for the used-up LUSD. | -| [currentLUSD](./lib-base.stabilitydeposit.currentlusd.md) | | [Decimal](./decimal.decimal.md) | Amount of LUSD left in the Stability Deposit. | -| [initialLUSD](./lib-base.stabilitydeposit.initiallusd.md) | | [Decimal](./decimal.decimal.md) | Amount of LUSD in the Stability Deposit at the time of the last direct modification. | +| [collateralGain](./lib-base.stabilitydeposit.collateralgain.md) | | [Decimal](./lib-base.decimal.md) | Amount of native currency (e.g. Ether) received in exchange for the used-up LUSD. | +| [currentLUSD](./lib-base.stabilitydeposit.currentlusd.md) | | [Decimal](./lib-base.decimal.md) | Amount of LUSD left in the Stability Deposit. | +| [initialLUSD](./lib-base.stabilitydeposit.initiallusd.md) | | [Decimal](./lib-base.decimal.md) | Amount of LUSD in the Stability Deposit at the time of the last direct modification. | | [isEmpty](./lib-base.stabilitydeposit.isempty.md) | | boolean | | -| [lqtyReward](./lib-base.stabilitydeposit.lqtyreward.md) | | [Decimal](./decimal.decimal.md) | Amount of LQTY rewarded since the last modification of the Stability Deposit. | +| [lqtyReward](./lib-base.stabilitydeposit.lqtyreward.md) | | [Decimal](./lib-base.decimal.md) | Amount of LQTY rewarded since the last modification of the Stability Deposit. | ## Methods diff --git a/docs/sdk/lib-base.stabilitydeposit.whatchanged.md b/docs/sdk/lib-base.stabilitydeposit.whatchanged.md index ad6386c78..ed2825ef5 100644 --- a/docs/sdk/lib-base.stabilitydeposit.whatchanged.md +++ b/docs/sdk/lib-base.stabilitydeposit.whatchanged.md @@ -16,11 +16,11 @@ whatChanged(thatLUSD: Decimalish): StabilityDepositChange | undefined; | Parameter | Type | Description | | --- | --- | --- | -| thatLUSD | [Decimalish](./decimal.decimalish.md) | | +| thatLUSD | [Decimalish](./lib-base.decimalish.md) | | Returns: -[StabilityDepositChange](./lib-base.stabilitydepositchange.md)<[Decimal](./decimal.decimal.md)> \| undefined +[StabilityDepositChange](./lib-base.stabilitydepositchange.md)<[Decimal](./lib-base.decimal.md)> \| undefined An object representing the change, or `undefined` if the deposited amounts are equal. diff --git a/docs/sdk/lib-base.stabilitydepositchangedetails.md b/docs/sdk/lib-base.stabilitydepositchangedetails.md index 4762f885b..c9281cf0b 100644 --- a/docs/sdk/lib-base.stabilitydepositchangedetails.md +++ b/docs/sdk/lib-base.stabilitydepositchangedetails.md @@ -17,5 +17,5 @@ export interface StabilityDepositChangeDetails extends StabilityPoolGainsWithdra | Property | Type | Description | | --- | --- | --- | -| [change](./lib-base.stabilitydepositchangedetails.change.md) | [StabilityDepositChange](./lib-base.stabilitydepositchange.md)<[Decimal](./decimal.decimal.md)> | Change that was made to the deposit by this transaction. | +| [change](./lib-base.stabilitydepositchangedetails.change.md) | [StabilityDepositChange](./lib-base.stabilitydepositchange.md)<[Decimal](./lib-base.decimal.md)> | Change that was made to the deposit by this transaction. | diff --git a/docs/sdk/lib-base.stabilitypoolgainswithdrawaldetails.md b/docs/sdk/lib-base.stabilitypoolgainswithdrawaldetails.md index cfefa142a..4a8376a04 100644 --- a/docs/sdk/lib-base.stabilitypoolgainswithdrawaldetails.md +++ b/docs/sdk/lib-base.stabilitypoolgainswithdrawaldetails.md @@ -16,8 +16,8 @@ export interface StabilityPoolGainsWithdrawalDetails | Property | Type | Description | | --- | --- | --- | -| [collateralGain](./lib-base.stabilitypoolgainswithdrawaldetails.collateralgain.md) | [Decimal](./decimal.decimal.md) | Amount of native currency (e.g. Ether) paid out to the depositor in this transaction. | -| [lqtyReward](./lib-base.stabilitypoolgainswithdrawaldetails.lqtyreward.md) | [Decimal](./decimal.decimal.md) | Amount of LQTY rewarded to the depositor in this transaction. | -| [lusdLoss](./lib-base.stabilitypoolgainswithdrawaldetails.lusdloss.md) | [Decimal](./decimal.decimal.md) | Amount of LUSD burned from the deposit by liquidations since the last modification. | -| [newLUSDDeposit](./lib-base.stabilitypoolgainswithdrawaldetails.newlusddeposit.md) | [Decimal](./decimal.decimal.md) | Amount of LUSD in the deposit directly after this transaction. | +| [collateralGain](./lib-base.stabilitypoolgainswithdrawaldetails.collateralgain.md) | [Decimal](./lib-base.decimal.md) | Amount of native currency (e.g. Ether) paid out to the depositor in this transaction. | +| [lqtyReward](./lib-base.stabilitypoolgainswithdrawaldetails.lqtyreward.md) | [Decimal](./lib-base.decimal.md) | Amount of LQTY rewarded to the depositor in this transaction. | +| [lusdLoss](./lib-base.stabilitypoolgainswithdrawaldetails.lusdloss.md) | [Decimal](./lib-base.decimal.md) | Amount of LUSD burned from the deposit by liquidations since the last modification. | +| [newLUSDDeposit](./lib-base.stabilitypoolgainswithdrawaldetails.newlusddeposit.md) | [Decimal](./lib-base.decimal.md) | Amount of LUSD in the deposit directly after this transaction. | diff --git a/docs/sdk/lib-base.transactableliquity.adjusttrove.md b/docs/sdk/lib-base.transactableliquity.adjusttrove.md index e514f086b..dee123fc7 100644 --- a/docs/sdk/lib-base.transactableliquity.adjusttrove.md +++ b/docs/sdk/lib-base.transactableliquity.adjusttrove.md @@ -16,7 +16,7 @@ adjustTrove(params: TroveAdjustmentParams): Promise<[Decimalish](./decimal.decimalish.md)> | Parameters of the adjustment. | +| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./lib-base.decimalish.md)> | Parameters of the adjustment. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.borrowlusd.md b/docs/sdk/lib-base.transactableliquity.borrowlusd.md index f9395dd74..b02509029 100644 --- a/docs/sdk/lib-base.transactableliquity.borrowlusd.md +++ b/docs/sdk/lib-base.transactableliquity.borrowlusd.md @@ -16,7 +16,7 @@ borrowLUSD(amount: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of LUSD to borrow. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of LUSD to borrow. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.depositcollateral.md b/docs/sdk/lib-base.transactableliquity.depositcollateral.md index 82cac0386..930fa0303 100644 --- a/docs/sdk/lib-base.transactableliquity.depositcollateral.md +++ b/docs/sdk/lib-base.transactableliquity.depositcollateral.md @@ -16,7 +16,7 @@ depositCollateral(amount: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of collateral to add to the Trove's existing collateral. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of collateral to add to the Trove's existing collateral. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.depositlusdinstabilitypool.md b/docs/sdk/lib-base.transactableliquity.depositlusdinstabilitypool.md index 2724e7619..a83f3a3b2 100644 --- a/docs/sdk/lib-base.transactableliquity.depositlusdinstabilitypool.md +++ b/docs/sdk/lib-base.transactableliquity.depositlusdinstabilitypool.md @@ -16,7 +16,7 @@ depositLUSDInStabilityPool(amount: Decimalish, frontendTag?: string): PromiseReturns: diff --git a/docs/sdk/lib-base.transactableliquity.opentrove.md b/docs/sdk/lib-base.transactableliquity.opentrove.md index ecdd0c4fa..39327ce1a 100644 --- a/docs/sdk/lib-base.transactableliquity.opentrove.md +++ b/docs/sdk/lib-base.transactableliquity.opentrove.md @@ -16,7 +16,7 @@ openTrove(params: TroveCreationParams): Promise<[Decimalish](./decimal.decimalish.md)> | How much to deposit and borrow. | +| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./lib-base.decimalish.md)> | How much to deposit and borrow. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.redeemlusd.md b/docs/sdk/lib-base.transactableliquity.redeemlusd.md index 0089c15ac..36d63f9b6 100644 --- a/docs/sdk/lib-base.transactableliquity.redeemlusd.md +++ b/docs/sdk/lib-base.transactableliquity.redeemlusd.md @@ -16,7 +16,7 @@ redeemLUSD(amount: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to be redeemed. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to be redeemed. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.registerfrontend.md b/docs/sdk/lib-base.transactableliquity.registerfrontend.md index 9dfc9fe44..d9672ee31 100644 --- a/docs/sdk/lib-base.transactableliquity.registerfrontend.md +++ b/docs/sdk/lib-base.transactableliquity.registerfrontend.md @@ -16,7 +16,7 @@ registerFrontend(kickbackRate: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | -| kickbackRate | [Decimalish](./decimal.decimalish.md) | The portion of LQTY rewards to pass onto users of the frontend (between 0 and 1). | +| kickbackRate | [Decimalish](./lib-base.decimalish.md) | The portion of LQTY rewards to pass onto users of the frontend (between 0 and 1). | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.repaylusd.md b/docs/sdk/lib-base.transactableliquity.repaylusd.md index 7b3e6fee5..d58f80bf4 100644 --- a/docs/sdk/lib-base.transactableliquity.repaylusd.md +++ b/docs/sdk/lib-base.transactableliquity.repaylusd.md @@ -16,7 +16,7 @@ repayLUSD(amount: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of LUSD to repay. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of LUSD to repay. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.sendlqty.md b/docs/sdk/lib-base.transactableliquity.sendlqty.md index c8210f428..344cff4c1 100644 --- a/docs/sdk/lib-base.transactableliquity.sendlqty.md +++ b/docs/sdk/lib-base.transactableliquity.sendlqty.md @@ -17,7 +17,7 @@ sendLQTY(toAddress: string, amount: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | | toAddress | string | Address of receipient. | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LQTY to send. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LQTY to send. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.sendlusd.md b/docs/sdk/lib-base.transactableliquity.sendlusd.md index 2c6eba26a..74ae68968 100644 --- a/docs/sdk/lib-base.transactableliquity.sendlusd.md +++ b/docs/sdk/lib-base.transactableliquity.sendlusd.md @@ -17,7 +17,7 @@ sendLUSD(toAddress: string, amount: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | | toAddress | string | Address of receipient. | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to send. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to send. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.stakelqty.md b/docs/sdk/lib-base.transactableliquity.stakelqty.md index 68ffa9ad8..dfb90be06 100644 --- a/docs/sdk/lib-base.transactableliquity.stakelqty.md +++ b/docs/sdk/lib-base.transactableliquity.stakelqty.md @@ -16,7 +16,7 @@ stakeLQTY(amount: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LQTY to add to new or existing stake. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LQTY to add to new or existing stake. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.unstakelqty.md b/docs/sdk/lib-base.transactableliquity.unstakelqty.md index c6396ebdf..a25d9c057 100644 --- a/docs/sdk/lib-base.transactableliquity.unstakelqty.md +++ b/docs/sdk/lib-base.transactableliquity.unstakelqty.md @@ -16,7 +16,7 @@ unstakeLQTY(amount: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LQTY to withdraw. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LQTY to withdraw. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.withdrawcollateral.md b/docs/sdk/lib-base.transactableliquity.withdrawcollateral.md index 66e889793..a3d49031d 100644 --- a/docs/sdk/lib-base.transactableliquity.withdrawcollateral.md +++ b/docs/sdk/lib-base.transactableliquity.withdrawcollateral.md @@ -16,7 +16,7 @@ withdrawCollateral(amount: Decimalish): Promise; | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of collateral to withdraw from the Trove. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of collateral to withdraw from the Trove. | Returns: diff --git a/docs/sdk/lib-base.transactableliquity.withdrawlusdfromstabilitypool.md b/docs/sdk/lib-base.transactableliquity.withdrawlusdfromstabilitypool.md index 0f1e7caf3..e95e1cc1b 100644 --- a/docs/sdk/lib-base.transactableliquity.withdrawlusdfromstabilitypool.md +++ b/docs/sdk/lib-base.transactableliquity.withdrawlusdfromstabilitypool.md @@ -16,7 +16,7 @@ withdrawLUSDFromStabilityPool(amount: Decimalish): PromiseReturns: diff --git a/docs/sdk/lib-base.trove.addcollateral.md b/docs/sdk/lib-base.trove.addcollateral.md index 084ced4db..db60904d0 100644 --- a/docs/sdk/lib-base.trove.addcollateral.md +++ b/docs/sdk/lib-base.trove.addcollateral.md @@ -14,7 +14,7 @@ addCollateral(collateral: Decimalish): Trove; | Parameter | Type | Description | | --- | --- | --- | -| collateral | [Decimalish](./decimal.decimalish.md) | | +| collateral | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.adddebt.md b/docs/sdk/lib-base.trove.adddebt.md index 18e2d9065..ef44257ed 100644 --- a/docs/sdk/lib-base.trove.adddebt.md +++ b/docs/sdk/lib-base.trove.adddebt.md @@ -14,7 +14,7 @@ addDebt(debt: Decimalish): Trove; | Parameter | Type | Description | | --- | --- | --- | -| debt | [Decimalish](./decimal.decimalish.md) | | +| debt | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.adjust.md b/docs/sdk/lib-base.trove.adjust.md index b9a83e515..e3d050ea4 100644 --- a/docs/sdk/lib-base.trove.adjust.md +++ b/docs/sdk/lib-base.trove.adjust.md @@ -16,8 +16,8 @@ adjust(params: TroveAdjustmentParams, borrowingRate?: Decimalish): T | Parameter | Type | Description | | --- | --- | --- | -| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./decimal.decimalish.md)> | Parameters of the transaction. | -| borrowingRate | [Decimalish](./decimal.decimalish.md) | Borrowing rate to use when adding to the Trove's debt. | +| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./lib-base.decimalish.md)> | Parameters of the transaction. | +| borrowingRate | [Decimalish](./lib-base.decimalish.md) | Borrowing rate to use when adding to the Trove's debt. | Returns: diff --git a/docs/sdk/lib-base.trove.adjustto.md b/docs/sdk/lib-base.trove.adjustto.md index 4cd6ba2a8..7f42d665b 100644 --- a/docs/sdk/lib-base.trove.adjustto.md +++ b/docs/sdk/lib-base.trove.adjustto.md @@ -17,9 +17,9 @@ adjustTo(that: Trove, borrowingRate?: Decimalish): TroveAdjustmentParamsReturns: -[TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimal](./decimal.decimal.md)> +[TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-base.trove.apply.md b/docs/sdk/lib-base.trove.apply.md index f9946b2f7..41278a420 100644 --- a/docs/sdk/lib-base.trove.apply.md +++ b/docs/sdk/lib-base.trove.apply.md @@ -16,8 +16,8 @@ apply(change: TroveChange | undefined, borrowingRate?: Decimalish): | Parameter | Type | Description | | --- | --- | --- | -| change | [TroveChange](./lib-base.trovechange.md)<[Decimalish](./decimal.decimalish.md)> \| undefined | The change to apply. | -| borrowingRate | [Decimalish](./decimal.decimalish.md) | Borrowing rate to use when adding a borrowed amount to the Trove's debt. | +| change | [TroveChange](./lib-base.trovechange.md)<[Decimalish](./lib-base.decimalish.md)> \| undefined | The change to apply. | +| borrowingRate | [Decimalish](./lib-base.decimalish.md) | Borrowing rate to use when adding a borrowed amount to the Trove's debt. | Returns: diff --git a/docs/sdk/lib-base.trove.collateralratio.md b/docs/sdk/lib-base.trove.collateralratio.md index e97b6913f..40d3a87b6 100644 --- a/docs/sdk/lib-base.trove.collateralratio.md +++ b/docs/sdk/lib-base.trove.collateralratio.md @@ -16,9 +16,9 @@ collateralRatio(price: Decimalish): Decimal; | Parameter | Type | Description | | --- | --- | --- | -| price | [Decimalish](./decimal.decimalish.md) | | +| price | [Decimalish](./lib-base.decimalish.md) | | Returns: -[Decimal](./decimal.decimal.md) +[Decimal](./lib-base.decimal.md) diff --git a/docs/sdk/lib-base.trove.collateralratioisbelowcritical.md b/docs/sdk/lib-base.trove.collateralratioisbelowcritical.md index 71e60c73c..10ff0cd4a 100644 --- a/docs/sdk/lib-base.trove.collateralratioisbelowcritical.md +++ b/docs/sdk/lib-base.trove.collateralratioisbelowcritical.md @@ -16,7 +16,7 @@ collateralRatioIsBelowCritical(price: Decimalish): boolean; | Parameter | Type | Description | | --- | --- | --- | -| price | [Decimalish](./decimal.decimalish.md) | | +| price | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.collateralratioisbelowminimum.md b/docs/sdk/lib-base.trove.collateralratioisbelowminimum.md index 588936902..3cc1eea71 100644 --- a/docs/sdk/lib-base.trove.collateralratioisbelowminimum.md +++ b/docs/sdk/lib-base.trove.collateralratioisbelowminimum.md @@ -16,7 +16,7 @@ collateralRatioIsBelowMinimum(price: Decimalish): boolean; | Parameter | Type | Description | | --- | --- | --- | -| price | [Decimalish](./decimal.decimalish.md) | | +| price | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.create.md b/docs/sdk/lib-base.trove.create.md index 5cedd7246..d9711e423 100644 --- a/docs/sdk/lib-base.trove.create.md +++ b/docs/sdk/lib-base.trove.create.md @@ -16,8 +16,8 @@ static create(params: TroveCreationParams, borrowingRate?: Decimalis | Parameter | Type | Description | | --- | --- | --- | -| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./decimal.decimalish.md)> | Parameters of the transaction. | -| borrowingRate | [Decimalish](./decimal.decimalish.md) | Borrowing rate to use when calculating the Trove's debt. | +| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./lib-base.decimalish.md)> | Parameters of the transaction. | +| borrowingRate | [Decimalish](./lib-base.decimalish.md) | Borrowing rate to use when calculating the Trove's debt. | Returns: diff --git a/docs/sdk/lib-base.trove.isopenableinrecoverymode.md b/docs/sdk/lib-base.trove.isopenableinrecoverymode.md index 39017de2b..7d7d71209 100644 --- a/docs/sdk/lib-base.trove.isopenableinrecoverymode.md +++ b/docs/sdk/lib-base.trove.isopenableinrecoverymode.md @@ -16,7 +16,7 @@ isOpenableInRecoveryMode(price: Decimalish): boolean; | Parameter | Type | Description | | --- | --- | --- | -| price | [Decimalish](./decimal.decimalish.md) | | +| price | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.md b/docs/sdk/lib-base.trove.md index f65a93a1f..208632c00 100644 --- a/docs/sdk/lib-base.trove.md +++ b/docs/sdk/lib-base.trove.md @@ -20,10 +20,10 @@ The constructor for this class is marked as internal. Third-party code should no | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [collateral](./lib-base.trove.collateral.md) | | [Decimal](./decimal.decimal.md) | Amount of native currency (e.g. Ether) collateralized. | -| [debt](./lib-base.trove.debt.md) | | [Decimal](./decimal.decimal.md) | Amount of LUSD owed. | +| [collateral](./lib-base.trove.collateral.md) | | [Decimal](./lib-base.decimal.md) | Amount of native currency (e.g. Ether) collateralized. | +| [debt](./lib-base.trove.debt.md) | | [Decimal](./lib-base.decimal.md) | Amount of LUSD owed. | | [isEmpty](./lib-base.trove.isempty.md) | | boolean | | -| [netDebt](./lib-base.trove.netdebt.md) | | [Decimal](./decimal.decimal.md) | Amount of LUSD that must be repaid to close this Trove. | +| [netDebt](./lib-base.trove.netdebt.md) | | [Decimal](./lib-base.decimal.md) | Amount of LUSD that must be repaid to close this Trove. | ## Methods diff --git a/docs/sdk/lib-base.trove.multiply.md b/docs/sdk/lib-base.trove.multiply.md index 5b48500ca..b632d8e8f 100644 --- a/docs/sdk/lib-base.trove.multiply.md +++ b/docs/sdk/lib-base.trove.multiply.md @@ -14,7 +14,7 @@ multiply(multiplier: Decimalish): Trove; | Parameter | Type | Description | | --- | --- | --- | -| multiplier | [Decimalish](./decimal.decimalish.md) | | +| multiplier | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.recreate.md b/docs/sdk/lib-base.trove.recreate.md index c781f3efc..0e506a554 100644 --- a/docs/sdk/lib-base.trove.recreate.md +++ b/docs/sdk/lib-base.trove.recreate.md @@ -17,9 +17,9 @@ static recreate(that: Trove, borrowingRate?: Decimalish): TroveCreationParamsReturns: -[TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimal](./decimal.decimal.md)> +[TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-base.trove.setcollateral.md b/docs/sdk/lib-base.trove.setcollateral.md index b4eac93ee..64a4d618d 100644 --- a/docs/sdk/lib-base.trove.setcollateral.md +++ b/docs/sdk/lib-base.trove.setcollateral.md @@ -14,7 +14,7 @@ setCollateral(collateral: Decimalish): Trove; | Parameter | Type | Description | | --- | --- | --- | -| collateral | [Decimalish](./decimal.decimalish.md) | | +| collateral | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.setdebt.md b/docs/sdk/lib-base.trove.setdebt.md index 8c9ec89a1..feb15dc14 100644 --- a/docs/sdk/lib-base.trove.setdebt.md +++ b/docs/sdk/lib-base.trove.setdebt.md @@ -14,7 +14,7 @@ setDebt(debt: Decimalish): Trove; | Parameter | Type | Description | | --- | --- | --- | -| debt | [Decimalish](./decimal.decimalish.md) | | +| debt | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.subtractcollateral.md b/docs/sdk/lib-base.trove.subtractcollateral.md index a2de7faf4..0a285d7bb 100644 --- a/docs/sdk/lib-base.trove.subtractcollateral.md +++ b/docs/sdk/lib-base.trove.subtractcollateral.md @@ -14,7 +14,7 @@ subtractCollateral(collateral: Decimalish): Trove; | Parameter | Type | Description | | --- | --- | --- | -| collateral | [Decimalish](./decimal.decimalish.md) | | +| collateral | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.subtractdebt.md b/docs/sdk/lib-base.trove.subtractdebt.md index baa17614e..e2b10cab9 100644 --- a/docs/sdk/lib-base.trove.subtractdebt.md +++ b/docs/sdk/lib-base.trove.subtractdebt.md @@ -14,7 +14,7 @@ subtractDebt(debt: Decimalish): Trove; | Parameter | Type | Description | | --- | --- | --- | -| debt | [Decimalish](./decimal.decimalish.md) | | +| debt | [Decimalish](./lib-base.decimalish.md) | | Returns: diff --git a/docs/sdk/lib-base.trove.whatchanged.md b/docs/sdk/lib-base.trove.whatchanged.md index b9c39f0c8..95cc57315 100644 --- a/docs/sdk/lib-base.trove.whatchanged.md +++ b/docs/sdk/lib-base.trove.whatchanged.md @@ -17,11 +17,11 @@ whatChanged(that: Trove, borrowingRate?: Decimalish): TroveChange | und | Parameter | Type | Description | | --- | --- | --- | | that | [Trove](./lib-base.trove.md) | The other Trove. | -| borrowingRate | [Decimalish](./decimal.decimalish.md) | Borrowing rate to use when calculating a borrowed amount. | +| borrowingRate | [Decimalish](./lib-base.decimalish.md) | Borrowing rate to use when calculating a borrowed amount. | Returns: -[TroveChange](./lib-base.trovechange.md)<[Decimal](./decimal.decimal.md)> \| undefined +[TroveChange](./lib-base.trovechange.md)<[Decimal](./lib-base.decimal.md)> \| undefined An object representing the change, or `undefined` if the Troves are equal. diff --git a/docs/sdk/lib-base.troveadjustmentdetails.md b/docs/sdk/lib-base.troveadjustmentdetails.md index d9568680d..9c6e72fa4 100644 --- a/docs/sdk/lib-base.troveadjustmentdetails.md +++ b/docs/sdk/lib-base.troveadjustmentdetails.md @@ -16,7 +16,7 @@ export interface TroveAdjustmentDetails | Property | Type | Description | | --- | --- | --- | -| [fee](./lib-base.troveadjustmentdetails.fee.md) | [Decimal](./decimal.decimal.md) | Amount of LUSD added to the Trove's debt as borrowing fee. | +| [fee](./lib-base.troveadjustmentdetails.fee.md) | [Decimal](./lib-base.decimal.md) | Amount of LUSD added to the Trove's debt as borrowing fee. | | [newTrove](./lib-base.troveadjustmentdetails.newtrove.md) | [Trove](./lib-base.trove.md) | New state of the adjusted Trove directly after the transaction. | -| [params](./lib-base.troveadjustmentdetails.params.md) | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimal](./decimal.decimal.md)> | Parameters of the adjustment. | +| [params](./lib-base.troveadjustmentdetails.params.md) | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimal](./lib-base.decimal.md)> | Parameters of the adjustment. | diff --git a/docs/sdk/lib-base.troveclosuredetails.md b/docs/sdk/lib-base.troveclosuredetails.md index 70a9e9b25..320968da6 100644 --- a/docs/sdk/lib-base.troveclosuredetails.md +++ b/docs/sdk/lib-base.troveclosuredetails.md @@ -16,5 +16,5 @@ export interface TroveClosureDetails | Property | Type | Description | | --- | --- | --- | -| [params](./lib-base.troveclosuredetails.params.md) | [TroveClosureParams](./lib-base.troveclosureparams.md)<[Decimal](./decimal.decimal.md)> | How much was withdrawn and repaid. | +| [params](./lib-base.troveclosuredetails.params.md) | [TroveClosureParams](./lib-base.troveclosureparams.md)<[Decimal](./lib-base.decimal.md)> | How much was withdrawn and repaid. | diff --git a/docs/sdk/lib-base.trovecreationdetails.md b/docs/sdk/lib-base.trovecreationdetails.md index 407f7c7d2..85df4901c 100644 --- a/docs/sdk/lib-base.trovecreationdetails.md +++ b/docs/sdk/lib-base.trovecreationdetails.md @@ -16,7 +16,7 @@ export interface TroveCreationDetails | Property | Type | Description | | --- | --- | --- | -| [fee](./lib-base.trovecreationdetails.fee.md) | [Decimal](./decimal.decimal.md) | Amount of LUSD added to the Trove's debt as borrowing fee. | +| [fee](./lib-base.trovecreationdetails.fee.md) | [Decimal](./lib-base.decimal.md) | Amount of LUSD added to the Trove's debt as borrowing fee. | | [newTrove](./lib-base.trovecreationdetails.newtrove.md) | [Trove](./lib-base.trove.md) | The Trove that was created by the transaction. | -| [params](./lib-base.trovecreationdetails.params.md) | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimal](./decimal.decimal.md)> | How much was deposited and borrowed. | +| [params](./lib-base.trovecreationdetails.params.md) | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimal](./lib-base.decimal.md)> | How much was deposited and borrowed. | diff --git a/docs/sdk/lib-base.trovewithpendingredistribution._constructor_.md b/docs/sdk/lib-base.trovewithpendingredistribution._constructor_.md index 7b6412bf4..24cda118f 100644 --- a/docs/sdk/lib-base.trovewithpendingredistribution._constructor_.md +++ b/docs/sdk/lib-base.trovewithpendingredistribution._constructor_.md @@ -16,8 +16,8 @@ constructor(collateral?: Decimal, debt?: Decimal, stake?: Decimal, snapshotOfTot | Parameter | Type | Description | | --- | --- | --- | -| collateral | [Decimal](./decimal.decimal.md) | | -| debt | [Decimal](./decimal.decimal.md) | | -| stake | [Decimal](./decimal.decimal.md) | | +| collateral | [Decimal](./lib-base.decimal.md) | | +| debt | [Decimal](./lib-base.decimal.md) | | +| stake | [Decimal](./lib-base.decimal.md) | | | snapshotOfTotalRedistributed | [Trove](./lib-base.trove.md) | | diff --git a/docs/sdk/lib-ethers.ethersliquity.adjusttrove.md b/docs/sdk/lib-ethers.ethersliquity.adjusttrove.md index d983491f3..e180950cd 100644 --- a/docs/sdk/lib-ethers.ethersliquity.adjusttrove.md +++ b/docs/sdk/lib-ethers.ethersliquity.adjusttrove.md @@ -16,7 +16,7 @@ adjustTrove(params: TroveAdjustmentParams, overrides?: EthersTransac | Parameter | Type | Description | | --- | --- | --- | -| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./decimal.decimalish.md)> | Parameters of the adjustment. | +| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./lib-base.decimalish.md)> | Parameters of the adjustment. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.borrowlusd.md b/docs/sdk/lib-ethers.ethersliquity.borrowlusd.md index e9b230678..19ee09bd3 100644 --- a/docs/sdk/lib-ethers.ethersliquity.borrowlusd.md +++ b/docs/sdk/lib-ethers.ethersliquity.borrowlusd.md @@ -16,7 +16,7 @@ borrowLUSD(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise< | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of LUSD to borrow. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of LUSD to borrow. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.depositcollateral.md b/docs/sdk/lib-ethers.ethersliquity.depositcollateral.md index ab9f460de..f3812131e 100644 --- a/docs/sdk/lib-ethers.ethersliquity.depositcollateral.md +++ b/docs/sdk/lib-ethers.ethersliquity.depositcollateral.md @@ -16,7 +16,7 @@ depositCollateral(amount: Decimalish, overrides?: EthersTransactionOverrides): P | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of collateral to add to the Trove's existing collateral. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of collateral to add to the Trove's existing collateral. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.depositlusdinstabilitypool.md b/docs/sdk/lib-ethers.ethersliquity.depositlusdinstabilitypool.md index 30a968129..7c5edc136 100644 --- a/docs/sdk/lib-ethers.ethersliquity.depositlusdinstabilitypool.md +++ b/docs/sdk/lib-ethers.ethersliquity.depositlusdinstabilitypool.md @@ -16,7 +16,7 @@ depositLUSDInStabilityPool(amount: Decimalish, frontendTag?: string, overrides?: | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to add to new or existing deposit. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to add to new or existing deposit. | | frontendTag | string | Address that should receive a share of this deposit's LQTY rewards. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | diff --git a/docs/sdk/lib-ethers.ethersliquity.getcollateralsurplusbalance.md b/docs/sdk/lib-ethers.ethersliquity.getcollateralsurplusbalance.md index 7abbc80fc..c16616c7f 100644 --- a/docs/sdk/lib-ethers.ethersliquity.getcollateralsurplusbalance.md +++ b/docs/sdk/lib-ethers.ethersliquity.getcollateralsurplusbalance.md @@ -21,7 +21,7 @@ getCollateralSurplusBalance(address?: string, overrides?: EthersCallOverrides): Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> ## Remarks diff --git a/docs/sdk/lib-ethers.ethersliquity.getlqtybalance.md b/docs/sdk/lib-ethers.ethersliquity.getlqtybalance.md index b28a7bfa1..8980f17fe 100644 --- a/docs/sdk/lib-ethers.ethersliquity.getlqtybalance.md +++ b/docs/sdk/lib-ethers.ethersliquity.getlqtybalance.md @@ -21,5 +21,5 @@ getLQTYBalance(address?: string, overrides?: EthersCallOverrides): PromiseReturns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.ethersliquity.getlusdbalance.md b/docs/sdk/lib-ethers.ethersliquity.getlusdbalance.md index 71f7bc3e9..7ab7eac13 100644 --- a/docs/sdk/lib-ethers.ethersliquity.getlusdbalance.md +++ b/docs/sdk/lib-ethers.ethersliquity.getlusdbalance.md @@ -21,5 +21,5 @@ getLUSDBalance(address?: string, overrides?: EthersCallOverrides): PromiseReturns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.ethersliquity.getlusdinstabilitypool.md b/docs/sdk/lib-ethers.ethersliquity.getlusdinstabilitypool.md index 854193549..8407d937b 100644 --- a/docs/sdk/lib-ethers.ethersliquity.getlusdinstabilitypool.md +++ b/docs/sdk/lib-ethers.ethersliquity.getlusdinstabilitypool.md @@ -20,5 +20,5 @@ getLUSDInStabilityPool(overrides?: EthersCallOverrides): Promise; Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.ethersliquity.getprice.md b/docs/sdk/lib-ethers.ethersliquity.getprice.md index 01a5f366b..331f7805b 100644 --- a/docs/sdk/lib-ethers.ethersliquity.getprice.md +++ b/docs/sdk/lib-ethers.ethersliquity.getprice.md @@ -20,5 +20,5 @@ getPrice(overrides?: EthersCallOverrides): Promise; Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.ethersliquity.gettotalstakedlqty.md b/docs/sdk/lib-ethers.ethersliquity.gettotalstakedlqty.md index d15b9ff16..5ff125a73 100644 --- a/docs/sdk/lib-ethers.ethersliquity.gettotalstakedlqty.md +++ b/docs/sdk/lib-ethers.ethersliquity.gettotalstakedlqty.md @@ -20,5 +20,5 @@ getTotalStakedLQTY(overrides?: EthersCallOverrides): Promise; Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.ethersliquity.opentrove.md b/docs/sdk/lib-ethers.ethersliquity.opentrove.md index 795af9929..4be6610b6 100644 --- a/docs/sdk/lib-ethers.ethersliquity.opentrove.md +++ b/docs/sdk/lib-ethers.ethersliquity.opentrove.md @@ -16,7 +16,7 @@ openTrove(params: TroveCreationParams, overrides?: EthersTransaction | Parameter | Type | Description | | --- | --- | --- | -| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./decimal.decimalish.md)> | How much to deposit and borrow. | +| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./lib-base.decimalish.md)> | How much to deposit and borrow. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.redeemlusd.md b/docs/sdk/lib-ethers.ethersliquity.redeemlusd.md index 39f4a1000..5cd6c2e8c 100644 --- a/docs/sdk/lib-ethers.ethersliquity.redeemlusd.md +++ b/docs/sdk/lib-ethers.ethersliquity.redeemlusd.md @@ -16,7 +16,7 @@ redeemLUSD(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise< | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to be redeemed. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to be redeemed. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.registerfrontend.md b/docs/sdk/lib-ethers.ethersliquity.registerfrontend.md index 553641a28..7b4b79e67 100644 --- a/docs/sdk/lib-ethers.ethersliquity.registerfrontend.md +++ b/docs/sdk/lib-ethers.ethersliquity.registerfrontend.md @@ -16,7 +16,7 @@ registerFrontend(kickbackRate: Decimalish, overrides?: EthersTransactionOverride | Parameter | Type | Description | | --- | --- | --- | -| kickbackRate | [Decimalish](./decimal.decimalish.md) | The portion of LQTY rewards to pass onto users of the frontend (between 0 and 1). | +| kickbackRate | [Decimalish](./lib-base.decimalish.md) | The portion of LQTY rewards to pass onto users of the frontend (between 0 and 1). | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.repaylusd.md b/docs/sdk/lib-ethers.ethersliquity.repaylusd.md index f938d1158..6f2cca0c7 100644 --- a/docs/sdk/lib-ethers.ethersliquity.repaylusd.md +++ b/docs/sdk/lib-ethers.ethersliquity.repaylusd.md @@ -16,7 +16,7 @@ repayLUSD(amount: Decimalish, overrides?: EthersTransactionOverrides): PromiseReturns: diff --git a/docs/sdk/lib-ethers.ethersliquity.sendlqty.md b/docs/sdk/lib-ethers.ethersliquity.sendlqty.md index a5b9bc6c5..270cf775d 100644 --- a/docs/sdk/lib-ethers.ethersliquity.sendlqty.md +++ b/docs/sdk/lib-ethers.ethersliquity.sendlqty.md @@ -17,7 +17,7 @@ sendLQTY(toAddress: string, amount: Decimalish, overrides?: EthersTransactionOve | Parameter | Type | Description | | --- | --- | --- | | toAddress | string | Address of receipient. | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LQTY to send. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LQTY to send. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.sendlusd.md b/docs/sdk/lib-ethers.ethersliquity.sendlusd.md index c1be21cef..2720931a0 100644 --- a/docs/sdk/lib-ethers.ethersliquity.sendlusd.md +++ b/docs/sdk/lib-ethers.ethersliquity.sendlusd.md @@ -17,7 +17,7 @@ sendLUSD(toAddress: string, amount: Decimalish, overrides?: EthersTransactionOve | Parameter | Type | Description | | --- | --- | --- | | toAddress | string | Address of receipient. | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to send. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to send. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.stakelqty.md b/docs/sdk/lib-ethers.ethersliquity.stakelqty.md index 6c981bc94..d129ce576 100644 --- a/docs/sdk/lib-ethers.ethersliquity.stakelqty.md +++ b/docs/sdk/lib-ethers.ethersliquity.stakelqty.md @@ -16,7 +16,7 @@ stakeLQTY(amount: Decimalish, overrides?: EthersTransactionOverrides): PromiseReturns: diff --git a/docs/sdk/lib-ethers.ethersliquity.unstakelqty.md b/docs/sdk/lib-ethers.ethersliquity.unstakelqty.md index d98c1eced..75f5e2907 100644 --- a/docs/sdk/lib-ethers.ethersliquity.unstakelqty.md +++ b/docs/sdk/lib-ethers.ethersliquity.unstakelqty.md @@ -16,7 +16,7 @@ unstakeLQTY(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LQTY to withdraw. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LQTY to withdraw. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.withdrawcollateral.md b/docs/sdk/lib-ethers.ethersliquity.withdrawcollateral.md index 494586a3c..a0ab24054 100644 --- a/docs/sdk/lib-ethers.ethersliquity.withdrawcollateral.md +++ b/docs/sdk/lib-ethers.ethersliquity.withdrawcollateral.md @@ -16,7 +16,7 @@ withdrawCollateral(amount: Decimalish, overrides?: EthersTransactionOverrides): | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of collateral to withdraw from the Trove. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of collateral to withdraw from the Trove. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.ethersliquity.withdrawlusdfromstabilitypool.md b/docs/sdk/lib-ethers.ethersliquity.withdrawlusdfromstabilitypool.md index eb30d9d81..8f093c109 100644 --- a/docs/sdk/lib-ethers.ethersliquity.withdrawlusdfromstabilitypool.md +++ b/docs/sdk/lib-ethers.ethersliquity.withdrawlusdfromstabilitypool.md @@ -16,7 +16,7 @@ withdrawLUSDFromStabilityPool(amount: Decimalish, overrides?: EthersTransactionO | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to withdraw. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to withdraw. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.adjusttrove.md b/docs/sdk/lib-ethers.populatableethersliquity.adjusttrove.md index 53e5054ec..ee449d597 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.adjusttrove.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.adjusttrove.md @@ -16,7 +16,7 @@ adjustTrove(params: TroveAdjustmentParams, overrides?: EthersTransac | Parameter | Type | Description | | --- | --- | --- | -| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./decimal.decimalish.md)> | Parameters of the adjustment. | +| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./lib-base.decimalish.md)> | Parameters of the adjustment. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.borrowlusd.md b/docs/sdk/lib-ethers.populatableethersliquity.borrowlusd.md index efdff9ee0..b31c11695 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.borrowlusd.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.borrowlusd.md @@ -16,7 +16,7 @@ borrowLUSD(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise< | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of LUSD to borrow. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of LUSD to borrow. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.depositcollateral.md b/docs/sdk/lib-ethers.populatableethersliquity.depositcollateral.md index 2066ed3e4..7a3b34a04 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.depositcollateral.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.depositcollateral.md @@ -16,7 +16,7 @@ depositCollateral(amount: Decimalish, overrides?: EthersTransactionOverrides): P | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of collateral to add to the Trove's existing collateral. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of collateral to add to the Trove's existing collateral. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.depositlusdinstabilitypool.md b/docs/sdk/lib-ethers.populatableethersliquity.depositlusdinstabilitypool.md index d600e4e27..de2de2595 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.depositlusdinstabilitypool.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.depositlusdinstabilitypool.md @@ -16,7 +16,7 @@ depositLUSDInStabilityPool(amount: Decimalish, frontendTag?: string, overrides?: | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to add to new or existing deposit. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to add to new or existing deposit. | | frontendTag | string | Address that should receive a share of this deposit's LQTY rewards. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | diff --git a/docs/sdk/lib-ethers.populatableethersliquity.opentrove.md b/docs/sdk/lib-ethers.populatableethersliquity.opentrove.md index a8f4a1ee8..3725ca867 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.opentrove.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.opentrove.md @@ -16,7 +16,7 @@ openTrove(params: TroveCreationParams, overrides?: EthersTransaction | Parameter | Type | Description | | --- | --- | --- | -| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./decimal.decimalish.md)> | How much to deposit and borrow. | +| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./lib-base.decimalish.md)> | How much to deposit and borrow. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.redeemlusd.md b/docs/sdk/lib-ethers.populatableethersliquity.redeemlusd.md index 6f5a211d4..a52f96cec 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.redeemlusd.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.redeemlusd.md @@ -16,7 +16,7 @@ redeemLUSD(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise< | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to be redeemed. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to be redeemed. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.registerfrontend.md b/docs/sdk/lib-ethers.populatableethersliquity.registerfrontend.md index 672872f72..92dd8c2a9 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.registerfrontend.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.registerfrontend.md @@ -16,7 +16,7 @@ registerFrontend(kickbackRate: Decimalish, overrides?: EthersTransactionOverride | Parameter | Type | Description | | --- | --- | --- | -| kickbackRate | [Decimalish](./decimal.decimalish.md) | The portion of LQTY rewards to pass onto users of the frontend (between 0 and 1). | +| kickbackRate | [Decimalish](./lib-base.decimalish.md) | The portion of LQTY rewards to pass onto users of the frontend (between 0 and 1). | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.repaylusd.md b/docs/sdk/lib-ethers.populatableethersliquity.repaylusd.md index 46c7da8c4..da8425bee 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.repaylusd.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.repaylusd.md @@ -16,7 +16,7 @@ repayLUSD(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise

Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.sendlqty.md b/docs/sdk/lib-ethers.populatableethersliquity.sendlqty.md index 6ce60a820..c086eff51 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.sendlqty.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.sendlqty.md @@ -17,7 +17,7 @@ sendLQTY(toAddress: string, amount: Decimalish, overrides?: EthersTransactionOve | Parameter | Type | Description | | --- | --- | --- | | toAddress | string | Address of receipient. | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LQTY to send. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LQTY to send. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.sendlusd.md b/docs/sdk/lib-ethers.populatableethersliquity.sendlusd.md index cbefd20cb..5120141f0 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.sendlusd.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.sendlusd.md @@ -17,7 +17,7 @@ sendLUSD(toAddress: string, amount: Decimalish, overrides?: EthersTransactionOve | Parameter | Type | Description | | --- | --- | --- | | toAddress | string | Address of receipient. | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to send. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to send. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.stakelqty.md b/docs/sdk/lib-ethers.populatableethersliquity.stakelqty.md index 8ee5402ee..f49b7f599 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.stakelqty.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.stakelqty.md @@ -16,7 +16,7 @@ stakeLQTY(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise

Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.unstakelqty.md b/docs/sdk/lib-ethers.populatableethersliquity.unstakelqty.md index 107472197..45e0964f4 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.unstakelqty.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.unstakelqty.md @@ -16,7 +16,7 @@ unstakeLQTY(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LQTY to withdraw. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LQTY to withdraw. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.withdrawcollateral.md b/docs/sdk/lib-ethers.populatableethersliquity.withdrawcollateral.md index 82d2b901b..8ae9961f2 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.withdrawcollateral.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.withdrawcollateral.md @@ -16,7 +16,7 @@ withdrawCollateral(amount: Decimalish, overrides?: EthersTransactionOverrides): | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of collateral to withdraw from the Trove. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of collateral to withdraw from the Trove. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.populatableethersliquity.withdrawlusdfromstabilitypool.md b/docs/sdk/lib-ethers.populatableethersliquity.withdrawlusdfromstabilitypool.md index 7899a9a8d..5720b25c8 100644 --- a/docs/sdk/lib-ethers.populatableethersliquity.withdrawlusdfromstabilitypool.md +++ b/docs/sdk/lib-ethers.populatableethersliquity.withdrawlusdfromstabilitypool.md @@ -16,7 +16,7 @@ withdrawLUSDFromStabilityPool(amount: Decimalish, overrides?: EthersTransactionO | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to withdraw. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to withdraw. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.readableethersliquity.getcollateralsurplusbalance.md b/docs/sdk/lib-ethers.readableethersliquity.getcollateralsurplusbalance.md index ab29f7e83..227fcf8a8 100644 --- a/docs/sdk/lib-ethers.readableethersliquity.getcollateralsurplusbalance.md +++ b/docs/sdk/lib-ethers.readableethersliquity.getcollateralsurplusbalance.md @@ -21,7 +21,7 @@ getCollateralSurplusBalance(address?: string, overrides?: EthersCallOverrides): Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> ## Remarks diff --git a/docs/sdk/lib-ethers.readableethersliquity.getlqtybalance.md b/docs/sdk/lib-ethers.readableethersliquity.getlqtybalance.md index 5a8ad94a6..4c259d1cf 100644 --- a/docs/sdk/lib-ethers.readableethersliquity.getlqtybalance.md +++ b/docs/sdk/lib-ethers.readableethersliquity.getlqtybalance.md @@ -21,5 +21,5 @@ getLQTYBalance(address?: string, overrides?: EthersCallOverrides): PromiseReturns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.readableethersliquity.getlusdbalance.md b/docs/sdk/lib-ethers.readableethersliquity.getlusdbalance.md index 1f740b307..a795686e1 100644 --- a/docs/sdk/lib-ethers.readableethersliquity.getlusdbalance.md +++ b/docs/sdk/lib-ethers.readableethersliquity.getlusdbalance.md @@ -21,5 +21,5 @@ getLUSDBalance(address?: string, overrides?: EthersCallOverrides): PromiseReturns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.readableethersliquity.getlusdinstabilitypool.md b/docs/sdk/lib-ethers.readableethersliquity.getlusdinstabilitypool.md index 211832f26..07096a561 100644 --- a/docs/sdk/lib-ethers.readableethersliquity.getlusdinstabilitypool.md +++ b/docs/sdk/lib-ethers.readableethersliquity.getlusdinstabilitypool.md @@ -20,5 +20,5 @@ getLUSDInStabilityPool(overrides?: EthersCallOverrides): Promise; Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.readableethersliquity.getprice.md b/docs/sdk/lib-ethers.readableethersliquity.getprice.md index 952de317a..fdae9f8d2 100644 --- a/docs/sdk/lib-ethers.readableethersliquity.getprice.md +++ b/docs/sdk/lib-ethers.readableethersliquity.getprice.md @@ -20,5 +20,5 @@ getPrice(overrides?: EthersCallOverrides): Promise; Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.readableethersliquity.gettotalstakedlqty.md b/docs/sdk/lib-ethers.readableethersliquity.gettotalstakedlqty.md index 7886fdfa3..9129a8a77 100644 --- a/docs/sdk/lib-ethers.readableethersliquity.gettotalstakedlqty.md +++ b/docs/sdk/lib-ethers.readableethersliquity.gettotalstakedlqty.md @@ -20,5 +20,5 @@ getTotalStakedLQTY(overrides?: EthersCallOverrides): Promise; Returns: -Promise<[Decimal](./decimal.decimal.md)> +Promise<[Decimal](./lib-base.decimal.md)> diff --git a/docs/sdk/lib-ethers.sendableethersliquity.adjusttrove.md b/docs/sdk/lib-ethers.sendableethersliquity.adjusttrove.md index 7a49f3ab6..8ab9ac79b 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.adjusttrove.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.adjusttrove.md @@ -16,7 +16,7 @@ adjustTrove(params: TroveAdjustmentParams, overrides?: EthersTransac | Parameter | Type | Description | | --- | --- | --- | -| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./decimal.decimalish.md)> | Parameters of the adjustment. | +| params | [TroveAdjustmentParams](./lib-base.troveadjustmentparams.md)<[Decimalish](./lib-base.decimalish.md)> | Parameters of the adjustment. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.borrowlusd.md b/docs/sdk/lib-ethers.sendableethersliquity.borrowlusd.md index 0a59b0f19..7b4e7fd2d 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.borrowlusd.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.borrowlusd.md @@ -16,7 +16,7 @@ borrowLUSD(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise< | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of LUSD to borrow. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of LUSD to borrow. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.depositcollateral.md b/docs/sdk/lib-ethers.sendableethersliquity.depositcollateral.md index 5a2bcf0ae..942bfcf81 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.depositcollateral.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.depositcollateral.md @@ -16,7 +16,7 @@ depositCollateral(amount: Decimalish, overrides?: EthersTransactionOverrides): P | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of collateral to add to the Trove's existing collateral. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of collateral to add to the Trove's existing collateral. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.depositlusdinstabilitypool.md b/docs/sdk/lib-ethers.sendableethersliquity.depositlusdinstabilitypool.md index b6d99e56c..66c687e69 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.depositlusdinstabilitypool.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.depositlusdinstabilitypool.md @@ -16,7 +16,7 @@ depositLUSDInStabilityPool(amount: Decimalish, frontendTag?: string, overrides?: | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to add to new or existing deposit. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to add to new or existing deposit. | | frontendTag | string | Address that should receive a share of this deposit's LQTY rewards. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | diff --git a/docs/sdk/lib-ethers.sendableethersliquity.opentrove.md b/docs/sdk/lib-ethers.sendableethersliquity.opentrove.md index 0786b3281..cf9ed84a2 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.opentrove.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.opentrove.md @@ -16,7 +16,7 @@ openTrove(params: TroveCreationParams, overrides?: EthersTransaction | Parameter | Type | Description | | --- | --- | --- | -| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./decimal.decimalish.md)> | How much to deposit and borrow. | +| params | [TroveCreationParams](./lib-base.trovecreationparams.md)<[Decimalish](./lib-base.decimalish.md)> | How much to deposit and borrow. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.redeemlusd.md b/docs/sdk/lib-ethers.sendableethersliquity.redeemlusd.md index ac1629de8..c77359882 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.redeemlusd.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.redeemlusd.md @@ -16,7 +16,7 @@ redeemLUSD(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise< | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to be redeemed. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to be redeemed. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.registerfrontend.md b/docs/sdk/lib-ethers.sendableethersliquity.registerfrontend.md index d49ae4407..d6eff162b 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.registerfrontend.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.registerfrontend.md @@ -16,7 +16,7 @@ registerFrontend(kickbackRate: Decimalish, overrides?: EthersTransactionOverride | Parameter | Type | Description | | --- | --- | --- | -| kickbackRate | [Decimalish](./decimal.decimalish.md) | The portion of LQTY rewards to pass onto users of the frontend (between 0 and 1). | +| kickbackRate | [Decimalish](./lib-base.decimalish.md) | The portion of LQTY rewards to pass onto users of the frontend (between 0 and 1). | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.repaylusd.md b/docs/sdk/lib-ethers.sendableethersliquity.repaylusd.md index a87ed9950..785005b0b 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.repaylusd.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.repaylusd.md @@ -16,7 +16,7 @@ repayLUSD(amount: Decimalish, overrides?: EthersTransactionOverrides): PromiseReturns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.sendlqty.md b/docs/sdk/lib-ethers.sendableethersliquity.sendlqty.md index 22ed1ea11..2ba27ca6f 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.sendlqty.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.sendlqty.md @@ -17,7 +17,7 @@ sendLQTY(toAddress: string, amount: Decimalish, overrides?: EthersTransactionOve | Parameter | Type | Description | | --- | --- | --- | | toAddress | string | Address of receipient. | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LQTY to send. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LQTY to send. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.sendlusd.md b/docs/sdk/lib-ethers.sendableethersliquity.sendlusd.md index 8928fae07..0acfe7453 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.sendlusd.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.sendlusd.md @@ -17,7 +17,7 @@ sendLUSD(toAddress: string, amount: Decimalish, overrides?: EthersTransactionOve | Parameter | Type | Description | | --- | --- | --- | | toAddress | string | Address of receipient. | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to send. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to send. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.stakelqty.md b/docs/sdk/lib-ethers.sendableethersliquity.stakelqty.md index 5e33e21d3..57a488ba3 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.stakelqty.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.stakelqty.md @@ -16,7 +16,7 @@ stakeLQTY(amount: Decimalish, overrides?: EthersTransactionOverrides): PromiseReturns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.unstakelqty.md b/docs/sdk/lib-ethers.sendableethersliquity.unstakelqty.md index edaf6514a..dfeb2977b 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.unstakelqty.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.unstakelqty.md @@ -16,7 +16,7 @@ unstakeLQTY(amount: Decimalish, overrides?: EthersTransactionOverrides): Promise | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LQTY to withdraw. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LQTY to withdraw. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.withdrawcollateral.md b/docs/sdk/lib-ethers.sendableethersliquity.withdrawcollateral.md index 936bf3da7..109f435e6 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.withdrawcollateral.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.withdrawcollateral.md @@ -16,7 +16,7 @@ withdrawCollateral(amount: Decimalish, overrides?: EthersTransactionOverrides): | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | The amount of collateral to withdraw from the Trove. | +| amount | [Decimalish](./lib-base.decimalish.md) | The amount of collateral to withdraw from the Trove. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/docs/sdk/lib-ethers.sendableethersliquity.withdrawlusdfromstabilitypool.md b/docs/sdk/lib-ethers.sendableethersliquity.withdrawlusdfromstabilitypool.md index 84671575b..015a31c39 100644 --- a/docs/sdk/lib-ethers.sendableethersliquity.withdrawlusdfromstabilitypool.md +++ b/docs/sdk/lib-ethers.sendableethersliquity.withdrawlusdfromstabilitypool.md @@ -16,7 +16,7 @@ withdrawLUSDFromStabilityPool(amount: Decimalish, overrides?: EthersTransactionO | Parameter | Type | Description | | --- | --- | --- | -| amount | [Decimalish](./decimal.decimalish.md) | Amount of LUSD to withdraw. | +| amount | [Decimalish](./lib-base.decimalish.md) | Amount of LUSD to withdraw. | | overrides | [EthersTransactionOverrides](./lib-ethers.etherstransactionoverrides.md) | | Returns: diff --git a/package.json b/package.json index 43f94f116..fc1429cb0 100644 --- a/package.json +++ b/package.json @@ -25,7 +25,6 @@ "fuzzer": "yarn workspace @liquity/fuzzer fuzzer", "prepare": "run-s prepare:*", "prepare:contracts": "yarn workspace @liquity/contracts prepare", - "prepare:decimal": "yarn workspace @liquity/decimal prepare", "prepare:lib-base": "yarn workspace @liquity/lib-base prepare", "prepare:lib-ethers": "yarn workspace @liquity/lib-ethers prepare", "prepare:lib-react": "yarn workspace @liquity/lib-react prepare", @@ -49,7 +48,6 @@ "stop-demo": "yarn stop-dev-chain", "test": "run-s test:*", "test:contracts": "yarn workspace @liquity/contracts test", - "test:decimal": "yarn workspace @liquity/decimal test", "test:lib-base": "yarn workspace @liquity/lib-base test", "test:lib-ethers": "yarn workspace @liquity/lib-ethers test", "test:dev-frontend": "run-s --continue-on-error test:dev-frontend:*", diff --git a/package.public.json b/package.public.json index bfd7b9f88..eee549943 100644 --- a/package.public.json +++ b/package.public.json @@ -20,7 +20,6 @@ "docs:collect-sdk-apis": "node scripts/collect-sdk-apis.js", "docs:api-documenter": "api-documenter generate -i temp/sdk-apis -o docs/sdk", "prepare": "run-s prepare:*", - "prepare:decimal": "yarn workspace @liquity/decimal prepare", "prepare:lib-base": "yarn workspace @liquity/lib-base prepare", "prepare:lib-ethers": "run-s prepare:lib-ethers:*", "prepare:lib-ethers:deployments": "yarn workspace @liquity/lib-ethers prepare:deployments", diff --git a/packages/decimal/.mocharc.yml b/packages/decimal/.mocharc.yml deleted file mode 100644 index 9ab5daa02..000000000 --- a/packages/decimal/.mocharc.yml +++ /dev/null @@ -1 +0,0 @@ -spec: "test/**/*.test.ts" diff --git a/packages/decimal/api-extractor.json b/packages/decimal/api-extractor.json deleted file mode 100644 index 2069b8ac3..000000000 --- a/packages/decimal/api-extractor.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", - "extends": "../../api-extractor.base.json" -} diff --git a/packages/decimal/etc/decimal.api.md b/packages/decimal/etc/decimal.api.md deleted file mode 100644 index a1c273203..000000000 --- a/packages/decimal/etc/decimal.api.md +++ /dev/null @@ -1,119 +0,0 @@ -## API Report File for "@liquity/decimal" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -// @public -export class Decimal { - // @internal (undocumented) - get absoluteValue(): this; - // (undocumented) - add(addend: Decimalish): Decimal; - // @internal (undocumented) - get bigNumber(): string; - // (undocumented) - div(divider: Decimalish): Decimal; - // (undocumented) - eq(that: Decimalish): boolean; - // (undocumented) - get finite(): this | undefined; - // (undocumented) - static from(decimalish: Decimalish): Decimal; - // (undocumented) - static fromBigNumberString(bigNumberString: string): Decimal; - // (undocumented) - gt(that: Decimalish): boolean; - // (undocumented) - gte(that: Decimalish): boolean; - // (undocumented) - static readonly HALF: Decimal; - // @internal (undocumented) - get hex(): string; - // (undocumented) - get infinite(): this | undefined; - // (undocumented) - static readonly INFINITY: Decimal; - // (undocumented) - get isZero(): boolean; - // (undocumented) - lt(that: Decimalish): boolean; - // (undocumented) - lte(that: Decimalish): boolean; - // (undocumented) - static max(a: Decimalish, b: Decimalish): Decimal; - // (undocumented) - static min(a: Decimalish, b: Decimalish): Decimal; - // (undocumented) - mul(multiplier: Decimalish): Decimal; - // (undocumented) - mulDiv(multiplier: Decimalish, divider: Decimalish): Decimal; - // (undocumented) - get nonZero(): this | undefined; - // (undocumented) - static readonly ONE: Decimal; - // (undocumented) - pow(exponent: number): Decimal; - // (undocumented) - prettify(precision?: number): string; - // (undocumented) - shorten(): string; - // (undocumented) - sub(subtrahend: Decimalish): Decimal; - // (undocumented) - toString(precision?: number): string; - // (undocumented) - static readonly ZERO: Decimal; - // (undocumented) - get zero(): this | undefined; -} - -// @public -export type Decimalish = Decimal | number | string; - -// @alpha (undocumented) -export class Difference { - // (undocumented) - get absoluteValue(): Decimal | undefined; - // (undocumented) - static between(d1: Decimalish | undefined, d2: Decimalish | undefined): Difference; - // (undocumented) - get finite(): this | undefined; - // (undocumented) - get infinite(): this | undefined; - // (undocumented) - mul(multiplier: Decimalish): Difference; - // (undocumented) - get negative(): this | undefined; - // (undocumented) - get nonZero(): this | undefined; - // (undocumented) - get positive(): this | undefined; - // (undocumented) - prettify(precision?: number): string; - // (undocumented) - toString(precision?: number): string; -} - -// @alpha (undocumented) -export class Percent { - constructor(ratio: T); - // (undocumented) - nonZeroish(precision: number): this | undefined; - // (undocumented) - prettify(): string; - // (undocumented) - toString(precision: number): string; -} - - -// (No @packageDocumentation comment for this package) - -``` diff --git a/packages/decimal/index.ts b/packages/decimal/index.ts deleted file mode 100644 index 5ada7e852..000000000 --- a/packages/decimal/index.ts +++ /dev/null @@ -1 +0,0 @@ -export * from "./src/Decimal"; diff --git a/packages/decimal/package.json b/packages/decimal/package.json deleted file mode 100644 index 5e748b398..000000000 --- a/packages/decimal/package.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "name": "@liquity/decimal", - "version": "0.0.1", - "private": true, - "main": "dist/index.js", - "types": "dist/index.d.ts", - "scripts": { - "prepare": "run-s prepare:*", - "prepare:tsc": "tsc --project tsconfig.dist.json", - "prepare:api": "api-extractor run --local", - "test": "mocha --require ts-node/register" - }, - "devDependencies": { - "@microsoft/api-extractor": "^7.13.0", - "@types/chai": "^4.2.9", - "@types/mocha": "^8.0.3", - "chai": "^4.2.0", - "fast-check": "^2.7.0", - "mocha": "^8.0.1", - "npm-run-all": "^4.1.5", - "ts-node": "^9.0.0", - "typescript": "^4.0.3" - }, - "dependencies": { - "@ethersproject/bignumber": "^5.0.0" - } -} diff --git a/packages/decimal/tsconfig.dist.json b/packages/decimal/tsconfig.dist.json deleted file mode 100644 index 78546c744..000000000 --- a/packages/decimal/tsconfig.dist.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "extends": "../../tsconfig.base.json", - "compilerOptions": { - "outDir": "dist" - }, - "include": ["src"], - "files": ["./index.ts"] -} diff --git a/packages/decimal/tsconfig.json b/packages/decimal/tsconfig.json deleted file mode 100644 index 7680f9972..000000000 --- a/packages/decimal/tsconfig.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "extends": "../../tsconfig.base.json", - "include": ["src", "test"] -} diff --git a/packages/dev-frontend/package.json b/packages/dev-frontend/package.json index 389e9e86f..6e034f802 100644 --- a/packages/dev-frontend/package.json +++ b/packages/dev-frontend/package.json @@ -9,10 +9,6 @@ "@fortawesome/free-regular-svg-icons": "^5.13.0", "@fortawesome/free-solid-svg-icons": "^5.13.0", "@fortawesome/react-fontawesome": "^0.1.10", - "@liquity/lib-base": "^0.0.1", - "@liquity/lib-ethers": "^0.0.1", - "@liquity/lib-react": "^0.0.1", - "@liquity/providers": "^0.0.1", "@popperjs/core": "^2.4.2", "@testing-library/dom": "^6.12.2", "@testing-library/jest-dom": "^5.1.1", diff --git a/packages/examples/package.json b/packages/examples/package.json index 119dc700f..d91da912b 100644 --- a/packages/examples/package.json +++ b/packages/examples/package.json @@ -2,9 +2,7 @@ "name": "@liquity/examples", "version": "0.0.1", "private": true, - "dependencies": { - "@liquity/lib-base": "^0.0.1", - "@liquity/lib-ethers": "^0.0.1", + "devDependencies": { "chalk": "^4.1.0", "ethers": "^5.0.0" }, diff --git a/packages/fuzzer/package.json b/packages/fuzzer/package.json index b19978ca6..0642506e2 100644 --- a/packages/fuzzer/package.json +++ b/packages/fuzzer/package.json @@ -6,9 +6,6 @@ "fuzzer": "ts-node src/index.ts" }, "devDependencies": { - "@liquity/lib-base": "^0.0.1", - "@liquity/lib-ethers": "^0.0.1", - "@liquity/lib-subgraph": "^0.0.1", "@types/yargs": "^15.0.7", "colors": "^1.4.0", "dotenv": "^8.2.0", diff --git a/packages/lib-base/.npmignore b/packages/lib-base/.npmignore new file mode 100644 index 000000000..e69de29bb diff --git a/packages/lib-base/.npmrc b/packages/lib-base/.npmrc new file mode 100644 index 000000000..94a06c218 --- /dev/null +++ b/packages/lib-base/.npmrc @@ -0,0 +1 @@ +access=public diff --git a/packages/lib-base/etc/lib-base.api.md b/packages/lib-base/etc/lib-base.api.md index 5100768b9..0e46ee6e0 100644 --- a/packages/lib-base/etc/lib-base.api.md +++ b/packages/lib-base/etc/lib-base.api.md @@ -4,9 +4,6 @@ ```ts -import { Decimal } from '@liquity/decimal'; -import { Decimalish } from '@liquity/decimal'; - // @internal (undocumented) export class _CachedReadableLiquity implements _ReadableLiquityWithExtraParams { constructor(readable: _ReadableLiquityWithExtraParams, cache: _LiquityReadCache); @@ -72,6 +69,97 @@ export const CRITICAL_COLLATERAL_RATIO: Decimal; // @internal (undocumented) export type _DebtChange = (_LUSDBorrowing & _NoLUSDRepayment) | (_LUSDRepayment & _NoLUSDBorrowing); +// @public +export class Decimal { + // @internal (undocumented) + get absoluteValue(): this; + // (undocumented) + add(addend: Decimalish): Decimal; + // @internal (undocumented) + get bigNumber(): string; + // (undocumented) + div(divider: Decimalish): Decimal; + // (undocumented) + eq(that: Decimalish): boolean; + // (undocumented) + get finite(): this | undefined; + // (undocumented) + static from(decimalish: Decimalish): Decimal; + // (undocumented) + static fromBigNumberString(bigNumberString: string): Decimal; + // (undocumented) + gt(that: Decimalish): boolean; + // (undocumented) + gte(that: Decimalish): boolean; + // (undocumented) + static readonly HALF: Decimal; + // @internal (undocumented) + get hex(): string; + // (undocumented) + get infinite(): this | undefined; + // (undocumented) + static readonly INFINITY: Decimal; + // (undocumented) + get isZero(): boolean; + // (undocumented) + lt(that: Decimalish): boolean; + // (undocumented) + lte(that: Decimalish): boolean; + // (undocumented) + static max(a: Decimalish, b: Decimalish): Decimal; + // (undocumented) + static min(a: Decimalish, b: Decimalish): Decimal; + // (undocumented) + mul(multiplier: Decimalish): Decimal; + // (undocumented) + mulDiv(multiplier: Decimalish, divider: Decimalish): Decimal; + // (undocumented) + get nonZero(): this | undefined; + // (undocumented) + static readonly ONE: Decimal; + // (undocumented) + pow(exponent: number): Decimal; + // (undocumented) + prettify(precision?: number): string; + // (undocumented) + shorten(): string; + // (undocumented) + sub(subtrahend: Decimalish): Decimal; + // (undocumented) + toString(precision?: number): string; + // (undocumented) + static readonly ZERO: Decimal; + // (undocumented) + get zero(): this | undefined; +} + +// @public +export type Decimalish = Decimal | number | string; + +// @alpha (undocumented) +export class Difference { + // (undocumented) + get absoluteValue(): Decimal | undefined; + // (undocumented) + static between(d1: Decimalish | undefined, d2: Decimalish | undefined): Difference; + // (undocumented) + get finite(): this | undefined; + // (undocumented) + get infinite(): this | undefined; + // (undocumented) + mul(multiplier: Decimalish): Difference; + // (undocumented) + get negative(): this | undefined; + // (undocumented) + get nonZero(): this | undefined; + // (undocumented) + get positive(): this | undefined; + // (undocumented) + prettify(precision?: number): string; + // (undocumented) + toString(precision?: number): string; +} + // @internal (undocumented) export const _emptyTrove: Trove; @@ -296,6 +384,24 @@ export type PendingReceipt = { // @internal (undocumented) export const _pendingReceipt: PendingReceipt; +// @alpha (undocumented) +export class Percent { + constructor(ratio: T); + // (undocumented) + nonZeroish(precision: number): this | undefined; + // (undocumented) + prettify(): string; + // (undocumented) + toString(precision: number): string; +} + // @internal (undocumented) export type _PopulatableFrom = { [M in keyof T]: T[M] extends (...args: infer A) => Promise ? U extends SentLiquityTransaction ? (...args: A) => Promise> : never : never; @@ -635,8 +741,6 @@ export class TroveWithPendingRedistribution extends Trove { } -export * from "@liquity/decimal"; - // (No @packageDocumentation comment for this package) ``` diff --git a/packages/lib-base/index.ts b/packages/lib-base/index.ts index b9f1df431..35b195a2b 100644 --- a/packages/lib-base/index.ts +++ b/packages/lib-base/index.ts @@ -1,6 +1,5 @@ -export * from "@liquity/decimal"; - export * from "./src/constants"; +export * from "./src/Decimal"; export * from "./src/Trove"; export * from "./src/StabilityDeposit"; export * from "./src/LQTYStake"; diff --git a/packages/lib-base/package.json b/packages/lib-base/package.json index 86ce9ec4b..f83972505 100644 --- a/packages/lib-base/package.json +++ b/packages/lib-base/package.json @@ -1,6 +1,6 @@ { "name": "@liquity/lib-base", - "version": "0.0.1", + "version": "0.0.0-semantic-release", "private": true, "main": "dist/index.js", "types": "dist/index.d.ts", @@ -12,7 +12,7 @@ "test": "mocha --require ts-node/register" }, "dependencies": { - "@liquity/decimal": "^0.0.1" + "@ethersproject/bignumber": "^5.0.0" }, "devDependencies": { "@ethersproject/bignumber": "^5.0.0", diff --git a/packages/decimal/src/Decimal.ts b/packages/lib-base/src/Decimal.ts similarity index 87% rename from packages/decimal/src/Decimal.ts rename to packages/lib-base/src/Decimal.ts index 04a7725c3..7c76adf54 100644 --- a/packages/decimal/src/Decimal.ts +++ b/packages/lib-base/src/Decimal.ts @@ -67,6 +67,7 @@ export class Decimal { } if (representation.includes("e")) { + // eslint-disable-next-line prefer-const let [coefficient, exponent] = representation.split("e"); if (exponent.startsWith("-")) { @@ -90,6 +91,7 @@ export class Decimal { return new Decimal(BigNumber.from(representation).mul(DIGITS)); } + // eslint-disable-next-line prefer-const let [characteristic, mantissa] = representation.split("."); if (mantissa.length < PRECISION) { @@ -105,7 +107,7 @@ export class Decimal { ); } - static from(decimalish: Decimalish) { + static from(decimalish: Decimalish): Decimal { switch (typeof decimalish) { case "object": return decimalish; @@ -152,7 +154,7 @@ export class Decimal { } } - toString(precision?: number) { + toString(precision?: number): string { if (this.infinite) { return "∞"; } else if (precision !== undefined) { @@ -162,14 +164,14 @@ export class Decimal { } } - prettify(precision: number = 2) { + prettify(precision = 2): string { const [characteristic, mantissa] = this.toString(precision).split("."); const prettyCharacteristic = characteristic.replace(/(\d)(?=(\d{3})+(?!\d))/g, "$1,"); return mantissa !== undefined ? prettyCharacteristic + "." + mantissa : prettyCharacteristic; } - shorten() { + shorten(): string { const characteristicLength = this.toString(0).length; const magnitude = Math.min(Math.floor((characteristicLength - 1) / 3), magnitudes.length - 1); @@ -179,19 +181,19 @@ export class Decimal { return normalized.prettify(precision) + magnitudes[magnitude]; } - add(addend: Decimalish) { + add(addend: Decimalish): Decimal { return new Decimal(this._bigNumber.add(Decimal.from(addend)._bigNumber)); } - sub(subtrahend: Decimalish) { + sub(subtrahend: Decimalish): Decimal { return new Decimal(this._bigNumber.sub(Decimal.from(subtrahend)._bigNumber)); } - mul(multiplier: Decimalish) { + mul(multiplier: Decimalish): Decimal { return new Decimal(this._bigNumber.mul(Decimal.from(multiplier)._bigNumber).div(DIGITS)); } - div(divider: Decimalish) { + div(divider: Decimalish): Decimal { divider = Decimal.from(divider); if (divider.isZero) { @@ -201,7 +203,7 @@ export class Decimal { return new Decimal(this._bigNumber.mul(DIGITS).div(divider._bigNumber)); } - mulDiv(multiplier: Decimalish, divider: Decimalish) { + mulDiv(multiplier: Decimalish, divider: Decimalish): Decimal { multiplier = Decimal.from(multiplier); divider = Decimal.from(divider); @@ -212,7 +214,7 @@ export class Decimal { return new Decimal(this._bigNumber.mul(multiplier._bigNumber).div(divider._bigNumber)); } - pow(exponent: number) { + pow(exponent: number): Decimal { assert(Number.isInteger(exponent)); assert(0 <= exponent && exponent <= 0xffffffff); // Ensure we're safe to use bitwise ops @@ -238,67 +240,67 @@ export class Decimal { return new Decimal(roundedMul(x, y)); } - get isZero() { + get isZero(): boolean { return this._bigNumber.isZero(); } - get zero() { + get zero(): this | undefined { if (this.isZero) { return this; } } - get nonZero() { + get nonZero(): this | undefined { if (!this.isZero) { return this; } } - get infinite() { + get infinite(): this | undefined { if (this.eq(Decimal.INFINITY)) { return this; } } - get finite() { + get finite(): this | undefined { if (!this.eq(Decimal.INFINITY)) { return this; } } /** @internal */ - get absoluteValue() { + get absoluteValue(): this { return this; } - lt(that: Decimalish) { + lt(that: Decimalish): boolean { return this._bigNumber.lt(Decimal.from(that)._bigNumber); } - eq(that: Decimalish) { + eq(that: Decimalish): boolean { return this._bigNumber.eq(Decimal.from(that)._bigNumber); } - gt(that: Decimalish) { + gt(that: Decimalish): boolean { return this._bigNumber.gt(Decimal.from(that)._bigNumber); } - gte(that: Decimalish) { + gte(that: Decimalish): boolean { return this._bigNumber.gte(Decimal.from(that)._bigNumber); } - lte(that: Decimalish) { + lte(that: Decimalish): boolean { return this._bigNumber.lte(Decimal.from(that)._bigNumber); } - static min(a: Decimalish, b: Decimalish) { + static min(a: Decimalish, b: Decimalish): Decimal { a = Decimal.from(a); b = Decimal.from(b); return a.lt(b) ? a : b; } - static max(a: Decimalish, b: Decimalish) { + static max(a: Decimalish, b: Decimalish): Decimal { a = Decimal.from(a); b = Decimal.from(b); @@ -316,7 +318,7 @@ export class Difference { this._number = number; } - static between(d1: Decimalish | undefined, d2: Decimalish | undefined) { + static between(d1: Decimalish | undefined, d2: Decimalish | undefined): Difference { if (d1 === undefined || d2 === undefined) { return new Difference(undefined); } @@ -339,7 +341,7 @@ export class Difference { } } - toString(precision?: number) { + toString(precision?: number): string { if (!this._number) { return "N/A"; } @@ -347,7 +349,7 @@ export class Difference { return this._number.sign + this._number.absoluteValue.toString(precision); } - prettify(precision?: number) { + prettify(precision?: number): string { if (!this._number) { return this.toString(); } @@ -355,7 +357,7 @@ export class Difference { return this._number.sign + this._number.absoluteValue.prettify(precision); } - mul(multiplier: Decimalish) { + mul(multiplier: Decimalish): Difference { return new Difference( this._number && { sign: this._number.sign, @@ -364,27 +366,27 @@ export class Difference { ); } - get nonZero() { + get nonZero(): this | undefined { return this._number?.absoluteValue.nonZero && this; } - get positive() { + get positive(): this | undefined { return this._number?.sign === "+" ? this : undefined; } - get negative() { + get negative(): this | undefined { return this._number?.sign === "-" ? this : undefined; } - get absoluteValue() { + get absoluteValue(): Decimal | undefined { return this._number?.absoluteValue; } - get infinite() { + get infinite(): this | undefined { return this._number?.absoluteValue.infinite && this; } - get finite() { + get finite(): this | undefined { return this._number?.absoluteValue.finite && this; } } @@ -407,7 +409,7 @@ export class Percent< this._percent = ratio.infinite || (ratio.mul && ratio.mul(100)) || ratio; } - nonZeroish(precision: number) { + nonZeroish(precision: number): this | undefined { const zeroish = `0.${"0".repeat(precision)}5`; if (this._percent.absoluteValue?.gte(zeroish)) { @@ -415,14 +417,14 @@ export class Percent< } } - toString(precision: number) { + toString(precision: number): string { return ( this._percent.toString(precision) + (this._percent.absoluteValue && !this._percent.infinite ? "%" : "") ); } - prettify() { + prettify(): string { if (this._percent.absoluteValue?.gte("1000")) { return this.toString(0); } else if (this._percent.absoluteValue?.gte("10")) { diff --git a/packages/lib-base/src/Fees.ts b/packages/lib-base/src/Fees.ts index 3f7eb6ec8..ab0ca9522 100644 --- a/packages/lib-base/src/Fees.ts +++ b/packages/lib-base/src/Fees.ts @@ -1,6 +1,6 @@ import assert from "assert"; -import { Decimal, Decimalish } from "@liquity/decimal"; +import { Decimal, Decimalish } from "./Decimal"; import { MAXIMUM_BORROWING_RATE, diff --git a/packages/lib-base/src/LQTYStake.ts b/packages/lib-base/src/LQTYStake.ts index 490951644..fd07128ea 100644 --- a/packages/lib-base/src/LQTYStake.ts +++ b/packages/lib-base/src/LQTYStake.ts @@ -1,4 +1,4 @@ -import { Decimal, Decimalish } from "@liquity/decimal"; +import { Decimal, Decimalish } from "./Decimal"; /** * Represents the change between two states of an LQTY Stake. diff --git a/packages/lib-base/src/LiquityStore.ts b/packages/lib-base/src/LiquityStore.ts index ce542c02d..c8314d3d9 100644 --- a/packages/lib-base/src/LiquityStore.ts +++ b/packages/lib-base/src/LiquityStore.ts @@ -1,6 +1,6 @@ import assert from "assert"; -import { Decimal } from "@liquity/decimal"; +import { Decimal } from "./Decimal"; import { StabilityDeposit } from "./StabilityDeposit"; import { Trove, TroveWithPendingRedistribution } from "./Trove"; import { Fees } from "./Fees"; diff --git a/packages/lib-base/src/ObservableLiquity.ts b/packages/lib-base/src/ObservableLiquity.ts index a75b67774..76537d5a9 100644 --- a/packages/lib-base/src/ObservableLiquity.ts +++ b/packages/lib-base/src/ObservableLiquity.ts @@ -1,5 +1,4 @@ -import { Decimal } from "@liquity/decimal"; - +import { Decimal } from "./Decimal"; import { Trove, TroveWithPendingRedistribution } from "./Trove"; import { StabilityDeposit } from "./StabilityDeposit"; diff --git a/packages/lib-base/src/ReadableLiquity.ts b/packages/lib-base/src/ReadableLiquity.ts index e390562ae..d835287a3 100644 --- a/packages/lib-base/src/ReadableLiquity.ts +++ b/packages/lib-base/src/ReadableLiquity.ts @@ -1,5 +1,4 @@ -import { Decimal } from "@liquity/decimal"; - +import { Decimal } from "./Decimal"; import { Trove, TroveWithPendingRedistribution } from "./Trove"; import { StabilityDeposit } from "./StabilityDeposit"; import { Fees } from "./Fees"; @@ -12,7 +11,7 @@ import { LQTYStake } from "./LQTYStake"; * Returned by the {@link ReadableLiquity.getFrontendStatus | getFrontendStatus()} function. * * When `status` is `"registered"`, `kickbackRate` gives the frontend's kickback rate as a - * {@link @liquity/decimal#Decimal} between 0 and 1. + * {@link Decimal} between 0 and 1. * * @public */ diff --git a/packages/lib-base/src/StabilityDeposit.ts b/packages/lib-base/src/StabilityDeposit.ts index cf83b3237..04065955e 100644 --- a/packages/lib-base/src/StabilityDeposit.ts +++ b/packages/lib-base/src/StabilityDeposit.ts @@ -1,4 +1,4 @@ -import { Decimal, Decimalish } from "@liquity/decimal"; +import { Decimal, Decimalish } from "./Decimal"; /** * Represents the change between two Stability Deposit states. diff --git a/packages/lib-base/src/TransactableLiquity.ts b/packages/lib-base/src/TransactableLiquity.ts index b30bec4cc..36fd38e8c 100644 --- a/packages/lib-base/src/TransactableLiquity.ts +++ b/packages/lib-base/src/TransactableLiquity.ts @@ -1,5 +1,4 @@ -import { Decimal, Decimalish } from "@liquity/decimal"; - +import { Decimal, Decimalish } from "./Decimal"; import { Trove, TroveAdjustmentParams, TroveClosureParams, TroveCreationParams } from "./Trove"; import { StabilityDepositChange } from "./StabilityDeposit"; diff --git a/packages/lib-base/src/Trove.ts b/packages/lib-base/src/Trove.ts index 0d1818bf1..1d47c879a 100644 --- a/packages/lib-base/src/Trove.ts +++ b/packages/lib-base/src/Trove.ts @@ -1,6 +1,6 @@ import assert from "assert"; -import { Decimal, Decimalish } from "@liquity/decimal"; +import { Decimal, Decimalish } from "./Decimal"; import { MINIMUM_COLLATERAL_RATIO, diff --git a/packages/lib-base/src/_CachedReadableLiquity.ts b/packages/lib-base/src/_CachedReadableLiquity.ts index 6e083e52a..92d7e109b 100644 --- a/packages/lib-base/src/_CachedReadableLiquity.ts +++ b/packages/lib-base/src/_CachedReadableLiquity.ts @@ -1,5 +1,4 @@ -import { Decimal } from "@liquity/decimal"; - +import { Decimal } from "./Decimal"; import { Fees } from "./Fees"; import { LQTYStake } from "./LQTYStake"; import { StabilityDeposit } from "./StabilityDeposit"; diff --git a/packages/lib-base/src/constants.ts b/packages/lib-base/src/constants.ts index 84de2d8cc..cd72b4c1f 100644 --- a/packages/lib-base/src/constants.ts +++ b/packages/lib-base/src/constants.ts @@ -1,4 +1,4 @@ -import { Decimal } from "@liquity/decimal"; +import { Decimal } from "./Decimal"; /** * Total collateral ratio below which recovery mode is triggered. diff --git a/packages/decimal/test/Decimal.test.ts b/packages/lib-base/test/Decimal.test.ts similarity index 99% rename from packages/decimal/test/Decimal.test.ts rename to packages/lib-base/test/Decimal.test.ts index ad94ae9e9..24a6e2b62 100644 --- a/packages/decimal/test/Decimal.test.ts +++ b/packages/lib-base/test/Decimal.test.ts @@ -2,8 +2,6 @@ import { describe, it } from "mocha"; import { expect } from "chai"; import fc from "fast-check"; -import { BigNumber } from "@ethersproject/bignumber"; - import { Decimal, Difference } from "../src/Decimal"; describe("Decimal", () => { diff --git a/packages/lib-base/test/LQTYStake.test.ts b/packages/lib-base/test/LQTYStake.test.ts index bf1bafe73..32640c381 100644 --- a/packages/lib-base/test/LQTYStake.test.ts +++ b/packages/lib-base/test/LQTYStake.test.ts @@ -1,8 +1,7 @@ import { describe, it } from "mocha"; import fc from "fast-check"; -import { Decimal } from "@liquity/decimal"; - +import { Decimal } from "../src/Decimal"; import { LQTYStake } from "../src/LQTYStake"; const arbitraryStake = () => diff --git a/packages/lib-base/test/StabilityDeposit.test.ts b/packages/lib-base/test/StabilityDeposit.test.ts index 7ae71fe1f..ca359f6f1 100644 --- a/packages/lib-base/test/StabilityDeposit.test.ts +++ b/packages/lib-base/test/StabilityDeposit.test.ts @@ -1,8 +1,7 @@ import { describe, it } from "mocha"; import fc from "fast-check"; -import { Decimal } from "@liquity/decimal"; - +import { Decimal } from "../src/Decimal"; import { StabilityDeposit } from "../src/StabilityDeposit"; const arbitraryDeposit = () => diff --git a/packages/lib-base/test/Trove.test.ts b/packages/lib-base/test/Trove.test.ts index 585c5fbe9..37638e5cb 100644 --- a/packages/lib-base/test/Trove.test.ts +++ b/packages/lib-base/test/Trove.test.ts @@ -2,9 +2,8 @@ import assert from "assert"; import { describe, it } from "mocha"; import fc from "fast-check"; -import { Decimal, Difference } from "@liquity/decimal"; - import { LUSD_LIQUIDATION_RESERVE } from "../src/constants"; +import { Decimal, Difference } from "../src/Decimal"; import { Trove, _emptyTrove } from "../src/Trove"; const minDebt = Number(LUSD_LIQUIDATION_RESERVE); diff --git a/packages/lib-ethers/.npmignore b/packages/lib-ethers/.npmignore new file mode 100644 index 000000000..76fd1715a --- /dev/null +++ b/packages/lib-ethers/.npmignore @@ -0,0 +1,2 @@ +/live +/accounts.json diff --git a/packages/lib-ethers/.npmrc b/packages/lib-ethers/.npmrc new file mode 100644 index 000000000..94a06c218 --- /dev/null +++ b/packages/lib-ethers/.npmrc @@ -0,0 +1 @@ +access=public diff --git a/packages/lib-ethers/package.json b/packages/lib-ethers/package.json index 114e3775a..78f6b01c7 100644 --- a/packages/lib-ethers/package.json +++ b/packages/lib-ethers/package.json @@ -1,6 +1,6 @@ { "name": "@liquity/lib-ethers", - "version": "0.0.1", + "version": "0.0.0-semantic-release", "private": true, "main": "dist/index.js", "types": "dist/index.d.ts", @@ -23,11 +23,10 @@ "test-live:run": "cross-env USE_LIVE_VERSION=true hardhat test" }, "peerDependencies": { - "@liquity/lib-base": "^0.0.1", + "@liquity/lib-base": "^1.0.0", "ethers": "^5.0.0" }, "devDependencies": { - "@liquity/lib-base": "^0.0.1", "@microsoft/api-extractor": "^7.13.0", "@nomiclabs/hardhat-ethers": "^2.0.0", "@types/chai": "^4.2.9", diff --git a/packages/lib-react/package.json b/packages/lib-react/package.json index a559d8641..e877fd556 100644 --- a/packages/lib-react/package.json +++ b/packages/lib-react/package.json @@ -11,12 +11,11 @@ "prepare:tsc": "tsc --project tsconfig.dist.json" }, "peerDependencies": { - "@liquity/lib-base": "^0.0.1", + "@liquity/lib-base": "^1.0.0", "react": "^16.13.1" }, "devDependencies": { "@ethersproject/bignumber": "^5.0.0", - "@liquity/lib-base": "^0.0.1", "@types/react": "^17.0.0", "@typescript-eslint/eslint-plugin": "^4.4.1", "@typescript-eslint/parser": "^4.4.1", diff --git a/packages/lib-subgraph/package.json b/packages/lib-subgraph/package.json index d8d2081e7..52fca8812 100644 --- a/packages/lib-subgraph/package.json +++ b/packages/lib-subgraph/package.json @@ -12,10 +12,9 @@ "prepare": "tsc --project tsconfig.dist.json" }, "peerDependencies": { - "@liquity/lib-base": "^0.0.1" + "@liquity/lib-base": "^1.0.0" }, "devDependencies": { - "@liquity/lib-base": "^0.0.1", "apollo": "^2.30.3", "npm-run-all": "^4.1.5", "rimraf": "^3.0.2", diff --git a/scripts/collect-sdk-apis.js b/scripts/collect-sdk-apis.js index 482ab81b2..4f3621bb2 100644 --- a/scripts/collect-sdk-apis.js +++ b/scripts/collect-sdk-apis.js @@ -2,7 +2,6 @@ const fs = require("fs-extra"); const path = require("path"); const filesToCollect = [ - "packages/decimal/temp/decimal.api.json", "packages/lib-base/temp/lib-base.api.json", "packages/lib-ethers/temp/lib-ethers.api.json" ]; diff --git a/yarn.lock b/yarn.lock index 36097e94e..389a826dd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -12757,7 +12757,7 @@ mocha@^7.1.1, mocha@^7.1.2: yargs-parser "13.1.2" yargs-unparser "1.6.0" -mocha@^8.0.1, mocha@^8.2.1: +mocha@^8.2.1: version "8.2.1" resolved "https://registry.yarnpkg.com/mocha/-/mocha-8.2.1.tgz#f2fa68817ed0e53343d989df65ccd358bc3a4b39" integrity sha512-cuLBVfyFfFqbNR0uUKbDGXKGk+UDFe6aR4os78XIrMQpZl/nv7JYHcvP5MFIAb374b2zFXsdgEGwmzMtP0Xg8w==