Querying THORChain
Supported Address Formats
Below are the list of supported Address Formats. Not using this risks loss of funds.
| Chain | Supported Address Format | Notes | |
|---|---|---|---|
| BTC | P2WSH /w Bech32 (preferred), P2WPKH /w Bech32, P2PKH, P2SH, P2TR | Do not send below the dust threshold. Do not use exotic spend scripts, locks or address formats | |
| ETH | EIP-55 | addresses. | Do not swap to smart contract addresses. |
| BSC | EIP-55 | addresses. | Do not swap to smart contract addresses. |
| AVAX | EIP-55 | addresses. | Do not swap to smart contract addresses. |
| DOGE | Bech32, P2PKH | Do not send below the dust threshold. Do not use exotic spend scripts, locks or address formats | |
| LTC | Bech32, P2PKH | Do not send below the dust threshold. Do not use exotic spend scripts, locks or address formats | |
| BCH | Bech32, P2PKH | Do not send below the dust threshold. Do not use exotic spend scripts, locks or address formats | |
| GAIA (cosmoshub) | Bech32 |
All inbound_address support this format.
Getting the Asgard Vault
Vaults are fetched from the /inbound_addresses endpoint:
https://thornode.ninerealms.com/thorchain/inbound_addresses
You need to select the address of the Chain the inbound transaction. See supported address formats.
The address will be the current active Asgard Address that accepts inbounds. Do not cache these address as they change regularly. Do not delay inbound transactions (e.g. do not use future timeLocks).
Example Output, each connected chain will be displayed.
{
"chain": "BTC",
"pub_key": "thorpub1addwnpepqtwl02y7c30shldqe3lr0s45xt6s0n9jkjchcd7zgscknmcn92vugv5v2ng",
"address": "bc1qkqg0v50q2wj7r5jykkmsjm549kpua70yfyav5t",
"halted": false,
"global_trading_paused": false,
"chain_trading_paused": false,
"chain_lp_actions_paused": false,
"gas_rate": "22",
"gas_rate_units": "satsperbyte",
"outbound_tx_size": "1000",
"outbound_fee": "45000",
"dust_threshold": "10000"
},
Inbound transactions should not be delayed for any reason else there is risk funds will be sent to an unreachable address. Use standard transactions, check the inbound address before sending and use the recommended gas rate to ensure transactions are confirmed in the next block to the latest Inbound_Address.
If a chain has a router on the inbound address endpoint, then everything must be deposited via the router. The router is a contract that the user first approves, and the deposit call transfers the asset into the network and emits an event to THORChain.
This is done because "tokens" on protocols don't support memos on-chain, thus need to be wrapped by a router which can force a memo.
Note: you can transfer the base asset, eg ETH, directly to the address and skip the router, but it is recommended to deposit everything via the router.
{
"address": "0x500b62a37c1afe79d59b373639512d03e3c4f5e8",
"chain": "ETH",
"gas_rate": "70",
"halted": false,
"pub_key": "thorpub1addwnpepq05w4xwaswph29ksls25ymjkypav30t8ktyu2dqzkxqk3pkf2l5zklvfzef",
"router": "0xD37BbE5744D730a1d98d8DC97c42F0Ca46aD7146"
}
If you connect to a public Midgard, you must be conscious of the fact that you can be phished and could send money to the WRONG vault. You should do safety checks, i.e. comparing with other nodes, or even inspecting the vault itself for the presence of funds. You should also consider running your own 'fullnode' instance to query for trusted data.
Chain: Chain NameAddress: Asgard Vault inbound address for that chain.,Halted: Boolean, if the chain is halted. This should be monitored.gas_rate: rate to be used, e.g. in Stats or GWei. See Fees.
Displaying available pairs
Use the /pools endpoint of Midgard to retrieve all swappable assets on THORChain. The response will be an array of objects like this:
{
"annualPercentageRate": "0.26851741838417964",
"asset": "ETH.USDC-0XA0B86991C6218B36C1D19D4A2E9EB0CE3606EB48",
"assetDepth": "704918488993385",
"assetPrice": "0.27957103705024305",
"assetPriceUSD": "1",
"earnings": "1806133325329",
"earningsAnnualAsPercentOfDepth": "0.23893708202900793",
"liquidityUnits": "30358099575031",
"lpLuvi": "-0.21236440724172345",
"nativeDecimal": "6",
"poolAPY": "0.26851741838417964",
"runeDepth": "197074793003771",
"saversAPR": "0.02920836798030401",
"saversDepth": "368446044075677",
"saversUnits": "338062015741477",
"saversYieldShare": "0.27977160028361103",
"status": "available",
"synthSupply": "458398271824424",
"synthUnits": "14626376130101",
"totalCollateral": "0",
"totalDebtTor": "0",
"units": "44984475705132",
"volume24h": "265009796099941"
}
"assetPrice" tells you the asset's price in RUNE (RUNE Depth/AssetDepth ). In the above example
1 ETH.USDC = 0.279571 RUNE
Decimals and Base Units
All values on THORChain (thornode and Midgard) are given in 1e8 eg, 100000000 base units (like Bitcoin), and unless postpended by "USD", they are in units of RUNE. Even 1e18 assets, such as ETH.ETH, are shortened to 1e8. 1e6 Assets like ETH.USDC, are padded to 1e8. THORNode will tell you the decimals for each asset, giving you the opportunity to convert back to native units in your interface.
See code examples using the THORChain xchain package here https://github.com/xchainjs/xchainjs-lib/tree/master/packages/xchain-thorchain
Finding Chain Status
There are two ways to see if a Chain is halted.
- Looking at the
/inbound_addressesendpoint and inspecting the halted flag. - Looking at Mimir and inspecting the HALT[Chain]TRADING setting. See network-halts.md for more details.