# GAMM

The GAMM module (Generalized Automated Market Maker) provides the logic to create and interact with liquidity pools on the Osmosis DEX.

# Contents

  1. Concepts
  2. Weights
  3. Pool Parameters
  4. Messages
  5. Transactions
  6. Queries and Transactions

# Concepts

The x/gamm module implements an AMM using Balancer style pools with varying amounts and weights of assets in pools.

# Pool

# Creation of Pool

At an initial creation of the pool, a fixed amount of 100 share token is minted in the pool and sent to the creator of the pool's account. The pool share denom is in the format of gamm/pool/{poolID} and is displayed in the format of GAMM-{poolID} to the user. Pool assets are sorted in alphabetical order by default.

# Joining Pool

When joining a pool, a user provides the maximum amount of tokens they're willing to deposit, while the front end takes care of the calculation of how many share tokens the user is eligible for at the specific moment of sending the transaction.

Calculation of exactly how many tokens are needed to get the designated share is done at the moment of processing the transaction, validating that it does not exceed the maximum amount of tokens the user is willing to deposit. After the validation, GAMM share tokens of the pool are minted and sent to the user's account. Joining the pool using a single asset is also possible.

# Exiting Pool

When exiting a pool, the user provides the minimum amount of tokens they are willing to receive as they are returning their shares of the pool. However, unlike joining a pool, exiting a pool requires the user to pay the exit fee, which is set as a param of the pool. The user's share tokens burnt as result. Exiting the pool using a single asset is also possible.

Exiting pool (opens new window)

# Swap

During the process of swapping a specific asset, the token the user is putting into the pool is denoted as tokenIn, while the token that would be returned to the user, the asset that is being swapped for, after the swap is denoted as tokenOut throughout the module.

Given a tokenIn, the following calculations are done to calculate how many tokens are to be swapped into and removed from the pool:

tokenBalanceOut * [1 - { tokenBalanceIn / (tokenBalanceIn + (1 - swapFee) * tokenAmountIn)} ^ (tokenWeightIn / tokenWeightOut)]

The calculation is also able to be reversed, the case where user provides tokenOut. The calculation for the amount of tokens that the user should be putting in is done through the following formula:

tokenBalanceIn * [{tokenBalanceOut / (tokenBalanceOut - tokenAmountOut)} ^ (tokenWeightOut / tokenWeightIn) -1] / tokenAmountIn

# Spot Price

Meanwhile, calculation of the spot price with a swap fee is done using the following formula:

spotPrice / (1 - swapFee), where spotPrice is defined as:

(tokenBalanceIn / tokenWeightIn) / (tokenBalanceOut / tokenWeightOut)

Spot price (opens new window)

# Multi-Hop

All tokens are swapped using a multi-hop mechanism. That is, all swaps are routed via the most cost-efficient way, swapping in and out from multiple pools in the process.

Multi-Hop (opens new window)

# Weights

Weights refer to the how we weight the reserves of assets within a pool. Its often convenient to think of weights in terms of ratios, so a 1:1 pool between "ATOM" and "BTC" is a pool where the spot price is #ATOM in pool / #BTC in pool.

