Skip to content
Snippets Groups Projects
Commit e9861ea9 authored by Amaury Martiny's avatar Amaury Martiny
Browse files

Generate docs

parent 82747d98
Branches 30
No related merge requests found
Pipeline #75236 passed with stage
in 1 minute and 47 seconds
Showing
with 102 additions and 42 deletions
......@@ -15,7 +15,9 @@
* ["methods/balances/transfer"](modules/_methods_balances_transfer_.md)
* ["methods/balances/transferKeepAlive"](modules/_methods_balances_transferkeepalive_.md)
* ["methods/staking/bond"](modules/_methods_staking_bond_.md)
* ["methods/staking/bondExtra"](modules/_methods_staking_bondextra_.md)
* ["methods/staking/nominate"](modules/_methods_staking_nominate_.md)
* ["methods/staking/unbond"](modules/_methods_staking_unbond_.md)
* ["methods/staking/withdrawUnbonded"](modules/_methods_staking_withdrawunbonded_.md)
* ["util/constants"](modules/_util_constants_.md)
* ["util/types"](modules/_util_types_.md)
......@@ -21,7 +21,7 @@
**dest**: *string*
*Defined in [src/methods/balances/transfer.ts:12](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/balances/transfer.ts#L12)*
*Defined in [src/methods/balances/transfer.ts:12](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/balances/transfer.ts#L12)*
The recipient address, SS-58 encoded.
......@@ -31,6 +31,6 @@ ___
**value**: *number*
*Defined in [src/methods/balances/transfer.ts:16](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/balances/transfer.ts#L16)*
*Defined in [src/methods/balances/transfer.ts:16](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/balances/transfer.ts#L16)*
The amount to send.
......@@ -22,7 +22,7 @@
**controller**: *string*
*Defined in [src/methods/staking/bond.ts:12](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/staking/bond.ts#L12)*
*Defined in [src/methods/staking/bond.ts:12](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/bond.ts#L12)*
The SS-58 encoded address of the Controller account.
......@@ -32,7 +32,7 @@ ___
**payee**: *string*
*Defined in [src/methods/staking/bond.ts:20](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/staking/bond.ts#L20)*
*Defined in [src/methods/staking/bond.ts:20](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/bond.ts#L20)*
The rewards destination. Can be "Stash", "Staked", or "Controller".
......@@ -42,6 +42,6 @@ ___
**value**: *number*
*Defined in [src/methods/staking/bond.ts:16](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/staking/bond.ts#L16)*
*Defined in [src/methods/staking/bond.ts:16](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/bond.ts#L16)*
The number of tokens to bond.
[@substrate/txwrapper](../README.md)[Globals](../globals.md)["methods/staking/bondExtra"](../modules/_methods_staking_bondextra_.md)[StakingBondExtraArgs](_methods_staking_bondextra_.stakingbondextraargs.md)
# Interface: StakingBondExtraArgs
## Hierarchy
* object
**StakingBondExtraArgs**
## Index
### Properties
* [maxAdditional](_methods_staking_bondextra_.stakingbondextraargs.md#maxadditional)
## Properties
### maxAdditional
**maxAdditional**: *number*
*Defined in [src/methods/staking/bondExtra.ts:12](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/bondExtra.ts#L12)*
The maximum amount to bond.
......@@ -20,7 +20,7 @@
**targets**: *Array‹string›*
*Defined in [src/methods/staking/nominate.ts:15](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/staking/nominate.ts#L15)*
*Defined in [src/methods/staking/nominate.ts:15](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/nominate.ts#L15)*
The SS-58 encoded addresses of the targets you wish to nominate. A maximum of 16
nominations are allowed.
......
......@@ -20,6 +20,6 @@
**value**: *number*
*Defined in [src/methods/staking/unbond.ts:12](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/staking/unbond.ts#L12)*
*Defined in [src/methods/staking/unbond.ts:12](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/unbond.ts#L12)*
The number of tokens to unbond.
......@@ -28,7 +28,7 @@ JSON format for information that is common to all transactions.
**address**: *string*
*Defined in [src/util/types.ts:21](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L21)*
*Defined in [src/util/types.ts:21](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L21)*
The ss-58 encoded address of the sending account.
......@@ -38,7 +38,7 @@ ___
**blockHash**: *string*
*Defined in [src/util/types.ts:25](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L25)*
*Defined in [src/util/types.ts:25](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L25)*
The checkpoint hash of the block, in hex.
......@@ -48,7 +48,7 @@ ___
**blockNumber**: *number*
*Defined in [src/util/types.ts:29](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L29)*
*Defined in [src/util/types.ts:29](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L29)*
The checkpoint block number (u32), in hex.
......@@ -58,7 +58,7 @@ ___
**genesisHash**: *string*
*Defined in [src/util/types.ts:33](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L33)*
*Defined in [src/util/types.ts:33](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L33)*
The genesis hash of the chain, in hex.
......@@ -68,7 +68,7 @@ ___
**metadataRpc**: *string*
*Defined in [src/util/types.ts:38](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L38)*
*Defined in [src/util/types.ts:38](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L38)*
The SCALE-encoded metadata, as a hex string. Can be retrieved via the RPC
call `state_getMetadata`.
......@@ -79,7 +79,7 @@ ___
**nonce**: *number*
*Defined in [src/util/types.ts:42](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L42)*
*Defined in [src/util/types.ts:42](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L42)*
The nonce for this transaction.
......@@ -89,7 +89,7 @@ ___
**specVersion**: *number*
*Defined in [src/util/types.ts:46](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L46)*
*Defined in [src/util/types.ts:46](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L46)*
The current spec version for the runtime.
......@@ -99,7 +99,7 @@ ___
**tip**: *number*
*Defined in [src/util/types.ts:50](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L50)*
*Defined in [src/util/types.ts:50](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L50)*
The tip for this transaction, in hex.
......@@ -109,7 +109,7 @@ ___
**validityPeriod**: *number*
*Defined in [src/util/types.ts:55](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L55)*
*Defined in [src/util/types.ts:55](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L55)*
The amount of time (in second) the transaction is valid for. Will be
translated into a mortal era.
......@@ -34,7 +34,7 @@ JSON format for an unsigned transaction.
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:182
Defined in node_modules/@polkadot/types/types.d.ts:184
**`description`** The ss-58 encoded address
......@@ -46,7 +46,7 @@ ___
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:186
Defined in node_modules/@polkadot/types/types.d.ts:188
**`description`** The checkpoint hash of the block, in hex
......@@ -58,7 +58,7 @@ ___
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:190
Defined in node_modules/@polkadot/types/types.d.ts:192
**`description`** The checkpoint block number, in hex
......@@ -70,7 +70,7 @@ ___
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:194
Defined in node_modules/@polkadot/types/types.d.ts:196
**`description`** The era for this transaction, in hex
......@@ -82,7 +82,7 @@ ___
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:198
Defined in node_modules/@polkadot/types/types.d.ts:200
**`description`** The genesis hash of the chain, in hex
......@@ -92,7 +92,7 @@ ___
**metadataRpc**: *string*
*Defined in [src/util/types.ts:11](https://github.com/paritytech/txwrapper/blob/770ebb6/src/util/types.ts#L11)*
*Defined in [src/util/types.ts:11](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/util/types.ts#L11)*
The SCALE-encoded metadata, as a hex string. Can be retrieved via the RPC
call `state_getMetadata`.
......@@ -105,7 +105,7 @@ ___
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:202
Defined in node_modules/@polkadot/types/types.d.ts:204
**`description`** The encoded method (with arguments) in hex
......@@ -117,7 +117,7 @@ ___
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:206
Defined in node_modules/@polkadot/types/types.d.ts:208
**`description`** The nonce for this transaction, in hex
......@@ -129,7 +129,7 @@ ___
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:210
Defined in node_modules/@polkadot/types/types.d.ts:212
**`description`** The current spec version for the runtime
......@@ -141,7 +141,7 @@ ___
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:214
Defined in node_modules/@polkadot/types/types.d.ts:216
**`description`** The tip for this transaction, in hex
......@@ -153,6 +153,6 @@ ___
*Inherited from void*
Defined in node_modules/@polkadot/types/types.d.ts:218
Defined in node_modules/@polkadot/types/types.d.ts:220
**`description`** The version of the extrinsic we are dealing with
......@@ -14,7 +14,7 @@
**createSignedTx**(`unsigned`: [UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md), `signature`: string): *string*
*Defined in [src/createSignedTx.ts:14](https://github.com/paritytech/txwrapper/blob/770ebb6/src/createSignedTx.ts#L14)*
*Defined in [src/createSignedTx.ts:14](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/createSignedTx.ts#L14)*
Serialize a signed transaction in a format that can be submitted over the
Node RPC Interface from the signing payload and signature produced by the
......
......@@ -14,7 +14,7 @@
**createSigningPayload**(`unsigned`: [UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)): *string*
*Defined in [src/createSigningPayload.ts:11](https://github.com/paritytech/txwrapper/blob/770ebb6/src/createSigningPayload.ts#L11)*
*Defined in [src/createSigningPayload.ts:11](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/createSigningPayload.ts#L11)*
Construct the signing payload from an unsigned transaction and export it to
a remote signer (this is often called "detached signing").
......
......@@ -14,7 +14,7 @@
**decode**(`unsignedTx`: [UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md), `metadataRpc`: string, `ss58Format?`: undefined | number): *DecodedUnsignedTx*
*Defined in [src/decode/decode.ts:18](https://github.com/paritytech/txwrapper/blob/770ebb6/src/decode/decode.ts#L18)*
*Defined in [src/decode/decode.ts:18](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/decode/decode.ts#L18)*
Parse the transaction information from a signing payload, an unsigned tx, or a signed tx.
......@@ -30,7 +30,7 @@ Name | Type | Description |
**decode**(`signedTx`: string, `metadataRpc`: string, `ss58Format?`: undefined | number): *DecodedSignedTx*
*Defined in [src/decode/decode.ts:32](https://github.com/paritytech/txwrapper/blob/770ebb6/src/decode/decode.ts#L32)*
*Defined in [src/decode/decode.ts:32](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/decode/decode.ts#L32)*
Parse the transaction information from a signing payload, an unsigned tx, or a signed tx.
......@@ -46,7 +46,7 @@ Name | Type | Description |
**decode**(`signingPayload`: string, `metadataRpc`: string, `ss58Format?`: undefined | number): *DecodedSigningPayload*
*Defined in [src/decode/decode.ts:46](https://github.com/paritytech/txwrapper/blob/770ebb6/src/decode/decode.ts#L46)*
*Defined in [src/decode/decode.ts:46](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/decode/decode.ts#L46)*
Parse the transaction information from a signing payload, an unsigned tx, or a signed tx.
......
......@@ -14,7 +14,7 @@
**deriveAddress**(`publicKey`: string | Uint8Array, `ss58Format`: number): *string*
*Defined in [src/deriveAddress.ts:11](https://github.com/paritytech/txwrapper/blob/770ebb6/src/deriveAddress.ts#L11)*
*Defined in [src/deriveAddress.ts:11](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/deriveAddress.ts#L11)*
Derive an address from a cryptographic public key offline.
......
......@@ -14,7 +14,7 @@
**getTxHash**(`signedTx`: string): *string*
*Defined in [src/getTxHash.ts:8](https://github.com/paritytech/txwrapper/blob/770ebb6/src/getTxHash.ts#L8)*
*Defined in [src/getTxHash.ts:8](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/getTxHash.ts#L8)*
Derive the tx hash of a signed transaction offline.
......
......@@ -18,7 +18,7 @@
Ƭ **KeyringPair**: *KeyringPairBase*
*Defined in [src/importPrivateKey.ts:10](https://github.com/paritytech/txwrapper/blob/770ebb6/src/importPrivateKey.ts#L10)*
*Defined in [src/importPrivateKey.ts:10](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/importPrivateKey.ts#L10)*
A keyring pair
......@@ -28,7 +28,7 @@ A keyring pair
**importPrivateKey**(`privateKey`: string | Uint8Array, `ss58Format`: number): *KeyringPair*
*Defined in [src/importPrivateKey.ts:18](https://github.com/paritytech/txwrapper/blob/770ebb6/src/importPrivateKey.ts#L18)*
*Defined in [src/importPrivateKey.ts:18](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/importPrivateKey.ts#L18)*
Import a private key and create a KeyringPair.
......
......@@ -18,7 +18,7 @@
**transfer**(`args`: [BalancesTransferArgs](../interfaces/_methods_balances_transfer_.balancestransferargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)*
*Defined in [src/methods/balances/transfer.ts:24](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/balances/transfer.ts#L24)*
*Defined in [src/methods/balances/transfer.ts:24](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/balances/transfer.ts#L24)*
Construct a balance transfer transaction offline.
......
......@@ -18,7 +18,7 @@
Ƭ **BalancesTransferKeepAliveArgs**: *[BalancesTransferArgs](../interfaces/_methods_balances_transfer_.balancestransferargs.md)*
*Defined in [src/methods/balances/transferKeepAlive.ts:4](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/balances/transferKeepAlive.ts#L4)*
*Defined in [src/methods/balances/transferKeepAlive.ts:4](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/balances/transferKeepAlive.ts#L4)*
## Functions
......@@ -26,7 +26,7 @@
**transferKeepAlive**(`args`: [BalancesTransferKeepAliveArgs](_methods_balances_transferkeepalive_.md#balancestransferkeepaliveargs), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)*
*Defined in [src/methods/balances/transferKeepAlive.ts:11](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/balances/transferKeepAlive.ts#L11)*
*Defined in [src/methods/balances/transferKeepAlive.ts:11](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/balances/transferKeepAlive.ts#L11)*
Construct a balance transfer transaction offline.
......
......@@ -18,7 +18,7 @@
**bond**(`args`: [StakingBondArgs](../interfaces/_methods_staking_bond_.stakingbondargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)*
*Defined in [src/methods/staking/bond.ts:28](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/staking/bond.ts#L28)*
*Defined in [src/methods/staking/bond.ts:28](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/bond.ts#L28)*
Construct a transaction to bond funds and create a Stash account.
......
[@substrate/txwrapper](../README.md)[Globals](../globals.md)["methods/staking/bondExtra"](_methods_staking_bondextra_.md)
# External module: "methods/staking/bondExtra"
## Index
### Interfaces
* [StakingBondExtraArgs](../interfaces/_methods_staking_bondextra_.stakingbondextraargs.md)
### Functions
* [bondExtra](_methods_staking_bondextra_.md#bondextra)
## Functions
### bondExtra
**bondExtra**(`args`: [StakingBondExtraArgs](../interfaces/_methods_staking_bondextra_.stakingbondextraargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)*
*Defined in [src/methods/staking/bondExtra.ts:21](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/bondExtra.ts#L21)*
Add some extra amount that have appeared in the stash `free_balance` into
the balance up for staking.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`args` | [StakingBondExtraArgs](../interfaces/_methods_staking_bondextra_.stakingbondextraargs.md) | - |
`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. |
**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)*
......@@ -18,7 +18,7 @@
**nominate**(`args`: [StakingNominateArgs](../interfaces/_methods_staking_nominate_.stakingnominateargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)*
*Defined in [src/methods/staking/nominate.ts:23](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/staking/nominate.ts#L23)*
*Defined in [src/methods/staking/nominate.ts:23](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/nominate.ts#L23)*
Construct a transaction to nominate. This must be called by the _Controller_ account.
......
......@@ -18,7 +18,7 @@
**unbond**(`args`: [StakingUnbondArgs](../interfaces/_methods_staking_unbond_.stakingunbondargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)*
*Defined in [src/methods/staking/unbond.ts:21](https://github.com/paritytech/txwrapper/blob/770ebb6/src/methods/staking/unbond.ts#L21)*
*Defined in [src/methods/staking/unbond.ts:21](https://github.com/amaurymartiny/polkadotjs-wrapper/blob/82747d9/src/methods/staking/unbond.ts#L21)*
Construct a transaction to unbond funds from a Stash account. This must be called
by the _Controller_ account.
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment