name: MisbehaviorKind
description: An EnumType containing a Bft misbehaviour
Hierarchy
↳ EnumType<BftProposeOutOfTurn | BftDoublePropose | BftDoublePrepare | BftDoubleCommit>
↳ MisbehaviorKind
Implements
Constructors
constructor
⊕ new MisbehaviorKind(value?: BftAtReportValue | Uint8Array, index?: undefined | number): MisbehaviorKind
Overrides EnumType.constructor
Defined in type/MisbehaviorReport.ts:121
Parameters:
| Name | Type |
|---|---|
Optional value | BftAtReportValue | Uint8Array |
Optional index | undefined | number |
Returns: MisbehaviorKind
Accessors
asBftDoubleCommit
get asBftDoubleCommit(): BftDoubleCommit
Defined in type/MisbehaviorReport.ts:134
description: Returns the item as a BftDoubleCommit
Returns: BftDoubleCommit
asBftDoublePrepare
get asBftDoublePrepare(): BftDoublePrepare
Defined in type/MisbehaviorReport.ts:141
description: Returns the item as a BftDoublePrepare
Returns: BftDoublePrepare
asBftDoublePropose
get asBftDoublePropose(): BftDoublePropose
Defined in type/MisbehaviorReport.ts:148
description: Returns the item as a BftDoublePropose
Returns: BftDoublePropose
asBftProposeOutOfTurn
get asBftProposeOutOfTurn(): BftProposeOutOfTurn
Defined in type/MisbehaviorReport.ts:155
description: Returns the item as a BftProposeOutOfTurn
Returns: BftProposeOutOfTurn
encodedLength
get encodedLength(): number
Inherited from EnumType.encodedLength
Defined in codec/EnumType.ts:114
description: The length of the value when encoded as a Uint8Array
Returns: number
index
get index(): number
Defined in codec/EnumType.ts:121
description: The index of the metadata value
Returns: number
isEmpty
get isEmpty(): boolean
Inherited from EnumType.isEmpty
Defined in codec/EnumType.ts:128
description: Checks if the value is an empty value
Returns: boolean
isNone
get isNone(): boolean
Inherited from EnumType.isNone
Defined in codec/EnumType.ts:135
description: Checks if the Enum points to a Null type
Returns: boolean
isNull
get isNull(): boolean
Inherited from EnumType.isNull
Defined in codec/EnumType.ts:142
description: Checks if the Enum points to a Null type (deprecated, use isNone)
Returns: boolean
type
get type(): string
Defined in codec/EnumType.ts:149
description: The name of the type this enum value represents
Returns: string
value
get value(): Codec
Defined in codec/EnumType.ts:156
description: The value of the enum
Returns: Codec
Methods
eq
▸ eq(other?: any): boolean
Defined in codec/EnumType.ts:163
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 codec/EnumType.ts:176
description: Returns a hex string representation of the value
Returns: string
toJSON
▸ toJSON(): any
Implementation of Codec.toJSON
Inherited from EnumType.toJSON
Defined in codec/EnumType.ts:183
description: Converts the Object to JSON, typically used for RPC transfers
Returns: any
toNumber
▸ toNumber(): number
Inherited from EnumType.toNumber
Defined in codec/EnumType.ts:192
description: Returns the number representation for the value
Returns: number
toString
▸ toString(): string
Implementation of Codec.toString
Inherited from EnumType.toString
Defined in codec/EnumType.ts:199
description: Returns the string representation of the value
Returns: string
toU8a
▸ toU8a(isBare?: undefined | false | true): Uint8Array
Defined in codec/EnumType.ts:209
description: Encodes the value as a Uint8Array as per the parity-codec specifications
Parameters:
| Name | Type | Description |
|---|---|---|
Optional isBare | undefined | false | true | true when the value has none of the type-specific prefixes (internal) |
Returns: Uint8Array
<Static> with
▸ with<S>(Types: S): EnumConstructor<EnumType<S>>
Defined in codec/EnumType.ts:101
Type parameters:
S : ConstructorDef
Parameters:
| Name | Type |
|---|---|
| Types | S |
Returns: EnumConstructor<EnumType<S>>