A 2:1 pool is one where the spot price is 2*(#ATOM in pool) / #BTC in pool. This weights allows one to get the same spot price in the pool, with fewer ATOM reserves. (This comes at the cost of having higher slippage, e.g. buying 10 atoms moves the price more than a 1:1 pool with the same BTC liquidity).

Within the state machine, we represent weights as numbers, and the ratios are computed internally. So you could specify a pool between three assets, with weights 100:30:50, which is equivalent to a 10:3:5 pool.

The ratios provided in a CreatePool message, or governance proposal are capped at 2^20. However, within the state machine they are stored with an extra 30 bits of precision, allowing for smooth changes between two weights to happen with sufficient granularity.

(Note, these docs are intended to get shuffled around as we write more of the spec for x/gamm. I just wanted to document this along with the PR, to save work for our future selves)

# Network Parameters

Pools have the following parameters:

Key Type
SwapFee sdk.Dec
ExitFee sdk.Dec
FutureGovernor *FutureGovernor
Weights *Weights
SmoothWeightChangeParams *SmoothWeightChangeParams
PoolCreationFee sdk.Coins
  1. SwapFee - The swap fee is the cut of all swaps that goes to the Liquidity Providers (LPs) for a pool. Suppose a pool has a swap fee s. Then if a user wants to swap T tokens in the pool, sT tokens go to the LP's, and then (1 - s)T tokens are swapped according to the AMM swap function.
  2. ExitFee - The exit fee is a fee that is applied to LP's that want to remove their liquidity from the pool. Suppose a pool has an exit fee e. If they currently have S LP shares, then when they remove their liquidity they get tokens worth (1 - e)S shares back. The remaining eS shares are then burned, and the tokens corresponding to these shares are kept as liquidity.
  3. FutureGovernor - Osmosis plans to allow every pool to act as a DAO, with its own governance in a future upgrade. To facilitate this transition, we allow pools to specify who the governor should be as a string. There are currently 3 options for the future governor.
    • No one will govern it. This is done by leaving the future governor string as blank.
    • Allow a given address to govern it. This is done by setting the future governor as a bech32 address.
    • Lockups to a token. This is the full DAO scenario. The future governor specifies a token denomination denom, and a lockup duration duration. This says that "all tokens of denomination denom that are locked up for duration or longer, have equal say in governance of this pool".
  4. Weights - This defines the weights of the pool - https://balancer.fi/whitepaper.pdf (opens new window)
  5. SmoothWeightChangeParams - This allows pool governance to smoothly change the weights of the assets it holds in the pool. So it can slowly move from a 2:1 ratio, to a 1:1 ratio. Currently, smooth weight changes are implemented as a linear change in weight ratios over a given duration of time. So weights changed from 4:1 to 2:2 over 2 days, then at day 1 of the change, the weights would be 3:1.5, and at day 2 its 2:2, and will remain at these weight ratios.

The GAMM module also has a PoolCreationFee parameter, which currently is set to 100000000 uosmo or 100 OSMO.



# Messages

The x/gamm module supports the following message types:

# MsgCreateBalancerPool

MsgCreateBalancerPool (opens new window)

# MsgJoinPool

MsgJoinPool (opens new window)

# MsgExitPool

MsgExitPool (opens new window)

# MsgSwapExactAmountIn

MsgSwapExactAmountIn (opens new window)

# MsgSwapExactAmountOut

MsgSwapExactAmountOut (opens new window)

# MsgJoinSwapExternAmountIn

MsgJoinSwapExternAmountIn (opens new window)

# MsgJoinSwapShareAmountOut

MsgJoinSwapShareAmountOut (opens new window)

# MsgExitSwapShareAmountIn

MsgExitSwapShareAmountIn (opens new window)

# MsgExitSwapExternAmountOut

MsgExitSwapExternAmountOut (opens new window)

# Transactions

# Create pool

Create a new liquidity pool and provide initial liquidity to it.

osmosisd tx gamm create-pool [config-file] --from --chain-id
1
Example

The JSON [config-file] must specify the following parameters:

{
 "weights": [list weighted denoms],
 "initial-deposit": [list of denoms with initial deposit amount],
 "swap-fee": [swap fee in percentage],
 "exit-fee": [exit fee in percentage],
 "future-governor": [see options in pool parameters section above]
}
1
2
3
4
5
6
7

Create a new 50/50 AKT-OSMO liquidity pool with a swap and exit fee of 1%.

osmosisd tx gamm create-pool --pool-file [config-file] --from WALLET_NAME --chain-id osmosis-1
1

The configuration json file contains the following parameters:

{
 "weights": "5ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4,5uosmo",
 "initial-deposit": "499404ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4,500000uosmo",
 "swap-fee": "0.01",
 "exit-fee": "0.01",
 "future-governor": ""
}
1
2
3
4
5
6
7

WARNING

There is now a 100 OSMO fee for creating pools.

# Join pool

Add liquidity to a specified pool to get an exact amount of LP shares while specifying a maximum number tokens willing to swap to receive said LP shares.

osmosisd tx gamm join-pool --pool-id --max-amounts-in --share-amount-out --from --chain-id
1
Example

Join pool 3 with a maximum of .037753 AKT and the corresponding amount of OSMO to get an exact share amount of 1.227549469722224220 gamm/pool/3 using WALLET_NAME on the osmosis mainnet:

osmosisd tx gamm join-pool --pool-id 3 --max-amounts-in 37753ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4 --share-amount-out 1227549469722224220 --from WALLET_NAME --chain-id osmosis-1
1

# Exit pool

Remove liquidity from a specified pool with an exact amount of LP shares while specifying the minimum number of tokens willing to receive for said LP shares.

osmosisd tx gamm exit-pool --pool-id --min-amounts-out --share-amount-in --from --chain-id
1
Example

Exit pool 3 with for exactly 1.136326462628731195 gamm/pool/3 in order to receive a minimum of .033358 AKT and the corresponding amount of OSMO using WALLET_NAME on the osmosis mainnet:

osmosisd tx gamm exit-pool --pool-id 3 --min-amounts-out 33358ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4 --share-amount-in 1136326462628731195 --from WALLET_NAME --chain-id osmosis-1
1

# Join-swap-extern-amount-in

Add liquidity to a specified pool with only one of the required assets (i.e. Join pool 1 (50/50 ATOM-OSMO) with just ATOM).

This command essentially swaps an exact amount of an asset for the required pairing and then converts the pair to a minimum of the requested LP shares in a single step (i.e. combines the swap-exact-amount-in and join-pool commands)

osmosisd tx gamm join-swap-extern-amount-in [token-in] [share-out-min-amount] --from --pool-id --chain-id
1
Example

Join pool 3 with exactly .200000 AKT (and 0 OSMO) to get a minimum of 3.234812471272883046 gamm/pool/3 using WALLET_NAME on the osmosis mainnet:

osmosisd tx gamm join-swap-extern-amount-in 200000ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4 3234812471272883046 --pool-id 3 --from WALLET_NAME --chain-id osmosis-1
1

# Exit-swap-extern-amount-out

Remove liquidity from a specified pool with a maximum amount of LP shares and swap to an exact amount of one of the token pairs (i.e. Leave pool 1 (50/50 ATOM-OSMO) and receive 100% ATOM instead of 50% OSMO and 50% ATOM).

This command essentially converts an LP share into the corresponding share of tokens and then swaps to the specified token-out in a single step (i.e. combines the swap-exact-amount-out and exit-pool commands)

osmosisd tx gamm exit-swap-extern-amount-out [token-out] [share-in-max-amount] --pool-id --from --chain-id
1
Example

Exit pool 3 by removing a maximum of 3.408979387886193586 gamm/pool/3 and swap the OSMO portion of the LP share to receive 100% AKT in the exact amount of 0.199430 AKT:

osmosisd tx gamm exit-swap-extern-amount-out 199430ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4 3408979387886193586 --pool-id 3 --from WALLET_NAME --chain-id osmosis-1
1

# Join-swap-share-amount-out

Swap a maximum amount of a specified token for another token, similar to swapping a token on the trade screen GUI (i.e. takes the specified asset and swaps it to the other asset needed to join the specified pool) and then adds an exact amount of LP shares to the specified pool.

osmosisd tx gamm join-swap-share-amount-out [token-in-denom] [token-in-max-amount] [share-out-amount] --pool-id --from --chain-id
1
Example

Swap a maximum of 0.312466 OSMO for the corresponding amount of AKT, then join pool 3 and receive exactly 1.4481270389710236872 gamm/pool/3:

osmosisd tx gamm join-swap-share-amount-out uosmo 312466 14481270389710236872 --pool-id 3 --from WALLET_NAME --chain-id osmosis-1
1

# Exit-swap-share-amount-in

Remove an exact amount of LP shares from a specified pool, swap the LP shares to one of the token pairs to receive a minimum of the specified token amount.

osmosisd tx gamm exit-swap-share-amount-in [token-out-denom] [share-in-amount] [token-out-min-amount] --pool-id --from --chain-id
1
Example

Exit pool 3 by removing exactly 14.563185400026723131 gamm/pool/3 and swap the AKT portion of the LP share to receive 100% OSMO in the minimum amount of .298548 OSMO:

osmosisd tx gamm exit-swap-share-amount-in uosmo 14563185400026723131 298548 --pool-id 3 --from WALLET_NAME --chain-id osmosis-1
1

# Swap-exact-amount-in

Swap an exact amount of tokens for a minimum of another token, similar to swapping a token on the trade screen GUI.

osmosisd tx gamm swap-exact-amount-in [token-in] [token-out-min-amount] --pool-id --from --chain-id
1
Example

Swap exactly .407239 AKT through pool 3 into a minimum of .140530 OSMO using WALLET_NAME on the osmosis mainnet:

osmosisd tx gamm swap-exact-amount-in 407239ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4 140530 --swap-route-pool-ids 3 --swap-route-denoms uosmo --from WALLET_NAME --chain-id osmosis-1
1

# Swap-exact-amount-out

Swap a maximum amount of tokens for an exact amount of another token, similar to swapping a token on the trade screen GUI.

osmosisd tx gamm swap-exact-amount-out [token-out] [token-out-max-amount] --swap-route-pool-ids --from --chain-id
1
Example

Swap a maximum of .407239 AKT through pool 3 into exactly .140530 OSMO using WALLET_NAME on the osmosis mainnet:

osmosisd tx gamm swap-exact-amount-out 140530uosmo 407239 --swap-route-pool-ids 3 --swap-route-denoms ibc/1480B8FD20AD5FCAE81EA87584D269547DD4D436843C1D20F15E00EB64743EF4 --from WALLET_NAME --chain-id osmosis-1
1

# Queries and Transactions

# Queries

The Query submodule of the GAMM module provides the logic to request information from the liquidity pools. It contains the following functions:

# Estimate Swap Exact Amount In

Query the estimated result of the Swap Exact Amount In transaction. Note that the flags swap-route-pool and swap-route-denoms are required.

# Usage

osmosisd query gamm estimate-swap-exact-amount-in <poolID> <sender> <tokenIn> [flags]
1

# Example

Query the amount of ATOM the sender would receive for swapping 1 OSMO in pool 1.

osmosisd query gamm estimate-swap-exact-amount-in 1 osmo123nfq6m8f88m4g3sky570unsnk4zng4uqv7cm8 1000000uosmo --swap-route-pool-ids 1 --swap-route-denoms ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2 
1

# Estimate Swap Exact Amount Out

Query the estimated result of the Swap Exact Amount Out transaction. Note that the flags swap-route-pool and swap-route-denoms are required.

# Usage

osmosisd query gamm estimate-swap-exact-amount-out <poolID> <sender> <tokenOut> [flags]
1

# Example

Query the amount of OSMO the sender would require to swap 1 ATOM out of pool 1.

osmosisd query gamm estimate-swap-exact-amount-out 1 osmo123nfq6m8f88m4g3sky570unsnk4zng4uqv7cm8 1000000ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2 --swap-route-pool-ids 1 --swap-route-denoms uosmo
1

# Num Pools

Query the number of active pools.

# Usage

osmosisd query gamm num-pools
1

# Pool

Query the parameter and assets of a specific pool.

# Usage

osmosisd query gamm pool <poolID> [flags]
1

# Example

Query parameters and assets from pool 1.

osmosisd query gamm pool 1
1

# Pool Assets

Query the assets of a specific pool. This query is a reduced form of the Pool query.

# Usage

osmosisd query gamm pool-assets <poolID> [flags]
1

# Example

Query the assets from pool 1.

osmosisd query gamm pool-assets 1
1

# Pool Params

Query the parameters of a specific pool. This query is a reduced form of the Pool query.

# Usage

osmosisd query gamm pool-params <poolID> [flags]
1

Query the parameters from pool 1.

# Example

osmosisd query gamm pool-params 1
1

# Pools

Query parameters and assets of all active pools.

# Usage

Query the price of OSMO based on the price of ATOM in pool 1.

osmosisd query gamm spot-price 1 uosmo ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2
1

# Total Liquidity

Query the total liquidity of all active pools.

# Usage

osmosisd query gamm total-liquidity
1

# Total Share

Query the total amount of GAMM shares of a specific pool.

# Usage

osmosisd query gamm total-share <poolID> [flags]
1

# Example

Query the total amount of GAMM shares of pool 1.

osmosisd query gamm total-share 1
1

# Transactions

The Transaction submodule of the GAMM module provides the logic to create and interact with the liquidity pools. It contains the following functions:

# Estimate-swap-exact-amount-in

Query the estimated result of the swap-exact-amount-in transaction.

osmosisd query gamm estimate-swap-exact-amount-in [poolID] [sender] [tokenIn] --swap-route-pool-ids --swap-route-denoms
1
Example

Query the amount of ATOM (or ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2) the sender would receive for swapping 1 OSMO in pool 1.

osmosisd query gamm estimate-swap-exact-amount-in 1 osmo123nfq6m8f88m4g3sky570unsnk4zng4uqv7cm8 1000000uosmo --swap-route-pool-ids 1 --swap-route-denoms ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2
1

# Estimate-swap-exact-amount-out

Query the estimated result of the swap-exact-amount-out transaction.

osmosisd query gamm estimate-swap-exact-amount-out [poolID] [sender] [tokenOut] --swap-route-pool-ids --swap-route-denoms
1
Example

Query the amount of OSMO the sender would require to swap 1 ATOM (or 1000000ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2) our of pool 1:

osmosisd query gamm estimate-swap-exact-amount-out 1 osmo123nfq6m8f88m4g3sky570unsnk4zng4uqv7cm8 1000000ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2 --swap-route-pool-ids 1 --swap-route-denoms uosmo
1

# Num-pools

Query the number of active pools.

osmosisd query gamm num-pools
1

# Pool

Query the parameter and assets of a specific pool.

osmosisd query gamm pool [poolID] [flags]
1
Example

Query parameters and assets from pool 1.

osmosisd query gamm pool 1
1

Which outputs:

  address: osmo1mw0ac6rwlp5r8wapwk3zs6g29h8fcscxqakdzw9emkne6c8wjp9q0t3v8t
  id: 1
  pool_params:
    swap_fee: "0.003000000000000000"
    exit_fee: "0.000000000000000000"
    smooth_weight_change_params: null
  future-governor: 24h
  total_weight: "1000000.000000000000000000"
  total_shares:
    denom: gamm/pool/1
    amount: "252329392916236134754561337"
  pool_assets:
  - |
    token:
      denom: ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2
      amount: "4024633105693"
    weight: "500000.000000000000000000"
  - |
    token:
      denom: uosmo
      amount: "21388879300450"
    weight: "500000.000000000000000000"
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Pool-assets

Query the assets of a specific pool. This query is a reduced form of the pool query.

osmosisd query gamm pool-assets [poolID] [flags]
1
Example

Query the assets from pool 1.

osmosisd query gamm pool-assets 1
1

Which outputs:

poolAssets:
- token:
    amount: "4024839695885"
    denom: ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2
  weight: "536870912000000"
- token:
    amount: "21387918414792"
    denom: uosmo
  weight: "536870912000000"
1
2
3
4
5
6
7
8
9

# Pool Params

Query the parameters of a specific pool. This query is a reduced form of the pool query.

osmosisd query gamm pool-params [poolID] [flags]
1
Example

Query the parameters from pool 1.

osmosisd query gamm pool-params 1
1

Which outputs:

swap_fee: "0.003000000000000000"
exit_fee: "0.000000000000000000"
smooth_weight_change_params: null
1
2
3

# Pools

Query parameters and assets of all active pools.

osmosisd query gamm pools
1

# Spot-price

Query the spot price of a pool asset based on a specific pool it is in.

osmosisd query gamm spot-price [poolID] [tokenInDenom] [tokenOutDenom] [flags]
1
Example

Query the price of OSMO based on the price of ATOM in pool 1:

osmosisd query gamm spot-price 1 uosmo ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2
1

Which outputs:

spotPrice: "5.314387014412388547"
1

In other words, at the time of this writing, ~5.314 OSMO is equivalent to 1 ATOM.

# Total-liquidity

Query the total liquidity of all active pools.

osmosisd query gamm total-liquidity
1

# Total-share

Query the total amount of GAMM shares of a specific pool.

osmosisd query gamm total-share [poolID] [flags]
1
Example

Query the total amount of GAMM shares of pool 1.

osmosisd query gamm total-share 1
1

Which outputs:

totalShares:
  amount: "252328895834096787303097071"
  denom: gamm/pool/1
1
2
3

Indicating there are a total of 252328895.834096787303097071 gamm/pool/1 at the time of this writing

# Create Pool

Create a new liquidity pool and provide the initial liquidity to it. Pool initialization parameters must be provided through a JSON file using the flag pool-file.

# Usage

osmosisd tx gamm create-pool [flags]
1

The configuration file config.json must specify the following parameters.

{
 "weights": [list weighted denoms],
 "initial-deposit": [list of denoms with initial deposit amount],
 "swap-fee": [swap fee in percentage],
 "exit-fee": [exit fee in percentage],
 "future-governor": [number of hours]
}
1
2
3
4
5
6
7

# Example

Create a new ATOM-OSMO liquidity pool with a swap and exit fee of 1%.

tx gamm create-pool --pool-file ../public/config.json --from myKeyringWallet
1

The configuration file contains the following parameters.

{
 "weights": "5uatom,5uosmo",
 "initial-deposit": "100uatom,100uosmo",
 "swap-fee": "0.01",
 "exit-fee": "0.01",
 "future-governor": "168h"
}
1
2
3
4
5
6
7

# Join Pool

Join a specific pool with a custom amount of tokens. Note that the flags pool-id, max-amounts-in and share-amount-out are required.

# Usage

osmosisd tx gamm join-pool [flags]
1

# Example

Join pool 1 with 1 OSMO and the respective amount of ATOM, using myKeyringWallet.

osmosisd tx gamm join-pool --pool-id 2 --max-amounts-in 1000000uosmo --max-amounts-in 1000000uion --share-amount-out 1000000 --from myKeyringWallet
1

# Exit Pool

Exit a specific pool with a custom amount of tokens. Note that the flags pool-id, min-amounts-out and share-amount-in are required.

# Usage

osmosisd tx gamm exit-pool [flags]
1

# Example

Exit pool one with 1 OSMO and the respective amount of ATOM using myKeyringWallet.

osmosisd tx gamm exit-pool --pool-id 1 --min-amounts-out 1000000uosmo --share-amount-in 1000000 --from myKeyringWallet
1

# Join Swap Extern Amount In

Note that the flags pool-id is required.

# Usage

osmosisd tx gamm join-swap-extern-amount-in [token-in] [share-out-min-amount] [flags]
1

# Example

osmosisd tx gamm join-swap-extern-amount-in 1000000uosmo 1000000 --pool-id 1 --from myKeyringWallet
1

# Exit Swap Extern Amount Out

Note that the flag pool-id is required.

osmosisd tx gamm exit-swap-extern-amount-out [token-out] [share-in-max-amount] [flags]
1

# Example

osmosisd tx gamm exit-swap-extern-amount-out 1000000uosmo 1000000 --pool-id 1 --from myKeyringWallet
1

# Join Swap Share Amount Out

Note that the flag pool-id is required.

# Usage

osmosisd tx gamm join-swap-share-amount-out [token-in-denom] [token-in-max-amount] [share-out-amount] [flags]
1

# Example

osmosisd tx gamm join-swap-share-amount-out uosmo 1000000 1000000 --pool-id 1 --from myKeyringWallet
1

# Exit Swap Share Amount In

Note that the flag pool-id is required.

# Usage

osmosisd tx gamm exit-swap-share-amount-in [token-out-denom] [share-in-amount] [token-out-min-amount] [flags]
1

# Example

osmosisd tx gamm exit-swap-share-amount-in uosmo 1000000 1000000 --pool-id 1 --from myKeyringWallet
1

# Swap Exact Amount In

Swap an exact amount of tokens into a specific pool. Note that the flags swap-route-pool-ids and swap-route-denoms are required.

# Usage

osmosisd tx gamm swap-exact-amount-in [token-in] [token-out-min-amount] [flags]
1

# Example

Swap 1 OSMO through pool 1 into at least 0.3 ATOM using MyKeyringWallet.

osmosisd tx gamm swap-exact-amount-in 1000000uosmo 300000 --swap-route-pool-ids 1 --swap-route-denoms ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2 --from MyKeyringWallet
1

# Swap Exact Amount Out

Swap an exact amount of tokens out of a specific pool. Note that the flags swap-route-pool-ids and swap-route-denoms are required.

# Usage

osmosisd tx gamm swap-exact-amount-out [token-out] [token-out-max-amount] [flags]
1

# Example

Swap 1 ATOM through pool 1 into at most 2.5 OSMO using MyKeyringWallet.

osmosisd tx gamm swap-exact-amount-out 1000000ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2 250000 --swap-route-pool-ids 1 --swap-route-denoms uosmo --from MyKeyringWallet
1

# Other resources

# Events

There are 4 types of events that exist in GAMM:

  • sdk.EventTypeMessage - "message"
  • types.TypeEvtPoolJoined - "pool_joined"
  • types.TypeEvtPoolExited - "pool_exited"
  • types.TypeEvtPoolCreated - "pool_created"
  • types.TypeEvtTokenSwapped - "token_swapped"

# sdk.EventTypeMessage

This event is emitted in the message server when any of the gamm messages finish execution.

TBD

# types.TypeEvtPoolExited

TBD

# types.TypeEvtPoolCreated

TBD

# types.TypeEvtTokenSwapped

This event is emitted after one of SwapExactAmountOut or SwapExactAmountIn updates pool state successfully.

It consists of the following attributes:

  • sdk.AttributeKeyModule - "module"
    • The value is the module's name - "gamm".
  • sdk.AttributeKeySender
    • The value is the address of the sender who created the swap message.
  • types.AttributeKeyPoolId
    • The value is the pool id of the pool where swap occurs.
  • types.AttributeKeyTokensIn
    • The value is the string representation of the tokens being swapped in.
  • types.AttributeKeyTokensOut
    • The value is the string representation of the tokens being swapped out.