@thorswap-lib/xchain-thorchain

Custom Thorchain client and utilities used by XChainJS clients

Usage no npm install needed!

<script type="module">
  import thorswapLibXchainThorchain from 'https://cdn.skypack.dev/@thorswap-lib/xchain-thorchain';
</script>

README

@thorswap-lib/xchain-thorchain

Thorchain Module for XChainJS Clients

Installation

yarn add @thorswap-lib/xchain-thorchain

Following peer dependencies have to be installed into your project. These are not included in @thorswap-lib/xchain-thorchain.

yarn add @thorswap-lib/xchain-client @thorswap-lib/xchain-crypto @thorswap-lib/xchain-util @thorswap-lib/xchain-cosmos axios cosmos-client

Important note: Make sure to install same version of cosmos-client as xchain-thorchain is using (currently cosmos-client@0.39.2 ). In other case things might break.

Thorchain Client Testing

yarn install
yarn test

Service Providers

This package uses the following service providers:

Function Service Notes
Balances Cosmos RPC https://cosmos.network/rpc/v0.37.9 (GET /bank/balances/{address})
Transaction history Tendermint RPC https://docs.tendermint.com/master/rpc/#/Info/tx_search
Transaction details by hash Cosmos RPC https://cosmos.network/rpc/v0.37.9 (GET /txs/{hash})
Transaction broadcast Cosmos RPC https://cosmos.network/rpc/v0.37.9 (POST /txs)
Explorer Thorchain.net https://thorchain.net

Rate limits: No

Examples

// import `xchain-thorchain`
import { Client } from '@thorswap-lib/xchain-thorchain'

// Create a `Client`
const client = new Client({ network: Network.Testnet, phrase: 'my secret phrase' })

// get address
const address = client.getAddress()
console.log('address:', address) // address: tthor13gym97tmw3axj3hpewdggy2cr288d3qffr8skg

// get private key
const privKey = client.getPrivKey()
console.log('privKey:', privKey.toBase64()) // privKey: {your-private-key} base64 encoded
console.log('privKey:', privKey.toBuffer()) // privKey: {your-private-key} as `Buffer`

// get public key
const pubKey = client.getPubKey()
console.log('pubKey:', pubKey.toBase64()) // pubKey: {your-public-key} base64 encoded
console.log('pubKey:', pubKey.toBuffer()) // pubKey: {your-public-key} as `Buffer`

// get balances
const balances = await client.getBalance(address)
console.log('balances:', balances[0].amount.amount().toString()) // balance: 6968080395099

// get transactions
const txs = await client.getTransactions({ address })
console.log('txs total:', txs.total) // txs total: 100

// get transaction details
const tx = await client.getTransactionData('any-tx-hash', address)
console.log('tx asset:', tx.asset) // tx asset: { chain: 'THOR', symbol: 'RUNE', ticker: 'RUNE' }

For more examples check out tests in ./__tests__/client.test.ts