interbtc-api

@interlay/interbtc-api / Exports / InterBtcApi

Interface: InterBtcApi

Implemented by

• DefaultInterBtcApi

Table of contents

Properties

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

Methods

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

Properties

account

• Readonly account: undefined | AddressOrPair

Defined in

src/interbtc-api.ts:65

---

amm

• Readonly amm: AMMAPI

Defined in

src/interbtc-api.ts:61

---

api

• Readonly api: ApiPromise

Defined in

src/interbtc-api.ts:44

---

assetRegistry

• Readonly assetRegistry: AssetRegistryAPI

Defined in

src/interbtc-api.ts:59

---

btcRelay

• Readonly btcRelay: BTCRelayAPI

Defined in

src/interbtc-api.ts:51

---

electrsAPI

• Readonly electrsAPI: ElectrsAPI

Defined in

src/interbtc-api.ts:50

---

escrow

• Readonly escrow: EscrowAPI

Defined in

src/interbtc-api.ts:58

---

faucet

• Readonly faucet: FaucetClient

Defined in

src/interbtc-api.ts:48

---

fee

• Readonly fee: FeeAPI

Defined in

src/interbtc-api.ts:55

---

issue

• Readonly issue: IssueAPI

Defined in

src/interbtc-api.ts:46

---

loans

• Readonly loans: LoansAPI

Defined in

src/interbtc-api.ts:60

---

nomination

• Readonly nomination: NominationAPI

Defined in

src/interbtc-api.ts:56

---

oracle

• Readonly oracle: OracleAPI

Defined in

src/interbtc-api.ts:49

---

redeem

• Readonly redeem: RedeemAPI

Defined in

src/interbtc-api.ts:47

---

replace

• Readonly replace: ReplaceAPI

Defined in

src/interbtc-api.ts:54

---

rewards

• Readonly rewards: RewardsAPI

Defined in

src/interbtc-api.ts:57

---

system

• Readonly system: SystemAPI

Defined in

src/interbtc-api.ts:53

---

tokens

• Readonly tokens: TokensAPI

Defined in

src/interbtc-api.ts:52

---

transaction

• Readonly transaction: TransactionAPI

Defined in

src/interbtc-api.ts:62

---

vaults

• Readonly vaults: VaultsAPI

Defined in

src/interbtc-api.ts:45

Methods

disconnect

▸ disconnect(): Promise<void>

Returns

Promise<void>

Defined in

src/interbtc-api.ts:69

---

getGovernanceCurrency

▸ getGovernanceCurrency(): Currency

Returns

Currency

Defined in

src/interbtc-api.ts:66

---

getRelayChainCurrency

▸ getRelayChainCurrency(): Currency

Returns

Currency

Defined in

src/interbtc-api.ts:68

---

getWrappedCurrency

▸ getWrappedCurrency(): Currency

Returns

Currency

Defined in

src/interbtc-api.ts:67

---

removeAccount

▸ removeAccount(): void

Returns

void

Defined in

src/interbtc-api.ts:64

---

setAccount

▸ setAccount(account, signer?): void

Parameters

Name	Type
account	AddressOrPair
signer?	Signer

Returns

void

Defined in

src/interbtc-api.ts:63

This site is open source. Improve this page.