Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): updated docs #360

Merged
merged 5 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ This libraries release process uses Lerna, and the following below is required t

* **N.B.** Ensure you have [`GH_TOKEN` env variable set](https://github.com/lerna/lerna/tree/main/commands/version#--create-release-type) to a GitHub personal access token (PAT) so lerna can publish the release on github.

* The publisher will need publishing permissions to the @substrate npm org.
* The publisher will need publishing permissions to the [substrate](https://www.npmjs.com/org/substrate) npm org.

1. Make sure you're logged in to `npm` using `npm login`.

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ This libraries release process uses Lerna, and the following below is required t

* **N.B.** Ensure you have [`GH_TOKEN` env variable set](https://github.com/lerna/lerna/tree/main/commands/version#--create-release-type) to a GitHub personal access token (PAT) so lerna can publish the release on github.

* The publisher will need publishing permissions to the @substrate npm org.
* The publisher will need publishing permissions to the [substrate](https://www.npmjs.com/org/substrate) npm org.

1. Make sure you're logged in to `npm` using `npm login`.

Expand Down
20 changes: 10 additions & 10 deletions docs/enums/txwrapper_core_src.PolkadotSS58Format.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,49 +9,49 @@ Prefix for ss58-encoded addresses on Polkadot, Kusama, and Westend. Note:

## Table of contents

### Enumeration members
### Enumeration Members

- [kusama](txwrapper_core_src.PolkadotSS58Format.md#kusama)
- [polkadot](txwrapper_core_src.PolkadotSS58Format.md#polkadot)
- [substrate](txwrapper_core_src.PolkadotSS58Format.md#substrate)
- [westend](txwrapper_core_src.PolkadotSS58Format.md#westend)

## Enumeration members
## Enumeration Members

### kusama

• **kusama** = `2`
• **kusama** = ``2``

#### Defined in

[txwrapper-core/src/core/util/polkadotss58Format.ts:7](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/core/util/polkadotss58Format.ts#L7)
[txwrapper-core/src/core/util/polkadotss58Format.ts:7](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/core/util/polkadotss58Format.ts#L7)

___

### polkadot

• **polkadot** = `0`
• **polkadot** = ``0``

#### Defined in

[txwrapper-core/src/core/util/polkadotss58Format.ts:6](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/core/util/polkadotss58Format.ts#L6)
[txwrapper-core/src/core/util/polkadotss58Format.ts:6](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/core/util/polkadotss58Format.ts#L6)

___

### substrate

• **substrate** = `42`
• **substrate** = ``42``

#### Defined in

[txwrapper-core/src/core/util/polkadotss58Format.ts:9](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/core/util/polkadotss58Format.ts#L9)
[txwrapper-core/src/core/util/polkadotss58Format.ts:8](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/core/util/polkadotss58Format.ts#L8)

___

### westend

• **westend** = `42`
• **westend** = ``42``

#### Defined in

[txwrapper-core/src/core/util/polkadotss58Format.ts:8](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/core/util/polkadotss58Format.ts#L8)
[txwrapper-core/src/core/util/polkadotss58Format.ts:9](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/core/util/polkadotss58Format.ts#L9)
40 changes: 23 additions & 17 deletions docs/interfaces/txwrapper_core_src.BaseTxInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,19 @@ The ss-58 encoded address of the sending account.

#### Defined in

[txwrapper-core/src/types/method.ts:89](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L89)
[txwrapper-core/src/types/method.ts:88](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L88)

___

### assetId

• `Optional` **assetId**: `number`
• `Optional` **assetId**: `number` \| `object`

The assetId used in ChargeAssetTxPayment

**`default`** 0

#### Defined in

[txwrapper-core/src/types/method.ts:95](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L95)
[txwrapper-core/src/types/method.ts:93](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L93)

___

Expand All @@ -64,7 +62,7 @@ The checkpoint hash of the block, in hex.

#### Defined in

[txwrapper-core/src/types/method.ts:99](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L99)
[txwrapper-core/src/types/method.ts:97](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L97)

___

Expand All @@ -76,7 +74,7 @@ The checkpoint block number (u32), in hex.

#### Defined in

[txwrapper-core/src/types/method.ts:103](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L103)
[txwrapper-core/src/types/method.ts:101](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L101)

___

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

**`default`** 64
**`Default`**

```ts
64
```

#### Defined in

[txwrapper-core/src/types/method.ts:110](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L110)
[txwrapper-core/src/types/method.ts:108](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L108)

___

Expand All @@ -103,20 +105,20 @@ The genesis hash of the chain, in hex.

#### Defined in

[txwrapper-core/src/types/method.ts:114](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L114)
[txwrapper-core/src/types/method.ts:112](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L112)

___

### metadataRpc

• **metadataRpc**: \`0x${string}\`
• **metadataRpc**: \`0x$\{string}\`

The SCALE-encoded metadata, as a hex string. Can be retrieved via the RPC
call `state_getMetadata`.

#### Defined in

[txwrapper-core/src/types/method.ts:119](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L119)
[txwrapper-core/src/types/method.ts:117](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L117)

___

Expand All @@ -128,7 +130,7 @@ The nonce for this transaction.

#### Defined in

[txwrapper-core/src/types/method.ts:123](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L123)
[txwrapper-core/src/types/method.ts:121](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L121)

___

Expand All @@ -140,7 +142,7 @@ The current spec version of the runtime.

#### Defined in

[txwrapper-core/src/types/method.ts:127](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L127)
[txwrapper-core/src/types/method.ts:125](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L125)

___

Expand All @@ -150,11 +152,15 @@ ___

The tip for this transaction, in hex.

**`default`** 0
**`Default`**

```ts
0
```

#### Defined in

[txwrapper-core/src/types/method.ts:133](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L133)
[txwrapper-core/src/types/method.ts:131](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L131)

___

Expand All @@ -166,4 +172,4 @@ The current transaction version for the runtime.

#### Defined in

[txwrapper-core/src/types/method.ts:137](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L137)
[txwrapper-core/src/types/method.ts:135](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L135)
6 changes: 3 additions & 3 deletions docs/interfaces/txwrapper_core_src.ChainProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ JSON object of ChainProperties codec from `@polkadot/api`.

#### Defined in

[txwrapper-core/src/types/codec.ts:5](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/codec.ts#L5)
[txwrapper-core/src/types/codec.ts:5](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/codec.ts#L5)

___

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

#### Defined in

[txwrapper-core/src/types/codec.ts:6](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/codec.ts#L6)
[txwrapper-core/src/types/codec.ts:6](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/codec.ts#L6)

___

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

#### Defined in

[txwrapper-core/src/types/codec.ts:7](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/codec.ts#L7)
[txwrapper-core/src/types/codec.ts:7](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/codec.ts#L7)
4 changes: 2 additions & 2 deletions docs/interfaces/txwrapper_core_src.DecodedUnsignedHexTx.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ which is the counterpart to `encodeUnsignedTransaction`.

#### Defined in

[txwrapper-core/src/types/decode.ts:23](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/decode.ts#L23)
[txwrapper-core/src/types/decode.ts:23](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/decode.ts#L23)

___

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

#### Defined in

[txwrapper-core/src/types/decode.ts:24](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/decode.ts#L24)
[txwrapper-core/src/types/decode.ts:24](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/decode.ts#L24)
22 changes: 11 additions & 11 deletions docs/interfaces/txwrapper_core_src.GetRegistryOptsCore.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Additional types to register in the registry.

#### Defined in

[txwrapper-core/src/types/registry.ts:49](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L49)
[txwrapper-core/src/types/registry.ts:49](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L49)

___

Expand All @@ -49,7 +49,7 @@ Used to reduce the metadata size by only having the calls

#### Defined in

[txwrapper-core/src/types/registry.ts:33](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L33)
[txwrapper-core/src/types/registry.ts:33](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L33)

___

Expand All @@ -61,19 +61,19 @@ chainName

#### Defined in

[txwrapper-core/src/types/registry.ts:17](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L17)
[txwrapper-core/src/types/registry.ts:17](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L17)

___

### metadataRpc

• **metadataRpc**: \`0x${string}\`
• **metadataRpc**: \`0x$\{string}\`

SCALE encoded runtime metadata as a hex string

#### Defined in

[txwrapper-core/src/types/registry.ts:25](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L25)
[txwrapper-core/src/types/registry.ts:25](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L25)

___

Expand All @@ -85,7 +85,7 @@ Chain ss58format, token decimals, and token ID

#### Defined in

[txwrapper-core/src/types/registry.ts:29](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L29)
[txwrapper-core/src/types/registry.ts:29](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L29)

___

Expand All @@ -97,7 +97,7 @@ Array of signedExtensions

#### Defined in

[txwrapper-core/src/types/registry.ts:37](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L37)
[txwrapper-core/src/types/registry.ts:37](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L37)

___

Expand All @@ -109,7 +109,7 @@ Runtime specName

#### Defined in

[txwrapper-core/src/types/registry.ts:13](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L13)
[txwrapper-core/src/types/registry.ts:13](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L13)

___

Expand All @@ -121,7 +121,7 @@ Runtime specVersion

#### Defined in

[txwrapper-core/src/types/registry.ts:21](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L21)
[txwrapper-core/src/types/registry.ts:21](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L21)

___

Expand All @@ -133,7 +133,7 @@ OverrideTypesBundle to set to registry

#### Defined in

[txwrapper-core/src/types/registry.ts:45](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L45)
[txwrapper-core/src/types/registry.ts:45](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L45)

___

Expand All @@ -145,4 +145,4 @@ User extensions used to inject into the type registry

#### Defined in

[txwrapper-core/src/types/registry.ts:41](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/registry.ts#L41)
[txwrapper-core/src/types/registry.ts:41](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/registry.ts#L41)
4 changes: 2 additions & 2 deletions docs/interfaces/txwrapper_core_src.IMethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Primitive version of `DecodeMethodInput` interface from polkadot-js.

#### Defined in

[txwrapper-core/src/types/decode.ts:31](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/decode.ts#L31)
[txwrapper-core/src/types/decode.ts:31](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/decode.ts#L31)

___

Expand All @@ -31,4 +31,4 @@ ___

#### Defined in

[txwrapper-core/src/types/decode.ts:32](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/decode.ts#L32)
[txwrapper-core/src/types/decode.ts:32](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/decode.ts#L32)
4 changes: 2 additions & 2 deletions docs/interfaces/txwrapper_core_src.Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Note: When creating an Immortal tx, the blockHash should be set as the genesis h

#### Defined in

[txwrapper-core/src/types/method.ts:156](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L156)
[txwrapper-core/src/types/method.ts:154](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L154)

___

Expand All @@ -46,4 +46,4 @@ The type registry of the runtime.

#### Defined in

[txwrapper-core/src/types/method.ts:148](https://github.com/paritytech/txwrapper-core/blob/bb9e677/packages/txwrapper-core/src/types/method.ts#L148)
[txwrapper-core/src/types/method.ts:146](https://github.com/paritytech/txwrapper-core/blob/fe8eeb2/packages/txwrapper-core/src/types/method.ts#L146)
Loading