Skip to content
This repository was archived by the owner on Sep 30, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all 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: 2 additions & 0 deletions docs/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
* ["src/methods/poll/vote"](modules/_src_methods_poll_vote_.md)
* ["src/methods/proxy/addProxy"](modules/_src_methods_proxy_addproxy_.md)
* ["src/methods/proxy/proxy"](modules/_src_methods_proxy_proxy_.md)
* ["src/methods/proxy/rejectAnnouncement"](modules/_src_methods_proxy_rejectannouncement_.md)
* ["src/methods/proxy/removeProxies"](modules/_src_methods_proxy_removeproxies_.md)
* ["src/methods/proxy/removeProxy"](modules/_src_methods_proxy_removeproxy_.md)
* ["src/methods/session/setKeys"](modules/_src_methods_session_setkeys_.md)
Expand All @@ -50,4 +51,5 @@
* ["src/util/constants"](modules/_src_util_constants_.md)
* ["src/util/encodeUnsignedTx"](modules/_src_util_encodeunsignedtx_.md)
* ["src/util/metadata"](modules/_src_util_metadata_.md)
* ["src/util/metadataStaticPolkadot23"](modules/_src_util_metadatastaticpolkadot23_.md)
* ["src/util/types"](modules/_src_util_types_.md)
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

• **dest**: *string*

