Skip to content

Commit

Permalink
docs: Generate docs (#18)
Browse files Browse the repository at this point in the history
Co-authored-by: emostov <emostov@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and emostov committed Nov 21, 2020
1 parent a5bee61 commit 95825c7
Show file tree
Hide file tree
Showing 41 changed files with 90 additions and 90 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@ Polkadot, Kusama, and Westened chainNames.

**Kusama**: = "Kusama"

*Defined in [packages/txwrapper-core/src/polkadot.ts:76](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L76)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:76](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L76)*

___

### Polkadot

**Polkadot**: = "Polkadot"

*Defined in [packages/txwrapper-core/src/polkadot.ts:78](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L78)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:78](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L78)*

___

### Westend

**Westend**: = "Westend"

*Defined in [packages/txwrapper-core/src/polkadot.ts:77](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L77)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:77](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L77)*
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@ Polkadot, Kusama, and Westened specNames.

**kusama**: = "kusama"

*Defined in [packages/txwrapper-core/src/polkadot.ts:67](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L67)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:67](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L67)*

___

### polkadot

**polkadot**: = "polkadot"

*Defined in [packages/txwrapper-core/src/polkadot.ts:69](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L69)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:69](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L69)*

___

### westend

**westend**: = "westend"

*Defined in [packages/txwrapper-core/src/polkadot.ts:68](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L68)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:68](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L68)*
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ Prefix for ss58-encoded addresses on Polkadot, Kusama, and Westend. Note:

**kusama**: = 2

*Defined in [packages/txwrapper-core/src/polkadot.ts:16](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L16)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:16](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L16)*

___

### polkadot

**polkadot**: = 0

*Defined in [packages/txwrapper-core/src/polkadot.ts:15](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L15)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:15](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L15)*

___

### westend

**westend**: = 42

*Defined in [packages/txwrapper-core/src/polkadot.ts:17](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L17)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:17](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L17)*
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@ Token decimal places for Polkadot, Kusama, and Westend.

**kusama**: = 12

*Defined in [packages/txwrapper-core/src/polkadot.ts:34](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L34)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:34](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L34)*

___

### polkadot

**polkadot**: = 10

*Defined in [packages/txwrapper-core/src/polkadot.ts:33](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L33)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:33](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L33)*

___

### westend

**westend**: = 12

*Defined in [packages/txwrapper-core/src/polkadot.ts:35](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L35)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:35](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L35)*
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@ Token symbols for Polkadot, Kusama, and Westend.

**kusama**: = "KSM"

*Defined in [packages/txwrapper-core/src/polkadot.ts:25](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L25)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:25](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L25)*

___

### polkadot

**polkadot**: = "DOT"

*Defined in [packages/txwrapper-core/src/polkadot.ts:24](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L24)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:24](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L24)*

___

### westend

**westend**: = "WND"

