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?: ExtrinsicSignatureValue | Uint8Array): ExtrinsicSignature
Overrides Struct.constructor
Defined in ExtrinsicSignature.ts:37
Parameters:
| Name | Type |
|---|---|
Optional value |
ExtrinsicSignatureValue | Uint8Array |
Returns: ExtrinsicSignature
Properties
__@toStringTag
● __@toStringTag: string
Inherited from Map.[Symbol.toStringTag]
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130
size
● size: number
Inherited from Map.size
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28
Accessors
Type
getType(): E
Defined in codec/Struct.ts:133
description: Returns the Type description to sthe structure
Returns: E
encodedLength
getencodedLength(): number
Overrides Struct.encodedLength
Defined in ExtrinsicSignature.ts:71
description: The length of the value when encoded as a Uint8Array
Returns: number
era
getera(): ExtrinsicEra
Defined in ExtrinsicSignature.ts:90
description: The ExtrinsicEra (mortal or immortal) this signature applies to
Returns: ExtrinsicEra
isSigned
getisSigned(): boolean
Defined in ExtrinsicSignature.ts:83
description: true if the signature is valid
Returns: boolean
nonce
getnonce(): Nonce
Defined in ExtrinsicSignature.ts:97
description: The Nonce for the signature
Returns: Nonce
signature
getsignature(): Signature
Defined in ExtrinsicSignature.ts:104
description: The actuall Signature hash
Returns: Signature
signer
getsigner(): Address
Defined in ExtrinsicSignature.ts:111
description: The Address that signed
Returns: Address
version
getversion(): number
Defined in ExtrinsicSignature.ts:118
description: The encoded version for the signature
Returns: number
Methods
__@iterator
▸ __@iterator(): IterableIterator<[keyof S, Codec]>
Inherited from Map.[Symbol.iterator]
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113
Returns an iterable of entries in the map.
Returns: IterableIterator<[keyof S, Codec]>
addSignature
▸ addSignature(signer: * [Address](_address.address.md) | Uint8Array, _signature: Uint8Array, _nonce: AnyNumber, _era?: Uint8Array*): ExtrinsicSignature
Defined in ExtrinsicSignature.ts:142
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
clear
▸ clear(): void
Inherited from Map.clear
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22
Returns: void
delete
▸ delete(key: keyof S): boolean
Inherited from Map.delete
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Parameters:
| Name | Type |
|---|---|
| key | keyof S |
Returns: boolean
entries
▸ entries(): IterableIterator<[keyof S, Codec]>
Inherited from Map.entries
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118
Returns an iterable of key, value pairs for every entry in the map.
Returns: IterableIterator<[keyof S, Codec]>
forEach
▸ forEach(callbackfn: function, thisArg?: any): void
Inherited from Map.forEach
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24
Parameters:
| Name | Type |
|---|---|
| callbackfn | function |
Optional thisArg |
any |
Returns: void
get
▸ get(name: keyof S): Codec | undefined
Overrides Map.get
Defined in codec/Struct.ts:150
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:157
description: Returns the values of a member at a specific index (Rather use get(name) for performance)
Parameters:
| Name | Type |
|---|---|
| index | number |
Returns: Codec
has
▸ has(key: keyof S): boolean
Inherited from Map.has
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters:
| Name | Type |
|---|---|
| key | keyof S |
Returns: boolean
keys
▸ keys(): IterableIterator<keyof S>
Inherited from Map.keys
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123
Returns an iterable of keys in the map
Returns: IterableIterator<keyof S>
set
▸ set(key: keyof S, value: Codec): this
Inherited from Map.set
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27
Parameters:
| Name | Type |
|---|---|
| key | keyof S |
| value | Codec |
Returns: this
sign
▸ sign(method: Method, signerPair: KeyringPair, nonce: AnyNumber, blockHash: AnyU8a, era?: Uint8Array): ExtrinsicSignature
Defined in ExtrinsicSignature.ts:154
description: Generate a payload and pplies the signature from a keypair
Parameters:
| Name | Type | Default value |
|---|---|---|
| method | Method | - |
| signerPair | KeyringPair |
- |
| nonce | AnyNumber | - |
| blockHash | AnyU8a | - |
Default value era |
Uint8Array |
IMMORTAL_ERA |
Returns: ExtrinsicSignature
toArray
▸ toArray(): Array<Codec>
Defined in codec/Struct.ts:164
description: Converts the Object to an standard JavaScript Array
Returns: Array<Codec>
toHex
▸ toHex(): string
Defined in codec/Struct.ts:171
description: Returns a hex string representation of the value
Returns: string
toJSON
▸ toJSON(): any
Implementation of Codec.toJSON
Defined in codec/Struct.ts:178
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:192
description: Returns the string representation of the value
Returns: string
toU8a
▸ toU8a(isBare?: undefined | false | true): Uint8Array
Defined in ExtrinsicSignature.ts:171
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
values
▸ values(): IterableIterator<Codec>
Inherited from Map.values
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128
Returns an iterable of values in the map
Returns: IterableIterator<Codec>
<Static> decodeExtrinsicSignature
▸ decodeExtrinsicSignature(value: ExtrinsicSignature | ExtrinsicSignatureValue | AnyU8a | undefined): object | Uint8Array
Defined in ExtrinsicSignature.ts:52
Parameters:
| Name | Type |
|---|---|
| value | ExtrinsicSignature | ExtrinsicSignatureValue | AnyU8a | undefined |
Returns: object | Uint8Array
<Static> with
▸ with<S>(Types: S): Constructor<Struct<S>>
Defined in codec/Struct.ts:113
Type parameters:
S : ConstructorDef
Parameters:
| Name | Type |
|---|---|
| Types | S |
Returns: Constructor<Struct<S>>