Files
api/docs/api/classes/_rx_submittableextrinsic_.submittableextrinsic.md
T
2018-12-21 09:38:18 +00:00

14 KiB

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

Extrinsic

↳ SubmittableExtrinsic

Implements

  • Codec

Constructors

constructor

⊕ new SubmittableExtrinsic(api: ApiRxInterface, extrinsic: * Extrinsic | Method*): SubmittableExtrinsic

Overrides Extrinsic.__constructor

Defined in rx/SubmittableExtrinsic.ts:14

Parameters:

Name Type
api ApiRxInterface
extrinsic Extrinsic | Method

Returns: SubmittableExtrinsic


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

Inherited from Struct.Type

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E


args

getargs(): Array<Codec>

Inherited from Extrinsic.args

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:71

description: The arguments passed to for the call, exposes args so it is compatible with Method

Returns: Array<Codec>


callIndex

getcallIndex(): Uint8Array

Inherited from Extrinsic.callIndex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:78

description: The actual [sectionIndex, methodIndex] as used in the Method

Returns: Uint8Array


data

getdata(): Uint8Array

Inherited from Extrinsic.data

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:85

description: The actual data for the Method

Returns: Uint8Array


encodedLength

getencodedLength(): number

Inherited from Extrinsic.encodedLength

Overrides Struct.encodedLength

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:92

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

Returns: number


hash

gethash(): Hash

Inherited from Extrinsic.hash

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:101

description: Convernience function, encodes the extrinsic and returns the actual hash

Returns: Hash


isSigned

getisSigned(): boolean

Inherited from Extrinsic.isSigned

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:110

description: true id the extrinsic is signed

Returns: boolean


length

getlength(): number

Inherited from Extrinsic.length

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:117

description: The length of the encoded value

Returns: number


meta

getmeta(): FunctionMetadata

Inherited from Extrinsic.meta

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:124

description: The FunctionMetadata that describes the extrinsic

Returns: FunctionMetadata


method

getmethod(): Method

Inherited from Extrinsic.method

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:131

description: The Method this extrinsic wraps

Returns: Method


signature

getsignature(): ExtrinsicSignature

Inherited from Extrinsic.signature

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:138

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

Inherited from Extrinsic.addSignature

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:145

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


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 /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:159

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 /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:166

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>


send

▸ send(): Observable<SubmittableSendResult>

Defined in rx/SubmittableExtrinsic.ts:22

Returns: Observable<SubmittableSendResult>


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, nonce: AnyNumber, blockHash?: AnyU8a): SubmittableExtrinsic

Overrides Extrinsic.sign

Defined in rx/SubmittableExtrinsic.ts:33

Parameters:

Name Type
signerPair KeyringPair
nonce AnyNumber
Optional blockHash AnyU8a

Returns: SubmittableExtrinsic


toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>


toHex

▸ toHex(): string

Inherited from Extrinsic.toHex

Overrides Struct.toHex

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:163

description: Returns a hex string representation of the value

Returns: string


toJSON

▸ toJSON(): any

Inherited from Extrinsic.toJSON

Overrides Struct.toJSON

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:170

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any


toString

▸ toString(): string

Inherited from Struct.toString

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:201

description: Returns the string representation of the value

Returns: string


toU8a

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

Inherited from Extrinsic.toU8a

Overrides Struct.toU8a

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:178

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

Inherited from Extrinsic.decodeExtrinsic

Defined in /home/travis/build/polkadot-js/api/packages/types/src/Extrinsic.ts:44

Parameters:

Name Type
value ExtrinsicValue | AnyU8a | Method

Returns: ExtrinsicValue | Array<number> | Uint8Array


<Static> with

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

Inherited from Struct.with

Defined in /home/travis/build/polkadot-js/api/packages/types/src/codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

Name Type
Types S

Returns: Constructor<Struct<S>>