interbtc-api

@interlay/interbtc-api / Exports / DecodedRequestExt

Interface: DecodedRequestExt

Hierarchy

Table of contents

Properties

Methods

Properties

Type

Type: Object

Inherited from

Omit.Type

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:50


[toStringTag]

Readonly [toStringTag]: string

Inherited from

Omit.[toStringTag]

Defined in

node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137


btc_address

btc_address: string

Defined in

src/utils/encoding.ts:155


createdAtHash

Optional createdAtHash: IU8a

Inherited from

Omit.createdAtHash

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:26


defKeys

defKeys: string[]

Inherited from

Omit.defKeys

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:34


encodedLength

encodedLength: number

Inherited from

Omit.encodedLength

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:42


hash

hash: IU8a

Inherited from

Omit.hash

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:46


initialU8aLength

Optional initialU8aLength: number

Inherited from

Omit.initialU8aLength

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:27


isEmpty

isEmpty: boolean

Inherited from

Omit.isEmpty

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:38


isStorageFallback

Optional isStorageFallback: boolean

Inherited from

Omit.isStorageFallback

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:28


registry

Readonly registry: Registry

Inherited from

Omit.registry

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:25


size

Readonly size: number

Inherited from

Omit.size

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:45

Methods

[iterator]

[iterator](): MapIterator<[string, Codec]>

Returns an iterable of entries in the map.

Returns

MapIterator<[string, Codec]>

Inherited from

Omit.[iterator]

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:143


clear

clear(): void

Returns

void

Inherited from

Omit.clear

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:20


delete

delete(key): boolean

Parameters

Name Type
key string

Returns

boolean

true if an element in the Map existed and has been removed, or false if the element does not exist.

Inherited from

Omit.delete

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:24


entries

entries(): MapIterator<[string, Codec]>

Returns an iterable of key, value pairs for every entry in the map.

Returns

MapIterator<[string, Codec]>

Inherited from

Omit.entries

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:148


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

Omit.eq

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:54


forEach

forEach(callbackfn, thisArg?): void

Executes a provided function once per each key/value pair in the Map, in insertion order.

Parameters

Name Type
callbackfn (value: Codec, key: string, map: Map<string, Codec>) => void
thisArg? any

Returns

void

Inherited from

Omit.forEach

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:28


get

get(key): undefined | Codec

Parameters

Name Type Description
key string The name of the entry to retrieve

Returns

undefined | Codec

Description

Returns a specific names entry in the structure

Inherited from

Omit.get

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:59


getAtIndex

getAtIndex(index): Codec

Parameters

Name Type
index number

Returns

Codec

Description

Returns the values of a member at a specific index (Rather use get(name) for performance)

Inherited from

Omit.getAtIndex

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:63


getT

getT<T>(key): T

Type parameters

Name
T

Parameters

Name Type
key string

Returns

T

Description

Returns the a types value by name

Inherited from

Omit.getT

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:67


has

has(key): boolean

Parameters

Name Type
key string

Returns

boolean

boolean indicating whether an element with the specified key exists or not.

Inherited from

Omit.has

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:37


inspect

inspect(isBare?): Inspect

Parameters

Name Type
isBare? BareOpts

Returns

Inspect

Description

Returns a breakdown of the hex encoding for this Codec

Inherited from

Omit.inspect

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:71


keys

keys(): MapIterator<string>

Returns an iterable of keys in the map

Returns

MapIterator<string>

Inherited from

Omit.keys

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:153


set

set(key, value): this

Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

Parameters

Name Type
key string
value Codec

Returns

this

Inherited from

Omit.set

Defined in

node_modules/typescript/lib/lib.es2015.collection.d.ts:41


toArray

toArray(): Codec[]

Returns

Codec[]

Description

Converts the Object to an standard JavaScript Array

Inherited from

Omit.toArray

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:75


toHex

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

Returns

`0x${string}`

Description

Returns a hex string representation of the value

Inherited from

Omit.toHex

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:79


toHuman

toHuman(isExtended?): Record<string, AnyJson>

Parameters

Name Type
isExtended? boolean

Returns

Record<string, AnyJson>

Description

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

Inherited from

Omit.toHuman

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:83


toJSON

toJSON(): Record<string, AnyJson>

Returns

Record<string, AnyJson>

Description

Converts the Object to JSON, typically used for RPC transfers

Inherited from

Omit.toJSON

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:87


toPrimitive

toPrimitive(): Record<string, AnyJson>

Returns

Record<string, AnyJson>

Description

Converts the value in a best-fit primitive form

Inherited from

Omit.toPrimitive

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:91


toRawType

toRawType(): string

Returns

string

Description

Returns the base runtime type name for this instance

Inherited from

Omit.toRawType

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:95


toString

toString(): string

Returns

string

Description

Returns the string representation of the value

Inherited from

Omit.toString

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:99


toU8a

toU8a(isBare?): Uint8Array

Parameters

Name Type Description
isBare? BareOpts 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

Omit.toU8a

Defined in

node_modules/@polkadot/types-codec/native/Struct.d.ts:104


values

values(): MapIterator<Codec>

Returns an iterable of values in the map

Returns

MapIterator<Codec>

Inherited from

Omit.values

Defined in

node_modules/typescript/lib/lib.es2015.iterable.d.ts:158