interbtc-api

@interlay/interbtc-api / Exports / DefaultInterBtcApi

Class: DefaultInterBtcApi

Implements

• InterBtcApi

Table of contents

Constructors

• constructor

Properties

• amm
• api
• assetRegistry
• btcRelay
• electrsAPI
• escrow
• faucet
• fee
• issue
• loans
• nomination
• oracle
• redeem
• replace
• rewards
• system
• tokens
• transaction
• vaults

Accessors

• account

Methods

• disconnect
• getGovernanceCurrency
• getRelayChainCurrency
• getWrappedCurrency
• removeAccount
• setAccount

Constructors

constructor

• new DefaultInterBtcApi(api, bitcoinNetwork?, _account?, esploraNetwork?): DefaultInterBtcApi

Parameters

Name	Type	Default value
api	ApiPromise	undefined
bitcoinNetwork	BitcoinNetwork	"mainnet"
_account?	AddressOrPair	undefined
esploraNetwork?	string	undefined

Returns

DefaultInterBtcApi

Defined in

src/interbtc-api.ts:95

Properties

amm

• Readonly amm: AMMAPI

Implementation of

InterBtcApi.amm

Defined in

src/interbtc-api.ts:92

---

api

• Readonly api: ApiPromise

Implementation of

InterBtcApi.api

Defined in

src/interbtc-api.ts:96

---

assetRegistry

• Readonly assetRegistry: AssetRegistryAPI

Implementation of

InterBtcApi.assetRegistry

Defined in

src/interbtc-api.ts:90

---

btcRelay

• Readonly btcRelay: BTCRelayAPI

Implementation of

InterBtcApi.btcRelay

Defined in

src/interbtc-api.ts:82

---

electrsAPI

• Readonly electrsAPI: ElectrsAPI

Implementation of

InterBtcApi.electrsAPI

Defined in

src/interbtc-api.ts:81

---

escrow

• Readonly escrow: EscrowAPI

Implementation of

InterBtcApi.escrow

Defined in

src/interbtc-api.ts:89

---

faucet

• Readonly faucet: FaucetClient

Implementation of

InterBtcApi.faucet

Defined in

src/interbtc-api.ts:79

---

fee

• Readonly fee: FeeAPI

Implementation of

InterBtcApi.fee

Defined in

src/interbtc-api.ts:86

---

issue

• Readonly issue: IssueAPI

Implementation of

InterBtcApi.issue

Defined in

src/interbtc-api.ts:77

---

loans

• Readonly loans: LoansAPI

Implementation of

InterBtcApi.loans

Defined in

src/interbtc-api.ts:91

---

nomination

• Readonly nomination: NominationAPI

Implementation of

InterBtcApi.nomination

Defined in

src/interbtc-api.ts:87

---

oracle

• Readonly oracle: OracleAPI

Implementation of

InterBtcApi.oracle

Defined in

src/interbtc-api.ts:80

---

redeem

• Readonly redeem: RedeemAPI

Implementation of

InterBtcApi.redeem

Defined in

src/interbtc-api.ts:78

---

replace

• Readonly replace: ReplaceAPI

Implementation of

InterBtcApi.replace

Defined in

src/interbtc-api.ts:85

---

rewards

• Readonly rewards: RewardsAPI

Implementation of

InterBtcApi.rewards

Defined in

src/interbtc-api.ts:88

---

system

• Readonly system: SystemAPI

Implementation of

InterBtcApi.system

Defined in

src/interbtc-api.ts:84

---

tokens

• Readonly tokens: TokensAPI

Implementation of

InterBtcApi.tokens

Defined in

src/interbtc-api.ts:83

---

transaction

• Readonly transaction: TransactionAPI

Implementation of

InterBtcApi.transaction

Defined in

src/interbtc-api.ts:93

---

vaults

• Readonly vaults: VaultsAPI

Implementation of

InterBtcApi.vaults

Defined in

src/interbtc-api.ts:76

Accessors

account

• get account(): undefined | AddressOrPair

Returns

undefined | AddressOrPair

Implementation of

InterBtcApi.account

Defined in

src/interbtc-api.ts:169

Methods

disconnect

▸ disconnect(): Promise<void>

Returns

Promise<void>

Implementation of

InterBtcApi.disconnect

Defined in

src/interbtc-api.ts:191

---

getGovernanceCurrency

▸ getGovernanceCurrency(): Currency

Returns

Currency

Implementation of

InterBtcApi.getGovernanceCurrency

Defined in

src/interbtc-api.ts:173

---

getRelayChainCurrency

▸ getRelayChainCurrency(): Currency

Returns

Currency

Implementation of

InterBtcApi.getRelayChainCurrency

Defined in

src/interbtc-api.ts:185

---

getWrappedCurrency

▸ getWrappedCurrency(): Currency

Returns

Currency

Implementation of

InterBtcApi.getWrappedCurrency

Defined in

src/interbtc-api.ts:179

---

removeAccount

▸ removeAccount(): void

Returns

void

Implementation of

InterBtcApi.removeAccount

Defined in

src/interbtc-api.ts:165

---

setAccount

▸ setAccount(account, signer?): void

Parameters

Name	Type
account	AddressOrPair
signer?	Signer

Returns

void

Implementation of

InterBtcApi.setAccount

Defined in

src/interbtc-api.ts:155

This site is open source. Improve this page.