At the time of writing this documentation, this is the recommended server specs by osmosis team. As the usage of the blockchain grows, the server requirements may increase as well.
- 4 or more physical CPU cores
- At least 500GB of SSD disk storage
- At least 16GB of memory
- At least 100mbps network bandwidth
Osmosis is built using Go and requires Go version 1.15+.
In this example, we will be installing Go on Ubuntu 18.04.2 LTS:
# First remove any existing old Go installation
sudo rm -rf /usr/local/go
# Install the latest version of Go using this helpful script
curl https://raw.githubusercontent.com/canha/golang-tools-install-script/master/goinstall.sh | bash
# Update environment variables to include go
cat <<'EOF' >>$HOME/.profile
export GOROOT=/usr/local/go
export GOPATH=$HOME/go
export PATH=$PATH:/usr/local/go/bin:$HOME/go/bin
EOF
source $HOME/.profile
# Verify that Go is installed
# Should return go version go1.16.4 linux/amd64
go version# Clone the project
# At the time of writing this guide, mainnet uses 3.1.0 version
git clone -b v3.1.0 https://github.com/osmosis-labs/osmosis.git
cd osmosis
go mod tidy
# Build osmosis node software "osmosisd"
# This command will install the executable osmosis node daemon to your GOPATH
make install
# Verify the osmosisd version
osmosisd version --long
->
name: osmosis
server_name: osmosisd
version: 3.1.0
commit: 13916d1e10bca718b6ea7f4b84715710bc319e6d
build_tags: netgo,ledger
go: go version go1.16.3 linux/amd64-
Initialize the chain
# (Recommend) Save chain id in osmosisd config # # This command will save the chain id into your client.toml which is located # in your home directory (default: $HOME/.osmosisd/config/client.toml) osmosisd config chain-id osmosis-1 # Initialize chain # # Replace <moniker> for the public alias of your node (you can edit moniker later) # Example: osmosisd init testnode --chain-id osmosis-1 # This will create a new $HOME/.osmosisd folder in your HOME directory osmosisd init <moniker> --chain-id=osmosis-1
-
Fetch the mainnet's genesis file
https://github.com/osmosis-labs/networks/blob/main/osmosis-1/genesis.json
wget -O $HOME/.osmosisd/config/genesis.json https://github.com/osmosis-labs/networks/raw/main/osmosis-1/genesis.json
-
Manually add the below peers list in your
$HOME/.osmosisd/config/config.tomlfile. You can find the peers list in this link. Since IBC and swap state transactions are very large, it is suggested to increase the timeout for a transaction to be committed and maximum size of request body and header. Without configuring those values, you may experience the node to stop from time to time when your node receives too many requests.seeds = "[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:36657,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,83adaa38d1c15450056050fd4c9763fcc7e02e2c@ec2-44-234-84-104.us-west-2.compute.amazonaws.com:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26666,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656,[email protected]:26656" # The ibc and swap state are very large, causing the node itself # to stop on excessive queries. Therefore, we customize the rpc configuration # as above. # How long to wait for a tx to be committed during /broadcast_tx_commit. # WARNING: Using a value larger than 10s will result in increasing the # global HTTP write timeout, which applies to all connections and endpoints. # See https://github.com/tendermint/tendermint/issues/3435 timeout_broadcast_tx_commit = "600s" # Maximum size of request body, in bytes max_body_bytes = 10000000 # Maximum size of request header, in bytes max_header_bytes = 10485760
-
Replace necessary configuration
sed -i '' 's#"tcp://127.0.0.1:26657"#"tcp://0.0.0.0:26657"#g' $HOME/.osmosisd/config/config.toml sed -i '' 's/enable = false/enable = true/g' $HOME/.osmosisd/config/config.toml sed -i '' 's/swagger = false/swagger = true/g' $HOME/.osmosisd/config/config.toml
State sync allows a new node to join a network by fetching a snapshot of the application state at a recent height instead of fetching and replaying all historical blocks. This can reduce the time needed to sync with the network from days to minutes. Reference this article to know more about Cosmos SDK state sync.
Option 1. Setup using state synced data dump
- You can follow this guide operated by ChainLayer
Option 2. State sync via snapshot supply nodes
-
snapshot supply nodes (2 node setting- Block must be at the latest height)
Manually add the below setting in
$HOME/.osmosisd/config/app.tomlfile.############################################################################### ### State Sync Configuration ### ############################################################################### # State sync snapshots allow other nodes to rapidly join the network without replaying historical # blocks, instead downloading and applying a snapshot of the application state at a given height. [state-sync] # snapshot-interval specifies the block interval at which local state sync snapshots are # taken (0 to disable). Must be a multiple of pruning-keep-every. snapshot-interval = 100 # snapshot-keep-recent specifies the number of recent snapshots to keep and serve (0 to keep all). snapshot-keep-recent = 2
-
Node to receive snapshot (1 node that needs to sync)
Manually change the state sync values in your
$HOME/.osmosisd/config/app.tomlfile.(Set the peers list as well)
#"snapshot-interval = 100, snapshot-keep-recent = 2" → lastblock - 100 = trust_heightcurl -s http://<Public-RPC-NODE>/block?height=7270300 | jq -r '.result.block.header.height + "\n" + .result.block_id.hash'
[statesync] # State sync rapidly bootstraps a new node by discovering, fetching, and restoring a state machine # snapshot from peers instead of fetching and replaying historical blocks. Requires some peers in # the network to take and serve state machine snapshots. State sync is not attempted if the node # has any local state (LastBlockHeight > 0). The node will have a truncated block history, # starting from the height of the snapshot. enable = true # RPC servers (comma-separated) for light client verification of the synced state machine and # retrieval of state data for node bootstrapping. Also needs a trusted height and corresponding # header hash obtained from a trusted source, and a period during which validators can be trusted. # # For Cosmos SDK-based chains, trust_period should usually be about 2/3 of the unbonding time (~2 # weeks) during which they can be financially punished (slashed) for misbehavior. rpc_servers = "http://<Public-RPC-NODE1>,http://<Public-RPC-NODE2>" trust_height = 7270300 trust_hash = "" trust_period = "336h" # Time to spend discovering snapshots before initiating a restore. discovery_time = "15s" # Temporary directory for state sync snapshot chunks, defaults to the OS tempdir (typically /tmp). # Will create a new, randomly named directory within, and remove it when done. temp_dir = "<snapshot save dir>"
-
osmosisd startIf you see log like this, it's going well.
7:11PM INF Fetching snapshot chunk chunk=7 format=1 height=7271000 module=statesync total=33 7:11PM INF Applied snapshot chunk to ABCI app chunk=3 format=1 height=7271000 module=statesync total=33 ... 7:15PM INF executed block height=7271024 module=state num_invalid_txs=0 num_valid_txs=0 7:15PM INF commit synced commit=436F6D6D697449447B5B313130203439203133392031353420313336203235342032303620313439203134203230352031323420313033203134322031392039392032303020313536203130372032392031343520313137203232362036342033372031333220343320323433203834203131392032313320323331203133355D3A3645463237307D 7:15PM INF committed state app_hash=6E318B9A88FECE950ECD7C678E1363C89C6B1D9175E24025842BF35477D5E787 height=7271024 module=state num_txs=0 7:15PM INF indexed block height=7271024 module=txindex 7:15PM INF minted coins from module account amount=4453682uatom from=mint module=x/bank 7:15PM INF executed block height=7271025 module=state num_invalid_txs=0 num_valid_txs=0 7:15PM INF commit synced commit=436F6D6D697449447B5B3233312039372032333720313738203230392031333020323435203431203234332039203139362032343620313036203231392031393920393120343220313732203234372031313120313632203238203738203631203232392033312036322035352032333620363420323237203233335D3A3645463237317D 7:15PM INF committed state app_hash=E761EDB2D182F529F309C4F66ADBC75B2AACF76FA21C4E3DE51F3E37EC40E3E9 height=7271025 module=state num_txs=0 7:15PM INF indexed block height=7271025 module=txindex
-
When the sync is complete, set it up as follows:
[statesync] # State sync rapidly bootstraps a new node by discovering, fetching, and restoring a state machine # snapshot from peers instead of fetching and replaying historical blocks. Requires some peers in # the network to take and serve state machine snapshots. State sync is not attempted if the node # has any local state (LastBlockHeight > 0). The node will have a truncated block history, # starting from the height of the snapshot. enable = false
-
Wait for at least 10 minutes to connect with peers. If you continue to see dialing peers in logs, then there may not be a single node that accepts connection. You need to find working peers by joining Osmosis Discord and ask for it.
Simple way to start
osmosisd startUse systemd service to start
sudo tee /etc/systemd/system/osmosisd.service > /dev/null <<EOF
[Unit]
Description=Osmosis Daemon
After=network-online.target
Requires=osmosisd.service
[Service]
User=root
ExecStart=/root/goApps/bin/osmosisd start
Restart=always
RestartSec=3
LimitNOFILE=4096
[Install]
WantedBy=multi-user.target
# Enable osmosisd and start
sudo systemctl daemon-reload
sudo systemctl enable osmosisd
sudo systemctl start osmosisd
# Monitor osmosisd service logs
journalctl -u osmosisd -fEach pair of tokens in a pool has a pool price defined by the reserves and weights of that pair of tokens.
When users swap tokens in the pool, they want to know how much the expected swap price is. Here, the expected swap price is the price considering slippage. (swap fees are not considered)
Not available yet
In this section, we're going to analyze ATOM / OSMO pool based on the calculation written above.
Note that REST API endpoint used in this section doesn't guarantee availability and it may not be stable to use for production level. We recommend you to set up your own if you consider doing arbitrage opportunity in mainnet.
At the time of writing (2021.08.12 03:17:00 UTC), the following prices are current ATOM and OSMO prices from CoinGecko
ATOM: $15.06: https://www.coingecko.com/en/coins/cosmos
OSMO: $1.99: https://www.coingecko.com/en/coins/osmosis
This means 1 OSMO is equal to 0.132138114209827 OSMO
→ Global Price: 0.132138114209827
In order to get pool price, you need an information about two reserve tokens amount.
You can use this REST API to get the information
First, let's get the pool information.
-
Query ATOM/OSMO pool uses pool id of 1
https://lcd-osmosis.keplr.app/osmosis/gamm/v1beta1/pools/1
You can see there is an information about two different tokens and their weights inside
poolAssetsarray.Note that denom starting with
ibc/{hash}is a denom that is transferred using IBC protocol.You need to use another REST API to get the name of denom.
{ "pool": { "@type": "/osmosis.gamm.v1beta1.Pool", "address": "osmo1mw0ac6rwlp5r8wapwk3zs6g29h8fcscxqakdzw9emkne6c8wjp9q0t3v8t", "id": "1", "poolParams": { "swapFee": "0.003000000000000000", "exitFee": "0.000000000000000000", "smoothWeightChangeParams": null }, "future_pool_governor": "24h", "totalShares": { "denom": "gamm/pool/1", "amount": "82104367121967389456514715" }, "poolAssets": Array[2][ { "token": { "denom": "ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2", "amount": "1083043337742" }, "weight": "536870912000000" }, { "token": { "denom": "uosmo", "amount": "8147463787407" }, "weight": "536870912000000" } ], "totalWeight": "1073741824000000" } } -
Query a denomination trace information
You can see that the denom is
uatomfrom the API.{ "denom_trace": { "path": "transfer/channel-0", "base_denom": "uatom" } }
Let's use the fields from the API result to calculate the pool price.
This means 1 OSMO is equal to 0.132930119851031 ATOM
→ Pool Price: 0.132930119850976
Let's say we would like to swap 100 ATOM (100000000uatom) from the pool.
What is the expected amount of OSMO to receive and swap price?
→ Expected Swap Amount: 752205502.588607647064247 (uosmo)
→ Expected Swap Price: 0.132942393609013
Gap between global price and pool price: 0.005958060084779
In ATOM/OSMO pool case, it is not worth of doing arbitrage since the gap is too small. However, if there is a enough gap that is worthwhile to take the opportunity, then you can send swap transaction to the network in your need. Reference section 6. References to get to know about how to use available command-line interfaces.
The following parameters are some params that you should take into consideration.
it is managed by the token holders of the pool respectively. You can query pools to know about the information. For example, https://lcd-osmosis.keplr.app/osmosis/gamm/v1beta1/pools/1
it is managed by the token holders of the pool respectively. You can query pools to know about the information. For example, https://lcd-osmosis.keplr.app/osmosis/gamm/v1beta1/pools/1
it is a minimum number of tokens when creating a pool
It is a maximum number of tokens when creating a pool
It is a fixed amount of share tokens (10^18 * 100) is minted at an initial creation of the pool.
The gamm module is designed to handle assets of a chain using the AMM and its concept of pool shares. It is where core logics of osmosis project locates.
Querying commands for the gamm module
Available Commands:
estimate-swap-exact-amount-in Query estimate-swap-exact-amount-in
estimate-swap-exact-amount-out Query estimate-swap-exact-amount-out
num-pools Query number of pools
pool Query pool
pool-assets Query pool-assets
pool-params Query pool-params
pools Query pools
spot-price Query spot-price
total-liquidity Query total-liquidity
total-share Query total-share-
num-pools
# Command-line Interface osmosisd q gamm num-pools --output json | jq # REST API http://localhost:1317/osmosis/gamm/v1beta1/num_pools
{ "numPools": "1" } -
pools
# Command-line Interface osmosisd q gamm pools --output json | jq # REST API http://localhost:1317/osmosis/gamm/v1beta1/pools
{ "pools": [ { "@type": "/osmosis.gamm.v1beta1.Pool", "address": "osmo1500hy75krs9e8t50aav6fahk8sxhajn9ctp40qwvvn8tcprkk6wszun4a5", "id": "1", "poolParams": { "swapFee": "0.003000000000000000", "exitFee": "0.000000000000000000", "smoothWeightChangeParams": null }, "future_pool_governor": "24h", "totalShares": { "denom": "gamm/pool/1", "amount": "110000000000000000000" }, "poolAssets": [ { "token": { "denom": "uatom", "amount": "5503000000" }, "weight": "5368709120" }, { "token": { "denom": "uosmo", "amount": "10994021257" }, "weight": "5368709120" } ], "totalWeight": "10737418240" } ], "pagination": { "next_key": null, "total": "2" } } -
pool
# Command-line Interface osmosisd q gamm pool 1 --output json | jq # REST API http://localhost:1317/osmosis/gamm/v1beta1/pools/1
{ "pools": [ { "@type": "/osmosis.gamm.v1beta1.Pool", "address": "osmo1500hy75krs9e8t50aav6fahk8sxhajn9ctp40qwvvn8tcprkk6wszun4a5", "id": "1", "poolParams": { "swapFee": "0.003000000000000000", "exitFee": "0.000000000000000000", "smoothWeightChangeParams": null }, "future_pool_governor": "24h", "totalShares": { "denom": "gamm/pool/1", "amount": "110000000000000000000" }, "poolAssets": [ { "token": { "denom": "uatom", "amount": "5503000000" }, "weight": "5368709120" }, { "token": { "denom": "uosmo", "amount": "10994021257" }, "weight": "5368709120" } ], "totalWeight": "10737418240" } ], "pagination": { "next_key": null, "total": "2" } } -
pool-params
# Command-line Interface osmosisd q gamm pool-params 1 --output json | jq # REST API /osmosis/gamm/v1beta1/pools/1/params
{ "params": { "swapFee": "0.003000000000000000", "exitFee": "0.000000000000000000", "smoothWeightChangeParams": null } } -
pool-assets
osmosisd q gamm pool-assets 1 --output json | jq http://localhost:1317/osmosis/gamm/v1beta1/pools/1/tokens{ "poolAssets": [ { "token": { "denom": "uatom", "amount": "5503000000" }, "weight": "5368709120" }, { "token": { "denom": "uosmo", "amount": "10994021257" }, "weight": "5368709120" } ] } -
spot-price
# Command-line Interface # Calculation: (B_in / W_in) / (B_out / W_out) # swap fee flag does not exist in cli whereas codebase deals with it osmosisd q gamm spot-price 1 uatom uosmo --output json | jq osmosisd q gamm spot-price 1 uosmo uatom --output json | jq # REST API Not Available
{ "spotPrice": "0.500000000000000000" } -
total-liquidity
# Command-line Interface osmosisd q gamm total-liquidity --output json | jq http://localhost:1317/osmosis/gamm/v1beta1/total_liquidity
{ "liquidity": [ { "denom": "uatom", "amount": "10000000000" }, { "denom": "uosmo", "amount": "20000000000" } ] } -
total-share
# Command-line Interface # initial pool shares is 10^18 * 100 (100000000000000000000) osmosisd q gamm total-share 1 --output json | jq # NOT WORKING http://localhost:1317/osmosis/gamm/v1beta1/pools/1/total_share
{ "totalShares": { "denom": "gamm/pool/1", "amount": "110000000000000000000" } } -
estimate-swap-exact-amount-in
# Command-line Interface osmosisd q gamm estimate-swap-exact-amount-in 1 osmo185fflsvwrz0cx46w6qada7mdy92m6kx4qm4l9k 1000000uatom \ --swap-route-denoms uosmo \ --swap-route-pool-ids 1 \ --output json | jq # REST API (Not working, need to dig more) http://localhost:1317/osmosis/gamm/v1beta1/1/estimate/swap_exact_amount_in?poolId=1&sender=osmo185fflsvwrz0cx46w6qada7mdy92m6kx4qm4l9k&tokenIn=1000000uatom
{ "tokenOutAmount": "1993602" } -
estimate-swap-exact-amount-out
# Command-line Interface osmosisd q gamm estimate-swap-exact-amount-out 1 osmo185fflsvwrz0cx46w6qada7mdy92m6kx4qm4l9k 1000000uatom \ --swap-route-denoms uosmo \ --swap-route-pool-ids 1 \ --output json | jq osmosisd q gamm estimate-swap-exact-amount-out 1 osmo185fflsvwrz0cx46w6qada7mdy92m6kx4qm4l9k 1000000uosmo \ --swap-route-denoms uatom \ --swap-route-pool-ids 1 \ --output json | jq
{ "tokenInAmount": "2005618" }
Transaction commands for the gamm module
Available Commands:
create-pool create a new pool and provide the liquidity to it
exit-pool exit a new pool and withdraw the liquidity from it
exit-swap-extern-amount-out exit swap extern amount out
exit-swap-share-amount-in exit swap share amount in
join-pool join a new pool and provide the liquidity to it
join-swap-extern-amount-in join swap extern amount in
join-swap-share-amount-out join swap share amount out
swap-exact-amount-in swap exact amount in
swap-exact-amount-out swap exact amount out-
create-pool
create a new pool and provide the liquidity to it
An example of
plan.jsonfile.{ "weights": "5uatom,5uosmo", "initial-deposit": "5000000000uatom,10000000000uosmo", "swap-fee": "0.003", "exit-fee": "0.00", "future-governor": "24h" }osmosisd tx gamm create-pool \ --chain-id localnet \ --pool-file="pool.json" \ --from user2 \ --keyring-backend test \ --broadcast-mode block \ --gas 500000 \ --yes
-
join-pool
join a new pool and provide the liquidity to it
# --share-amount-out: shareRatio is the desired number of shares # divided by the total number of shares currently in the pool. # # http://localhost:1317/osmosis/gamm/v1beta1/pools # osmosisd tx gamm join-pool \ --chain-id localnet \ --from user2 \ --keyring-backend test \ --broadcast-mode block \ --pool-id 1 \ --share-amount-out 10000000000000000000 \ --max-amounts-in 500000000uatom \ --max-amounts-in 1000000000uosmo \ --yes
-
exit-pool
exit a new pool and withdraw the liquidity from it
osmosisd tx gamm exit-pool \ --chain-id localnet \ --from user2 \ --keyring-backend test \ --broadcast-mode block \ --pool-id 1 \ --share-amount-in 1000000000000000000 \ --min-amounts-out 50000000uatom \ --min-amounts-out 100000000uosmo \ --yes -
swap-exact-amount-in
# Command-line Interface osmosisd tx gamm swap-exact-amount-in 1000000uatom 1993602 \ --chain-id localnet \ --from user2 \ --keyring-backend test \ --broadcast-mode block \ --swap-route-pool-ids 1 \ --swap-route-denoms uosmo \ --yes
-
swap-exact-amount-out
osmosisd tx gamm swap-exact-amount-out 1000000uatom 2005618 \ --chain-id localnet \ --from user2 \ --keyring-backend test \ --broadcast-mode block \ --swap-route-pool-ids 1 \ --swap-route-denoms uosmo \ --yes