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.

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

Remove docs from Osmosis repo #828

Merged
merged 31 commits into from
Feb 7, 2022
Merged
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
f594f5b
Added Algolia crawler settings and instructions.
daniel-farina Dec 29, 2021
c085f44
Added Algolia crawler settings and instructions. (Config & Readme)
daniel-farina Dec 29, 2021
fe7c719
created example dropdowns in place of very busy page. Styl changes re…
czarcas7ic Dec 29, 2021
78e5b9b
footer no longer blank, different favicon than app
czarcas7ic Dec 30, 2021
f0fe370
rearranged cli section, took out mailing list function until implemented
czarcas7ic Dec 30, 2021
835d285
added asset page with ibc denoms and channels
czarcas7ic Jan 1, 2022
bffadf2
added module accounts with their addresses
czarcas7ic Jan 1, 2022
859a45e
added history of changes to osmosis
czarcas7ic Jan 4, 2022
f73e432
band-aid fix for testnet snapshot path issue
czarcas7ic Jan 8, 2022
b0863af
github edit now takes you to docs branch instead of main
czarcas7ic Jan 17, 2022
c502ded
pubkey update
czarcas7ic Jan 19, 2022
e45fc2f
pubkey update
czarcas7ic Jan 19, 2022
de6ec7d
Updated "Recommended readings" for IBC
daniel-farina Jan 19, 2022
d448a80
limitnofile update inf
czarcas7ic Jan 20, 2022
48172c9
limitnofile to inf
czarcas7ic Jan 20, 2022
f917ee5
added limitnproc to inf
czarcas7ic Jan 20, 2022
46f4a27
added limitnproc to inf
czarcas7ic Jan 20, 2022
4abd85c
changed rpc
czarcas7ic Jan 20, 2022
504100e
rocksdb guide
czarcas7ic Jan 20, 2022
06dacb9
use 6.2.0
czarcas7ic Jan 22, 2022
61f820c
correct from tx send to tx bank send
czarcas7ic Jan 23, 2022
ded9a01
swap exact amount out fix
czarcas7ic Jan 23, 2022
70e7198
create rocksdb guide (#779)
clemensgg Jan 24, 2022
1ebed66
need to reload journald now for logs to work
czarcas7ic Jan 25, 2022
ff9d93b
created airdrop account export instructions
czarcas7ic Jan 26, 2022
9499dcd
state export time increase and 2> explanation
czarcas7ic Jan 26, 2022
8ec59b2
added atom scan block explorer
czarcas7ic Jan 27, 2022
d0520d8
Updated docs build to execute on commits on the main branch that cont…
daniel-farina Jan 28, 2022
742d78b
Updated docsBranch on the vue app for the "edit this page on Github" …
daniel-farina Jan 28, 2022
afa7626
Merge branch 'main' of https://github.com/osmosis-labs/osmosis into docs
daniel-farina Feb 5, 2022
0ec7593
Remove Docs from osmosis's repo
daniel-farina Feb 5, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Merge branch 'main' of https://github.com/osmosis-labs/osmosis into docs
� Conflicts:
�	docs/developing/modules/spec-gamm.md
  • Loading branch information
daniel-farina committed Feb 5, 2022
commit afa76266c373a247f2741eb67d2058a2fce12efc
113 changes: 73 additions & 40 deletions docs/developing/modules/spec-gamm.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,9 @@ The GAMM module also has a **PoolCreationFee** parameter, which currently is set
Create a new liquidity pool and provide initial liquidity to it.

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

::: details Example
The JSON [config-file] must specify the following parameters:
The JSON `--pool-file` (in this case named `config.json`) must specify the following parameters:

```json
{
Expand All @@ -65,13 +63,15 @@ The JSON [config-file] must specify the following parameters:
}
```

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

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

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

The configuration json file contains the following parameters:
The configuration file contains the following parameters:

```json
{
Expand All @@ -82,13 +82,15 @@ The configuration json file contains the following parameters:
"future_pool_governor": ""
}
```
:::
</br>

::: warning
There is now a 100 OSMO fee for creating pools.
:::


</br>
</br>

### 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.
Expand All @@ -97,16 +99,17 @@ Add liquidity to a specified pool to get an **exact** amount of LP shares while
osmosisd tx gamm join-pool --pool-id --max-amounts-in --share-amount-out --from --chain-id
```

::: details Example
#### 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:

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


</br>
</br>


### exit-pool
Expand All @@ -116,16 +119,18 @@ Remove liquidity from a specified pool with an **exact** amount of LP shares whi
osmosisd tx gamm exit-pool --pool-id --min-amounts-out --share-amount-in --from --chain-id
```

::: details Example
#### 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:

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


</br>
</br>



### join-swap-extern-amount-in
Expand All @@ -138,15 +143,16 @@ This command essentially swaps an **exact** amount of an asset for the required
osmosisd tx gamm join-swap-extern-amount-in [token-in] [share-out-min-amount] --from --pool-id --chain-id
```

::: details Example
#### 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:

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

</br>
</br>



Expand All @@ -160,16 +166,18 @@ This command essentially converts an LP share into the corresponding share of to
osmosisd tx gamm exit-swap-extern-amount-out [token-out] [share-in-max-amount] --pool-id --from --chain-id
```

::: details Example
#### 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`:

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


</br>
</br>



### join-swap-share-amount-out
Expand All @@ -180,15 +188,16 @@ Swap a **maximum** amount of a specified token for another token, similar to swa
osmosisd tx gamm join-swap-share-amount-out [token-in-denom] [token-in-max-amount] [share-out-amount] --pool-id --from --chain-id
```

::: details Example
#### 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`:

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

</br>
</br>



Expand All @@ -200,16 +209,18 @@ Remove an **exact** amount of LP shares from a specified pool, swap the LP share
osmosisd tx gamm exit-swap-share-amount-in [token-out-denom] [share-in-amount] [token-out-min-amount] --pool-id --from --chain-id
```

::: details Example
#### 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`:

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


</br>
</br>


### swap-exact-amount-in

Expand All @@ -220,26 +231,27 @@ Swap an **exact** amount of tokens for a **minimum** of another token, similar t
osmosisd tx gamm swap-exact-amount-in [token-in] [token-out-min-amount] --pool-id --from --chain-id
```

::: details Example
#### Example

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

```sh
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
```
:::

</br>
</br>


### 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.
Swap a **maximum** amount of tokens out 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
osmosisd tx gamm swap-exact-amount-out [token-out] [token-in-max-amount] --swap-route-pool-ids --from --chain-id
```

::: details Example
#### Example

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

Expand All @@ -249,9 +261,10 @@ osmosisd tx gamm swap-exact-amount-out 140530uosmo 407239 --swap-route-pool-ids


[comment]: <> (Other resources Creating a liquidity bootstrapping pool and Creating a pool with a pool file)
:::


</br>
</br>


## Queries
Expand All @@ -264,15 +277,16 @@ Query the estimated result of the [swap-exact-amount-in](#swap-exact-amount-in)
osmosisd query gamm estimate-swap-exact-amount-in [poolID] [sender] [tokenIn] --swap-route-pool-ids --swap-route-denoms
```

::: details Example
#### Example

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

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

</br>
</br>


### estimate-swap-exact-amount-out
Expand All @@ -283,25 +297,30 @@ Query the estimated result of the [swap-exact-amount-out](#swap-exact-amount-out
osmosisd query gamm estimate-swap-exact-amount-out [poolID] [sender] [tokenOut] --swap-route-pool-ids --swap-route-denoms
```

::: details Example
#### Example

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

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

</br>
</br>


### num-pools

Query the number of active pools.

#### Example

```sh
osmosisd query gamm num-pools
```

</br>
</br>


### pool
Expand All @@ -312,7 +331,7 @@ Query the parameter and assets of a specific pool.
osmosisd query gamm pool [poolID] [flags]
```

::: details Example
#### Example

Query parameters and assets from `pool 1`.

Expand Down Expand Up @@ -346,8 +365,9 @@ Which outputs:
amount: "21388879300450"
weight: "500000.000000000000000000"
```
:::

</br>
</br>

### pool-assets

Expand All @@ -357,7 +377,7 @@ Query the assets of a specific pool. This query is a reduced form of the [pool](
osmosisd query gamm pool-assets [poolID] [flags]
```

::: details Example
#### Example

Query the assets from `pool 1`.

Expand All @@ -378,9 +398,11 @@ poolAssets:
denom: uosmo
weight: "536870912000000"
```
:::


</br>
</br>

### Pool Params

Query the parameters of a specific pool. This query is a reduced form of the [pool](#pool) query.
Expand All @@ -389,7 +411,7 @@ Query the parameters of a specific pool. This query is a reduced form of the [po
osmosisd query gamm pool-params [poolID] [flags]
```

::: details Example
#### Example

Query the parameters from pool 1.

Expand All @@ -404,17 +426,23 @@ swap_fee: "0.003000000000000000"
exit_fee: "0.000000000000000000"
smooth_weight_change_params: null
```
:::

</br>
</br>


### pools

Query parameters and assets of all active pools.

#### Usage

```sh
osmosisd query gamm pools
```

</br>
</br>



Expand All @@ -426,7 +454,7 @@ 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]
```

::: details Example
#### Example

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

Expand All @@ -441,19 +469,25 @@ spotPrice: "5.314387014412388547"
```

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



</br>
</br>


### total-liquidity

Query the total liquidity of all active pools.

#### Usage

```sh
osmosisd query gamm total-liquidity
```

</br>
</br>



Expand All @@ -465,7 +499,7 @@ Query the total amount of GAMM shares of a specific pool.
osmosisd query gamm total-share [poolID] [flags]
```

::: details Example
#### Example

Query the total amount of GAMM shares of pool 1.

Expand All @@ -482,4 +516,3 @@ totalShares:
```

Indicating there are a total of `252328895.834096787303097071 gamm/pool/1` at the time of this writing
:::
You are viewing a condensed version of this merge commit. You can view the full changes here.