1.0.10 • Published 7 months ago

@xchainjs/xchain-doge v1.0.10

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

@xchainjs/xchain-doge

Modules

Installation

yarn add @xchainjs/xchain-doge

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

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

Documentation

xchain doge

How xchain-doge works\ How to use xchain-doge

Service Providers

This package uses the following service providers:

FunctionServiceNotes
BalancesSochainhttps://sochain.com/api#get-balance
Transaction historySochainhttps://sochain.com/api#get-display-data-address, https://sochain.com/api#get-tx
Transaction details by hashSochainhttps://sochain.com/api#get-tx
Transaction feesBlockCypherhttps://api.blockcypher.com/v1/doge/main
Transaction broadcastBlockCypherhttps://api.blockcypher.com/v1/doge/main/txs/push
ExplorerBlockchairhttps://blockchair.com/dogecoin

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

BlockCypher API rate limits: https://api.blockcypher.com/v1/doge/main (5 requests/second)

UtxoOnlineDataProviders

default providers

Creating a no-arg DOGE Client will default to the following settings:

const defaultDogeParams: UtxoClientParams = {
  network: Network.Mainnet,
  phrase: '',
  explorerProviders: blockstreamExplorerProviders,
  dataProviders: [blockcypherDataProviders],
  rootDerivationPaths: {
    [Network.Mainnet]: `m/44'/3'/0'/0/`,
    [Network.Stagenet]: `m/44'/3'/0'/0/`,
    [Network.Testnet]: `m/44'/1'/0'/0/`,
  },
  feeBounds: {
    lower: LOWER_FEE_BOUND,
    upper: UPPER_FEE_BOUND,
  },
}

Note: BlockCypher is the default online data provider (to fetch realtime utxos, balances, etc)

Overriding providers

You can specify own array of providers, whoch will be executed in array-order, to provide automated failover to the subsequent providers if calls to the first providers fail

example sochain v3, blockcypher backup

import { Client, defaultDogeParams, AssetDOGE, SochainDataProviders, blockcypherDataProviders } from '@xchainjs/xchain-doge'
import { SochainNetwork,  SochainProvider } from '@xchainjs/xchain-utxo-providers'
import { Network, UtxoClientParams } from '@xchainjs/xchain-client'

// override with your API key
SochainDataProviders[Network.Mainnet].apiKey = 'YOUR_SOCHAIN_API_KEY'

// or set in env variables so default config can access.
`SOCHAIN_API_KEY={YOUR_BLOCKCYPHER_API_KEY}`
`BLOCKCYPHER_API_KEY={YOUR_SOCHAIN_API_KEY}`
//Default config can access.
process.env.BLOCKCYPHER_API_KEY
process.env.SOCHAIN_API_KEY

//overridde the default init params with your onfig
const initParams: UtxoClientParams = {
  ...defaultDogeParams,
  dataProviders: [SochainDataProviders, BlockcypherDataProviders]// use sochain first and blockcypher as fallback
  phrase: process.env.PHRASE,
}
const DOGEClient = new Client(sochainParams)
1.0.10

7 months ago

1.0.9

8 months ago

1.0.8

9 months ago

1.0.7

11 months ago

1.0.6

11 months ago

1.0.2

1 year ago

1.0.5

11 months ago

1.0.4

12 months ago

1.0.3

12 months ago

1.0.1

1 year ago

1.0.0

1 year ago

0.7.20

1 year ago

0.7.19

1 year ago

0.7.18

1 year ago

0.7.17

1 year ago

0.7.16

1 year ago

0.7.15

1 year ago

0.7.14

1 year ago

0.7.13

1 year ago

0.7.12

1 year ago

0.7.11

2 years ago

0.7.10

2 years ago

0.7.9

2 years ago

0.7.5

2 years ago

0.7.7

2 years ago

0.7.2

2 years ago

0.6.3

2 years ago

0.6.2

2 years ago

0.7.4

2 years ago

0.6.5

2 years ago

0.7.3

2 years ago

0.7.0

2 years ago

0.6.1

2 years ago

0.5.10

2 years ago

0.5.11

2 years ago

0.5.9

2 years ago

0.5.12

2 years ago

0.5.13

2 years ago

0.6.0

2 years ago

0.5.8

3 years ago

0.5.7

3 years ago

0.3.0

3 years ago

0.2.1

3 years ago

0.2.0

3 years ago

0.2.0-alpha.1

3 years ago

0.5.4

3 years ago

0.5.6

3 years ago

0.5.5

3 years ago

0.5.0

3 years ago

0.5.2

3 years ago

0.5.1

3 years ago

0.1.2

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago