Class GenericExtrinsicPayloadV5

Name

GenericExtrinsicPayloadV5

Description

A signing payload for an [[Extrinsic]]. For the final encoding, it is variable length based on the contents included

Hierarchy (View Summary)

Struct
- GenericExtrinsicPayloadV5

Index

Constructors

constructor

new GenericExtrinsicPayloadV5(
registry: Registry,
value?: Uint8Array | `0x${string}` | ExtrinsicPayloadValue,
): GenericExtrinsicPayloadV5
Parameters
- registry: Registry
- Optionalvalue: Uint8Array | `0x${string}` | ExtrinsicPayloadValue
Returns GenericExtrinsicPayloadV5
Overrides Struct.constructor
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:22

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Optional`createdAtHash

createdAtHash?: IU8a

Description

The block at which this value was retrieved/created (set to non-empty when retrieved from storage)

`Optional`initialU8aLength

initialU8aLength?: number

Description

The length of the initial encoded value (Only available when the value was constructed from a Uint8Array input)

`Optional`isStorageFallback

isStorageFallback?: boolean

Description

(internal usage) Indicates that the value was created via a fallback. This is used when with data specified in the metadata when the storage entry is empty.

With metadata fallback values (available as defaults on most storage entries) any empty storage item should erturn the default. (This is the same as the implementation on the Bizinikiwi runtime)

`Readonly`registry

registry: Registry

Description

The registry associated with this object

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly`[species]

"[species]": MapConstructor

Accessors

assetId

get assetId(): IOption<INumber | MultiLocation>
Returns IOption<INumber | MultiLocation>

Description
The (optional) asset id for this signature for chains that support transaction fees in assets
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:96

blockHash

get blockHash(): BlockHash
Returns BlockHash

Description
The block [[BlockHash]] the signature applies to (mortal/immortal)
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:40

defKeys

get defKeys(): string[]
Returns string[]

Description
The available keys for this struct
Inherited from Metadata.defKeys
- Defined in packages/types-codec/src/native/Struct.ts:154

encodedLength

get encodedLength(): number
Returns number

Description
The length of the value when encoded as a Uint8Array
Inherited from Struct.encodedLength
- Defined in packages/types-codec/src/native/Struct.ts:168

era

get era(): ExtrinsicEra
Returns ExtrinsicEra

Description
The [[ExtrinsicEra]]
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:47

genesisHash

get genesisHash(): BlockHash
Returns BlockHash

Description
The genesis [[BlockHash]] the signature applies to (mortal/immortal)
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:54

hash

get hash(): IU8a
Returns IU8a

Description
returns a hash of the contents
Inherited from Metadata.hash
- Defined in packages/types-codec/src/native/Struct.ts:181

isEmpty

get isEmpty(): boolean
Returns boolean

Description
Checks if the value is an empty value '{}'
Inherited from Metadata.isEmpty
- Defined in packages/types-codec/src/native/Struct.ts:161

metadataHash

get metadataHash(): IOption<Hash>
Returns IOption<Hash>

Description
The (optional) metadataHash proof for the CheckMetadataHash TransactionExtension
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:103

method

get method(): Bytes
Returns Bytes

Description
The [[Bytes]] contained in the payload
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:61

nonce

get nonce(): ICompact<INumber>
Returns ICompact<INumber>

Description
The [[Index]]
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:68

specVersion

get specVersion(): INumber
Returns INumber

Description
The specVersion for this signature
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:75

tip

get tip(): ICompact<INumber>
Returns ICompact<INumber>

Description
The tip [[Balance]]
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:82

transactionVersion

get transactionVersion(): INumber
Returns INumber

Description
The transactionVersion for this signature
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:89

Type

get Type(): E
Returns E

Description
Returns the Type description of the structure
Inherited from Struct.Type
- Defined in packages/types-codec/src/native/Struct.ts:188

Methods

[iterator]

"[iterator]"(): IterableIterator<[string, Codec]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, Codec]>
Inherited from Struct.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Inherited from Struct.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from Struct.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

entries

entries(): IterableIterator<[string, Codec]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, Codec]>
Inherited from Struct.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

eq

eq(other?: unknown): boolean
Parameters
- Optionalother: unknown
Returns boolean

Description
Compares the value of the input to see if there is a match
Inherited from Struct.eq
- Defined in packages/types-codec/src/native/Struct.ts:202

forEach

forEach(
callbackfn: (value: Codec, key: string, map: Map<string, Codec>) => void,
thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: Codec, key: string, map: Map<string, Codec>) => void
- OptionalthisArg: any
Returns void
Inherited from Struct.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get(key: string): Codec | undefined
Parameters
- key: string
  The name of the entry to retrieve
Returns Codec | undefined

Description
Returns a specific names entry in the structure
Inherited from Struct.get
- Defined in packages/types-codec/src/native/Struct.ts:210

getAtIndex

getAtIndex(index: number): Codec
Parameters
- index: number
Returns Codec

Description
Returns the values of a member at a specific index (Rather use get(name) for performance)
Inherited from Struct.getAtIndex
- Defined in packages/types-codec/src/native/Struct.ts:217

getT

getT<T = Codec>(key: string): T
Type Parameters
- T = Codec
Parameters
- key: string
Returns T

