@test-xchain/xchain-mayachain
v0.19.21
Published
Custom Mayachain client and utilities used by XChainJS clients
Downloads
16
Readme
@test-xchain/xchain-mayachain
Mayachain Module for XChainJS Clients
Installation
yarn add @test-xchain/xchain-mayachain
Following peer dependencies have to be installed into your project. These are not included in @test-xchain/xchain-mayachain
.
yarn add @test-xchain/xchain-client @test-xchain/xchain-crypto @test-xchain/xchain-util @test-xchain/xchain-cosmos axios cosmos-client
Important note: Make sure to install same version of cosmos-client
as xchain-mayachain
is using (currently [email protected]
). In other case things might break.
Mayachain 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 | Mayachain.net | https://mayachain.net |
Rate limits: No
Examples
// import `xchain-mayachain`
import { Client } from '@test-xchain/xchain-mayachain'
// Create a `Client`
const client = new Client({ network: Network.Testnet, phrase: 'my secret phrase' })
// get address
const address = client.getAddress()
console.log('address:', client.getAddress()) // address: tthor13gym97tmw3axj3hpewdggy2cr288d3qffr8skg
// 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: 'MAYA', symbol: 'RUNE', ticker: 'RUNE' }
For more examples check out tests in ./__tests__/client.test.ts