@interlay/interbtc-api / Exports / VaultId
Name
VaultId
Struct
↳ VaultId
• Private #private: any
Struct.#private
node_modules/@polkadot/types-codec/native/Struct.d.ts:24
• Readonly [toStringTag]: string
Struct.[toStringTag]
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137
• Readonly account_id: AccountId
src/interfaces/default/types.ts:149
• Optional createdAtHash: IU8a
Struct.createdAtHash
node_modules/@polkadot/types-codec/native/Struct.d.ts:26
• Readonly currencies: VaultCurrencyPair
src/interfaces/default/types.ts:150
• Optional initialU8aLength: number
Struct.initialU8aLength
node_modules/@polkadot/types-codec/native/Struct.d.ts:27
• Optional isStorageFallback: boolean
Struct.isStorageFallback
node_modules/@polkadot/types-codec/native/Struct.d.ts:28
• Readonly registry: Registry
Struct.registry
node_modules/@polkadot/types-codec/native/Struct.d.ts:25
• Readonly size: number
Struct.size
node_modules/typescript/lib/lib.es2015.collection.d.ts:45
• get Type(): E
E
Description
Returns the Type description of the structure
Struct.Type
node_modules/@polkadot/types-codec/native/Struct.d.ts:50
• get defKeys(): string[]
string[]
Description
The available keys for this struct
Struct.defKeys
node_modules/@polkadot/types-codec/native/Struct.d.ts:34
• get encodedLength(): number
number
Description
The length of the value when encoded as a Uint8Array
Struct.encodedLength
node_modules/@polkadot/types-codec/native/Struct.d.ts:42
• get hash(): IU8a
IU8a
Description
returns a hash of the contents
Struct.hash
node_modules/@polkadot/types-codec/native/Struct.d.ts:46
• get isEmpty(): boolean
boolean
Description
Checks if the value is an empty value
Struct.isEmpty
node_modules/@polkadot/types-codec/native/Struct.d.ts:38
▸ [iterator](): MapIterator<[string, Codec]>
Returns an iterable of entries in the map.
MapIterator<[string, Codec]>
Struct.[iterator]
node_modules/typescript/lib/lib.es2015.iterable.d.ts:143
▸ clear(): void
void
Struct.clear
node_modules/typescript/lib/lib.es2015.collection.d.ts:20
▸ delete(key): boolean
| Name | Type |
|---|---|
key |
string |
boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Struct.delete
node_modules/typescript/lib/lib.es2015.collection.d.ts:24
▸ entries(): MapIterator<[string, Codec]>
Returns an iterable of key, value pairs for every entry in the map.
MapIterator<[string, Codec]>
Struct.entries
node_modules/typescript/lib/lib.es2015.iterable.d.ts:148
▸ eq(other?): boolean
| Name | Type |
|---|---|
other? |
unknown |
boolean
Description
Compares the value of the input to see if there is a match
Struct.eq
node_modules/@polkadot/types-codec/native/Struct.d.ts:54
▸ forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
| Name | Type |
|---|---|
callbackfn |
(value: Codec, key: string, map: Map<string, Codec>) => void |
thisArg? |
any |
void
Struct.forEach
node_modules/typescript/lib/lib.es2015.collection.d.ts:28
▸ get(key): undefined | Codec
| Name | Type | Description |
|---|---|---|
key |
string |
The name of the entry to retrieve |
undefined | Codec
Description
Returns a specific names entry in the structure
Struct.get
node_modules/@polkadot/types-codec/native/Struct.d.ts:59
▸ getAtIndex(index): Codec
| Name | Type |
|---|---|
index |
number |
Codec
Description
Returns the values of a member at a specific index (Rather use get(name) for performance)
Struct.getAtIndex
node_modules/@polkadot/types-codec/native/Struct.d.ts:63
▸ getT<T>(key): T
| Name |
|---|
T |
| Name | Type |
|---|---|
key |
string |
T
Description
Returns the a types value by name
Struct.getT
node_modules/@polkadot/types-codec/native/Struct.d.ts:67
▸ has(key): boolean
| Name | Type |
|---|---|
key |
string |
boolean
boolean indicating whether an element with the specified key exists or not.
Struct.has
node_modules/typescript/lib/lib.es2015.collection.d.ts:37
▸ inspect(isBare?): Inspect
| Name | Type |
|---|---|
isBare? |
BareOpts |
Inspect
Description
Returns a breakdown of the hex encoding for this Codec
Struct.inspect
node_modules/@polkadot/types-codec/native/Struct.d.ts:71
▸ keys(): MapIterator<string>
Returns an iterable of keys in the map
MapIterator<string>
Struct.keys
node_modules/typescript/lib/lib.es2015.iterable.d.ts:153
▸ 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.
| Name | Type |
|---|---|
key |
string |
value |
Codec |
this
Struct.set
node_modules/typescript/lib/lib.es2015.collection.d.ts:41
▸ toArray(): Codec[]
Codec[]
Description
Converts the Object to an standard JavaScript Array
Struct.toArray
node_modules/@polkadot/types-codec/native/Struct.d.ts:75
▸ toHex(): `0x${string}`
`0x${string}`
Description
Returns a hex string representation of the value
Struct.toHex
node_modules/@polkadot/types-codec/native/Struct.d.ts:79
▸ toHuman(isExtended?): Record<string, AnyJson>
| Name | Type |
|---|---|
isExtended? |
boolean |
Record<string, AnyJson>
Description
Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
Struct.toHuman
node_modules/@polkadot/types-codec/native/Struct.d.ts:83
▸ toJSON(): Record<string, AnyJson>
Record<string, AnyJson>
Description
Converts the Object to JSON, typically used for RPC transfers
Struct.toJSON
node_modules/@polkadot/types-codec/native/Struct.d.ts:87
▸ toPrimitive(): Record<string, AnyJson>
Record<string, AnyJson>
Description
Converts the value in a best-fit primitive form
Struct.toPrimitive
node_modules/@polkadot/types-codec/native/Struct.d.ts:91
▸ toRawType(): string
string
Description
Returns the base runtime type name for this instance
Struct.toRawType
node_modules/@polkadot/types-codec/native/Struct.d.ts:95
▸ toString(): string
string
Description
Returns the string representation of the value
Struct.toString
node_modules/@polkadot/types-codec/native/Struct.d.ts:99
▸ toU8a(isBare?): Uint8Array
| Name | Type | Description |
|---|---|---|
isBare? |
BareOpts |
true when the value has none of the type-specific prefixes (internal) |
Uint8Array
Description
Encodes the value as a Uint8Array as per the SCALE specifications
Struct.toU8a
node_modules/@polkadot/types-codec/native/Struct.d.ts:104
▸ values(): MapIterator<Codec>
Returns an iterable of values in the map
MapIterator<Codec>
Struct.values
node_modules/typescript/lib/lib.es2015.iterable.d.ts:158