name: SignaturePayload

description: A signing payload for an Extrinsic. For the final encoding, it is variable length based on the conetnts included

8 bytes: The Transaction Index/Nonce as provided in the transaction itself. 2+ bytes: The Function Descriptor as provided in the transaction itself. 2 bytes: The Transaction Era as provided in the transaction itself. 32 bytes: The hash of the authoring block implied by the Transaction Era and the current block.

# Type parameters

# S : ConstructorDef

# T : object

# V : object

# E : object

# Hierarchy

↳ Struct

↳ SignaturePayload

# Implements

• Codec

# Constructors

# constructor

⊕ new SignaturePayload(value?: SignaturePayloadValue | Uint8Array): SignaturePayload

Overrides Struct.constructor

Defined in type/SignaturePayload.ts:36

Parameters:

Name	Type
Optional value	SignaturePayloadValue | Uint8Array

Returns: SignaturePayload

---

# 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

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E

---

# blockHash

get blockHash(): Hash

Defined in type/SignaturePayload.ts:57

description: The block Hash the signature applies to (mortal/immortal)

Returns: Hash

---

# encodedLength

get encodedLength(): number

Inherited from Struct.encodedLength

Defined in codec/Struct.ts:167

description: The length of the value when encoded as a Uint8Array

Returns: number

---

# era

get era(): ExtrinsicEra

Defined in type/SignaturePayload.ts:71

description: The ExtrinsicEra

Returns: ExtrinsicEra

---

# isEmpty

get isEmpty(): boolean

Inherited from Struct.isEmpty

Defined in codec/Struct.ts:145

description: Checks if the value is an empty value

Returns: boolean

---

# isSigned

get isSigned(): boolean

Defined in type/SignaturePayload.ts:50

description: true if the payload refers to a valid signature

Returns: boolean

---

# method

get method(): Method

Defined in type/SignaturePayload.ts:64

description: The Method contained in the payload

Returns: Method

---

# nonce

get nonce(): Nonce

Defined in type/SignaturePayload.ts:78

description: The Nonce

Returns: Nonce

---

# signature

get signature(): Uint8Array

Defined in type/SignaturePayload.ts:85

description: The raw signature as a Uint8Array

Returns: Uint8Array

---

# 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]>

---

# 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]>

---

# eq

▸ eq(other?: any): boolean

Implementation of Codec.eq

Inherited from Struct.eq

Defined in codec/Struct.ts:176

description: Compares the value of the input to see if there is a match

Parameters:

Name	Type
Optional other	any

Returns: boolean

---

# 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

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:184

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:191

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(signerPair: KeyringPair, version?: RuntimeVersion): Uint8Array

Defined in type/SignaturePayload.ts:96

description: Sign the payload with the keypair

Parameters:

Name	Type
signerPair	KeyringPair
Optional version	RuntimeVersion

Returns: Uint8Array

---

# toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:198

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

---

# toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:205

description: Returns a hex string representation of the value

Returns: string

---

# toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:212

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:226

description: Returns the string representation of the value

Returns: string

---

# toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from Struct.toU8a

Defined in codec/Struct.ts:234

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> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:125

Type parameters:

# S : ConstructorDef

Parameters:

Name	Type
Types	S

Returns: Constructor<Struct<S>>

---