x/gamm: Consider renaming CalcExitPoolShares to CalcExitCoinsFromShares

[AlpinYukseloglu]

Background

CalcExitPoolShares calculates the expected tokens output by a pool given some number of shares. With the current name, it's not clear whether or not the function calculates the number of shares from output tokens or output tokens from the number of shares, so I think it might be worth considering renaming it to something like CalcExitCoinsFromShares (or something else that better specifies what the function does).

osmosis/x/gamm/pool-models/balancer/amm.go

Line 501 in 85529c7

func (p *Pool) CalcExitPoolShares(ctx sdk.Context, exitingShares sdk.Int, exitFee sdk.Dec) (exitedCoins sdk.Coins, err error) {

Suggested Design

• CalcExitPoolShares -> CalcExitCoinsFromShares

Acceptance Criteria

• All existing and new tests pass
  

[p0mvn]

I like the idea. Suggest even being more verbose for clarity: CalcExitPoolCoinsFromShares

[AlpinYukseloglu]

cc: @ValarDragon @alexanderbez thoughts?