-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## [@nibiruchain/indexer-nibi-v0.21.34](https://github.com/NibiruChain/ts-sdk/compare/@nibiruchain/indexer-nibi-v0.21.33...@nibiruchain/indexer-nibi-v0.21.34) (2024-01-05) ### Miscellaneous Chores * develop -> main ([#275](#275)) ([c5e4f87](c5e4f87)), closes [#254](#254) [#256](#256) [#257](#257) [#262](#262) [#260](#260) [skip ci]
- Loading branch information
1 parent
c5e4f87
commit b8e3018
Showing
41 changed files
with
12,841 additions
and
12,629 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| [NibiJS Documentation - v0.21.45](../intro.md) / [Exports](../modules.md) / BalancerPool | ||
|
|
||
| # Class: BalancerPool | ||
|
|
||
| Balancer contains the logic for exchanging tokens in a traditional xy=k AMM pool | ||
|
|
||
| Constructor: | ||
|
|
||
| **`Param`** | ||
|
|
||
| **`Param`** | ||
|
|
||
| **`Param`** | ||
|
|
||
| **`Export`** | ||
|
|
||
| ## Table of contents | ||
|
|
||
| ### Constructors | ||
|
|
||
| - [constructor](BalancerPool.md#constructor) | ||
|
|
||
| ### Properties | ||
|
|
||
| - [swapFee](BalancerPool.md#swapfee) | ||
| - [x](BalancerPool.md#x) | ||
| - [y](BalancerPool.md#y) | ||
|
|
||
| ### Methods | ||
|
|
||
| - [k](BalancerPool.md#k) | ||
| - [spotPrice](BalancerPool.md#spotprice) | ||
| - [swapX](BalancerPool.md#swapx) | ||
| - [swapY](BalancerPool.md#swapy) | ||
|
|
||
| ## Constructors | ||
|
|
||
| ### constructor | ||
|
|
||
| • **new BalancerPool**(`x`, `y`, `fee`) | ||
|
|
||
| #### Parameters | ||
|
|
||
| | Name | Type | | ||
| | :---- | :---------- | | ||
| | `x` | `BigNumber` | | ||
| | `y` | `BigNumber` | | ||
| | `fee` | `BigNumber` | | ||
|
|
||
| #### Defined in | ||
|
|
||
| [src/balancer/balancer.ts:61](https://github.com/NibiruChain/ts-sdk/blob/c5e4f87/packages/nibijs/src/balancer/balancer.ts#L61) | ||
|
|
||
| ## Properties | ||
|
|
||
| ### swapFee | ||
|
|
||
| • **swapFee**: `BigNumber` | ||
|
|
||
| the swap fee expressed as a ratio | ||
|
|
||
| #### Defined in | ||
|
|
||
| [src/balancer/balancer.ts:59](https://github.com/NibiruChain/ts-sdk/blob/c5e4f87/packages/nibijs/src/balancer/balancer.ts#L59) | ||
|
|
||
| --- | ||
|
|
||
| ### x | ||
|
|
||
| • **x**: `BigNumber` | ||
|
|
||
| the amount of x in the pool | ||
|
|
||
| #### Defined in | ||
|
|
||
| [src/balancer/balancer.ts:57](https://github.com/NibiruChain/ts-sdk/blob/c5e4f87/packages/nibijs/src/balancer/balancer.ts#L57) | ||
|
|
||
| --- | ||
|
|
||
| ### y | ||
|
|
||
| • **y**: `BigNumber` | ||
|
|
||
| the amount of y in the pool | ||
|
|
||
| #### Defined in | ||
|
|
||
| [src/balancer/balancer.ts:58](https://github.com/NibiruChain/ts-sdk/blob/c5e4f87/packages/nibijs/src/balancer/balancer.ts#L58) | ||
|
|
||
| ## Methods | ||
|
|
||
| ### k | ||
|
|
||
| ▸ **k**(): `BigNumber` | ||
|
|
||
| #### Returns | ||
|
|
||
| `BigNumber` | ||
|
|
||
| #### Defined in | ||
|
|
||
| [src/balancer/balancer.ts:67](https://github.com/NibiruChain/ts-sdk/blob/c5e4f87/packages/nibijs/src/balancer/balancer.ts#L67) | ||
|
|
||
| --- | ||
|
|
||
| ### spotPrice | ||
|
|
||
| ▸ **spotPrice**(): `BigNumber` | ||
|
|
||
| #### Returns | ||
|
|
||
| `BigNumber` | ||
|
|
||
| #### Defined in | ||
|
|
||
| [src/balancer/balancer.ts:71](https://github.com/NibiruChain/ts-sdk/blob/c5e4f87/packages/nibijs/src/balancer/balancer.ts#L71) | ||
|
|
||
| --- | ||
|
|
||
| ### swapX | ||
|
|
||
| ▸ **swapX**(`dxAmm`): `undefined` \| [`Swap`](Swap.md) | ||
|
|
||
| Calculates the result of adding x to the pool | ||
|
|
||
| #### Parameters | ||
|
|
||
| | Name | Type | Description | | ||
| | :------ | :---------- | :----------------------------------------------------- | | ||
| | `dxAmm` | `BigNumber` | the amount of x to add to the pool. Could be negative. | | ||
|
|
||
| #### Returns | ||
|
|
||
| `undefined` \| [`Swap`](Swap.md) | ||
|
|
||
| a Swap object representing the result of the swap | ||
|
|
||
| #### Defined in | ||
|
|
||
| [src/balancer/balancer.ts:81](https://github.com/NibiruChain/ts-sdk/blob/c5e4f87/packages/nibijs/src/balancer/balancer.ts#L81) | ||
|
|
||
| --- | ||
|
|
||
| ### swapY | ||
|
|
||
| ▸ **swapY**(`dyAmm`): `undefined` \| [`Swap`](Swap.md) | ||
|
|
||
| Calculates the result of adding y to the pool | ||
|
|
||
| #### Parameters | ||
|
|
||
| | Name | Type | Description | | ||
| | :------ | :---------- | :----------------------------------------------------- | | ||
| | `dyAmm` | `BigNumber` | the amount of y to add to the pool. Could be negative. | | ||
|
|
||
| #### Returns | ||
|
|
||
| `undefined` \| [`Swap`](Swap.md) | ||
|
|
||
| a Swap object representing the result of the swap | ||
|
|
||
| #### Defined in | ||
|
|
||
| [src/balancer/balancer.ts:117](https://github.com/NibiruChain/ts-sdk/blob/c5e4f87/packages/nibijs/src/balancer/balancer.ts#L117) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.