name: ExtrinsicSignature
description: A container for the Signature associated with a specific Extrinsic
Type parameters
S : ConstructorDef
T : object
V : object
E : object
Hierarchy
↳ Struct
↳ ExtrinsicSignature
Implements
Constructors
constructor
⊕ new ExtrinsicSignature(value?: Uint8Array): ExtrinsicSignature
Overrides Struct.constructor
Defined in ExtrinsicSignature.ts:36
Parameters:
| Name | Type |
|---|---|
Optional value |
Uint8Array |
Returns: ExtrinsicSignature
Accessors
Type
getType(): E
Defined in codec/Struct.ts:142
description: Returns the Type description to sthe structure
Returns: E
encodedLength
getencodedLength(): number
Overrides Struct.encodedLength
Defined in ExtrinsicSignature.ts:73
description: The length of the value when encoded as a Uint8Array
Returns: number
era
getera(): ExtrinsicEra
Defined in ExtrinsicSignature.ts:89
description: The ExtrinsicEra (mortal or immortal) this signature applies to
Returns: ExtrinsicEra
isSigned
getisSigned(): boolean
Defined in ExtrinsicSignature.ts:82
description: true if the signature is valid
Returns: boolean
nonce
getnonce(): Nonce
Defined in ExtrinsicSignature.ts:96
description: The Nonce for the signature
Returns: Nonce
signature
getsignature(): Signature
Defined in ExtrinsicSignature.ts:103
description: The actuall Signature hash
Returns: Signature
signer
getsigner(): Address
Defined in ExtrinsicSignature.ts:110
description: The Address that signed
Returns: Address
version
getversion(): number
Defined in ExtrinsicSignature.ts:117
description: The encoded version for the signature
Returns: number
Methods
addSignature
▸ addSignature(signer: *[Address](_address.address.md) | Uint8Array, _signature: Uint8Array, _nonce: AnyNumber, _era?: Uint8Array*): ExtrinsicSignature
Defined in ExtrinsicSignature.ts:138
description: Adds a raw signature
Parameters:
| Name | Type | Default value | |
|---|---|---|---|
| _signer | Address | Uint8Array |
- |
| _signature | Uint8Array |
- | |
| _nonce | AnyNumber | - | |
Default value _era |
Uint8Array |
IMMORTAL_ERA |
Returns: ExtrinsicSignature
eq
▸ eq(other?: any): boolean
Defined in codec/Struct.ts:158
description: Compares the value of the input to see if there is a match
Parameters:
| Name | Type |
|---|---|
Optional other |
any |
Returns: boolean
get
▸ get(name: keyof S): Codec | undefined
Overrides Map.get
Defined in codec/Struct.ts:166
description: Returns a specific names entry in the structure
Parameters:
| Name | Type | Description |
|---|---|---|
| name | keyof S |
The name of the entry to retrieve |
Returns: Codec | undefined
getAtIndex
▸ getAtIndex(index: number): Codec
Inherited from Struct.getAtIndex
Defined in codec/Struct.ts:173
description: Returns the values of a member at a specific index (Rather use get(name) for performance)
Parameters:
| Name | Type |
|---|---|
| index | number |
Returns: Codec
sign
▸ sign(method: Method, account: KeyringPair, _namedParameters: object): [ExtrinsicSignature](_extrinsicsignature.extrinsicsignature.md)
Defined in ExtrinsicSignature.ts:150
description: Generate a payload and pplies the signature from a keypair
Parameters:
| Name | Type |
|---|---|
| method | Method |
| account | KeyringPair |
| __namedParameters | object |
Returns: ExtrinsicSignature
toArray
▸ toArray(): Array<Codec>
Defined in codec/Struct.ts:180
description: Converts the Object to an standard JavaScript Array
Returns: Array<Codec>
toHex
▸ toHex(): string
Defined in codec/Struct.ts:187
description: Returns a hex string representation of the value
Returns: string
toJSON
▸ toJSON(): any
Implementation of Codec.toJSON
Defined in codec/Struct.ts:194
description: Converts the Object to JSON, typically used for RPC transfers
Returns: any
toString
▸ toString(): string
Implementation of Codec.toString
Inherited from Struct.toString
Defined in codec/Struct.ts:208
description: Returns the string representation of the value
Returns: string
toU8a
▸ toU8a(isBare?: undefined | false | true): Uint8Array
Defined in ExtrinsicSignature.ts:167
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> decodeExtrinsicSignature
▸ decodeExtrinsicSignature(value?: Uint8Array): object | Uint8Array
Defined in ExtrinsicSignature.ts:53
Parameters:
| Name | Type |
|---|---|
Optional value |
Uint8Array |
Returns: object | Uint8Array
<Static> with
▸ with<S>(Types: S): Constructor<Struct<S>>
Defined in codec/Struct.ts:122
Type parameters:
S : ConstructorDef
Parameters:
| Name | Type |
|---|---|
| Types | S |
Returns: Constructor<Struct<S>>