*Defined in [packages/txwrapper-core/src/polkadot.ts:26](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/polkadot.ts#L26)*
*Defined in [packages/txwrapper-core/src/polkadot.ts:26](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/polkadot.ts#L26)*
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

**chainProperties**: [ChainProperties](_packages_txwrapper_core_src_types_codec_.chainproperties.md) \| AnyJson

*Defined in [packages/txwrapper-core/src/core/metadata/getRegistry.ts:11](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/core/metadata/getRegistry.ts#L11)*
*Defined in [packages/txwrapper-core/src/core/metadata/getRegistry.ts:11](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/core/metadata/getRegistry.ts#L11)*

Chain properties, normally returned by the `system_properties` call.

Expand All @@ -32,7 +32,7 @@ ___

**metadataRpc**: string

*Defined in [packages/txwrapper-core/src/core/metadata/getRegistry.ts:19](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/core/metadata/getRegistry.ts#L19)*
*Defined in [packages/txwrapper-core/src/core/metadata/getRegistry.ts:19](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/core/metadata/getRegistry.ts#L19)*

Used to set the correct metadata for the registry

Expand All @@ -42,6 +42,6 @@ ___

**specTypes**: RegistryTypes

*Defined in [packages/txwrapper-core/src/core/metadata/getRegistry.ts:15](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/core/metadata/getRegistry.ts#L15)*
*Defined in [packages/txwrapper-core/src/core/metadata/getRegistry.ts:15](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/core/metadata/getRegistry.ts#L15)*

Chain specific type definitions to registry.
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

**dest**: string

*Defined in [packages/txwrapper-core/src/test-helpers/balancesTransfer.ts:9](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/test-helpers/balancesTransfer.ts#L9)*
*Defined in [packages/txwrapper-core/src/test-helpers/balancesTransfer.ts:9](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/test-helpers/balancesTransfer.ts#L9)*

The recipient address, SS-58 encoded.

Expand All @@ -33,6 +33,6 @@ ___

**value**: number \| string

*Defined in [packages/txwrapper-core/src/test-helpers/balancesTransfer.ts:13](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/test-helpers/balancesTransfer.ts#L13)*
*Defined in [packages/txwrapper-core/src/test-helpers/balancesTransfer.ts:13](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/test-helpers/balancesTransfer.ts#L13)*

The amount to send.
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ JSON object of ChainProperties codec from `@polkadot/api`.

`Optional` **ss58Format**: undefined \| number

*Defined in [packages/txwrapper-core/src/types/codec.ts:5](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/codec.ts#L5)*
*Defined in [packages/txwrapper-core/src/types/codec.ts:5](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/codec.ts#L5)*

___

### tokenDecimals

`Optional` **tokenDecimals**: undefined \| number

*Defined in [packages/txwrapper-core/src/types/codec.ts:6](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/codec.ts#L6)*
*Defined in [packages/txwrapper-core/src/types/codec.ts:6](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/codec.ts#L6)*

___

### tokenSymbol

`Optional` **tokenSymbol**: undefined \| string

*Defined in [packages/txwrapper-core/src/types/codec.ts:7](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/codec.ts#L7)*
*Defined in [packages/txwrapper-core/src/types/codec.ts:7](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/codec.ts#L7)*
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ JSON format for information that is common to all transactions.

**address**: string

*Defined in [packages/txwrapper-core/src/types/method.ts:65](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L65)*
*Defined in [packages/txwrapper-core/src/types/method.ts:65](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L65)*

The ss-58 encoded address of the sending account.

Expand All @@ -45,7 +45,7 @@ ___

**blockHash**: string

*Defined in [packages/txwrapper-core/src/types/method.ts:69](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L69)*
*Defined in [packages/txwrapper-core/src/types/method.ts:69](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L69)*

The checkpoint hash of the block, in hex.

Expand All @@ -55,7 +55,7 @@ ___

**blockNumber**: number

*Defined in [packages/txwrapper-core/src/types/method.ts:73](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L73)*
*Defined in [packages/txwrapper-core/src/types/method.ts:73](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L73)*

The checkpoint block number (u32), in hex.

Expand All @@ -65,7 +65,7 @@ ___

`Optional` **eraPeriod**: undefined \| number

*Defined in [packages/txwrapper-core/src/types/method.ts:80](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L80)*
*Defined in [packages/txwrapper-core/src/types/method.ts:80](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L80)*

Describe the longevity of a transaction. It represents the validity from
the `blockHash` field, in number of blocks. Defaults to 64 blocks.
Expand All @@ -78,7 +78,7 @@ ___

**genesisHash**: string

*Defined in [packages/txwrapper-core/src/types/method.ts:84](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L84)*
*Defined in [packages/txwrapper-core/src/types/method.ts:84](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L84)*

The genesis hash of the chain, in hex.

Expand All @@ -88,7 +88,7 @@ ___

**metadataRpc**: string

*Defined in [packages/txwrapper-core/src/types/method.ts:89](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L89)*
*Defined in [packages/txwrapper-core/src/types/method.ts:89](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L89)*

The SCALE-encoded metadata, as a hex string. Can be retrieved via the RPC
call `state_getMetadata`.
Expand All @@ -99,7 +99,7 @@ ___

**nonce**: number

*Defined in [packages/txwrapper-core/src/types/method.ts:93](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L93)*
*Defined in [packages/txwrapper-core/src/types/method.ts:93](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L93)*

The nonce for this transaction.

Expand All @@ -109,7 +109,7 @@ ___

**specVersion**: number

*Defined in [packages/txwrapper-core/src/types/method.ts:97](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L97)*
*Defined in [packages/txwrapper-core/src/types/method.ts:97](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L97)*

The current spec version of the runtime.

Expand All @@ -119,7 +119,7 @@ ___

`Optional` **tip**: undefined \| number

*Defined in [packages/txwrapper-core/src/types/method.ts:103](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L103)*
*Defined in [packages/txwrapper-core/src/types/method.ts:103](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L103)*

The tip for this transaction, in hex.

Expand All @@ -131,6 +131,6 @@ ___

**transactionVersion**: number

*Defined in [packages/txwrapper-core/src/types/method.ts:107](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L107)*
*Defined in [packages/txwrapper-core/src/types/method.ts:107](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L107)*

The current transaction version for the runtime.
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ functions that only require registry.

**registry**: TypeRegistry

*Defined in [packages/txwrapper-core/src/types/method.ts:118](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L118)*
*Defined in [packages/txwrapper-core/src/types/method.ts:118](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L118)*

The type registry of the runtime.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ options to functions that require registry and metadata.

**metadataRpc**: string

*Defined in [packages/txwrapper-core/src/types/method.ts:16](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L16)*
*Defined in [packages/txwrapper-core/src/types/method.ts:16](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L16)*

The metadata of the runtime.

Expand All @@ -38,6 +38,6 @@ ___

*Inherited from [OptionsWithMeta](_packages_txwrapper_core_src_types_method_.optionswithmeta.md).[registry](_packages_txwrapper_core_src_types_method_.optionswithmeta.md#registry)*

*Defined in [packages/txwrapper-core/src/types/method.ts:118](https://github.com/paritytech/txwrapper-core/blob/e071077/packages/txwrapper-core/src/types/method.ts#L118)*
*Defined in [packages/txwrapper-core/src/types/method.ts:118](https://github.com/paritytech/txwrapper-core/blob/a5bee61/packages/txwrapper-core/src/types/method.ts#L118)*

The type registry of the runtime.

0 comments on commit 95825c7

Please sign in to comment.