interbtc-api

@interlay/interbtc-api / Exports / DefaultBTCRelayAPI

Class: DefaultBTCRelayAPI

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new DefaultBTCRelayAPI(api): DefaultBTCRelayAPI

Parameters

Name Type
api ApiPromise

Returns

DefaultBTCRelayAPI

Defined in

src/parachain/btc-relay.ts:37

Properties

api

Private api: ApiPromise

Defined in

src/parachain/btc-relay.ts:37

Methods

getLatestBlock

getLatestBlock(): Promise<BitcoinH256Le>

Returns

Promise<BitcoinH256Le>

The raw transaction data, represented as a Buffer object

Implementation of

BTCRelayAPI.getLatestBlock

Defined in

src/parachain/btc-relay.ts:47


getLatestBlockHeight

getLatestBlockHeight(): Promise<number>

Returns

Promise<number>

The height of the latest Bitcoin block that was rekayed by the BTC-Relay

Implementation of

BTCRelayAPI.getLatestBlockHeight

Defined in

src/parachain/btc-relay.ts:51


getStableBitcoinConfirmations

getStableBitcoinConfirmations(): Promise<number>

Returns

Promise<number>

A global security parameter: the required block confirmations for a transaction to be considered stable on Bitcoin

Implementation of

BTCRelayAPI.getStableBitcoinConfirmations

Defined in

src/parachain/btc-relay.ts:39


getStableParachainConfirmations

getStableParachainConfirmations(): Promise<number>

Returns

Promise<number>

A global security parameter: the required block confirmations for a transaction to be considered stable on the parachain

Implementation of

BTCRelayAPI.getStableParachainConfirmations

Defined in

src/parachain/btc-relay.ts:43


isBlockInRelay

isBlockInRelay(blockHash): Promise<boolean>

Parameters

Name Type
blockHash string

Returns

Promise<boolean>

True if the block is in the relay, false otherwise.

Implementation of

BTCRelayAPI.isBlockInRelay

Defined in

src/parachain/btc-relay.ts:55