Class BlockcypherProvider

Implements

UtxoOnlineDataProvider

Index

Constructors

constructor

new BlockcypherProvider(baseUrl?, chain, asset, assetDecimals, blockcypherNetwork, apiKey?): BlockcypherProvider
Parameters
- baseUrl: string = 'https://api.blockcypher.com/v1/'
- chain: string
- asset: Asset
- assetDecimals: number
- blockcypherNetwork: BlockcypherNetwork
- Optional apiKey: string
Returns BlockcypherProvider
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:18

Properties

`Private` `Optional` _apiKey

_apiKey?: string

`Private` asset

asset: Asset

`Private` assetDecimals

assetDecimals: number

`Private` baseUrl

baseUrl: string

`Private` blockcypherNetwork

blockcypherNetwork: BlockcypherNetwork

`Private` chain

chain: string

Accessors

apiKey

get apiKey(): undefined | string
Returns undefined | string
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:35
set apiKey(value): void
Parameters
- value: undefined | string
Returns void
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:38

Methods

`Private` addArrayUpToLimit

addArrayUpToLimit(arr, toAdd, limit): void
helper function tto limit adding to an array
Parameters
- arr: string[]
  array to be added to
- toAdd: string[]
  elements to add
- limit: number
  do not add more than this limit
Returns void
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:178

broadcastTx

broadcastTx(txHex): Promise<string>
Parameters
- txHex: string
Returns Promise<string>
Implementation of UtxoOnlineDataProvider.broadcastTx
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:41

`Private` delay

delay(ms): Promise<unknown>
Parameters
- ms: number
Returns Promise<unknown>
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:186

getBalance

getBalance(address, assets?, confirmedOnly?): Promise<Balance[]>
Get the balance for a given address.
Parameters
- address: string
  The address to get the balance for.
- Optional assets: Asset[]
  (Optional) An array of assets to get the balance for.
- Optional confirmedOnly: boolean
Returns Promise<Balance[]>
A promise that resolves to an array of balances.
Implementation of UtxoOnlineDataProvider.getBalance
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:62

getConfirmedUnspentTxs

getConfirmedUnspentTxs(address): Promise<UTXO[]>
Parameters
- address: string
Returns Promise<UTXO[]>
Implementation of UtxoOnlineDataProvider.getConfirmedUnspentTxs
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:50

getFeeRates

getFeeRates(): Promise<FeeRates>
Returns a fee rate estimation from Blockcypher API service.

Returns Promise<FeeRates>
Estimated fee rates
Implementation of UtxoOnlineDataProvider.getFeeRates
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:117

`Private` getRawTransactions

getRawTransactions(params?, unspentOnly?): Promise<Transaction[]>
Get transaction history of a given address with pagination options. By default it will return the transaction history of the current wallet.
Parameters
- Optional params: TxHistoryParams
  The options to get transaction history. (optional)
- unspentOnly: boolean = false
Returns Promise<Transaction[]>
The transaction history.
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:197

getTransactionData

getTransactionData(txId): Promise<Tx>
Get the transaction details of a given transaction id.
Parameters
- txId: string
  The transaction id.
Returns Promise<Tx>
The transaction details of the given transaction id.
Implementation of UtxoOnlineDataProvider.getTransactionData
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:98

getTransactions

getTransactions(params?, unspentOnly?): Promise<TxsPage>
Get transaction history of a given address with pagination options. By default it will return the transaction history of the current wallet.
Parameters
- Optional params: TxHistoryParams
  The options to get transaction history. (optional)
- unspentOnly: boolean = false
Returns Promise<TxsPage>
The transaction history.
Implementation of UtxoOnlineDataProvider.getTransactions
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:82

getUnspentTxs

getUnspentTxs(address): Promise<UTXO[]>
Parameters
- address: string
Returns Promise<UTXO[]>
Implementation of UtxoOnlineDataProvider.getUnspentTxs
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:57

`Private` mapTransactionToTx

mapTransactionToTx(rawTx): Tx
Parameters
- rawTx: Transaction
Returns Tx
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:130

`Private` mapUTXOs

mapUTXOs(address, utxos): UTXO[]
Parameters
- address: string
- utxos: Transaction[]
Returns UTXO[]
- Defined in xchain-utxo-providers/src/providers/blockcypher/blockcypher-data-provider.ts:146

Class BlockcypherProvider

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BlockcypherProvider

Properties

Private Optional _apiKey

Private asset

Private assetDecimals

Private baseUrl

Private blockcypherNetwork

Private chain

Accessors

apiKey

Returns undefined | string

Parameters

Returns void

Methods

Private addArrayUpToLimit

Parameters

Returns void

broadcastTx

Parameters

Returns Promise<string>

Private delay

Parameters

Returns Promise<unknown>

getBalance

Parameters

Returns Promise<Balance[]>

getConfirmedUnspentTxs

Parameters

Returns Promise<UTXO[]>

getFeeRates

Returns Promise<FeeRates>

Private getRawTransactions

Parameters

Returns Promise<Transaction[]>

getTransactionData

Parameters

Returns Promise<Tx>

getTransactions

Parameters

Returns Promise<TxsPage>

getUnspentTxs

Parameters

Returns Promise<UTXO[]>

Private mapTransactionToTx

Parameters

Returns Tx

Private mapUTXOs

Parameters

Returns UTXO[]

Settings

Member Visibility

Theme

On This Page

`Private` `Optional` _apiKey

`Private` asset

`Private` assetDecimals

`Private` baseUrl

`Private` blockcypherNetwork

`Private` chain

`Private` addArrayUpToLimit

`Private` delay

`Private` getRawTransactions

`Private` mapTransactionToTx

`Private` mapUTXOs