name: ChainProperties
description: Wraps the properties retrieved from the chain via the system.properties RPC call. It extends the standard JS Map with de-facto values exposed as getters. While it implements a Codec, it is limited in that it can only be used with input objects via RPC, i.e. no hex decoding. Unlike a struct, this wrasp a JSON object with unknown keys and any values for those
Hierarchy
Map<string, any>
↳ ChainProperties
Implements
Constructors
constructor
⊕ new ChainProperties(value?: object | null): ChainProperties
Defined in type/ChainProperties.ts:17
Parameters:
| Name | Type |
|---|---|
Optional value | object | null |
Returns: ChainProperties
Properties
<Static> Map
● Map: MapConstructor
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:36
Accessors
encodedLength
get encodedLength(): number
Defined in type/ChainProperties.ts:29
description: Always 0, never encodes as a Uint8Array
Returns: number
isEmpty
get isEmpty(): boolean
Defined in type/ChainProperties.ts:36
description: Checks if the value is an empty value
Returns: boolean
tokenDecimals
get tokenDecimals(): number | undefined
Defined in type/ChainProperties.ts:43
description: The token decimals, if defined (de-facto standard only)
Returns: number | undefined
tokenSymbol
get tokenSymbol(): string | undefined
Defined in type/ChainProperties.ts:50
description: The token system, if defined (de-facto standard only)
Returns: string | undefined
Methods
eq
▸ eq(other?: any): boolean
Defined in type/ChainProperties.ts:57
description: Compares the value of the input to see if there is a match
Parameters:
| Name | Type |
|---|---|
Optional other | any |
Returns: boolean
toHex
▸ toHex(): string
Defined in type/ChainProperties.ts:64
description: Unimplemented, will throw
Returns: string
toJSON
▸ toJSON(): any
Implementation of Codec.toJSON
Defined in type/ChainProperties.ts:71
description: Converts the Object to JSON, typically used for RPC transfers
Returns: any
toString
▸ toString(): string
Implementation of Codec.toString
Defined in type/ChainProperties.ts:82
description: Returns the string representation of the value
Returns: string
toU8a
▸ toU8a(isBare?: undefined | false | true): Uint8Array
Defined in type/ChainProperties.ts:89
description: Unimplemented, will throw
Parameters:
| Name | Type |
|---|---|
Optional isBare | undefined | false | true |
Returns: Uint8Array