*Defined in [src/methods/balances/transfer.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/balances/transfer.ts#L13)*
*Defined in [src/methods/balances/transfer.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/balances/transfer.ts#L13)*

The recipient address, SS-58 encoded.

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

• **value**: *number | string*

*Defined in [src/methods/balances/transfer.ts:17](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/balances/transfer.ts#L17)*
*Defined in [src/methods/balances/transfer.ts:17](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/balances/transfer.ts#L17)*

The amount to send.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@

• **statement**: *string*

*Defined in [src/methods/claims/attest.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/claims/attest.ts#L13)*
*Defined in [src/methods/claims/attest.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/claims/attest.ts#L13)*

The identity of the statement that is being attested to in the signature.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

• **dest**: *string*

*Defined in [src/methods/claims/claimAttest.ts:14](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/claims/claimAttest.ts#L14)*
*Defined in [src/methods/claims/claimAttest.ts:14](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/claims/claimAttest.ts#L14)*

The destination account to which to pay out the claim. This method is only
available on Polkadot.
Expand All @@ -33,7 +33,7 @@ ___

• **ethereumSignature**: *string*

*Defined in [src/methods/claims/claimAttest.ts:19](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/claims/claimAttest.ts#L19)*
*Defined in [src/methods/claims/claimAttest.ts:19](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/claims/claimAttest.ts#L19)*

The signature of an Ethereum signed message matching the format described
above.
Expand All @@ -44,6 +44,6 @@ ___

• **statement**: *string*

*Defined in [src/methods/claims/claimAttest.ts:23](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/claims/claimAttest.ts#L23)*
*Defined in [src/methods/claims/claimAttest.ts:23](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/claims/claimAttest.ts#L23)*

The identity of the statement that is being attested to in the signature.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@

• **proxy**: *string*

*Defined in [src/methods/democracy/activateProxy.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/democracy/activateProxy.ts#L13)*
*Defined in [src/methods/democracy/activateProxy.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/democracy/activateProxy.ts#L13)*

Address to set as proxy, SS-58 encoded.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@

• **proxy**: *string*

*Defined in [src/methods/democracy/deactivateProxy.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/democracy/deactivateProxy.ts#L13)*
*Defined in [src/methods/democracy/deactivateProxy.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/democracy/deactivateProxy.ts#L13)*

The address of the proxy to remove, SS-58 encoded.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@

• **target**: *string*

*Defined in [src/methods/democracy/openProxy.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/democracy/openProxy.ts#L13)*
*Defined in [src/methods/democracy/openProxy.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/democracy/openProxy.ts#L13)*

The address of the proxy to remove, SS-58 encoded.
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@

• **refIndex**: *number*

*Defined in [src/methods/democracy/proxyVote.ts:14](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/democracy/proxyVote.ts#L14)*
*Defined in [src/methods/democracy/proxyVote.ts:14](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/democracy/proxyVote.ts#L14)*

___

### vote

• **vote**: *[AccountVote](../modules/_src_methods_democracy_types_.md#accountvote)*

*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/democracy/proxyVote.ts#L18)*
*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/democracy/proxyVote.ts#L18)*

Vote.
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@

• **refIndex**: *number*

*Defined in [src/methods/democracy/vote.ts:14](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/democracy/vote.ts#L14)*
*Defined in [src/methods/democracy/vote.ts:14](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/democracy/vote.ts#L14)*

___

### vote

• **vote**: *[AccountVote](../modules/_src_methods_democracy_types_.md#accountvote)*

*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/democracy/vote.ts#L18)*
*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/democracy/vote.ts#L18)*

Vote.
2 changes: 1 addition & 1 deletion docs/interfaces/_src_methods_poll_vote_.pollvoteargs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@

• **approvals**: *boolean[]*

*Defined in [src/methods/poll/vote.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/poll/vote.ts#L13)*
*Defined in [src/methods/poll/vote.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/poll/vote.ts#L13)*

The options to vote for. Must be a boolean array of length 4.
25 changes: 18 additions & 7 deletions docs/interfaces/_src_methods_proxy_addproxy_.proxyaddproxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,28 @@

### Properties

* [proxy](_src_methods_proxy_addproxy_.proxyaddproxy.md#proxy)
* [delay](_src_methods_proxy_addproxy_.proxyaddproxy.md#delay)
* [delegate](_src_methods_proxy_addproxy_.proxyaddproxy.md#delegate)
* [proxyType](_src_methods_proxy_addproxy_.proxyaddproxy.md#proxytype)

## Properties

### proxy
### delay

• **proxy**: *string*
• **delay**: *number | string*

*Defined in [src/methods/proxy/addProxy.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/proxy/addProxy.ts#L13)*
*Defined in [src/methods/proxy/addProxy.ts:27](https://github.com/paritytech/txwrapper/blob/6ef1ba4/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.

___

### delegate

• **delegate**: *string*

*Defined in [src/methods/proxy/addProxy.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/proxy/addProxy.ts#L13)*

The account that the `caller` would like to make a proxy.

Expand All @@ -31,12 +43,11 @@ ___

• **proxyType**: *string*

*Defined in [src/methods/proxy/addProxy.ts:23](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/proxy/addProxy.ts#L23)*
*Defined in [src/methods/proxy/addProxy.ts:22](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/proxy/addProxy.ts#L22)*

The permissions for this proxy account. See the runtime for the `call` filters.
Current known types (Polkadot v8, Kusama v2008, Westend v28):
Current known types:
- 'Any'
- 'NonTransfer'
- 'Governance'
- 'Staking'
- 'SudoBalances' (only relevant if sender is `sudo`)
6 changes: 3 additions & 3 deletions docs/interfaces/_src_methods_proxy_proxy_.proxyproxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

• **call**: *object | string*

*Defined in [src/methods/proxy/proxy.ts:23](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/proxy/proxy.ts#L23)*
*Defined in [src/methods/proxy/proxy.ts:23](https://github.com/paritytech/txwrapper/blob/6ef1ba4/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.
Expand All @@ -33,7 +33,7 @@ ___

• **forceProxyType**: *string*

*Defined in [src/methods/proxy/proxy.ts:18](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/proxy/proxy.ts#L18)*
*Defined in [src/methods/proxy/proxy.ts:18](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/proxy/proxy.ts#L18)*

Specify the exact proxy type to be used and checked for this call.

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

• **real**: *string*

*Defined in [src/methods/proxy/proxy.ts:14](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/proxy/proxy.ts#L14)*
*Defined in [src/methods/proxy/proxy.ts:14](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/proxy/proxy.ts#L14)*

Dispatch the given `call` from an account that the sender is authorized for
through, `add_proxy`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["src/methods/proxy/rejectAnnouncement"](../modules/_src_methods_proxy_rejectannouncement_.md) › [ProxyRejectAnnouncementArgs](_src_methods_proxy_rejectannouncement_.proxyrejectannouncementargs.md)

# Interface: ProxyRejectAnnouncementArgs

## Hierarchy

* object

↳ **ProxyRejectAnnouncementArgs**

## Index

### Properties

* [callHash](_src_methods_proxy_rejectannouncement_.proxyrejectannouncementargs.md#callhash)
* [delegate](_src_methods_proxy_rejectannouncement_.proxyrejectannouncementargs.md#delegate)

## Properties

### callHash

• **callHash**: *string*

*Defined in [src/methods/proxy/rejectAnnouncement.ts:17](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/proxy/rejectAnnouncement.ts#L17)*

The hash of the call that the proxy wants to execute.

___

### delegate

• **delegate**: *string*

*Defined in [src/methods/proxy/rejectAnnouncement.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/proxy/rejectAnnouncement.ts#L13)*

The account that previously announced the call.
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,27 @@

### Properties

* [proxy](_src_methods_proxy_removeproxy_.proxyremoveproxy.md#proxy)
* [delay](_src_methods_proxy_removeproxy_.proxyremoveproxy.md#delay)
* [delegate](_src_methods_proxy_removeproxy_.proxyremoveproxy.md#delegate)
* [proxyType](_src_methods_proxy_removeproxy_.proxyremoveproxy.md#proxytype)

## Properties

### proxy
### delay

• **proxy**: *string*
• **delay**: *string | number*

*Defined in [src/methods/proxy/removeProxy.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/proxy/removeProxy.ts#L13)*
*Defined in [src/methods/proxy/removeProxy.ts:21](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/proxy/removeProxy.ts#L21)*

The delay of the proxy to remove.

___

### delegate

• **delegate**: *string*

*Defined in [src/methods/proxy/removeProxy.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/proxy/removeProxy.ts#L13)*

The account that the `caller` would like to unregister.

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

• **proxyType**: *string*

*Defined in [src/methods/proxy/removeProxy.ts:17](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/proxy/removeProxy.ts#L17)*
*Defined in [src/methods/proxy/removeProxy.ts:17](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/proxy/removeProxy.ts#L17)*

The permissions currently enabled for the target proxy account.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

• **keys**: *string[]*

*Defined in [src/methods/session/setKeys.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/session/setKeys.ts#L13)*
*Defined in [src/methods/session/setKeys.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/session/setKeys.ts#L13)*

The 5 keys to set.

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

• **proof**? : *undefined | string*

*Defined in [src/methods/session/setKeys.ts:17](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/session/setKeys.ts#L17)*
*Defined in [src/methods/session/setKeys.ts:17](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/session/setKeys.ts#L17)*

Proof (unused for now).
10 changes: 5 additions & 5 deletions docs/interfaces/_src_methods_staking_bond_.stakingbondargs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,26 @@

• **controller**: *string*

*Defined in [src/methods/staking/bond.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/bond.ts#L13)*
*Defined in [src/methods/staking/bond.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/staking/bond.ts#L13)*

The SS-58 encoded address of the Controller account.

___

### payee

• **payee**: *string*
• **payee**: *string | object*

*Defined in [src/methods/staking/bond.ts:21](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/bond.ts#L21)*
*Defined in [src/methods/staking/bond.ts:21](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/staking/bond.ts#L21)*

The rewards destination. Can be "Stash", "Staked", or "Controller".
The rewards destination. Can be "Stash", "Staked", "Controller" or "{ Account: accountId }"".

___

### value

• **value**: *number | string*

*Defined in [src/methods/staking/bond.ts:17](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/bond.ts#L17)*
*Defined in [src/methods/staking/bond.ts:17](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/staking/bond.ts#L17)*

The number of tokens to bond.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@

• **maxAdditional**: *number | string*

*Defined in [src/methods/staking/bondExtra.ts:13](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/bondExtra.ts#L13)*
*Defined in [src/methods/staking/bondExtra.ts:13](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/staking/bondExtra.ts#L13)*

The maximum amount to bond.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

• **targets**: *Array‹string›*

*Defined in [src/methods/staking/nominate.ts:16](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/nominate.ts#L16)*
*Defined in [src/methods/staking/nominate.ts:16](https://github.com/paritytech/txwrapper/blob/6ef1ba4/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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

• **era**: *number*

*Defined in [src/methods/staking/payoutNominator.ts:15](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/payoutNominator.ts#L15)*
*Defined in [src/methods/staking/payoutNominator.ts:15](https://github.com/paritytech/txwrapper/blob/6ef1ba4/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
Expand All @@ -33,7 +33,7 @@ ___

• **validators**: *[string, number][]*

*Defined in [src/methods/staking/payoutNominator.ts:22](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/payoutNominator.ts#L22)*
*Defined in [src/methods/staking/payoutNominator.ts:22](https://github.com/paritytech/txwrapper/blob/6ef1ba4/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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

• **era**: *number | string*

*Defined in [src/methods/staking/payoutStakers.ts:19](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/payoutStakers.ts#L19)*
*Defined in [src/methods/staking/payoutStakers.ts:19](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/staking/payoutStakers.ts#L19)*

May be any era between `[current_era - history_depth; current_era]`. Substrate only
retains up to `history_depth` eras of reward information.
Expand All @@ -32,7 +32,7 @@ ___

• **validatorStash**: *string*

*Defined in [src/methods/staking/payoutStakers.ts:14](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/payoutStakers.ts#L14)*
*Defined in [src/methods/staking/payoutStakers.ts:14](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/staking/payoutStakers.ts#L14)*

The Stash account of a _validator._ Their nominators, up to, the maximum
`MaxNominatorRewardedPerValidator`, will also receive their rewards.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

• **era**: *number*

*Defined in [src/methods/staking/payoutValidator.ts:15](https://github.com/paritytech/txwrapper/blob/5aca21f/src/methods/staking/payoutValidator.ts#L15)*
*Defined in [src/methods/staking/payoutValidator.ts:15](https://github.com/paritytech/txwrapper/blob/6ef1ba4/src/methods/staking/payoutValidator.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
Expand Down
Loading