interbtc-api

@interlay/interbtc-api / Exports / CurrencyId

Interface: CurrencyId

Name

CurrencyId

Hierarchy

Table of contents

Properties

Accessors

Methods

Properties

#private

Private #private: any

Inherited from

Enum.#private

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:23


asForeignAsset

Readonly asForeignAsset: ForeignAssetId

Defined in

src/interfaces/default/types.ts:18


asLendToken

Readonly asLendToken: LendTokenId

Defined in

src/interfaces/default/types.ts:20


asLpToken

Readonly asLpToken: ITuple<[LpToken, LpToken]>

Defined in

src/interfaces/default/types.ts:22


asStableLpToken

Readonly asStableLpToken: StablePoolId

Defined in

src/interfaces/default/types.ts:24


asToken

Readonly asToken: TokenSymbol

Defined in

src/interfaces/default/types.ts:16


createdAtHash

Optional createdAtHash: IU8a

Inherited from

Enum.createdAtHash

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:25


initialU8aLength

Optional initialU8aLength: number

Inherited from

Enum.initialU8aLength

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:26


isForeignAsset

Readonly isForeignAsset: boolean

Defined in

src/interfaces/default/types.ts:17


isLendToken

Readonly isLendToken: boolean

Defined in

src/interfaces/default/types.ts:19


isLpToken

Readonly isLpToken: boolean

Defined in

src/interfaces/default/types.ts:21


isStableLpToken

Readonly isStableLpToken: boolean

Defined in

src/interfaces/default/types.ts:23


isStorageFallback

Optional isStorageFallback: boolean

Inherited from

Enum.isStorageFallback

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:27


isToken

Readonly isToken: boolean

Defined in

src/interfaces/default/types.ts:15


registry

Readonly registry: Registry

Inherited from

Enum.registry

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:24


type

Readonly type: "Token" | "ForeignAsset" | "LendToken" | "LpToken" | "StableLpToken"

Overrides

Enum.type

Defined in

src/interfaces/default/types.ts:25

Accessors

defIndexes

get defIndexes(): number[]

Returns

number[]

Description

The available keys for this enum

Inherited from

Enum.defIndexes

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:61


defKeys

get defKeys(): string[]

Returns

string[]

Description

The available keys for this enum

Inherited from

Enum.defKeys

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:65


encodedLength

get encodedLength(): number

Returns

number

Description

The length of the value when encoded as a Uint8Array

Inherited from

Enum.encodedLength

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:33


hash

get hash(): IU8a

Returns

IU8a

Description

returns a hash of the contents

Inherited from

Enum.hash

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:37


index

get index(): number

Returns

number

Description

The index of the enum value

Inherited from

Enum.index

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:41


inner

get inner(): Codec

Returns

Codec

Description

The value of the enum

Inherited from

Enum.inner

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:45


isBasic

get isBasic(): boolean

Returns

boolean

Description

true if this is a basic enum (no values)

Inherited from

Enum.isBasic

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:49


isEmpty

get isEmpty(): boolean

Returns

boolean

Description

Checks if the value is an empty value

Inherited from

Enum.isEmpty

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:53


isNone

get isNone(): boolean

Returns

boolean

Description

Checks if the Enum points to a [[Null]] type

Inherited from

Enum.isNone

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:57


value

get value(): Codec

Returns

Codec

Description

The value of the enum

Inherited from

Enum.value

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:73

Methods

_toRawStruct

_toRawStruct(): string[] | Record<string, string | number>

Returns

string[] | Record<string, string | number>

Description

Returns a raw struct representation of the enum types

Inherited from

Enum._toRawStruct

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:105


eq

eq(other?): boolean

Parameters

Name Type
other? unknown

Returns

boolean

Description

Compares the value of the input to see if there is a match

Inherited from

Enum.eq

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:77


inspect

inspect(): Inspect

Returns

Inspect

Description

Returns a breakdown of the hex encoding for this Codec

Inherited from

Enum.inspect

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:81


toHex

toHex(): `0x${string}`

Returns

`0x${string}`

Description

Returns a hex string representation of the value

Inherited from

Enum.toHex

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:85


toHuman

toHuman(isExtended?): AnyJson

Parameters

Name Type
isExtended? boolean

Returns

AnyJson

Description

Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information

Inherited from

Enum.toHuman

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:89


toJSON

toJSON(): AnyJson

Returns

AnyJson

Description

Converts the Object to JSON, typically used for RPC transfers

Inherited from

Enum.toJSON

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:93


toNumber

toNumber(): number

Returns

number

Description

Returns the number representation for the value

Inherited from

Enum.toNumber

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:97


toPrimitive

toPrimitive(): AnyJson

Returns

AnyJson

Description

Converts the value in a best-fit primitive form

Inherited from

Enum.toPrimitive

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:101


toRawType

toRawType(): string

Returns

string

Description

Returns the base runtime type name for this instance

Inherited from

Enum.toRawType

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:109


toString

toString(): string

Returns

string

Description

Returns the string representation of the value

Inherited from

Enum.toString

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:113


toU8a

toU8a(isBare?): Uint8Array

Parameters

Name Type Description
isBare? boolean true when the value has none of the type-specific prefixes (internal)

Returns

Uint8Array

Description

Encodes the value as a Uint8Array as per the SCALE specifications

Inherited from

Enum.toU8a

Defined in

node_modules/@polkadot/types-codec/base/Enum.d.ts:118