interbtc-api

@interlay/interbtc-api / Exports / DefaultAssetRegistryAPI

Class: DefaultAssetRegistryAPI

Implements

• AssetRegistryAPI

Table of contents

Constructors

• constructor

Properties

• api

Methods

• extractCollateralCeilingEntryKeys
• getAssetRegistryEntries
• getCollateralForeignAssets
• getForeignAsset
• getForeignAssets
• getSystemCollateralCeilingEntries
• metadataToCurrency
• metadataTupleToForeignAsset
• unwrapMetadataFromEntries

Constructors

constructor

• new DefaultAssetRegistryAPI(api): DefaultAssetRegistryAPI

Parameters

Name	Type
api	ApiPromise

Returns

DefaultAssetRegistryAPI

Defined in

src/parachain/asset-registry.ts:43

Properties

api

• Private api: ApiPromise

Defined in

src/parachain/asset-registry.ts:43

Methods

extractCollateralCeilingEntryKeys

▸ extractCollateralCeilingEntryKeys(entries): InterbtcPrimitivesVaultCurrencyPair[]

Parameters

Name	Type
entries	SystemCollateralCeilingTuple[]

Returns

InterbtcPrimitivesVaultCurrencyPair[]

Defined in

src/parachain/asset-registry.ts:104

---

getAssetRegistryEntries

▸ getAssetRegistryEntries(): Promise<AssetRegistryMetadataTuple[]>

Returns

Promise<AssetRegistryMetadataTuple[]>

Defined in

src/parachain/asset-registry.ts:71

---

getCollateralForeignAssets

▸ getCollateralForeignAssets(): Promise<ForeignAsset[]>

Get all foreign assets which have a registered collateral ceiling, meaning they can be used as collateral currency.

Returns

Promise<ForeignAsset[]>

All foreign assets that have been registered as collateral currency

Implementation of

AssetRegistryAPI.getCollateralForeignAssets

Defined in

src/parachain/asset-registry.ts:110

---

getForeignAsset

▸ getForeignAsset(id): Promise<ForeignAsset>

Get foreign asset by its id.

Parameters

Name	Type	Description
id	number | u32	The id of the foreign asset.

Returns

Promise<ForeignAsset>

The foreign asset.

Implementation of

AssetRegistryAPI.getForeignAsset

Defined in

src/parachain/asset-registry.ts:94

---

getForeignAssets

▸ getForeignAssets(): Promise<ForeignAsset[]>

Get all currencies (foreign assets) in the asset registry.

Returns

Promise<ForeignAsset[]>

A list of currencies.

Implementation of

AssetRegistryAPI.getForeignAssets

Defined in

src/parachain/asset-registry.ts:86

---

getSystemCollateralCeilingEntries

▸ getSystemCollateralCeilingEntries(): Promise<SystemCollateralCeilingTuple[]>

Returns

Promise<SystemCollateralCeilingTuple[]>

Defined in

src/parachain/asset-registry.ts:99

---

metadataToCurrency

▸ metadataToCurrency(metadata): Currency

Parameters

Name	Type
metadata	OrmlTraitsAssetRegistryAssetMetadata

Returns

Currency

Defined in

src/parachain/asset-registry.ts:45

---

metadataTupleToForeignAsset

▸ metadataTupleToForeignAsset(«destructured»): ForeignAsset

Parameters

Name	Type
«destructured»	UnwrappedAssetRegistryMetadataTuple

Returns

ForeignAsset

Defined in

src/parachain/asset-registry.ts:56

---

unwrapMetadataFromEntries

▸ unwrapMetadataFromEntries(entries): UnwrappedAssetRegistryMetadataTuple[]

Static method to filter out metadata that can be unwrapped.ie. Option.isSome !== true.

Parameters

Name	Type	Description
entries	AssetRegistryMetadataTuple[]	The entries from the asset registry.

Returns

UnwrappedAssetRegistryMetadataTuple[]

A list of all entries containing metadata.

Defined in

src/parachain/asset-registry.ts:80

This site is open source. Improve this page.