Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor Join/Exit Interface to Add/Remove Liquidity #124

Merged
merged 29 commits into from
Nov 14, 2023
Merged

Refactor Join/Exit Interface to Add/Remove Liquidity #124

merged 29 commits into from
Nov 14, 2023

Conversation

brunoguerios
Copy link
Member

@brunoguerios brunoguerios commented Nov 10, 2023 •
edited
Loading

Main changes:

  • rename Join to AddLiquidity (and all its variations)
  • rename Exit to RemoveLiquidity (and all its variations)

Other changes:

  • rename several "Result" to "Output" to keep consistency with "Input"
  • rename SingleAsset to SingleToken to follow standard defined on Notion

Notes:

  • did not change external interfaces (e.g. encoders from v2 are still using join/exit)
  • used AddLiquidity always as prefix for consistency (e.g. AddLiquidityUnbalanced instead of UnbalancedJoin)
  • used RemoveLiquidity always as prefix for consistency (e.g. RemoveLiquidityUnbalanced instead of UnbalancedExit)

@brunoguerios
Refactor AmountsJoin into AddLiquidityAmounts
483220d
@brunoguerios
Refactor JoinKind into AddLiquidityKind
b06078c
@brunoguerios
Refactor JoinInput into AddLiquidityInput
010ad6d
@brunoguerios
Refactor JoinQueryResult into AddLiquidityQueryResult
7c9851d
@brunoguerios
Refactor JoinCall into AddLiquidityCall
f608e6f
@brunoguerios
Refactor PoolJoin into AddLiquidity
280950d
@brunoguerios
Refactor JoinBuildOutput into AddLiquidityOutput
85cfd33
@brunoguerios
Refactor QueryResult into QueryOutput for consistency
0676e28
@brunoguerios
Refactor doQueryJoin and parseJoinArgs to doAddLiquidityQuery and par…
3a014d7 
…seAddLiquidityArgs
@brunoguerios
Refactor join into addLiquidity within tests
50c6934
@brunoguerios
Refactor remaining comments throughout the code
e70254f
@brunoguerios
Refactor encoders to expose addLiquidity functions instead of join
6a4dd95
@brunoguerios
Refactor join into addLiquidity within examples and readme
cd50289
@brunoguerios
Merge remote-tracking branch 'origin/join' into refactor-join-interface
738c08d 
# Conflicts:
#	src/entities/join/types.ts
#	test/lib/utils/exitHelper.ts
#	test/lib/utils/joinHelper.ts
@brunoguerios
Refactor ExitKind into RemoveLiquidityKind
fbb33b1
@brunoguerios
Refactor ExitInput into RemoveLiquidityInput
c47de57
@brunoguerios
Refactor ExitQueryResult into RemoveLiquidityQueryOutput
933ebaf
@brunoguerios
Refactor ExitCall into RemoveLiquidityCall
2cf4d39
@brunoguerios
Refactor PoolExit into RemoveLiquidity
1332692
@brunoguerios
Refactor ExitBuildOutput into RemoveLiquidityOutput
b63f1b8
@brunoguerios
Refactor encoders and other files from exit to removeLiquidity
30ea9e3
@brunoguerios
Refactor remaining exit to removeLiquidity
26025a8
@brunoguerios
Refactor SingleAsset to SingleToken
54b917c
@brunoguerios
Refactor exitWithNativeAsset parameter to toNativeAsset
c82f935
@brunoguerios
Refactor some result into output for consistency
65651a2
@brunoguerios brunoguerios self-assigned this Nov 10, 2023
johngrantuk
johngrantuk approved these changes Nov 13, 2023
View reviewed changes
Copy link
Member

@johngrantuk johngrantuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of changes! But LGTM.

@brunoguerios
Merge remote-tracking branch 'origin/join' into refactor-join-interface
acfd6d0 
# Conflicts:
#	src/entities/addLiquidity/utils/validateInputs.ts
#	src/entities/exit/poolExit.ts
#	src/entities/join/poolJoin.ts
#	src/entities/removeLiquidity/utils/validateInputs.ts
@brunoguerios
Refactor join into addLiquidity and exit into removeLiquidity for Gyr…
b366164 
…o pools
@brunoguerios brunoguerios merged commit 31d244a into join Nov 14, 2023
3 of 4 checks passed
@brunoguerios brunoguerios deleted the refactor-join-interface branch November 14, 2023 17:46
@agualis agualis mentioned this pull request Nov 21, 2023
Merged
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johngrantuk johngrantuk johngrantuk approved these changes

@lgahdl lgahdl Awaiting requested review from lgahdl

Assignees

@brunoguerios brunoguerios

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@brunoguerios @johngrantuk