Description
Returns the a types value by name
Inherited from Struct.getT
- Defined in packages/types-codec/src/native/Struct.ts:224

has

has(key: string): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Struct.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

inspect

inspect(): Inspect
Returns Inspect

Description
Returns a breakdown of the hex encoding for this Codec
Overrides Struct.inspect
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:33

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Inherited from Struct.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

set

set(key: string, value: Codec): this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: string
- value: Codec
Returns this
Inherited from Struct.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:41

sign

sign(_signerPair: IKeyringPair): Uint8Array
Parameters
- _signerPair: IKeyringPair
Returns Uint8Array

Description
Sign the payload with the keypair

[Disabled for ExtrinsicV5]
- Defined in packages/types/src/extrinsic/v5/ExtrinsicPayload.ts:112

toArray

toArray(): Codec[]
Returns Codec[]

Description
Converts the Object to an standard JavaScript Array
Inherited from Struct.toArray
- Defined in packages/types-codec/src/native/Struct.ts:253

toHex

toHex(): `0x${string}`
Returns `0x${string}`

Description
Returns a hex string representation of the value
Inherited from Struct.toHex
- Defined in packages/types-codec/src/native/Struct.ts:260

toHuman

toHuman(isExtended?: boolean, disableAscii?: boolean): Record<string, AnyJson>
Parameters
- OptionalisExtended: boolean
- OptionaldisableAscii: boolean
Returns Record<string, AnyJson>

Description
Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
Inherited from Struct.toHuman
- Defined in packages/types-codec/src/native/Struct.ts:267

toJSON

toJSON(): Record<string, AnyJson>
Returns Record<string, AnyJson>

Description
Converts the Object to JSON, typically used for RPC transfers
Inherited from Struct.toJSON
- Defined in packages/types-codec/src/native/Struct.ts:280

toPrimitive

toPrimitive(disableAscii?: boolean): Record<string, AnyJson>
Parameters
- OptionaldisableAscii: boolean
Returns Record<string, AnyJson>

Description
Converts the value in a best-fit primitive form
Inherited from Struct.toPrimitive
- Defined in packages/types-codec/src/native/Struct.ts:295

toRawType

toRawType(): string
Returns string

Description
Returns the base runtime type name for this instance
Inherited from Struct.toRawType
- Defined in packages/types-codec/src/native/Struct.ts:308

toString

toString(): string
Returns string

Description
Returns the string representation of the value
Inherited from Struct.toString
- Defined in packages/types-codec/src/native/Struct.ts:315

toU8a

toU8a(isBare?: BareOpts): Uint8Array
Parameters
- OptionalisBare: BareOpts
  true when the value has none of the type-specific prefixes (internal)
Returns Uint8Array

Description
Encodes the value as a Uint8Array as per the SCALE specifications
Inherited from Struct.toU8a
- Defined in packages/types-codec/src/native/Struct.ts:323

values

values(): IterableIterator<Codec>
Returns an iterable of values in the map

Returns IterableIterator<Codec>
Inherited from Struct.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

`Static`with

with<S extends TypesDef<Codec>>(
    Types: S,
    jsonMap?: Map<string, string>,
): CodecClass<
    Struct<
        S,
        { [K in string
        | number
        | symbol]: any },
        { [K in string | number | symbol]: string },
    >,
>
Type Parameters
- S extends TypesDef<Codec>
Parameters
- Types: S
- OptionaljsonMap: Map<string, string>
Returns CodecClass<
    Struct<
        S,
        { [K in string
        | number
        | symbol]: any },
        { [K in string | number | symbol]: string },
    >,
>
Inherited from Struct.with
- Defined in packages/types-codec/src/native/Struct.ts:129

Class GenericExtrinsicPayloadV5

Name

Description

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GenericExtrinsicPayloadV5

Properties

Readonly[toStringTag]

OptionalcreatedAtHash

Description

OptionalinitialU8aLength

Description

OptionalisStorageFallback

Description

Readonlyregistry

Description

Readonlysize

Returns

Static Readonly[species]

Accessors

assetId

Returns IOption<INumber | MultiLocation>

Description

blockHash

Returns BlockHash

Description

defKeys

Returns string[]

Description

encodedLength

Returns number

Description

era

Returns ExtrinsicEra

Description

genesisHash

Returns BlockHash

Description

hash

Returns IU8a

Description

isEmpty

Returns boolean

Description

metadataHash

Returns IOption<Hash>

Description

method

Returns Bytes

Description

nonce

Returns ICompact<INumber>

Description

specVersion

Returns INumber

Description

tip

Returns ICompact<INumber>

Description

transactionVersion

Returns INumber

Description

Type

Returns E

Description

Methods

[iterator]

Returns IterableIterator<[string, Codec]>

clear

Returns void

delete

Parameters

Returns boolean

`Readonly`[toStringTag]

`Optional`createdAtHash

`Optional`initialU8aLength

`Optional`isStorageFallback

`Readonly`registry

`Readonly`size

`Static` `Readonly`[species]

`Static`with

Returns CodecClass<
Struct<
S,
{ [K in string
| number
| symbol]: any },
{ [K in string | number | symbol]: string },
>,
>