Commit 12eea7db authored by emostov's avatar emostov Committed by GitHub
Browse files

docs: Generate docs

parent 47968f6c
......@@ -23,7 +23,7 @@
**dest**: string
*Defined in [src/methods/balances/transfer.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/balances/transfer.ts#L13)*
*Defined in [src/methods/balances/transfer.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/balances/transfer.ts#L13)*
The recipient address, SS-58 encoded.
......@@ -33,6 +33,6 @@ ___
**value**: number \| string
*Defined in [src/methods/balances/transfer.ts:17](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/balances/transfer.ts#L17)*
*Defined in [src/methods/balances/transfer.ts:17](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/balances/transfer.ts#L17)*
The amount to send.
......@@ -22,6 +22,6 @@
**statement**: string
*Defined in [src/methods/claims/attest.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/claims/attest.ts#L13)*
*Defined in [src/methods/claims/attest.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/claims/attest.ts#L13)*
The identity of the statement that is being attested to in the signature.
......@@ -24,7 +24,7 @@
**dest**: string
*Defined in [src/methods/claims/claimAttest.ts:14](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/claims/claimAttest.ts#L14)*
*Defined in [src/methods/claims/claimAttest.ts:14](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/claims/claimAttest.ts#L14)*
The destination account to which to pay out the claim. This method is only
available on Polkadot.
......@@ -35,7 +35,7 @@ ___
**ethereumSignature**: string
*Defined in [src/methods/claims/claimAttest.ts:19](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/claims/claimAttest.ts#L19)*
*Defined in [src/methods/claims/claimAttest.ts:19](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/claims/claimAttest.ts#L19)*
The signature of an Ethereum signed message matching the format described
above.
......@@ -46,6 +46,6 @@ ___
**statement**: string
*Defined in [src/methods/claims/claimAttest.ts:23](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/claims/claimAttest.ts#L23)*
*Defined in [src/methods/claims/claimAttest.ts:23](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/claims/claimAttest.ts#L23)*
The identity of the statement that is being attested to in the signature.
......@@ -22,6 +22,6 @@
**proxy**: string
*Defined in [src/methods/democracy/activateProxy.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/democracy/activateProxy.ts#L13)*
*Defined in [src/methods/democracy/activateProxy.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/democracy/activateProxy.ts#L13)*
Address to set as proxy, SS-58 encoded.
......@@ -22,6 +22,6 @@
**proxy**: string
*Defined in [src/methods/democracy/deactivateProxy.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/democracy/deactivateProxy.ts#L13)*
*Defined in [src/methods/democracy/deactivateProxy.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/democracy/deactivateProxy.ts#L13)*
The address of the proxy to remove, SS-58 encoded.
......@@ -22,6 +22,6 @@
**target**: string
*Defined in [src/methods/democracy/openProxy.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/democracy/openProxy.ts#L13)*
*Defined in [src/methods/democracy/openProxy.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/democracy/openProxy.ts#L13)*
The address of the proxy to remove, SS-58 encoded.
......@@ -23,7 +23,7 @@
**refIndex**: number
*Defined in [src/methods/democracy/proxyVote.ts:14](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/democracy/proxyVote.ts#L14)*
*Defined in [src/methods/democracy/proxyVote.ts:14](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/democracy/proxyVote.ts#L14)*
___
......@@ -31,6 +31,6 @@ ___
**vote**: [AccountVote](../modules/_src_methods_democracy_types_.md#accountvote)
*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/democracy/proxyVote.ts#L18)*
*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/democracy/proxyVote.ts#L18)*
Vote.
......@@ -23,7 +23,7 @@
**refIndex**: number
*Defined in [src/methods/democracy/vote.ts:14](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/democracy/vote.ts#L14)*
*Defined in [src/methods/democracy/vote.ts:14](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/democracy/vote.ts#L14)*
___
......@@ -31,6 +31,6 @@ ___
**vote**: [AccountVote](../modules/_src_methods_democracy_types_.md#accountvote)
*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/democracy/vote.ts#L18)*
*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/democracy/vote.ts#L18)*
Vote.
......@@ -22,6 +22,6 @@
**approvals**: boolean[]
*Defined in [src/methods/poll/vote.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/poll/vote.ts#L13)*
*Defined in [src/methods/poll/vote.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/poll/vote.ts#L13)*
The options to vote for. Must be a boolean array of length 4.
......@@ -24,7 +24,7 @@
**delay**: number \| string
*Defined in [src/methods/proxy/addProxy.ts:27](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/addProxy.ts#L27)*
*Defined in [src/methods/proxy/addProxy.ts:27](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/addProxy.ts#L27)*
The number of blocks that an announcement must be in place for before the corresponding call
may be dispatched. If zero, then no announcement is needed.
......@@ -35,7 +35,7 @@ ___
**delegate**: string
*Defined in [src/methods/proxy/addProxy.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/addProxy.ts#L13)*
*Defined in [src/methods/proxy/addProxy.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/addProxy.ts#L13)*
The account that the `caller` would like to make a proxy.
......@@ -45,7 +45,7 @@ ___
**proxyType**: string
*Defined in [src/methods/proxy/addProxy.ts:22](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/addProxy.ts#L22)*
*Defined in [src/methods/proxy/addProxy.ts:22](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/addProxy.ts#L22)*
The permissions for this proxy account. See the runtime for the `call` filters.
Current known types:
......
......@@ -23,7 +23,7 @@
**callHash**: string
*Defined in [src/methods/proxy/announce.ts:17](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/announce.ts#L17)*
*Defined in [src/methods/proxy/announce.ts:17](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/announce.ts#L17)*
The hash of the call to be made by the `real` account.
......@@ -33,6 +33,6 @@ ___
**real**: string
*Defined in [src/methods/proxy/announce.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/announce.ts#L13)*
*Defined in [src/methods/proxy/announce.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/announce.ts#L13)*
The account that the proxy will make a call on behalf of.
......@@ -24,7 +24,7 @@
**call**: { args?: undefined \| string ; callIndex?: undefined \| string } \| string
*Defined in [src/methods/proxy/proxy.ts:23](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/proxy.ts#L23)*
*Defined in [src/methods/proxy/proxy.ts:23](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/proxy.ts#L23)*
The call to be made by the `real` account.
To take advantage of txwrapper methods, this could be UnsignedTransaction.method.
......@@ -35,7 +35,7 @@ ___
**forceProxyType**: string
*Defined in [src/methods/proxy/proxy.ts:18](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/proxy.ts#L18)*
*Defined in [src/methods/proxy/proxy.ts:18](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/proxy.ts#L18)*
Specify the exact proxy type to be used and checked for this call.
......@@ -45,7 +45,7 @@ ___
**real**: string
*Defined in [src/methods/proxy/proxy.ts:14](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/proxy.ts#L14)*
*Defined in [src/methods/proxy/proxy.ts:14](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/proxy.ts#L14)*
Dispatch the given `call` from an account that the sender is authorized for
through, `add_proxy`.
......@@ -25,7 +25,7 @@
**call**: { args?: undefined \| string ; callIndex?: undefined \| string } \| string
*Defined in [src/methods/proxy/proxyAnnounced.ts:26](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/proxyAnnounced.ts#L26)*
*Defined in [src/methods/proxy/proxyAnnounced.ts:26](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/proxyAnnounced.ts#L26)*
The call to be made by the `real` account.
To take advantage of txwrapper methods, this could be UnsignedTransaction.method.
......@@ -36,7 +36,7 @@ ___
**delegate**: string
*Defined in [src/methods/proxy/proxyAnnounced.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/proxyAnnounced.ts#L13)*
*Defined in [src/methods/proxy/proxyAnnounced.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/proxyAnnounced.ts#L13)*
The account that previously announced the call.
......@@ -46,7 +46,7 @@ ___
**forceProxyType**: string
*Defined in [src/methods/proxy/proxyAnnounced.ts:21](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/proxyAnnounced.ts#L21)*
*Defined in [src/methods/proxy/proxyAnnounced.ts:21](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/proxyAnnounced.ts#L21)*
Specify the exact proxy type to be used and checked for this call.
......@@ -56,6 +56,6 @@ ___
**real**: string
*Defined in [src/methods/proxy/proxyAnnounced.ts:17](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/proxyAnnounced.ts#L17)*
*Defined in [src/methods/proxy/proxyAnnounced.ts:17](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/proxyAnnounced.ts#L17)*
The account that the proxy will make a call on behalf of.
......@@ -23,7 +23,7 @@
**callHash**: string
*Defined in [src/methods/proxy/rejectAnnouncement.ts:17](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/rejectAnnouncement.ts#L17)*
*Defined in [src/methods/proxy/rejectAnnouncement.ts:17](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/rejectAnnouncement.ts#L17)*
The hash of the call that the proxy wants to execute.
......@@ -33,6 +33,6 @@ ___
**delegate**: string
*Defined in [src/methods/proxy/rejectAnnouncement.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/rejectAnnouncement.ts#L13)*
*Defined in [src/methods/proxy/rejectAnnouncement.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/rejectAnnouncement.ts#L13)*
The account that previously announced the call.
......@@ -24,7 +24,7 @@
**delay**: string \| number
*Defined in [src/methods/proxy/removeProxy.ts:21](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/removeProxy.ts#L21)*
*Defined in [src/methods/proxy/removeProxy.ts:21](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/removeProxy.ts#L21)*
The delay of the proxy to remove.
......@@ -34,7 +34,7 @@ ___
**delegate**: string
*Defined in [src/methods/proxy/removeProxy.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/removeProxy.ts#L13)*
*Defined in [src/methods/proxy/removeProxy.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/removeProxy.ts#L13)*
The account that the `caller` would like to unregister.
......@@ -44,6 +44,6 @@ ___
**proxyType**: string
*Defined in [src/methods/proxy/removeProxy.ts:17](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/proxy/removeProxy.ts#L17)*
*Defined in [src/methods/proxy/removeProxy.ts:17](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/proxy/removeProxy.ts#L17)*
The permissions currently enabled for the target proxy account.
......@@ -23,7 +23,7 @@
**keys**: string[]
*Defined in [src/methods/session/setKeys.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/session/setKeys.ts#L13)*
*Defined in [src/methods/session/setKeys.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/session/setKeys.ts#L13)*
The 5 keys to set.
......@@ -33,6 +33,6 @@ ___
`Optional` **proof**: undefined \| string
*Defined in [src/methods/session/setKeys.ts:17](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/session/setKeys.ts#L17)*
*Defined in [src/methods/session/setKeys.ts:17](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/session/setKeys.ts#L17)*
Proof (unused for now).
......@@ -24,7 +24,7 @@
**controller**: string
*Defined in [src/methods/staking/bond.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/staking/bond.ts#L13)*
*Defined in [src/methods/staking/bond.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/staking/bond.ts#L13)*
The SS-58 encoded address of the Controller account.
......@@ -34,7 +34,7 @@ ___
**payee**: string \| { Account: string }
*Defined in [src/methods/staking/bond.ts:21](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/staking/bond.ts#L21)*
*Defined in [src/methods/staking/bond.ts:21](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/staking/bond.ts#L21)*
The rewards destination. Can be "Stash", "Staked", "Controller" or "{ Account: accountId }"".
......@@ -44,6 +44,6 @@ ___
**value**: number \| string
*Defined in [src/methods/staking/bond.ts:17](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/staking/bond.ts#L17)*
*Defined in [src/methods/staking/bond.ts:17](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/staking/bond.ts#L17)*
The number of tokens to bond.
......@@ -22,6 +22,6 @@
**maxAdditional**: number \| string
*Defined in [src/methods/staking/bondExtra.ts:13](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/staking/bondExtra.ts#L13)*
*Defined in [src/methods/staking/bondExtra.ts:13](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/staking/bondExtra.ts#L13)*
The maximum amount to bond.
......@@ -20,9 +20,9 @@
### targets
**targets**: Array\<string>
**targets**: Array<string\>
*Defined in [src/methods/staking/nominate.ts:16](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/staking/nominate.ts#L16)*
*Defined in [src/methods/staking/nominate.ts:16](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/staking/nominate.ts#L16)*
The SS-58 encoded addresses of the targets you wish to nominate. A maximum of 16
nominations are allowed.
......
......@@ -23,7 +23,7 @@
**era**: number
*Defined in [src/methods/staking/payoutNominator.ts:15](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/staking/payoutNominator.ts#L15)*
*Defined in [src/methods/staking/payoutNominator.ts:15](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/staking/payoutNominator.ts#L15)*
May not be lower than one following the most recently paid era. If it is
higher, then it indicates an instruction to skip the payout of all
......@@ -35,7 +35,7 @@ ___
**validators**: [string, number][]
*Defined in [src/methods/staking/payoutNominator.ts:22](https://github.com/paritytech/txwrapper/blob/968ccb6/src/methods/staking/payoutNominator.ts#L22)*
*Defined in [src/methods/staking/payoutNominator.ts:22](https://github.com/paritytech/txwrapper/blob/47968f6/src/methods/staking/payoutNominator.ts#L22)*
List of all validators that `who` had exposure to during `era` alongside
the index of the `who` in the clipped exposure of the validator. i.e. each
......
Supports Markdown
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