Support for automated market makers (CAP-38). #693
Merged
Conversation
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
…ce `/lib` is in stellar-base's `.gitignore`, yarn install doesn't work properly with the github module version and we need to run an extra step manually, as explained in the CHANGELOG.
* Add call builder for liquidity pools, w/ filters by reserve asset
…Liquidity Pool trades (#685)
### What Add GitHub Actions to run tests for every PR. ### Why So all AMM related PRs we're merging into [v9.0.0](https://github.com/stellar/js-stellar-sdk/tree/v9.0.0) will need to pass the CI tests.
…ounts balance response (#688) Support `/accounts?liquidity_pool={:pool_id}` and update the response from `/accounts/{:acc_id}` ### Update - A new type of trustline called `liquidity_pool_shares` was added, which is included in the account `balances` array and causes a breaking change (see below) ([#688](#688)). - Clients can now filter the results from the `/accounts` endpoint based on participation in a certain liquidity pool ([#688](#688)). ### Breaking Changes - The `balances` array from an account response now supports liquidity pool balances ([#688](#688)). - the `asset_type` field can now be `liquidity_pool_shares`. - `buying_liabilities`, `selling_liabilities`, `asset_code`, and `asset_issuer` are omitted from the response for pool shares because they are not relevant to liquidity pools. - Update the `ChangeTrustOperationResponse` interface so it can conform to a change in a liquidity pool trustline ([#688](#688)). - `asset_type` can now be `liquidity_pool_shares`. - `asset_code` and `asset_issuer` are now optional. - Added `liquidity_pool_id` as an optional field.
… pool. (#689) Co-authored-by: Marcelo Salloum dos Santos <marcelo@stellar.org>
### Add - New effect types: `DepositLiquidityEffect`, `WithdrawLiquidityEffect`, `LiquidityPoolTradeEffect`, `LiquidityPoolCreatedEffect`, `LiquidityPoolRemovedEffect` and `LiquidityPoolRevokedEffect`. ### Breaking changes - Trustline created/updated/revoked effects' asset type can now be `liquidity_pool_shares`. - Trustline sponsorship effects have been updated so the `asset` becomes optional and is replaced with `liquidity_pool_id` for liquidity pools.
### Add - Add operations `DepositLiquidityOperationResponse` and `WithdrawLiquidityOperationResponse`. ### Breaking Changes - The `trustee` attribute was made optional in the `ChangeTrustOperationResponse`.
* Provides more precise error type
One of my biggest take-aways from Google's technical writing course was "use more lists." I've tried to incorporate that here, breaking down changes into specific items. Another big change was being more specific and precise with the data structures in the SDK that have been updated. For example, we now list the effects that changed directly, specify fields that have changed more explicitly, and call out specific endpoints that we've introduced and their respective call builders. Co-authored-by: Marcelo Salloum dos Santos <marcelo@stellar.org>
Shaptic
changed the title
14 tasks
paulbellamy
approved these changes
Sep 2, 2021
* Update payment call builder to use helper method * Update two more builders to use helper * Simplify sequence number code since strings are strings Co-authored-by: Marcelo Salloum dos Santos <marcelo@stellar.org>
Co-authored-by: Marcelo Salloum dos Santos <marcelo@stellar.org>
Shaptic
changed the title
tamirms
reviewed
Sep 2, 2021
tamirms
reviewed
Sep 2, 2021
| last_modified_ledger: number; | ||
| is_authorized: boolean; | ||
| is_authorized_to_maintain_liabilities: boolean; | ||
| is_clawback_enabled: boolean; |
There was a problem hiding this comment.
a pool share trustline can be sponsored so I think we need a sponsor?: string here
There was a problem hiding this comment.
Nice catch, will be fixed by #702 👍
tamirms
reviewed
Sep 2, 2021
tamirms
approved these changes
Sep 2, 2021
* Add sponsor field to pool share balances * Refactor ledger filter to always convert to a string * Drop the Horizon-deprecated offer_id field
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This release adds support for Automated Market Makers. For details, you can refer to CAP-38 for XDR changes and this document for detailed changes to the Horizon API.
Add
Introduced a
LiquidityPoolCallBuilderto make calls to a new endpoint:/liquidity_pools[?reserves=...]- a collection of liquidity pools, optionally filtered by one or more assets (#682)/liquidity_pools/:id- a specific liquidity pool (#687)Expanded the
TransactionCallBuilder,OperationCallBuilder, andEffectsCallBuilders to apply to specific liquidity pools (#689). This corresponds to the following new endpoints:/liquidity_pools/:id/transactions/liquidity_pools/:id/operations/liquidity_pools/:id/effectsExpanded the
TradesCallBuilderto support fetching liquidity pool trades and accepts a newtrade_typefilter (#685):/trades?trade_type={orderbook,liquidity_pools}liquidity_pool_fee_bp: LP fee expressed in basis points, and eitherbase_liquidity_pool_idorcounter_liquidity_pool_idAdded new effects related to liquidity pools (#690):
DepositLiquidityEffectWithdrawLiquidityEffectLiquidityPoolTradeEffectLiquidityPoolCreatedEffectLiquidityPoolRemovedEffectLiquidityPoolRevokedEffectAdded new responses related to liquidity pool operations (#692):
DepositLiquidityOperationResponseWithdrawLiquidityOperationResponseUpdates
Updated the underlying
stellar-baselibrary to v6.0.1 to include CAP-38 changes (#681).Updated
AccountResponseto include liquidity pool shares in itsbalancesfield (#688).Updated
AccountCallBuilderto allow filtering based on participation in a certain liquidity pool (#688), corresponding to the following new filter:/accounts?reserves=[...list of assets...]Updated
RevokeSponsorshipOperationResponseto contain an optional attributetrustline_liquidity_pool_id, for when a liquidity pool trustline is revoked (#690).Breaking changes
A
TradeRecordcan now correspond to two different types of trades and has changed (#685):Orderbook(the existing structure)counter_offer_idandbase_offer_idonly show up in these recordsLiquidityPool(new)base_accountxorcounter_accountwill appear in these recordspricefields changed fromnumbers tostringsbaseandcountercan now point to either an account or a liquidity poolAn account's
balancesarray can now include a new type (#688):asset_typecan now beliquidity_pool_sharesbuying_liabilitiesselling_liabilitiesasset_codeasset_issueThe
ChangeTrustOperationResponsehas changed (#688, #692):asset_typecan now beliquidity_pool_sharesasset_code,asset_issuer, andtrusteeare now optionalliquidity_pool_idis a new optional fieldThe trustline effects (
TrustlineCreated,TrustlineUpdated,TrustlineRevoked) have changed (#690):liquidity_pool_sharesliquidity_pool_idTrustline sponsorship effects (
TrustlineSponsorshipCreated,TrustlineSponsorshipUpdated,TrustlineSponsorshipRemoved) have been updated (#690):assetfield is now optional, and is replaced byliquidity_pool_idfield for liquidity pools