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 type/ExtrinsicSignature.ts:29

Parameters:

Name Type
Optional value 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

get Type(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:160

description: Returns the Type description to sthe structure

Returns: E


encodedLength

get encodedLength(): number

Overrides Struct.encodedLength

Defined in type/ExtrinsicSignature.ts:66

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

Returns: number


era

get era(): ExtrinsicEra

Defined in type/ExtrinsicSignature.ts:82

description: The ExtrinsicEra (mortal or immortal) this signature applies to

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/ExtrinsicSignature.ts:75

description: true if the signature is valid

Returns: boolean


nonce

get nonce(): Nonce

Defined in type/ExtrinsicSignature.ts:89

description: The Nonce for the signature

Returns: Nonce


signature

get signature(): Signature

Defined in type/ExtrinsicSignature.ts:96

description: The actuall Signature hash

Returns: Signature


signer

get signer(): Address

Defined in type/ExtrinsicSignature.ts:103

description: The Address that signed

Returns: Address


version

get version(): number

Defined in type/ExtrinsicSignature.ts:110

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 | Uint8Array, _signature: Uint8Array, _nonce: AnyNumber, _era?: Uint8Array): ExtrinsicSignature

Defined in type/ExtrinsicSignature.ts:131

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


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(method: Method, account: KeyringPair, __namedParameters: object): ExtrinsicSignature

Defined in type/ExtrinsicSignature.ts:143

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>

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

Overrides Struct.toU8a

Defined in type/ExtrinsicSignature.ts:160

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?: Uint8Array): object | Uint8Array

Defined in type/ExtrinsicSignature.ts:46

Parameters:

Name Type
Optional value Uint8Array

Returns: object | Uint8Array


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


Last Updated: 2/25/2019, 4:39:16 PM