interbtc-api

@interlay/interbtc-api / Exports / DefaultTransactionAPI

Class: DefaultTransactionAPI

Implements

• TransactionAPI

Table of contents

Constructors

• constructor

Properties

• account
• api

Methods

• buildBatchExtrinsic
• dryRun
• getAccount
• getFeeEstimate
• removeAccount
• sendLogged
• setAccount
• buildBatchExtrinsic
• doesArrayContainEvent
• isDispatchError
• printEvents
• sendLogged

Constructors

constructor

• new DefaultTransactionAPI(api, account?): DefaultTransactionAPI

Parameters

Name	Type
api	ApiPromise
account?	AddressOrPair

Returns

DefaultTransactionAPI

Defined in

src/parachain/transaction.ts:58

Properties

account

• Private Optional account: AddressOrPair

Defined in

src/parachain/transaction.ts:58

---

api

• api: ApiPromise

Implementation of

TransactionAPI.api

Defined in

src/parachain/transaction.ts:58

Methods

buildBatchExtrinsic

▸ buildBatchExtrinsic(extrinsics, atomic?): SubmittableExtrinsic<"promise", ISubmittableResult>

Builds a submittable extrinsic to send other extrinsic in batch.

Parameters

Name	Type	Default value	Description
extrinsics	SubmittableExtrinsic<"promise", ISubmittableResult>[]	undefined	An array of extrinsics to be submitted as batch.
atomic	boolean	true	Whether the given extrinsics should be handled atomically or not. When true (default) all extrinsics will rollback if one fails (batchAll), otherwise allows partial successes (batch).

Returns

SubmittableExtrinsic<"promise", ISubmittableResult>

A batch/batchAll submittable extrinsic.

Implementation of

TransactionAPI.buildBatchExtrinsic

Defined in

src/parachain/transaction.ts:107

---

dryRun

▸ dryRun(extrinsic): Promise<DryRunResult>

Tests extrinsic execution against runtime.

Parameters

Name	Type	Description
extrinsic	SubmittableExtrinsic<"promise", ISubmittableResult>	Extrinsic to dry run.

Returns

Promise<DryRunResult>

Object consisting of success boolean that is true if extrinsic was successfully executed, false otherwise. If execution fails, caught error is exposed.

Implementation of

TransactionAPI.dryRun

Defined in

src/parachain/transaction.ts:95

---

getAccount

▸ getAccount(): undefined | AddressOrPair

Returns

undefined | AddressOrPair

Implementation of

TransactionAPI.getAccount

Defined in

src/parachain/transaction.ts:68

---

getFeeEstimate

▸ getFeeEstimate(extrinsic): Promise<MonetaryAmount<Currency>>

Getter for fee estimate of the extrinsic.

Parameters

Name	Type	Description
extrinsic	SubmittableExtrinsic<"promise", ISubmittableResult>	Extrinsic to get fee estimation about.

Returns

Promise<MonetaryAmount<Currency>>

amount of native currency that will be paid as transaction fee.

Note

This fee estimation does not include tip.

Implementation of

TransactionAPI.getFeeEstimate

Defined in

src/parachain/transaction.ts:83

---

removeAccount

▸ removeAccount(): void

Returns

void

Implementation of

TransactionAPI.removeAccount

Defined in

src/parachain/transaction.ts:64

---

sendLogged

▸ sendLogged<T>(transaction, successEventType?, extrinsicStatus?): Promise<ISubmittableResult>

Type parameters

Name	Type
T	extends AnyTuple

Parameters

Name	Type
transaction	SubmittableExtrinsic<"promise", ISubmittableResult>
successEventType?	AugmentedEvent<ApiTypes, T>
extrinsicStatus?	ExtrinsicStatus

Returns

Promise<ISubmittableResult>

Implementation of

TransactionAPI.sendLogged

Defined in

src/parachain/transaction.ts:72

---

setAccount

▸ setAccount(account): void

Parameters

Name	Type
account	AddressOrPair

Returns

void

Implementation of

TransactionAPI.setAccount

Defined in

src/parachain/transaction.ts:60

---

buildBatchExtrinsic

▸ buildBatchExtrinsic(api, extrinsics, atomic?): SubmittableExtrinsic<"promise", ISubmittableResult>

Builds a submittable extrinsic to send other extrinsic in batch.

Parameters

Name	Type	Default value	Description
api	ApiPromise	undefined	The ApiPromis instance to construct the batch extrinsic with.
extrinsics	SubmittableExtrinsic<"promise", ISubmittableResult>[]	undefined	An array of extrinsics to be submitted as batch.
atomic	boolean	true	Whether the given extrinsics should be handled atomically or not. When true (default) all extrinsics will rollback if one fails (batchAll), otherwise allows partial successes (batch).

Returns

SubmittableExtrinsic<"promise", ISubmittableResult>

A batch/batchAll submittable extrinsic.

Defined in

src/parachain/transaction.ts:123

---

doesArrayContainEvent

▸ doesArrayContainEvent<T>(events, eventType): boolean

Type parameters

Name	Type
T	extends AnyTuple

Parameters

Name	Type
events	EventRecord[]
eventType	AugmentedEvent<ApiTypes, T>

Returns

boolean

Defined in

src/parachain/transaction.ts:238

---

isDispatchError

▸ isDispatchError(eventData): eventData is DispatchError

Parameters

Name	Type
eventData	unknown

Returns

eventData is DispatchError

Defined in

src/parachain/transaction.ts:234

---

printEvents

▸ printEvents(api, events): void

Parameters

Name	Type
api	ApiPromise
events	EventRecord[]

Returns

void

Defined in

src/parachain/transaction.ts:204

---

sendLogged

▸ sendLogged<T>(api, account, transaction, successEventType?, extrinsicStatus?): Promise<ISubmittableResult>

Type parameters

Name	Type
T	extends AnyTuple

Parameters

Name	Type
api	ApiPromise
account	AddressOrPair
transaction	SubmittableExtrinsic<"promise", ISubmittableResult>
successEventType?	AugmentedEvent<ApiTypes, T>
extrinsicStatus?	ExtrinsicStatus

Returns

Promise<ISubmittableResult>

Defined in

src/parachain/transaction.ts:132

This site is open source. Improve this page.