Reference / Modules / node-api / Queries

Class: Queries

node-api.Queries

Table of contents

Constructors

• constructor

Properties

• adapters
• api
• availableRegions
• DOT_BALANCE

Accessors

• ss58Prefix

Methods

• computeAvailableRegions
• getAccountData
• getActiveRecovery
• getAvailableRegions
• getCoinBalances
• getCollectionItem
• getCollectionItems
• getCollectionSize
• getDefaultRegion
• getGuestsOf
• getLegalOfficerCase
• getLegalOfficerData
• getLegalOfficerVerifiedIssuers
• getProxy
• getRecoveryConfig
• getSponsorship
• getValidAccountId
• isInvitedContributorOf
• isValidAccountId
• buildCoinBalance
• getCoin
• of

Constructors

constructor

• new Queries(api, adapters): Queries

Parameters

Name	Type
api	ApiPromise
adapters	Adapters

Returns

Queries

Defined in

Queries.ts:38

Properties

adapters

• Private adapters: Adapters

Defined in

Queries.ts:52

---

api

• Private api: ApiPromise

Defined in

Queries.ts:51

---

availableRegions

• Private Optional availableRegions: "Europe"[]

Defined in

Queries.ts:267

---

DOT_BALANCE

▪ Static Readonly DOT_BALANCE: CoinBalance

Defined in

Queries.ts:92

Accessors

ss58Prefix

• get ss58Prefix(): number

Returns

number

Defined in

Queries.ts:285

Methods

computeAvailableRegions

▸ computeAvailableRegions(): "Europe"[]

Returns

"Europe"[]

Defined in

Queries.ts:269

---

getAccountData

▸ getAccountData(accountId): Promise<TypesAccountData>

Parameters

Name	Type
accountId	ValidAccountId

Returns

Promise<TypesAccountData>

Defined in

Queries.ts:66

---

getActiveRecovery

▸ getActiveRecovery(sourceAccountId, destinationAccountId): Promise<undefined | TypesRecoveryConfig>

Parameters

Name	Type
sourceAccountId	ValidAccountId
destinationAccountId	ValidAccountId

Returns

Promise<undefined | TypesRecoveryConfig>

Defined in

Queries.ts:182

---

getAvailableRegions

▸ getAvailableRegions(): "Europe"[]

Returns

"Europe"[]

Defined in

Queries.ts:262

---

getCoinBalances

▸ getCoinBalances(accountId): Promise<CoinBalance[]>

Parameters

Name	Type
accountId	ValidAccountId

Returns

Promise<CoinBalance[]>

Defined in

Queries.ts:71

---

getCollectionItem

▸ getCollectionItem(locId, itemId): Promise<undefined | CollectionItem>

Parameters

Name	Type
locId	UUID
itemId	Hash

Returns

Promise<undefined | CollectionItem>

Defined in

Queries.ts:143

---

getCollectionItems

▸ getCollectionItems(locId): Promise<CollectionItem[]>

Parameters

Name	Type
locId	UUID

Returns

Promise<CollectionItem[]>

Defined in

Queries.ts:155

---

getCollectionSize

▸ getCollectionSize(locId): Promise<undefined | number>

Parameters

Name	Type
locId	UUID

Returns

Promise<undefined | number>

Defined in

Queries.ts:163

---

getDefaultRegion

▸ getDefaultRegion(): "Europe"

Returns

"Europe"

Defined in

Queries.ts:274

---

getGuestsOf

▸ getGuestsOf(accountId): Promise<string[]>

Parameters

Name	Type
accountId	ValidAccountId

Returns

Promise<string[]>

Defined in

Queries.ts:253

---

getLegalOfficerCase

▸ getLegalOfficerCase(locId): Promise<undefined | LegalOfficerCase>

Parameters

Name	Type
locId	UUID

Returns

Promise<undefined | LegalOfficerCase>

Defined in

Queries.ts:134

---

getLegalOfficerData

▸ getLegalOfficerData(accountId): Promise<LegalOfficerData>

Parameters

Name	Type
accountId	ValidAccountId

Returns

Promise<LegalOfficerData>

Defined in

Queries.ts:227

---

getLegalOfficerVerifiedIssuers

▸ getLegalOfficerVerifiedIssuers(accountId): Promise<VerifiedIssuerType[]>

Parameters

Name	Type
accountId	ValidAccountId

Returns

Promise<VerifiedIssuerType[]>

Defined in

Queries.ts:209

---

getProxy

▸ getProxy(accountId): Promise<undefined | ValidAccountId>

Parameters

Name	Type
accountId	ValidAccountId

Returns

Promise<undefined | ValidAccountId>

Defined in

Queries.ts:192

---

getRecoveryConfig

▸ getRecoveryConfig(accountId): Promise<undefined | TypesRecoveryConfig>

Parameters

Name	Type
accountId	ValidAccountId

Returns

Promise<undefined | TypesRecoveryConfig>

Defined in

Queries.ts:172

---

getSponsorship

▸ getSponsorship(sponsorshipId): Promise<undefined | Sponsorship>

Parameters

Name	Type
sponsorshipId	UUID

Returns

Promise<undefined | Sponsorship>

Defined in

Queries.ts:200

---

getValidAccountId

▸ getValidAccountId(accountId, type): ValidAccountId

Parameters

Name	Type
accountId	string
type	AccountType

Returns

ValidAccountId

Defined in

Queries.ts:62

---

isInvitedContributorOf

▸ isInvitedContributorOf(accountId, locId): Promise<boolean>

Parameters

Name	Type
accountId	ValidAccountId
locId	UUID

Returns

Promise<boolean>

Defined in

Queries.ts:278

---

isValidAccountId

▸ isValidAccountId(accountId?, type?): boolean

Parameters

Name	Type
accountId?	null | string
type?	AccountType

Returns

boolean

Defined in

Queries.ts:54

---

buildCoinBalance

▸ buildCoinBalance(args): CoinBalance

Parameters

Name	Type
args	Object
args.available	PrefixedNumber
args.coinId	string
args.level	number
args.reserved	PrefixedNumber
args.total	PrefixedNumber

Returns

CoinBalance

Defined in

Queries.ts:100

---

getCoin

▸ getCoin(coinId): Coin

Parameters

Name	Type
coinId	string

Returns

Coin

Defined in

Queries.ts:118

---

of

▸ of(apiPromise): Promise<Queries>

Parameters

Name	Type
apiPromise	Promise<ApiPromise>

Returns

Promise<Queries>

Defined in

Queries.ts:46