Class BnsConnection

Talks directly to the BNS blockchain and exposes the same interface we have with the BCP protocol.

We can embed in iov-core process or use this in a BCP-relay

Hierarchy

BnsConnection

Implements

AtomicSwapConnection

Methods

chainId

chainId(): ChainId

- Defined in bnsconnection.ts:260
The chain ID this connection is connected to

We store this info from the initialization, no need to query every time

Returns ChainId

disconnect

disconnect(): void

- Defined in bnsconnection.ts:251
Returns void

getAccount

getAccount(query: AccountQuery): Promise<Account | undefined>

- Defined in bnsconnection.ts:370
Parameters
- query: AccountQuery
Returns Promise<Account | undefined>

getAllTokens

getAllTokens(): Promise<keyof Token[]>

- Defined in bnsconnection.ts:357
Returns Promise<keyof Token[]>

getBlockHeader

getBlockHeader(height: number): Promise<BlockHeader>

- Defined in bnsconnection.ts:574
Parameters
- height: number
Returns Promise<BlockHeader>

Protected getDefaultFee

getDefaultFee(): Promise<Amount | undefined>

- Defined in bnsconnection.ts:744
Queries the blockchain for the enforced anti-spam fee

Returns Promise<Amount | undefined>

getElectionRules

getElectionRules(): Promise<keyof ElectionRule[]>

- Defined in bnsconnection.ts:673
Returns Promise<keyof ElectionRule[]>

getElectorates

getElectorates(): Promise<keyof Electorate[]>

- Defined in bnsconnection.ts:666
Returns Promise<keyof Electorate[]>

getFeeQuote

getFeeQuote(transaction: UnsignedTransaction): Promise<Fee>

- Defined in bnsconnection.ts:711
Parameters
- transaction: UnsignedTransaction
Returns Promise<Fee>

getNonce

getNonce(query: AddressQuery | PubkeyQuery): Promise<Nonce>

- Defined in bnsconnection.ts:403
Parameters
- query: AddressQuery | PubkeyQuery
Returns Promise<Nonce>

getNonces

getNonces(query: AddressQuery | PubkeyQuery, count: number): Promise<keyof Nonce[]>

- Defined in bnsconnection.ts:424
Parameters
- query: AddressQuery | PubkeyQuery
- count: number
Returns Promise<keyof Nonce[]>

Protected getProductFee

getProductFee(transaction: BnsTx): Promise<Amount | undefined>

- Defined in bnsconnection.ts:757
Queries the blockchain for the enforced product fee for this kind of transaction. Returns undefined if no product fee is defined

Parameters
- transaction: BnsTx
Returns Promise<Amount | undefined>

getProposals

getProposals(): Promise<keyof Proposal[]>

- Defined in bnsconnection.ts:680
Returns Promise<keyof Proposal[]>

getSwaps

getSwaps(query: AtomicSwapQuery): Promise<keyof AtomicSwap[]>

- Defined in bnsconnection.ts:472
All matching swaps that are open (in app state)

To get claimed and returned, we need to look at the transactions.... TODO

Parameters
- query: AtomicSwapQuery
Returns Promise<keyof AtomicSwap[]>

getSwapsFromState

getSwapsFromState(query: AtomicSwapQuery): Promise<keyof AtomicSwap[]>

- Defined in bnsconnection.ts:445
All matching swaps that are open (from app state)

Parameters
- query: AtomicSwapQuery
Returns Promise<keyof AtomicSwap[]>

getToken

getToken(ticker: TokenTicker): Promise<Token | undefined>

- Defined in bnsconnection.ts:353
Parameters
- ticker: TokenTicker
Returns Promise<Token | undefined>

getTx

getTx(id: TransactionId): Promise<ConfirmedAndSignedTransaction<UnsignedTransaction> | FailedTransaction>

- Defined in bnsconnection.ts:532
Parameters
- id: TransactionId
Returns Promise<ConfirmedAndSignedTransaction<UnsignedTransaction> | FailedTransaction>

getUsernames

getUsernames(query: BnsUsernamesQuery): Promise<keyof BnsUsernameNft[]>

- Defined in bnsconnection.ts:695
Parameters
- query: BnsUsernamesQuery
Returns Promise<keyof BnsUsernameNft[]>

getValidators

getValidators(): Promise<keyof Validator[]>

- Defined in bnsconnection.ts:649
Returns Promise<keyof Validator[]>

getVotes

getVotes(voter: Address): Promise<keyof Vote[]>

- Defined in bnsconnection.ts:687
Parameters
- voter: Address
Returns Promise<keyof Vote[]>

height

height(): Promise<number>

- Defined in bnsconnection.ts:264
Returns Promise<number>

listenTx

listenTx(query: TransactionQuery): Stream<ConfirmedTransaction<LightTransaction> | FailedTransaction>

- Defined in bnsconnection.ts:554
A stream of all transactions that match the tags from the present moment on

Parameters
- query: TransactionQuery
Returns Stream<ConfirmedTransaction<LightTransaction> | FailedTransaction>

liveTx

liveTx(query: TransactionQuery): Stream<ConfirmedTransaction<LightTransaction> | FailedTransaction>

- Defined in bnsconnection.ts:568
Does a search and then subscribes to all future changes.

It returns a stream starting the array of all existing transactions and then continuing with live feeds

Parameters
- query: TransactionQuery
Returns Stream<ConfirmedTransaction<LightTransaction> | FailedTransaction>

postTx

postTx(tx: PostableBytes): Promise<PostTxResponse>

- Defined in bnsconnection.ts:269
Parameters
- tx: PostableBytes
Returns Promise<PostTxResponse>

Protected query

query(path: string, data: Uint8Array): Promise<QueryResponse>

- Defined in bnsconnection.ts:724
Parameters
- path: string
- data: Uint8Array
Returns Promise<QueryResponse>

searchTx

searchTx(query: TransactionQuery): Promise<keyof (FailedTransaction | ConfirmedTransaction<LightTransaction>)[]>

- Defined in bnsconnection.ts:545
Parameters
- query: TransactionQuery
Returns Promise<keyof (FailedTransaction | ConfirmedTransaction<LightTransaction>)[]>

Protected updateSwapAmounts

updateSwapAmounts<T>(swap: T): Promise<T>

- Defined in bnsconnection.ts:734
Type parameters
- T: AtomicSwap
Parameters
- swap: T
Returns Promise<T>

watchAccount

watchAccount(query: AccountQuery): Stream<Account | undefined>

- Defined in bnsconnection.ts:635
Gets current balance and emits an update every time it changes

Parameters
- query: AccountQuery
Returns Stream<Account | undefined>

watchBlockHeaders

watchBlockHeaders(): Stream<BlockHeader>

- Defined in bnsconnection.ts:620
Returns Stream<BlockHeader>

watchSwaps

watchSwaps(query: AtomicSwapQuery): Stream<AtomicSwap>

- Defined in bnsconnection.ts:505
Emits currentState (getSwap) as a stream, then sends updates for any matching swap

This includes an open swap beind claimed/aborted as well as a new matching swap being offered

Parameters
- query: AtomicSwapQuery
Returns Stream<AtomicSwap>

withDefaultFee

withDefaultFee<T>(transaction: T): Promise<T>

- Defined in bnsconnection.ts:720
Type parameters
- T: UnsignedTransaction
Parameters
- transaction: T
Returns Promise<T>

Static establish

establish(url: string): Promise<BnsConnection>

- Defined in bnsconnection.ts:217
Parameters
- url: string
Returns Promise<BnsConnection>

Generated using TypeDoc