name: Extrinsic
description: Representation of an Extrinsic in the system. It contains the actual call, (optional) signature and encodes with an actual length prefix
https://github.com/paritytech/wiki/blob/master/Extrinsic.md#the-extrinsic-format-for-node.
Can be:
- signed, to create a transaction
- left as is, to create an inherent
Type parameters
S : ConstructorDef
T : object
V : object
E : object
Hierarchy
↳ Struct
↳ Extrinsic
Implements
Constructors
constructor
⊕ new Extrinsic(value?: ExtrinsicValue | AnyU8a | Method): Extrinsic
Overrides Struct.constructor
Defined in type/Extrinsic.ts:36
Parameters:
| Name | Type |
|---|---|
Optional value | ExtrinsicValue | AnyU8a | Method |
Returns: Extrinsic
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
Defined in codec/Struct.ts:160
description: Returns the Type description to sthe structure
Returns: E
args
get args(): Array<Codec>
Defined in type/Extrinsic.ts:76
description: The arguments passed to for the call, exposes args so it is compatible with Method
Returns: Array<Codec>
callIndex
get callIndex(): Uint8Array
Defined in type/Extrinsic.ts:83
description: The actual [sectionIndex, methodIndex] as used in the Method
Returns: Uint8Array
data
get data(): Uint8Array
Defined in type/Extrinsic.ts:90
description: The actual data for the Method
Returns: Uint8Array
encodedLength
get encodedLength(): number
Overrides Struct.encodedLength
Defined in type/Extrinsic.ts:97
description: The length of the value when encoded as a Uint8Array
Returns: number
hash
get hash(): Hash
Defined in type/Extrinsic.ts:106
description: Convernience function, encodes the extrinsic and returns the actual hash
Returns: Hash
isEmpty
get isEmpty(): boolean
Defined in codec/Struct.ts:145
description: Checks if the value is an empty value
Returns: boolean
isSigned
get isSigned(): boolean
Defined in type/Extrinsic.ts:115
description: true id the extrinsic is signed
Returns: boolean
length
get length(): number
Defined in type/Extrinsic.ts:122
description: The length of the encoded value
Returns: number
meta
get meta(): FunctionMetadata
Defined in type/Extrinsic.ts:129
description: The FunctionMetadata that describes the extrinsic
Returns: FunctionMetadata
method
get method(): Method
Defined in type/Extrinsic.ts:136
description: The Method this extrinsic wraps
Returns: Method
signature
get signature(): ExtrinsicSignature
Defined in type/Extrinsic.ts:143
description: The ExtrinsicSignature
Returns: ExtrinsicSignature
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): Extrinsic
Defined in type/Extrinsic.ts:150
description: Add an ExtrinsicSignature to the extrinsic (already generated)
Parameters:
| Name | Type |
|---|---|
| signer | Address | Uint8Array |
| signature | Uint8Array |
| nonce | AnyNumber |
Optional era | Uint8Array |
Returns: Extrinsic
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
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
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(account: KeyringPair, options: SignatureOptions): Extrinsic
Defined in type/Extrinsic.ts:159
description: Sign the extrinsic with a specific keypair
Parameters:
| Name | Type |
|---|---|
| account | KeyringPair |
| options | SignatureOptions |
Returns: Extrinsic
toArray
▸ toArray(): Array<Codec>
Defined in codec/Struct.ts:198
description: Converts the Object to an standard JavaScript Array
Returns: Array<Codec>
toHex
▸ toHex(): string
Defined in type/Extrinsic.ts:168
description: Returns a hex string representation of the value
Returns: string
toJSON
▸ toJSON(): any
Implementation of Codec.toJSON
Defined in type/Extrinsic.ts:175
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
Defined in type/Extrinsic.ts:183
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> decodeExtrinsic
▸ decodeExtrinsic(value: ExtrinsicValue | AnyU8a | Method): ExtrinsicValue | Array<number> | Uint8Array
Defined in type/Extrinsic.ts:44
Parameters:
| Name | Type |
|---|---|
| value | ExtrinsicValue | AnyU8a | Method |
Returns: ExtrinsicValue | Array<number> | Uint8Array
<Static> with
▸ with<S>(Types: S): Constructor<Struct<S>>
Defined in codec/Struct.ts:125
Type parameters:
S : ConstructorDef
Parameters:
| Name | Type |
|---|---|
| Types | S |
Returns: Constructor<Struct<S>>