@thorwallet/xchain-litecoin
TypeScript icon, indicating that this package has built-in type declarations

0.1.1-lazy.0 • Public • Published

@xchainjs/xchain-client

Modules

Installation

yarn add @xchainjs/xchain-client

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

yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util axios bitcoinjs-lib coininfo wif

Service Providers

This package uses the following service providers:

Function Service Notes
Balances Sochain https://sochain.com/api#get-balance
Transaction history Sochain https://sochain.com/api#get-display-data-address, https://sochain.com/api#get-tx
Transaction details by hash Sochain https://sochain.com/api#get-tx
Transaction fees Bitgo https://app.bitgo.com/docs/#operation/v2.tx.getfeeestimate
Transaction broadcast Bitaps https://ltc.bitaps.com/broadcast
Explorer Blockstream https://blockstream.info

Sochain API rate limits: https://sochain.com/api#rate-limits (300 requests/minute)

Bitgo API rate limits: https://app.bitgo.com/docs/#section/Rate-Limiting (10 requests/second)

Bitaps API rate limits: Standard limit 15 requests within 5 seconds for a single IP address.

Usage

Initialize client and use class methods:

import { Client, Network } from '../src/client'

// Create a new client interface
const ltcClient = new Client({ network: 'testnet' })

// Set phrase
ltcClient.setPhrase('phrase here')

// Get address
const address = ltcClient.getAddress()

// Get balance
const balance = await ltcClient.getBalance()

// Transfer with feeRate
const txid = await ltcClient.transfer({ asset: AssetLTC, recipient: 'recipient address here', amount: baseAmount(100, LTC_DECIMAL), feeRate: 1 })

// Transfer with default feeRate (default is `fast`)
const txid = await ltcClient.transfer({ asset: AssetLTC, recipient: 'recipient address here', amount: baseAmount(100, LTC_DECIMAL) })

// Get fee estimations
const { fast, fastest, average } = await ltcClient.getFees()

// Get feeRate estimations
const { fast, fastest, average } = await ltcClient.getFeeRates()

// Search transactions
const transactions = await ltcClient.getTransactions({ address: 'address here', limit: 4 })

// Get a transaction with a given txId/hash
const txData = await ltcClient.getTransactionData('b660ee07167cfa32681e2623f3a29dc64a089cabd9a3a07dd17f9028ac956eb8')

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
0.1.1-lazy.00latest
0.1.1-alpha.9700canary

Version History

VersionDownloads (Last 7 Days)Published
0.1.1-alpha.9700
0.1.1-alpha.9690
0.1.1-alpha.9670
0.1.1-alpha.9660
0.1.1-alpha.9650
0.1.1-alpha.9620
0.1.1-alpha.9600
0.1.1-alpha.9580
0.1.1-lazy.00
0.0.1-alpha.9281
0.1.0-alpha.170
0.1.0-alpha.140
0.1.0-alpha.130
0.1.0-alpha.120
0.1.0-alpha.110
0.1.0-alpha.101
0.1.0-alpha.80
0.1.0-alpha.70
0.1.0-alpha.60
0.1.0-alpha.50
0.1.0-alpha.40
0.1.0-alpha.30
0.1.0-lazy.00
0.0.1-alpha.9790
0.0.1-alpha.9270
0.0.1-alpha.9260
0.0.1-alpha.9250
0.0.1-alpha.9240
0.0.1-alpha.9230
0.0.1-alpha.9220
0.0.1-alpha.9210
0.0.1-alpha.9190
0.0.1-alpha.9170
0.0.1-alpha.9160
0.0.1-alpha.9150
0.0.1-alpha.9141
0.0.1-alpha.9110
0.0.1-alpha.9100
0.0.1-alpha.9080
0.0.1-alpha.9020
0.0.1-alpha.9050
0.0.1-alpha.9040
0.0.1-alpha.9030
0.0.1-alpha.9780
0.0.1-alpha.9000
0.0.1-alpha.8970
0.0.1-alpha.8960
0.0.1-alpha.8950
0.0.1-alpha.8940
0.0.1-alpha.8930
0.0.1-alpha.8920
0.0.1-alpha.8910
0.0.1-alpha.8900
0.0.1-alpha.8890
0.0.1-alpha.8880
0.0.1-alpha.8870
0.0.1-alpha.8860
0.0.1-alpha.8840
0.0.1-alpha.8830
0.0.1-alpha.8811
0.0.1-alpha.8800
0.0.1-alpha.8790
0.0.1-alpha.8751
0.0.1-alpha.8680
0.0.1-alpha.8670
0.0.1-alpha.8730
0.0.1-alpha.8720
0.0.1-alpha.8690
0.0.1-alpha.8660
0.0.1-alpha.8640
0.0.1-alpha.8620
0.0.1-alpha.8590
0.0.1-alpha.8570
0.0.1-alpha.8560
0.0.1-alpha.8550
0.0.1-alpha.8510
0.0.1-alpha.8500
0.0.1-alpha.8490
0.0.1-alpha.8470
0.0.1-alpha.8430
0.0.1-alpha.8420
0.0.1-alpha.8400
0.0.1-alpha.8380
0.0.1-alpha.8360
0.0.1-alpha.8350
0.0.1-alpha.8340
0.0.1-alpha.8320
0.0.1-alpha.8310
0.0.1-alpha.8291
0.0.1-alpha.8280
0.0.1-alpha.8270
0.0.1-alpha.8260
0.0.1-alpha.8250
0.0.1-alpha.8240
0.0.1-alpha.8230
0.0.1-alpha.8220
0.0.1-alpha.8200
0.0.1-alpha.8190
0.0.1-alpha.8180
0.0.1-alpha.8140
0.0.1-alpha.8130
0.0.1-alpha.8020
0.0.1-alpha.8010
0.0.1-alpha.7960
0.0.1-alpha.7950
0.0.1-alpha.7940

Package Sidebar

Install

npm i @thorwallet/xchain-litecoin

Weekly Downloads

6

Version

0.1.1-lazy.0

License

MIT

Unpacked Size

7.67 MB

Total Files

51

Last publish

Collaborators

  • jonbru
  • jonny
  • severinwullschleger