From 41d325484b405cf5b02f5035f958b7d4526f0ba6 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 11:04:22 +0100 Subject: [PATCH 01/12] Add staking and democracy --- package.json | 2 +- src/decode/decodeSignedTx.spec.ts | 10 +- src/decode/decodeSigningPayload.spec.ts | 9 +- src/decode/decodeUnsignedTx.spec.ts | 9 +- ...setProxy.spec.ts => activateProxy.spec.ts} | 8 +- .../{setProxy.ts => activateProxy.ts} | 8 +- ...resignProxy.spec.ts => closeProxy.spec.ts} | 8 +- .../{resignProxy.ts => closeProxy.ts} | 4 +- ...eProxy.spec.ts => deactivateProxy.spec.ts} | 8 +- .../{removeProxy.ts => deactivateProxy.ts} | 8 +- src/methods/democracy/index.ts | 7 +- src/methods/democracy/openProxy.spec.ts | 20 ++ src/methods/democracy/openProxy.ts | 32 ++++ src/methods/staking/index.ts | 2 + src/methods/staking/payoutNominator.spec.ts | 20 ++ src/methods/staking/payoutNominator.ts | 43 +++++ src/methods/staking/payoutValidator.spec.ts | 18 ++ src/methods/staking/payoutValidator.ts | 37 ++++ src/util/registry.ts | 1 + src/util/testUtil.ts | 29 ++- yarn.lock | 175 +++++++++--------- 21 files changed, 331 insertions(+), 127 deletions(-) rename src/methods/democracy/{setProxy.spec.ts => activateProxy.spec.ts} (63%) rename src/methods/democracy/{setProxy.ts => activateProxy.ts} (73%) rename src/methods/democracy/{resignProxy.spec.ts => closeProxy.spec.ts} (58%) rename src/methods/democracy/{resignProxy.ts => closeProxy.ts} (73%) rename src/methods/democracy/{removeProxy.spec.ts => deactivateProxy.spec.ts} (62%) rename src/methods/democracy/{removeProxy.ts => deactivateProxy.ts} (73%) create mode 100644 src/methods/democracy/openProxy.spec.ts create mode 100644 src/methods/democracy/openProxy.ts create mode 100644 src/methods/staking/payoutNominator.spec.ts create mode 100644 src/methods/staking/payoutNominator.ts create mode 100644 src/methods/staking/payoutValidator.spec.ts create mode 100644 src/methods/staking/payoutValidator.ts diff --git a/package.json b/package.json index 4253286b..44c8707f 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "test": "jest" }, "dependencies": { - "@polkadot/api": "^1.4.1" + "@polkadot/api": "^1.5.1" }, "devDependencies": { "@amaurymartiny/config": "^1.0.10", diff --git a/src/decode/decodeSignedTx.spec.ts b/src/decode/decodeSignedTx.spec.ts index 575df443..229fc3c1 100644 --- a/src/decode/decodeSignedTx.spec.ts +++ b/src/decode/decodeSignedTx.spec.ts @@ -52,9 +52,10 @@ function testDecodeSignedTx(pallet: string, name: string): void { describe('decodeSignedTx', () => { testDecodeSignedTx('balances', 'transfer'); testDecodeSignedTx('balances', 'transferKeepAlive'); - testDecodeSignedTx('democracy', 'removeProxy'); - testDecodeSignedTx('democracy', 'resignProxy'); - testDecodeSignedTx('democracy', 'setProxy'); + testDecodeSignedTx('democracy', 'activateProxy'); + testDecodeSignedTx('democracy', 'closeProxy'); + testDecodeSignedTx('democracy', 'deactivateProxy'); + testDecodeSignedTx('democracy', 'openProxy'); // Skipping until Vote has correct JSON serialization in polkadot-api. // testDecodeSignedTx('democracy', 'proxyVote'); // testDecodeSignedTx('democracy', 'vote'); @@ -63,6 +64,9 @@ describe('decodeSignedTx', () => { testDecodeSignedTx('staking', 'bondExtra'); testDecodeSignedTx('staking', 'chill'); testDecodeSignedTx('staking', 'nominate'); + testDecodeSignedTx('staking', 'payoutNominator'); + testDecodeSignedTx('staking', 'payoutValidator'); + testDecodeSignedTx('staking', 'validate'); testDecodeSignedTx('staking', 'unbond'); testDecodeSignedTx('staking', 'validate'); testDecodeSignedTx('staking', 'withdrawUnbonded'); diff --git a/src/decode/decodeSigningPayload.spec.ts b/src/decode/decodeSigningPayload.spec.ts index bf395deb..dcc44b21 100644 --- a/src/decode/decodeSigningPayload.spec.ts +++ b/src/decode/decodeSigningPayload.spec.ts @@ -54,9 +54,10 @@ function testDecodeSigningPayload(pallet: string, name: string): void { describe('decodeSigningPayload', () => { testDecodeSigningPayload('balances', 'transfer'); testDecodeSigningPayload('balances', 'transferKeepAlive'); - testDecodeSigningPayload('democracy', 'removeProxy'); - testDecodeSigningPayload('democracy', 'resignProxy'); - testDecodeSigningPayload('democracy', 'setProxy'); + testDecodeSigningPayload('democracy', 'activateProxy'); + testDecodeSigningPayload('democracy', 'closeProxy'); + testDecodeSigningPayload('democracy', 'deactivateProxy'); + testDecodeSigningPayload('democracy', 'openProxy'); // Skipping until Vote has correct JSON serialization in polkadot-api. // testDecodeSigningPayload('democracy', 'proxyVote'); // testDecodeSigningPayload('democracy', 'vote'); @@ -65,6 +66,8 @@ describe('decodeSigningPayload', () => { testDecodeSigningPayload('staking', 'bondExtra'); testDecodeSigningPayload('staking', 'chill'); testDecodeSigningPayload('staking', 'nominate'); + testDecodeSigningPayload('staking', 'payoutNominator'); + testDecodeSigningPayload('staking', 'payoutValidator'); testDecodeSigningPayload('staking', 'unbond'); testDecodeSigningPayload('staking', 'validate'); testDecodeSigningPayload('staking', 'withdrawUnbonded'); diff --git a/src/decode/decodeUnsignedTx.spec.ts b/src/decode/decodeUnsignedTx.spec.ts index f65f43e6..64b28d0e 100644 --- a/src/decode/decodeUnsignedTx.spec.ts +++ b/src/decode/decodeUnsignedTx.spec.ts @@ -51,9 +51,10 @@ function testDecodeUnsignedTx(pallet: string, name: string): void { describe('decodeUnsignedTx', () => { testDecodeUnsignedTx('balances', 'transfer'); testDecodeUnsignedTx('balances', 'transferKeepAlive'); - testDecodeUnsignedTx('democracy', 'removeProxy'); - testDecodeUnsignedTx('democracy', 'resignProxy'); - testDecodeUnsignedTx('democracy', 'setProxy'); + testDecodeUnsignedTx('democracy', 'activateProxy'); + testDecodeUnsignedTx('democracy', 'closeProxy'); + testDecodeUnsignedTx('democracy', 'deactivateProxy'); + testDecodeUnsignedTx('democracy', 'openProxy'); // Skipping until Vote has correct JSON serialization in polkadot-api. // testDecodeUnsignedTx('democracy', 'proxyVote'); // testDecodeUnsignedTx('democracy', 'vote'); @@ -62,6 +63,8 @@ describe('decodeUnsignedTx', () => { testDecodeUnsignedTx('staking', 'bondExtra'); testDecodeUnsignedTx('staking', 'chill'); testDecodeUnsignedTx('staking', 'nominate'); + testDecodeUnsignedTx('staking', 'payoutNominator'); + testDecodeUnsignedTx('staking', 'payoutValidator'); testDecodeUnsignedTx('staking', 'unbond'); testDecodeUnsignedTx('staking', 'validate'); testDecodeUnsignedTx('staking', 'withdrawUnbonded'); diff --git a/src/methods/democracy/setProxy.spec.ts b/src/methods/democracy/activateProxy.spec.ts similarity index 63% rename from src/methods/democracy/setProxy.spec.ts rename to src/methods/democracy/activateProxy.spec.ts index 840f129c..167f88e0 100644 --- a/src/methods/democracy/setProxy.spec.ts +++ b/src/methods/democracy/activateProxy.spec.ts @@ -3,12 +3,12 @@ import { TEST_METHOD_ARGS, testBaseTxInfo } from '../../util'; -import { setProxy } from './setProxy'; +import { activateProxy } from './activateProxy'; -describe('democracy::setProxy', () => { +describe('democracy::activateProxy', () => { it('should work', () => { - const unsigned = setProxy( - TEST_METHOD_ARGS.democracy.setProxy, + const unsigned = activateProxy( + TEST_METHOD_ARGS.democracy.activateProxy, TEST_BASE_TX_INFO ); diff --git a/src/methods/democracy/setProxy.ts b/src/methods/democracy/activateProxy.ts similarity index 73% rename from src/methods/democracy/setProxy.ts rename to src/methods/democracy/activateProxy.ts index cb63e2cd..83fb69c7 100644 --- a/src/methods/democracy/setProxy.ts +++ b/src/methods/democracy/activateProxy.ts @@ -5,7 +5,7 @@ import { UnsignedTransaction } from '../../util'; -export interface DemocracySetProxyArgs extends Args { +export interface DemocracyActivateProxyArgs extends Args { /** * Address to set as proxy, SS-58 encoded. */ @@ -17,14 +17,14 @@ export interface DemocracySetProxyArgs extends Args { * * @param info - Information required to construct the transaction. */ -export function setProxy( - args: DemocracySetProxyArgs, +export function activateProxy( + args: DemocracyActivateProxyArgs, info: BaseTxInfo ): UnsignedTransaction { return createMethod({ method: { args, - name: 'setProxy', + name: 'activateProxy', pallet: 'democracy' }, ...info diff --git a/src/methods/democracy/resignProxy.spec.ts b/src/methods/democracy/closeProxy.spec.ts similarity index 58% rename from src/methods/democracy/resignProxy.spec.ts rename to src/methods/democracy/closeProxy.spec.ts index ec1eb208..28164967 100644 --- a/src/methods/democracy/resignProxy.spec.ts +++ b/src/methods/democracy/closeProxy.spec.ts @@ -3,12 +3,12 @@ import { TEST_METHOD_ARGS, testBaseTxInfo } from '../../util'; -import { resignProxy } from './resignProxy'; +import { closeProxy } from './closeProxy'; -describe('democracy::resignProxy', () => { +describe('democracy::closeProxy', () => { it('should work', () => { - const unsigned = resignProxy( - TEST_METHOD_ARGS.democracy.resignProxy, + const unsigned = closeProxy( + TEST_METHOD_ARGS.democracy.closeProxy, TEST_BASE_TX_INFO ); diff --git a/src/methods/democracy/resignProxy.ts b/src/methods/democracy/closeProxy.ts similarity index 73% rename from src/methods/democracy/resignProxy.ts rename to src/methods/democracy/closeProxy.ts index a0ea5045..7e8b3f91 100644 --- a/src/methods/democracy/resignProxy.ts +++ b/src/methods/democracy/closeProxy.ts @@ -5,11 +5,11 @@ import { BaseTxInfo, createMethod, UnsignedTransaction } from '../../util'; * * @param info - Information required to construct the transaction. */ -export function resignProxy(args: {}, info: BaseTxInfo): UnsignedTransaction { +export function closeProxy(args: {}, info: BaseTxInfo): UnsignedTransaction { return createMethod({ method: { args, - name: 'resignProxy', + name: 'closeProxy', pallet: 'democracy' }, ...info diff --git a/src/methods/democracy/removeProxy.spec.ts b/src/methods/democracy/deactivateProxy.spec.ts similarity index 62% rename from src/methods/democracy/removeProxy.spec.ts rename to src/methods/democracy/deactivateProxy.spec.ts index 1b665371..4eb1fb8a 100644 --- a/src/methods/democracy/removeProxy.spec.ts +++ b/src/methods/democracy/deactivateProxy.spec.ts @@ -3,12 +3,12 @@ import { TEST_METHOD_ARGS, testBaseTxInfo } from '../../util'; -import { removeProxy } from './removeProxy'; +import { deactivateProxy } from './deactivateProxy'; -describe('democracy::removeProxy', () => { +describe('democracy::deactivateProxy', () => { it('should work', () => { - const unsigned = removeProxy( - TEST_METHOD_ARGS.democracy.removeProxy, + const unsigned = deactivateProxy( + TEST_METHOD_ARGS.democracy.deactivateProxy, TEST_BASE_TX_INFO ); diff --git a/src/methods/democracy/removeProxy.ts b/src/methods/democracy/deactivateProxy.ts similarity index 73% rename from src/methods/democracy/removeProxy.ts rename to src/methods/democracy/deactivateProxy.ts index 1e7d2ad8..a0504bd3 100644 --- a/src/methods/democracy/removeProxy.ts +++ b/src/methods/democracy/deactivateProxy.ts @@ -5,7 +5,7 @@ import { UnsignedTransaction } from '../../util'; -export interface DemocracyRemoveProxyArgs extends Args { +export interface DemocracyDeactivateProxyArgs extends Args { /** * The address of the proxy to remove, SS-58 encoded. */ @@ -17,14 +17,14 @@ export interface DemocracyRemoveProxyArgs extends Args { * * @param info - Information required to construct the transaction. */ -export function removeProxy( - args: DemocracyRemoveProxyArgs, +export function deactivateProxy( + args: DemocracyDeactivateProxyArgs, info: BaseTxInfo ): UnsignedTransaction { return createMethod({ method: { args, - name: 'removeProxy', + name: 'deactivateProxy', pallet: 'democracy' }, ...info diff --git a/src/methods/democracy/index.ts b/src/methods/democracy/index.ts index 0cba135c..70b4db21 100644 --- a/src/methods/democracy/index.ts +++ b/src/methods/democracy/index.ts @@ -1,5 +1,6 @@ +export * from './activateProxy'; +export * from './closeProxy'; +export * from './deactivateProxy'; +export * from './openProxy'; export * from './proxyVote'; -export * from './removeProxy'; -export * from './resignProxy'; -export * from './setProxy'; export * from './vote'; diff --git a/src/methods/democracy/openProxy.spec.ts b/src/methods/democracy/openProxy.spec.ts new file mode 100644 index 00000000..e6b3b467 --- /dev/null +++ b/src/methods/democracy/openProxy.spec.ts @@ -0,0 +1,20 @@ +import { + TEST_BASE_TX_INFO, + TEST_METHOD_ARGS, + testBaseTxInfo +} from '../../util'; +import { openProxy } from './openProxy'; + +describe('democracy::openProxy', () => { + it('should work', () => { + const unsigned = openProxy( + TEST_METHOD_ARGS.democracy.openProxy, + TEST_BASE_TX_INFO + ); + + testBaseTxInfo(unsigned); + expect(unsigned.method).toBe( + '0x09168eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48' + ); + }); +}); diff --git a/src/methods/democracy/openProxy.ts b/src/methods/democracy/openProxy.ts new file mode 100644 index 00000000..7f0cabe4 --- /dev/null +++ b/src/methods/democracy/openProxy.ts @@ -0,0 +1,32 @@ +import { + Args, + BaseTxInfo, + createMethod, + UnsignedTransaction +} from '../../util'; + +export interface DemocracyOpenProxyArgs extends Args { + /** + * The address of the proxy to remove, SS-58 encoded. + */ + target: string; +} + +/** + * Become a proxy. This must be called prior to a later `activate_proxy`. + * + * @param info - Information required to construct the transaction. + */ +export function openProxy( + args: DemocracyOpenProxyArgs, + info: BaseTxInfo +): UnsignedTransaction { + return createMethod({ + method: { + args, + name: 'openProxy', + pallet: 'democracy' + }, + ...info + }); +} diff --git a/src/methods/staking/index.ts b/src/methods/staking/index.ts index ef0cbf35..7e979052 100644 --- a/src/methods/staking/index.ts +++ b/src/methods/staking/index.ts @@ -2,6 +2,8 @@ export * from './bond'; export * from './bondExtra'; export * from './chill'; export * from './nominate'; +export * from './payoutNominator'; +export * from './payoutValidator'; export * from './unbond'; export * from './validate'; export * from './withdrawUnbonded'; diff --git a/src/methods/staking/payoutNominator.spec.ts b/src/methods/staking/payoutNominator.spec.ts new file mode 100644 index 00000000..c9cef6f1 --- /dev/null +++ b/src/methods/staking/payoutNominator.spec.ts @@ -0,0 +1,20 @@ +import { + TEST_BASE_TX_INFO, + TEST_METHOD_ARGS, + testBaseTxInfo +} from '../../util'; +import { payoutNominator } from './payoutNominator'; + +describe('staking::payoutNominator', () => { + it('should work', () => { + const unsigned = payoutNominator( + TEST_METHOD_ARGS.staking.payoutNominator, + TEST_BASE_TX_INFO + ); + + testBaseTxInfo(unsigned); + expect(unsigned.method).toBe( + '0x071064000000048eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a4802000000' + ); + }); +}); diff --git a/src/methods/staking/payoutNominator.ts b/src/methods/staking/payoutNominator.ts new file mode 100644 index 00000000..6b1d1275 --- /dev/null +++ b/src/methods/staking/payoutNominator.ts @@ -0,0 +1,43 @@ +import { + Args, + BaseTxInfo, + createMethod, + UnsignedTransaction +} from '../../util'; + +export interface StakingPayoutNominatorArgs extends Args { + /** + * 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 + * previous eras. + */ + era: number; + /** + * List of all validators that `who` had exposure to during `era`. If it is + * incomplete, then less than the full reward will be paid out. It must not + * exceed `MAX_NOMINATIONS`. + */ + validators: [string, number][]; +} + +/** + * Make one nominator's payout for one era. + * WARNING: once an era is payed for a validator such validator can't claim the + * payout of previous era. + * WARNING: Incorrect arguments here can result in loss of payout. Be very careful. + * + * @param info - Information required to construct the transaction. + */ +export function payoutNominator( + args: StakingPayoutNominatorArgs, + info: BaseTxInfo +): UnsignedTransaction { + return createMethod({ + method: { + args, + name: 'payoutNominator', + pallet: 'staking' + }, + ...info + }); +} diff --git a/src/methods/staking/payoutValidator.spec.ts b/src/methods/staking/payoutValidator.spec.ts new file mode 100644 index 00000000..9ed8a947 --- /dev/null +++ b/src/methods/staking/payoutValidator.spec.ts @@ -0,0 +1,18 @@ +import { + TEST_BASE_TX_INFO, + TEST_METHOD_ARGS, + testBaseTxInfo +} from '../../util'; +import { payoutValidator } from './payoutValidator'; + +describe('staking::payoutValidator', () => { + it('should work', () => { + const unsigned = payoutValidator( + TEST_METHOD_ARGS.staking.payoutValidator, + TEST_BASE_TX_INFO + ); + + testBaseTxInfo(unsigned); + expect(unsigned.method).toBe('0x071164000000'); + }); +}); diff --git a/src/methods/staking/payoutValidator.ts b/src/methods/staking/payoutValidator.ts new file mode 100644 index 00000000..b536532f --- /dev/null +++ b/src/methods/staking/payoutValidator.ts @@ -0,0 +1,37 @@ +import { + Args, + BaseTxInfo, + createMethod, + UnsignedTransaction +} from '../../util'; + +export interface StakingPayoutValidatorArgs extends Args { + /** + * 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 + * previous eras. + */ + era: number; +} + +/** + * Make one nominator's payout for one era. + * WARNING: once an era is payed for a validator such validator can't claim the + * payout of previous era. + * WARNING: Incorrect arguments here can result in loss of payout. Be very careful. + * + * @param info - Information required to construct the transaction. + */ +export function payoutValidator( + args: StakingPayoutValidatorArgs, + info: BaseTxInfo +): UnsignedTransaction { + return createMethod({ + method: { + args, + name: 'payoutValidator', + pallet: 'staking' + }, + ...info + }); +} diff --git a/src/util/registry.ts b/src/util/registry.ts index 2d400a8f..e3c6b2e7 100644 --- a/src/util/registry.ts +++ b/src/util/registry.ts @@ -20,6 +20,7 @@ export function getRegistry( // Register types specific to chain/runtimeVersion registry.register( getSpecTypes( + registry, createType(registry, 'Text'), // Unneeded for now createType(registry, 'RuntimeVersion', { specName, diff --git a/src/util/testUtil.ts b/src/util/testUtil.ts index fcf96b70..25e54d8b 100644 --- a/src/util/testUtil.ts +++ b/src/util/testUtil.ts @@ -3,7 +3,7 @@ */ /** */ import { Keyring } from '@polkadot/api'; -import metadataRpc from '@polkadot/metadata/Metadata/v10/static'; +import metadataRpc from '@polkadot/metadata/Metadata/v11/static'; import { createType } from '@polkadot/types'; import { TRANSACTION_VERSION } from '@polkadot/types/extrinsic/v4/Extrinsic'; import { cryptoWaitReady } from '@polkadot/util-crypto'; @@ -62,6 +62,16 @@ export const TEST_METHOD_ARGS = { } }, democracy: { + activateProxy: { + proxy: 'FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP' // seed "//Bob" + }, + closeProxy: {}, + deactivateProxy: { + proxy: 'FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP' // seed "//Bob" + }, + openProxy: { + target: 'FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP' // seed "//Bob" + }, proxyVote: { refIndex: 0, vote: { @@ -69,13 +79,6 @@ export const TEST_METHOD_ARGS = { conviction: 'Locked1x' } }, - removeProxy: { - proxy: 'FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP' // seed "//Bob" - }, - resignProxy: {}, - setProxy: { - proxy: 'FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP' // seed "//Bob" - }, vote: { refIndex: 0, vote: { @@ -112,6 +115,16 @@ export const TEST_METHOD_ARGS = { 'Fr4NzY1udSFFLzb2R3qxVQkwz9cZraWkyfH4h3mVVk7BK7P' // seed "//Charlie" ] }, + payoutNominator: { + era: 100, + validators: [['FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP', 2]] as [ + string, + number + ][] + }, + payoutValidator: { + era: 100 + }, unbond: { value: 100 }, validate: { prefs: { commission: 5 } diff --git a/yarn.lock b/yarn.lock index 378c2e5d..e5306863 100644 --- a/yarn.lock +++ b/yarn.lock @@ -481,136 +481,136 @@ "@types/yargs" "^15.0.0" chalk "^3.0.0" -"@polkadot/api-derive@1.4.2": - version "1.4.2" - resolved "https://registry.yarnpkg.com/@polkadot/api-derive/-/api-derive-1.4.2.tgz#c3f77a2174b8b9d7b81604f684f891cecd66270e" - integrity sha512-0wDicrqizfaQhSC7PfwOWikoeMcJKuOIF4+UokX4Zl1211GUJso//+5tMge0oaBNBip1OgXpjHY1ElkgC+bn/Q== +"@polkadot/api-derive@1.5.1": + version "1.5.1" + resolved "https://registry.yarnpkg.com/@polkadot/api-derive/-/api-derive-1.5.1.tgz#2bc31c1943e8707d08854eae1b623b357d3bb118" + integrity sha512-KmN9UBZFv1v0Q0PMgHGgcZvEbgIYnnyj3mV7M0o7F/200VyvWCySaR+T7Tqu19zdGvQ7ocmQ6VnTw9E2cKqUrA== dependencies: "@babel/runtime" "^7.8.4" - "@polkadot/api" "1.4.2" - "@polkadot/rpc-core" "1.4.2" - "@polkadot/rpc-provider" "1.4.2" - "@polkadot/types" "1.4.2" - "@polkadot/util" "^2.5.1" - "@polkadot/util-crypto" "^2.5.1" + "@polkadot/api" "1.5.1" + "@polkadot/rpc-core" "1.5.1" + "@polkadot/rpc-provider" "1.5.1" + "@polkadot/types" "1.5.1" + "@polkadot/util" "^2.6.1" + "@polkadot/util-crypto" "^2.6.1" bn.js "^5.1.1" memoizee "^0.4.14" rxjs "^6.5.4" -"@polkadot/api@1.4.2", "@polkadot/api@^1.4.1": - version "1.4.2" - resolved "https://registry.yarnpkg.com/@polkadot/api/-/api-1.4.2.tgz#fefabcd45f80fddbec488cfb9368faa7782be569" - integrity sha512-jXpW8rvmGGEIyBv9+SC4VW4MtH4iV7C6K1oXOQyF6SIds+Tzub97JwlLJexbCvYFx6j5ABNHyDjp+EQ6LEvr2w== +"@polkadot/api@1.5.1", "@polkadot/api@^1.5.1": + version "1.5.1" + resolved "https://registry.yarnpkg.com/@polkadot/api/-/api-1.5.1.tgz#2da9adddfa94fd693692239e717e307092767ffa" + integrity sha512-cvqasyk91/lPB2YXCrQApvrVm0E/8aQcl/AO2iVNJQ1L+pHzR6rnd+94iKMmWFCtRZj86qguR813xsKwJ/PgLg== dependencies: "@babel/runtime" "^7.8.4" - "@polkadot/api-derive" "1.4.2" - "@polkadot/keyring" "^2.5.1" - "@polkadot/metadata" "1.4.2" - "@polkadot/rpc-core" "1.4.2" - "@polkadot/rpc-provider" "1.4.2" - "@polkadot/types" "1.4.2" - "@polkadot/util" "^2.5.1" - "@polkadot/util-crypto" "^2.5.1" + "@polkadot/api-derive" "1.5.1" + "@polkadot/keyring" "^2.6.1" + "@polkadot/metadata" "1.5.1" + "@polkadot/rpc-core" "1.5.1" + "@polkadot/rpc-provider" "1.5.1" + "@polkadot/types" "1.5.1" + "@polkadot/util" "^2.6.1" + "@polkadot/util-crypto" "^2.6.1" bn.js "^5.1.1" eventemitter3 "^4.0.0" rxjs "^6.5.4" -"@polkadot/jsonrpc@1.4.2": - version "1.4.2" - resolved "https://registry.yarnpkg.com/@polkadot/jsonrpc/-/jsonrpc-1.4.2.tgz#cf96a72ba54f00528c8d0fe07f83f204439cbd98" - integrity sha512-XydE0ckR35S3no9Lt+XSkDN8PXMJO37TV0Y5wCnfrLkH5xYTsno/Cje8JKmAz4epnakeAf+qecGBAZ9RMpR6dQ== +"@polkadot/jsonrpc@1.5.1": + version "1.5.1" + resolved "https://registry.yarnpkg.com/@polkadot/jsonrpc/-/jsonrpc-1.5.1.tgz#4259306678033be2dc4199e8baa0465946952c2b" + integrity sha512-Re9ibWzYXG44X05HyQPPHNXMurrOAxVwJaeSCjVJ3UN7DxXkXniIWohvupIoiRn0Ayp1/1QOK8YvEOjqxyqTMw== dependencies: "@babel/runtime" "^7.8.4" - "@polkadot/types" "1.4.2" - "@polkadot/util" "^2.5.1" + "@polkadot/types" "1.5.1" + "@polkadot/util" "^2.6.1" -"@polkadot/keyring@^2.5.1": - version "2.5.1" - resolved "https://registry.yarnpkg.com/@polkadot/keyring/-/keyring-2.5.1.tgz#53a7368f20e40faea5904d89b96dc89975360a22" - integrity sha512-E6CdkHidW6CdP11sJv0Nq7sVPAAHSsIYdybPW34drVHjl11leho7WETIGkXGrbAFjj4bi6H2CFWfF4i0gh7qhg== +"@polkadot/keyring@^2.6.1": + version "2.6.1" + resolved "https://registry.yarnpkg.com/@polkadot/keyring/-/keyring-2.6.1.tgz#dad4d2047ed94334aa509b404bf7d49374e219e6" + integrity sha512-h12f5tWfqzJUmXTnjQ5fVrfSIiZH2ToRdPwEn467yHpeCDPWNCnKN/qHHoYOFQi8TkALiQk03NZbLX4QgoNRFw== dependencies: "@babel/runtime" "^7.8.4" - "@polkadot/util" "2.5.1" - "@polkadot/util-crypto" "2.5.1" + "@polkadot/util" "2.6.1" + "@polkadot/util-crypto" "2.6.1" -"@polkadot/metadata@1.4.2": - version "1.4.2" - resolved "https://registry.yarnpkg.com/@polkadot/metadata/-/metadata-1.4.2.tgz#b17786ca21310187c939c41ae60f68bf9e998fa0" - integrity sha512-E3adceNls4NlJm4ErK7GIu6el6Z3GiUVuZDMmY2iZoo4awcgMjhRyJS/7k8VotcSW0B1q3EU7qPaOoD6f9xHLQ== +"@polkadot/metadata@1.5.1": + version "1.5.1" + resolved "https://registry.yarnpkg.com/@polkadot/metadata/-/metadata-1.5.1.tgz#4a859e73708f9ed1b627e155a7d7faea334fb805" + integrity sha512-Su7mdelNVn5fNUcM9qFlha6gayLoOnTjT7yWy21apt7bg11mrj5aiJ2J6YvKhnM+9xGpKYnTqAX2fFyDbPqiFg== dependencies: "@babel/runtime" "^7.8.4" - "@polkadot/types" "1.4.2" - "@polkadot/util" "^2.5.1" - "@polkadot/util-crypto" "^2.5.1" + "@polkadot/types" "1.5.1" + "@polkadot/util" "^2.6.1" + "@polkadot/util-crypto" "^2.6.1" bn.js "^5.1.1" -"@polkadot/rpc-core@1.4.2": - version "1.4.2" - resolved "https://registry.yarnpkg.com/@polkadot/rpc-core/-/rpc-core-1.4.2.tgz#001c55e99cc6d4b3c8507c5490ab7e866bc25883" - integrity sha512-teHT+psl5QoDHE6lPF/YUE0dpXrdSIZYfEG0sOkYzL/eS63WKcixXYYf8inaRvjNhbapPd/JvTof60a/PAHFqw== +"@polkadot/rpc-core@1.5.1": + version "1.5.1" + resolved "https://registry.yarnpkg.com/@polkadot/rpc-core/-/rpc-core-1.5.1.tgz#aa722e5b1348c1dd31899897a65c6a56f3695ad8" + integrity sha512-SE0cAcTeLvZxJHnD8+saiksyjoBhMGRcVB9BkDLPPKZJ1+xZfZ/SItHhXCtCgL1Ur3UUTbrdLHVLNgE6Tb11lg== dependencies: "@babel/runtime" "^7.8.4" - "@polkadot/jsonrpc" "1.4.2" - "@polkadot/metadata" "1.4.2" - "@polkadot/rpc-provider" "1.4.2" - "@polkadot/types" "1.4.2" - "@polkadot/util" "^2.5.1" + "@polkadot/jsonrpc" "1.5.1" + "@polkadot/metadata" "1.5.1" + "@polkadot/rpc-provider" "1.5.1" + "@polkadot/types" "1.5.1" + "@polkadot/util" "^2.6.1" memoizee "^0.4.14" rxjs "^6.5.4" -"@polkadot/rpc-provider@1.4.2": - version "1.4.2" - resolved "https://registry.yarnpkg.com/@polkadot/rpc-provider/-/rpc-provider-1.4.2.tgz#59d97b4279c5ff7b7ccee1d1877663a9118cac36" - integrity sha512-v9D+q5YACa8SCHWiYmlOy7evaoc8a2mPH1Yh7DNOnfi5b51D9dA6vbZSDfWavB/M9E1tTMGdFNzt7j+sAsnwKw== +"@polkadot/rpc-provider@1.5.1": + version "1.5.1" + resolved "https://registry.yarnpkg.com/@polkadot/rpc-provider/-/rpc-provider-1.5.1.tgz#48b463302f4ae153044e08fac79b9a75ffb370c4" + integrity sha512-w81LZbo0r0vEGu72YdiKYgC3zvtVPqkopASTu6pyr3GjltVHmdXRsogdEoogveYCaJvEG8ul2CW/gFROzr53EA== dependencies: "@babel/runtime" "^7.8.4" - "@polkadot/jsonrpc" "1.4.2" - "@polkadot/metadata" "1.4.2" - "@polkadot/types" "1.4.2" - "@polkadot/util" "^2.5.1" - "@polkadot/util-crypto" "^2.5.1" + "@polkadot/jsonrpc" "1.5.1" + "@polkadot/metadata" "1.5.1" + "@polkadot/types" "1.5.1" + "@polkadot/util" "^2.6.1" + "@polkadot/util-crypto" "^2.6.1" bn.js "^5.1.1" eventemitter3 "^4.0.0" isomorphic-fetch "^2.2.1" websocket "^1.0.31" -"@polkadot/types@1.4.2": - version "1.4.2" - resolved "https://registry.yarnpkg.com/@polkadot/types/-/types-1.4.2.tgz#4535d08d501186b22b0071eb3b540b05ad5ca2ce" - integrity sha512-Zpn7NQbFla0LWIGyHoMw3Vg83EcCGsC9ABWkoG9OzJQpInM7XCo7hA/Q/kHMKPyoICfNKOaweqf8+gbBtlAj/g== +"@polkadot/types@1.5.1": + version "1.5.1" + resolved "https://registry.yarnpkg.com/@polkadot/types/-/types-1.5.1.tgz#4e3acbd2e718536fad7e8874dfbf1957d4bb6fce" + integrity sha512-Iom607LqB7QT/+gPD1+n7lpq2fZ71Kfw1u7WASfrxGVO/K7LdzmC12rv1/hbsFP7vsiw8SKeEH16FIiU5/S5WA== dependencies: "@babel/runtime" "^7.8.4" - "@polkadot/metadata" "1.4.2" - "@polkadot/util" "^2.5.1" - "@polkadot/util-crypto" "^2.5.1" + "@polkadot/metadata" "1.5.1" + "@polkadot/util" "^2.6.1" + "@polkadot/util-crypto" "^2.6.1" "@types/bn.js" "^4.11.6" bn.js "^5.1.1" memoizee "^0.4.14" rxjs "^6.5.4" -"@polkadot/util-crypto@2.5.1", "@polkadot/util-crypto@^2.5.1": - version "2.5.1" - resolved "https://registry.yarnpkg.com/@polkadot/util-crypto/-/util-crypto-2.5.1.tgz#9dceda1b2a6684d077ebe2981c4e0dbc69a52fd0" - integrity sha512-AhL37ffn8MkSNwg//uj/xYFYzdbR3h196UB7y3IN6CPhD+pOPZOqDpqdd0oT2xpksppctvWZqYEaT1k7l3R2Tw== +"@polkadot/util-crypto@2.6.1", "@polkadot/util-crypto@^2.6.1": + version "2.6.1" + resolved "https://registry.yarnpkg.com/@polkadot/util-crypto/-/util-crypto-2.6.1.tgz#d5982e08d79e5315eb0ca8105ee0580f2284e572" + integrity sha512-XYPWlmuilDl4Yo1p/toYUoEp583lt3iwKOb1haIyylUzzQPIhW0t+7ys1ZSarAhuSqhy+7jbi3+DX5b8K1lFBQ== dependencies: "@babel/runtime" "^7.8.4" - "@polkadot/util" "2.5.1" - "@polkadot/wasm-crypto" "^1.0.1" - base-x "^3.0.7" + "@polkadot/util" "2.6.1" + "@polkadot/wasm-crypto" "^1.2.1" + base-x "^3.0.8" bip39 "^3.0.2" blakejs "^1.1.0" bn.js "^5.1.1" bs58 "^4.0.1" elliptic "^6.5.2" js-sha3 "^0.8.0" - pbkdf2 "^3.0.9" + pbkdf2 "^3.0.17" tweetnacl "^1.0.3" xxhashjs "^0.2.2" -"@polkadot/util@2.5.1", "@polkadot/util@^2.5.1": - version "2.5.1" - resolved "https://registry.yarnpkg.com/@polkadot/util/-/util-2.5.1.tgz#8b4be9f7418a2872f6ccb1a0d18e426b4e8779a9" - integrity sha512-MVQPyxkhfERvV1uGyne0b7iekX9h7v892144bNB5VYZ7C2rTuJ5XpaWgx0V9DANeaEv+cqfjeW+8ngYQwYhQKw== +"@polkadot/util@2.6.1", "@polkadot/util@^2.6.1": + version "2.6.1" + resolved "https://registry.yarnpkg.com/@polkadot/util/-/util-2.6.1.tgz#1b8b1d76a87072ad1099319031d278756215ee43" + integrity sha512-iaTqsCH6EEFm1yHSxLGCi/cplZS1lNFcs6QEb+FNgP418nG55NW/j+acpUf94JfZ3MPRB4228ooh45drsaUqPQ== dependencies: "@babel/runtime" "^7.8.4" "@types/bn.js" "^4.11.6" @@ -619,10 +619,10 @@ chalk "^3.0.0" ip-regex "^4.1.0" -"@polkadot/wasm-crypto@^1.0.1": - version "1.1.1" - resolved "https://registry.yarnpkg.com/@polkadot/wasm-crypto/-/wasm-crypto-1.1.1.tgz#f3bf66ce96f02c674287fe59b059964a0c5804d0" - integrity sha512-LMZA+KDnE2qKD7Un9/OJKuCmsf63vvhjGqM/lcb+2FZu5TpfjP1AMeTurDOt1ip3+qEukd5FkfUHXQIiFJLVBQ== +"@polkadot/wasm-crypto@^1.2.1": + version "1.2.1" + resolved "https://registry.yarnpkg.com/@polkadot/wasm-crypto/-/wasm-crypto-1.2.1.tgz#2189702447acd28d763886359576c87562241767" + integrity sha512-nckIoZBV4nBZdeKwFwH5t7skS7L7GO5EFUl5B1F6uCjUfdNpDz3DtqbYQHcLdCZNmG4TDLg6w/1J+rkl2SiUZw== "@sinonjs/commons@^1.7.0": version "1.7.0" @@ -1059,13 +1059,20 @@ balanced-match@^1.0.0: resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767" integrity sha1-ibTRmasr7kneFk6gK4nORi1xt2c= -base-x@^3.0.2, base-x@^3.0.7: +base-x@^3.0.2: version "3.0.7" resolved "https://registry.yarnpkg.com/base-x/-/base-x-3.0.7.tgz#1c5a7fafe8f66b4114063e8da102799d4e7c408f" integrity sha512-zAKJGuQPihXW22fkrfOclUUZXM2g92z5GzlSMHxhO6r6Qj+Nm0ccaGNBzDZojzwOMkpjAv4J0fOv1U4go+a4iw== dependencies: safe-buffer "^5.0.1" +base-x@^3.0.8: + version "3.0.8" + resolved "https://registry.yarnpkg.com/base-x/-/base-x-3.0.8.tgz#1e1106c2537f0162e8b52474a557ebb09000018d" + integrity sha512-Rl/1AWP4J/zRrk54hhlxH4drNxPJXYUaKffODVI53/dAsV4t9fBxyxYKAVPU1XBHxYwOWP9h9H0hM2MVw4YfJA== + dependencies: + safe-buffer "^5.0.1" + base@^0.11.1: version "0.11.2" resolved "https://registry.yarnpkg.com/base/-/base-0.11.2.tgz#7bde5ced145b6d551a90db87f83c558b4eb48a8f" @@ -4323,7 +4330,7 @@ path-type@^3.0.0: dependencies: pify "^3.0.0" -pbkdf2@^3.0.9: +pbkdf2@^3.0.17, pbkdf2@^3.0.9: version "3.0.17" resolved "https://registry.yarnpkg.com/pbkdf2/-/pbkdf2-3.0.17.tgz#976c206530617b14ebb32114239f7b09336e93a6" integrity sha512-U/il5MsrZp7mGg3mSQfn742na2T+1/vHDCG5/iTI3X9MKUuYUZVLQhyRsg06mCgDBTd57TxzgZt7P+fYfjRLtA== From 639f70a6e2b924b0306e64d9ba841a8080a8f536 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 11:28:49 +0100 Subject: [PATCH 02/12] Add vesting --- src/decode/decodeSignedTx.spec.ts | 22 ++------------ src/decode/decodeSigningPayload.spec.ts | 21 ++------------ src/decode/decodeUnsignedTx.spec.ts | 21 ++------------ src/methods/index.ts | 3 +- src/methods/vesting/index.ts | 2 ++ src/methods/vesting/vest.spec.ts | 15 ++++++++++ src/methods/vesting/vest.ts | 17 +++++++++++ src/methods/vesting/vestOther.spec.ts | 20 +++++++++++++ src/methods/vesting/vestOther.ts | 33 +++++++++++++++++++++ src/util/testUtil.ts | 38 ++++++++++++++++++++++++- 10 files changed, 132 insertions(+), 60 deletions(-) create mode 100644 src/methods/vesting/index.ts create mode 100644 src/methods/vesting/vest.spec.ts create mode 100644 src/methods/vesting/vest.ts create mode 100644 src/methods/vesting/vestOther.spec.ts create mode 100644 src/methods/vesting/vestOther.ts diff --git a/src/decode/decodeSignedTx.spec.ts b/src/decode/decodeSignedTx.spec.ts index 229fc3c1..1918b9ec 100644 --- a/src/decode/decodeSignedTx.spec.ts +++ b/src/decode/decodeSignedTx.spec.ts @@ -2,6 +2,7 @@ import { createSignedTx } from '../createSignedTx'; import { createSigningPayload } from '../createSigningPayload'; import * as methods from '../methods'; import { + getAllMethods, KUSAMA_SS58_FORMAT, metadataRpc, signWithAlice, @@ -50,24 +51,5 @@ function testDecodeSignedTx(pallet: string, name: string): void { } describe('decodeSignedTx', () => { - testDecodeSignedTx('balances', 'transfer'); - testDecodeSignedTx('balances', 'transferKeepAlive'); - testDecodeSignedTx('democracy', 'activateProxy'); - testDecodeSignedTx('democracy', 'closeProxy'); - testDecodeSignedTx('democracy', 'deactivateProxy'); - testDecodeSignedTx('democracy', 'openProxy'); - // Skipping until Vote has correct JSON serialization in polkadot-api. - // testDecodeSignedTx('democracy', 'proxyVote'); - // testDecodeSignedTx('democracy', 'vote'); - testDecodeSignedTx('session', 'setKeys'); - testDecodeSignedTx('staking', 'bond'); - testDecodeSignedTx('staking', 'bondExtra'); - testDecodeSignedTx('staking', 'chill'); - testDecodeSignedTx('staking', 'nominate'); - testDecodeSignedTx('staking', 'payoutNominator'); - testDecodeSignedTx('staking', 'payoutValidator'); - testDecodeSignedTx('staking', 'validate'); - testDecodeSignedTx('staking', 'unbond'); - testDecodeSignedTx('staking', 'validate'); - testDecodeSignedTx('staking', 'withdrawUnbonded'); + getAllMethods().forEach(method => testDecodeSignedTx(...method)); }); diff --git a/src/decode/decodeSigningPayload.spec.ts b/src/decode/decodeSigningPayload.spec.ts index dcc44b21..6ca742f4 100644 --- a/src/decode/decodeSigningPayload.spec.ts +++ b/src/decode/decodeSigningPayload.spec.ts @@ -1,6 +1,7 @@ import { createSigningPayload } from '../createSigningPayload'; import * as methods from '../methods'; import { + getAllMethods, KUSAMA_SS58_FORMAT, metadataRpc, TEST_BASE_TX_INFO, @@ -52,23 +53,5 @@ function testDecodeSigningPayload(pallet: string, name: string): void { } describe('decodeSigningPayload', () => { - testDecodeSigningPayload('balances', 'transfer'); - testDecodeSigningPayload('balances', 'transferKeepAlive'); - testDecodeSigningPayload('democracy', 'activateProxy'); - testDecodeSigningPayload('democracy', 'closeProxy'); - testDecodeSigningPayload('democracy', 'deactivateProxy'); - testDecodeSigningPayload('democracy', 'openProxy'); - // Skipping until Vote has correct JSON serialization in polkadot-api. - // testDecodeSigningPayload('democracy', 'proxyVote'); - // testDecodeSigningPayload('democracy', 'vote'); - testDecodeSigningPayload('session', 'setKeys'); - testDecodeSigningPayload('staking', 'bond'); - testDecodeSigningPayload('staking', 'bondExtra'); - testDecodeSigningPayload('staking', 'chill'); - testDecodeSigningPayload('staking', 'nominate'); - testDecodeSigningPayload('staking', 'payoutNominator'); - testDecodeSigningPayload('staking', 'payoutValidator'); - testDecodeSigningPayload('staking', 'unbond'); - testDecodeSigningPayload('staking', 'validate'); - testDecodeSigningPayload('staking', 'withdrawUnbonded'); + getAllMethods().forEach(method => testDecodeSigningPayload(...method)); }); diff --git a/src/decode/decodeUnsignedTx.spec.ts b/src/decode/decodeUnsignedTx.spec.ts index 64b28d0e..57a99c85 100644 --- a/src/decode/decodeUnsignedTx.spec.ts +++ b/src/decode/decodeUnsignedTx.spec.ts @@ -1,5 +1,6 @@ import * as methods from '../methods'; import { + getAllMethods, KUSAMA_SS58_FORMAT, metadataRpc, TEST_BASE_TX_INFO, @@ -49,23 +50,5 @@ function testDecodeUnsignedTx(pallet: string, name: string): void { } describe('decodeUnsignedTx', () => { - testDecodeUnsignedTx('balances', 'transfer'); - testDecodeUnsignedTx('balances', 'transferKeepAlive'); - testDecodeUnsignedTx('democracy', 'activateProxy'); - testDecodeUnsignedTx('democracy', 'closeProxy'); - testDecodeUnsignedTx('democracy', 'deactivateProxy'); - testDecodeUnsignedTx('democracy', 'openProxy'); - // Skipping until Vote has correct JSON serialization in polkadot-api. - // testDecodeUnsignedTx('democracy', 'proxyVote'); - // testDecodeUnsignedTx('democracy', 'vote'); - testDecodeUnsignedTx('session', 'setKeys'); - testDecodeUnsignedTx('staking', 'bond'); - testDecodeUnsignedTx('staking', 'bondExtra'); - testDecodeUnsignedTx('staking', 'chill'); - testDecodeUnsignedTx('staking', 'nominate'); - testDecodeUnsignedTx('staking', 'payoutNominator'); - testDecodeUnsignedTx('staking', 'payoutValidator'); - testDecodeUnsignedTx('staking', 'unbond'); - testDecodeUnsignedTx('staking', 'validate'); - testDecodeUnsignedTx('staking', 'withdrawUnbonded'); + getAllMethods().forEach(method => testDecodeUnsignedTx(...method)); }); diff --git a/src/methods/index.ts b/src/methods/index.ts index df6984a6..53032cdc 100644 --- a/src/methods/index.ts +++ b/src/methods/index.ts @@ -2,5 +2,6 @@ import * as balances from './balances'; import * as democracy from './democracy'; import * as session from './session'; import * as staking from './staking'; +import * as vesting from './vesting'; -export { balances, democracy, session, staking }; +export { balances, democracy, session, staking, vesting }; diff --git a/src/methods/vesting/index.ts b/src/methods/vesting/index.ts new file mode 100644 index 00000000..cc55eb0b --- /dev/null +++ b/src/methods/vesting/index.ts @@ -0,0 +1,2 @@ +export * from './vest'; +export * from './vestOther'; diff --git a/src/methods/vesting/vest.spec.ts b/src/methods/vesting/vest.spec.ts new file mode 100644 index 00000000..be7f5c7a --- /dev/null +++ b/src/methods/vesting/vest.spec.ts @@ -0,0 +1,15 @@ +import { + TEST_BASE_TX_INFO, + TEST_METHOD_ARGS, + testBaseTxInfo +} from '../../util'; +import { vest } from './vest'; + +describe('vesting::vest', () => { + it('should work', () => { + const unsigned = vest(TEST_METHOD_ARGS.vesting.vest, TEST_BASE_TX_INFO); + + testBaseTxInfo(unsigned); + expect(unsigned.method).toBe('0x1a00'); + }); +}); diff --git a/src/methods/vesting/vest.ts b/src/methods/vesting/vest.ts new file mode 100644 index 00000000..e86e99eb --- /dev/null +++ b/src/methods/vesting/vest.ts @@ -0,0 +1,17 @@ +import { BaseTxInfo, createMethod, UnsignedTransaction } from '../../util'; + +/** + * Unlock any vested funds of the sender account. + * + * @param info - Information required to construct the transaction. + */ +export function vest(args: {}, info: BaseTxInfo): UnsignedTransaction { + return createMethod({ + method: { + args, + name: 'vest', + pallet: 'vesting' + }, + ...info + }); +} diff --git a/src/methods/vesting/vestOther.spec.ts b/src/methods/vesting/vestOther.spec.ts new file mode 100644 index 00000000..2afce2f7 --- /dev/null +++ b/src/methods/vesting/vestOther.spec.ts @@ -0,0 +1,20 @@ +import { + TEST_BASE_TX_INFO, + TEST_METHOD_ARGS, + testBaseTxInfo +} from '../../util'; +import { vestOther } from './vestOther'; + +describe('vesting::vestOther', () => { + it('should work', () => { + const unsigned = vestOther( + TEST_METHOD_ARGS.vesting.vestOther, + TEST_BASE_TX_INFO + ); + + testBaseTxInfo(unsigned); + expect(unsigned.method).toBe( + '0x1a01ff90b5ab205c6974c9ea841be688864633dc9ca8a357843eeacf2314649965fe22' + ); + }); +}); diff --git a/src/methods/vesting/vestOther.ts b/src/methods/vesting/vestOther.ts new file mode 100644 index 00000000..671e432e --- /dev/null +++ b/src/methods/vesting/vestOther.ts @@ -0,0 +1,33 @@ +import { + Args, + BaseTxInfo, + createMethod, + UnsignedTransaction +} from '../../util'; + +export interface VestingVestOtherArgs extends Args { + /** + * The account whose vested funds should be unlocked. Must have funds still + * locked under this module. + */ + target: string; +} + +/** + * Unlock any vested funds of the sender account. + * + * @param info - Information required to construct the transaction. + */ +export function vestOther( + args: VestingVestOtherArgs, + info: BaseTxInfo +): UnsignedTransaction { + return createMethod({ + method: { + args, + name: 'vestOther', + pallet: 'vesting' + }, + ...info + }); +} diff --git a/src/util/testUtil.ts b/src/util/testUtil.ts index 25e54d8b..9661ade6 100644 --- a/src/util/testUtil.ts +++ b/src/util/testUtil.ts @@ -8,6 +8,7 @@ import { createType } from '@polkadot/types'; import { TRANSACTION_VERSION } from '@polkadot/types/extrinsic/v4/Extrinsic'; import { cryptoWaitReady } from '@polkadot/util-crypto'; +import * as methods from '../methods'; import { getRegistry } from './registry'; import { UnsignedTransaction } from './types'; @@ -48,7 +49,33 @@ export function testBaseTxInfo(unsigned: UnsignedTransaction): void { } /** - * Arguments for all methods we're testing + * Return all methods available in txwrapper as [pallet, methodName]. Used for + * testing decodes on all methods. + */ +export function getAllMethods(): [string, string][] { + return Object.keys(methods) + .reduce((acc, pallet) => { + return acc.concat( + Object.keys(methods[pallet as keyof typeof methods]).map(name => [ + pallet, + name + ]) + ); + }, [] as [string, string][]) + .filter( + ([pallet, name]) => + !( + // Skipping until Vote has correct JSON serialization in polkadot-api. + ( + (pallet === 'democracy' && name === 'proxyVote') || + (pallet === 'democracy' && name === 'vote') + ) + ) + ); +} + +/** + * Dummy arguments for all methods we're testing. */ export const TEST_METHOD_ARGS = { balances: { @@ -130,9 +157,18 @@ export const TEST_METHOD_ARGS = { prefs: { commission: 5 } }, withdrawUnbonded: {} + }, + vesting: { + vest: {}, + vestOther: { + target: 'Fr4NzY1udSFFLzb2R3qxVQkwz9cZraWkyfH4h3mVVk7BK7P' // seed "//Charlie" + } } }; +/** + * Sign a payload with seed `//Alice`. + */ export async function signWithAlice(signingPayload: string): Promise { // We're creating an Alice account that will sign the payload // Wait for the promise to resolve async WASM From 79435da6c2139baec606b51513a5c523d738f006 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 11:41:08 +0100 Subject: [PATCH 03/12] Add setController --- src/methods/staking/index.ts | 1 + src/methods/staking/setController.spec.ts | 20 ++++++++++++++ src/methods/staking/setController.ts | 33 +++++++++++++++++++++++ src/util/testUtil.ts | 3 +++ 4 files changed, 57 insertions(+) create mode 100644 src/methods/staking/setController.spec.ts create mode 100644 src/methods/staking/setController.ts diff --git a/src/methods/staking/index.ts b/src/methods/staking/index.ts index 7e979052..41de4a75 100644 --- a/src/methods/staking/index.ts +++ b/src/methods/staking/index.ts @@ -4,6 +4,7 @@ export * from './chill'; export * from './nominate'; export * from './payoutNominator'; export * from './payoutValidator'; +export * from './setController'; export * from './unbond'; export * from './validate'; export * from './withdrawUnbonded'; diff --git a/src/methods/staking/setController.spec.ts b/src/methods/staking/setController.spec.ts new file mode 100644 index 00000000..498036f1 --- /dev/null +++ b/src/methods/staking/setController.spec.ts @@ -0,0 +1,20 @@ +import { + TEST_BASE_TX_INFO, + TEST_METHOD_ARGS, + testBaseTxInfo +} from '../../util'; +import { setController } from './setController'; + +describe('staking::setController', () => { + it('should work', () => { + const unsigned = setController( + TEST_METHOD_ARGS.staking.setController, + TEST_BASE_TX_INFO + ); + + testBaseTxInfo(unsigned); + expect(unsigned.method).toBe( + '0x0708ff8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48' + ); + }); +}); diff --git a/src/methods/staking/setController.ts b/src/methods/staking/setController.ts new file mode 100644 index 00000000..564fd9ac --- /dev/null +++ b/src/methods/staking/setController.ts @@ -0,0 +1,33 @@ +import { + Args, + BaseTxInfo, + createMethod, + UnsignedTransaction +} from '../../util'; + +export interface StakingSetControllerArgs extends Args { + /** + * The SS-58 encoded controller address. + */ + controller: string; +} + +/** + * (Re-)set the controller of a stash. Effects will be felt at the beginning o + * the next era. + * + * @param info - Information required to construct the transaction. + */ +export function setController( + args: StakingSetControllerArgs, + info: BaseTxInfo +): UnsignedTransaction { + return createMethod({ + method: { + args, + name: 'setController', + pallet: 'staking' + }, + ...info + }); +} diff --git a/src/util/testUtil.ts b/src/util/testUtil.ts index 9661ade6..671fc02e 100644 --- a/src/util/testUtil.ts +++ b/src/util/testUtil.ts @@ -152,6 +152,9 @@ export const TEST_METHOD_ARGS = { payoutValidator: { era: 100 }, + setController: { + controller: 'FoQJpPyadYccjavVdTWxpxU7rUEaYhfLCPwXgkfD6Zat9QP' // seed "//Bob" + }, unbond: { value: 100 }, validate: { prefs: { commission: 5 } From 1957959bd12e63cf6b17c1918a332319bc5df09a Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 11:41:32 +0100 Subject: [PATCH 04/12] docs --- docs/globals.md | 12 ++++-- ...balances_transfer_.balancestransferargs.md | 4 +- ...tivateproxy_.democracyactivateproxyargs.md | 25 ++++++++++++ ...vateproxy_.democracydeactivateproxyargs.md | 25 ++++++++++++ ...cracy_openproxy_.democracyopenproxyargs.md | 25 ++++++++++++ ...cracy_proxyvote_.democracyproxyvoteargs.md | 4 +- ...y_removeproxy_.democracyremoveproxyargs.md | 25 ------------ ...mocracy_setproxy_.democracysetproxyargs.md | 25 ------------ ...thods_democracy_vote_.democracyvoteargs.md | 4 +- ...ods_session_setkeys_.sessionsetkeysargs.md | 4 +- .../_methods_staking_bond_.stakingbondargs.md | 6 +-- ...staking_bondextra_.stakingbondextraargs.md | 2 +- ...s_staking_nominate_.stakingnominateargs.md | 2 +- ...utnominator_.stakingpayoutnominatorargs.md | 40 +++++++++++++++++++ ...utvalidator_.stakingpayoutvalidatorargs.md | 27 +++++++++++++ ...setcontroller_.stakingsetcontrollerargs.md | 25 ++++++++++++ ...thods_staking_unbond_.stakingunbondargs.md | 2 +- ...s_staking_validate_.stakingvalidateargs.md | 2 +- ...vesting_vestother_.vestingvestotherargs.md | 26 ++++++++++++ docs/interfaces/_util_types_.basetxinfo.md | 18 ++++----- .../_util_types_.unsignedtransaction.md | 2 +- docs/modules/_createsignedtx_.md | 2 +- docs/modules/_createsigningpayload_.md | 2 +- docs/modules/_decode_decode_.md | 6 +-- docs/modules/_deriveaddress_.md | 2 +- docs/modules/_gettxhash_.md | 2 +- docs/modules/_importprivatekey_.md | 4 +- docs/modules/_methods_balances_transfer_.md | 2 +- .../_methods_balances_transferkeepalive_.md | 4 +- .../_methods_democracy_activateproxy_.md | 32 +++++++++++++++ .../modules/_methods_democracy_closeproxy_.md | 28 +++++++++++++ .../_methods_democracy_deactivateproxy_.md | 32 +++++++++++++++ docs/modules/_methods_democracy_openproxy_.md | 32 +++++++++++++++ docs/modules/_methods_democracy_proxyvote_.md | 2 +- .../_methods_democracy_removeproxy_.md | 32 --------------- .../_methods_democracy_resignproxy_.md | 28 ------------- docs/modules/_methods_democracy_setproxy_.md | 32 --------------- docs/modules/_methods_democracy_types_.md | 2 +- docs/modules/_methods_democracy_vote_.md | 2 +- docs/modules/_methods_session_setkeys_.md | 2 +- docs/modules/_methods_staking_bond_.md | 2 +- docs/modules/_methods_staking_bondextra_.md | 2 +- docs/modules/_methods_staking_chill_.md | 2 +- docs/modules/_methods_staking_nominate_.md | 2 +- .../_methods_staking_payoutnominator_.md | 35 ++++++++++++++++ .../_methods_staking_payoutvalidator_.md | 35 ++++++++++++++++ .../_methods_staking_setcontroller_.md | 33 +++++++++++++++ docs/modules/_methods_staking_unbond_.md | 2 +- docs/modules/_methods_staking_validate_.md | 2 +- .../_methods_staking_withdrawunbonded_.md | 2 +- docs/modules/_methods_vesting_vest_.md | 28 +++++++++++++ docs/modules/_methods_vesting_vestother_.md | 32 +++++++++++++++ docs/modules/_util_constants_.md | 6 +-- docs/modules/_util_registry_.md | 2 +- 54 files changed, 541 insertions(+), 197 deletions(-) create mode 100644 docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md create mode 100644 docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md create mode 100644 docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md delete mode 100644 docs/interfaces/_methods_democracy_removeproxy_.democracyremoveproxyargs.md delete mode 100644 docs/interfaces/_methods_democracy_setproxy_.democracysetproxyargs.md create mode 100644 docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md create mode 100644 docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md create mode 100644 docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md create mode 100644 docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md create mode 100644 docs/modules/_methods_democracy_activateproxy_.md create mode 100644 docs/modules/_methods_democracy_closeproxy_.md create mode 100644 docs/modules/_methods_democracy_deactivateproxy_.md create mode 100644 docs/modules/_methods_democracy_openproxy_.md delete mode 100644 docs/modules/_methods_democracy_removeproxy_.md delete mode 100644 docs/modules/_methods_democracy_resignproxy_.md delete mode 100644 docs/modules/_methods_democracy_setproxy_.md create mode 100644 docs/modules/_methods_staking_payoutnominator_.md create mode 100644 docs/modules/_methods_staking_payoutvalidator_.md create mode 100644 docs/modules/_methods_staking_setcontroller_.md create mode 100644 docs/modules/_methods_vesting_vest_.md create mode 100644 docs/modules/_methods_vesting_vestother_.md diff --git a/docs/globals.md b/docs/globals.md index 99c26b0d..0742ea14 100644 --- a/docs/globals.md +++ b/docs/globals.md @@ -14,10 +14,11 @@ * ["importPrivateKey"](modules/_importprivatekey_.md) * ["methods/balances/transfer"](modules/_methods_balances_transfer_.md) * ["methods/balances/transferKeepAlive"](modules/_methods_balances_transferkeepalive_.md) +* ["methods/democracy/activateProxy"](modules/_methods_democracy_activateproxy_.md) +* ["methods/democracy/closeProxy"](modules/_methods_democracy_closeproxy_.md) +* ["methods/democracy/deactivateProxy"](modules/_methods_democracy_deactivateproxy_.md) +* ["methods/democracy/openProxy"](modules/_methods_democracy_openproxy_.md) * ["methods/democracy/proxyVote"](modules/_methods_democracy_proxyvote_.md) -* ["methods/democracy/removeProxy"](modules/_methods_democracy_removeproxy_.md) -* ["methods/democracy/resignProxy"](modules/_methods_democracy_resignproxy_.md) -* ["methods/democracy/setProxy"](modules/_methods_democracy_setproxy_.md) * ["methods/democracy/types"](modules/_methods_democracy_types_.md) * ["methods/democracy/vote"](modules/_methods_democracy_vote_.md) * ["methods/session/setKeys"](modules/_methods_session_setkeys_.md) @@ -25,9 +26,14 @@ * ["methods/staking/bondExtra"](modules/_methods_staking_bondextra_.md) * ["methods/staking/chill"](modules/_methods_staking_chill_.md) * ["methods/staking/nominate"](modules/_methods_staking_nominate_.md) +* ["methods/staking/payoutNominator"](modules/_methods_staking_payoutnominator_.md) +* ["methods/staking/payoutValidator"](modules/_methods_staking_payoutvalidator_.md) +* ["methods/staking/setController"](modules/_methods_staking_setcontroller_.md) * ["methods/staking/unbond"](modules/_methods_staking_unbond_.md) * ["methods/staking/validate"](modules/_methods_staking_validate_.md) * ["methods/staking/withdrawUnbonded"](modules/_methods_staking_withdrawunbonded_.md) +* ["methods/vesting/vest"](modules/_methods_vesting_vest_.md) +* ["methods/vesting/vestOther"](modules/_methods_vesting_vestother_.md) * ["util/constants"](modules/_util_constants_.md) * ["util/registry"](modules/_util_registry_.md) * ["util/types"](modules/_util_types_.md) diff --git a/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md b/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md index 917e13cb..521370fd 100644 --- a/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md +++ b/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md @@ -21,7 +21,7 @@ • **dest**: *string* -*Defined in [src/methods/balances/transfer.ts:12](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/balances/transfer.ts#L12)* +*Defined in [src/methods/balances/transfer.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/methods/balances/transfer.ts#L16)* +*Defined in [src/methods/balances/transfer.ts:16](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/balances/transfer.ts#L16)* The amount to send. diff --git a/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md b/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md new file mode 100644 index 00000000..86358d6b --- /dev/null +++ b/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md @@ -0,0 +1,25 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/activateProxy"](../modules/_methods_democracy_activateproxy_.md) › [DemocracyActivateProxyArgs](_methods_democracy_activateproxy_.democracyactivateproxyargs.md) + +# Interface: DemocracyActivateProxyArgs + +## Hierarchy + +* object + + ↳ **DemocracyActivateProxyArgs** + +## Index + +### Properties + +* [proxy](_methods_democracy_activateproxy_.democracyactivateproxyargs.md#proxy) + +## Properties + +### proxy + +• **proxy**: *string* + +*Defined in [src/methods/democracy/activateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/activateProxy.ts#L12)* + +Address to set as proxy, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md b/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md new file mode 100644 index 00000000..7e802745 --- /dev/null +++ b/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md @@ -0,0 +1,25 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/deactivateProxy"](../modules/_methods_democracy_deactivateproxy_.md) › [DemocracyDeactivateProxyArgs](_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md) + +# Interface: DemocracyDeactivateProxyArgs + +## Hierarchy + +* object + + ↳ **DemocracyDeactivateProxyArgs** + +## Index + +### Properties + +* [proxy](_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md#proxy) + +## Properties + +### proxy + +• **proxy**: *string* + +*Defined in [src/methods/democracy/deactivateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/deactivateProxy.ts#L12)* + +The address of the proxy to remove, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md b/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md new file mode 100644 index 00000000..06e1d569 --- /dev/null +++ b/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md @@ -0,0 +1,25 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/openProxy"](../modules/_methods_democracy_openproxy_.md) › [DemocracyOpenProxyArgs](_methods_democracy_openproxy_.democracyopenproxyargs.md) + +# Interface: DemocracyOpenProxyArgs + +## Hierarchy + +* object + + ↳ **DemocracyOpenProxyArgs** + +## Index + +### Properties + +* [target](_methods_democracy_openproxy_.democracyopenproxyargs.md#target) + +## Properties + +### target + +• **target**: *string* + +*Defined in [src/methods/democracy/openProxy.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/openProxy.ts#L12)* + +The address of the proxy to remove, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md b/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md index 620b3655..b7db1f2a 100644 --- a/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md +++ b/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md @@ -21,7 +21,7 @@ • **refIndex**: *number* -*Defined in [src/methods/democracy/proxyVote.ts:13](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/proxyVote.ts#L13)* +*Defined in [src/methods/democracy/proxyVote.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/proxyVote.ts#L13)* ___ @@ -29,6 +29,6 @@ ___ • **vote**: *[Vote](../modules/_methods_democracy_types_.md#vote)* -*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/proxyVote.ts#L18)* +*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/proxyVote.ts#L18)* Vote diff --git a/docs/interfaces/_methods_democracy_removeproxy_.democracyremoveproxyargs.md b/docs/interfaces/_methods_democracy_removeproxy_.democracyremoveproxyargs.md deleted file mode 100644 index 8cf0d872..00000000 --- a/docs/interfaces/_methods_democracy_removeproxy_.democracyremoveproxyargs.md +++ /dev/null @@ -1,25 +0,0 @@ -[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/removeProxy"](../modules/_methods_democracy_removeproxy_.md) › [DemocracyRemoveProxyArgs](_methods_democracy_removeproxy_.democracyremoveproxyargs.md) - -# Interface: DemocracyRemoveProxyArgs - -## Hierarchy - -* object - - ↳ **DemocracyRemoveProxyArgs** - -## Index - -### Properties - -* [proxy](_methods_democracy_removeproxy_.democracyremoveproxyargs.md#proxy) - -## Properties - -### proxy - -• **proxy**: *string* - -*Defined in [src/methods/democracy/removeProxy.ts:12](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/removeProxy.ts#L12)* - -The address of the proxy to remove, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_setproxy_.democracysetproxyargs.md b/docs/interfaces/_methods_democracy_setproxy_.democracysetproxyargs.md deleted file mode 100644 index 45773f8f..00000000 --- a/docs/interfaces/_methods_democracy_setproxy_.democracysetproxyargs.md +++ /dev/null @@ -1,25 +0,0 @@ -[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/setProxy"](../modules/_methods_democracy_setproxy_.md) › [DemocracySetProxyArgs](_methods_democracy_setproxy_.democracysetproxyargs.md) - -# Interface: DemocracySetProxyArgs - -## Hierarchy - -* object - - ↳ **DemocracySetProxyArgs** - -## Index - -### Properties - -* [proxy](_methods_democracy_setproxy_.democracysetproxyargs.md#proxy) - -## Properties - -### proxy - -• **proxy**: *string* - -*Defined in [src/methods/democracy/setProxy.ts:12](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/setProxy.ts#L12)* - -Address to set as proxy, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md b/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md index 8f846d8e..b37ec6f2 100644 --- a/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md +++ b/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md @@ -21,7 +21,7 @@ • **refIndex**: *number* -*Defined in [src/methods/democracy/vote.ts:13](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/vote.ts#L13)* +*Defined in [src/methods/democracy/vote.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/vote.ts#L13)* ___ @@ -29,6 +29,6 @@ ___ • **vote**: *[Vote](../modules/_methods_democracy_types_.md#vote)* -*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/vote.ts#L18)* +*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/vote.ts#L18)* Vote diff --git a/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md b/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md index 9d094b6c..579f0985 100644 --- a/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md +++ b/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md @@ -21,7 +21,7 @@ • **keys**: *string[]* -*Defined in [src/methods/session/setKeys.ts:12](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/session/setKeys.ts#L12)* +*Defined in [src/methods/session/setKeys.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/session/setKeys.ts#L12)* The 5 keys to set. @@ -31,6 +31,6 @@ ___ • **proof**? : *undefined | string* -*Defined in [src/methods/session/setKeys.ts:16](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/session/setKeys.ts#L16)* +*Defined in [src/methods/session/setKeys.ts:16](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/session/setKeys.ts#L16)* Proof (unused for now). diff --git a/docs/interfaces/_methods_staking_bond_.stakingbondargs.md b/docs/interfaces/_methods_staking_bond_.stakingbondargs.md index 927465c8..d01a55f0 100644 --- a/docs/interfaces/_methods_staking_bond_.stakingbondargs.md +++ b/docs/interfaces/_methods_staking_bond_.stakingbondargs.md @@ -22,7 +22,7 @@ • **controller**: *string* -*Defined in [src/methods/staking/bond.ts:12](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/staking/bond.ts#L12)* +*Defined in [src/methods/staking/bond.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/methods/staking/bond.ts#L20)* +*Defined in [src/methods/staking/bond.ts:20](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/methods/staking/bond.ts#L16)* +*Defined in [src/methods/staking/bond.ts:16](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/bond.ts#L16)* The number of tokens to bond. diff --git a/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md b/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md index de0b7728..d9712f2a 100644 --- a/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md +++ b/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md @@ -20,6 +20,6 @@ • **maxAdditional**: *number* -*Defined in [src/methods/staking/bondExtra.ts:12](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/staking/bondExtra.ts#L12)* +*Defined in [src/methods/staking/bondExtra.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/bondExtra.ts#L12)* The maximum amount to bond. diff --git a/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md b/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md index 53b72fd6..ba61bc86 100644 --- a/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md +++ b/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md @@ -20,7 +20,7 @@ • **targets**: *Array‹string›* -*Defined in [src/methods/staking/nominate.ts:15](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/staking/nominate.ts#L15)* +*Defined in [src/methods/staking/nominate.ts:15](https://github.com/paritytech/txwrapper/blob/79435da/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. diff --git a/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md b/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md new file mode 100644 index 00000000..373ae142 --- /dev/null +++ b/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md @@ -0,0 +1,40 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/staking/payoutNominator"](../modules/_methods_staking_payoutnominator_.md) › [StakingPayoutNominatorArgs](_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md) + +# Interface: StakingPayoutNominatorArgs + +## Hierarchy + +* object + + ↳ **StakingPayoutNominatorArgs** + +## Index + +### Properties + +* [era](_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md#era) +* [validators](_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md#validators) + +## Properties + +### era + +• **era**: *number* + +*Defined in [src/methods/staking/payoutNominator.ts:14](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutNominator.ts#L14)* + +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 +previous eras. + +___ + +### validators + +• **validators**: *[string, number][]* + +*Defined in [src/methods/staking/payoutNominator.ts:20](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutNominator.ts#L20)* + +List of all validators that `who` had exposure to during `era`. If it is +incomplete, then less than the full reward will be paid out. It must not +exceed `MAX_NOMINATIONS`. diff --git a/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md b/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md new file mode 100644 index 00000000..4794e4bb --- /dev/null +++ b/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md @@ -0,0 +1,27 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/staking/payoutValidator"](../modules/_methods_staking_payoutvalidator_.md) › [StakingPayoutValidatorArgs](_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md) + +# Interface: StakingPayoutValidatorArgs + +## Hierarchy + +* object + + ↳ **StakingPayoutValidatorArgs** + +## Index + +### Properties + +* [era](_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md#era) + +## Properties + +### era + +• **era**: *number* + +*Defined in [src/methods/staking/payoutValidator.ts:14](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutValidator.ts#L14)* + +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 +previous eras. diff --git a/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md b/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md new file mode 100644 index 00000000..1835dfcc --- /dev/null +++ b/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md @@ -0,0 +1,25 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/staking/setController"](../modules/_methods_staking_setcontroller_.md) › [StakingSetControllerArgs](_methods_staking_setcontroller_.stakingsetcontrollerargs.md) + +# Interface: StakingSetControllerArgs + +## Hierarchy + +* object + + ↳ **StakingSetControllerArgs** + +## Index + +### Properties + +* [controller](_methods_staking_setcontroller_.stakingsetcontrollerargs.md#controller) + +## Properties + +### controller + +• **controller**: *string* + +*Defined in [src/methods/staking/setController.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/setController.ts#L12)* + +The SS-58 encoded controller address. diff --git a/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md b/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md index 3c4f9c33..74a086f2 100644 --- a/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md +++ b/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md @@ -20,6 +20,6 @@ • **value**: *number* -*Defined in [src/methods/staking/unbond.ts:12](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/staking/unbond.ts#L12)* +*Defined in [src/methods/staking/unbond.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/unbond.ts#L12)* The number of tokens to unbond. diff --git a/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md b/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md index 67d03d6b..7581930d 100644 --- a/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md +++ b/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md @@ -20,7 +20,7 @@ • **prefs**: *object* -*Defined in [src/methods/staking/validate.ts:12](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/staking/validate.ts#L12)* +*Defined in [src/methods/staking/validate.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/validate.ts#L12)* Set the desired commission for the validator. Value is Perbill. diff --git a/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md b/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md new file mode 100644 index 00000000..a94da0f3 --- /dev/null +++ b/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md @@ -0,0 +1,26 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/vesting/vestOther"](../modules/_methods_vesting_vestother_.md) › [VestingVestOtherArgs](_methods_vesting_vestother_.vestingvestotherargs.md) + +# Interface: VestingVestOtherArgs + +## Hierarchy + +* object + + ↳ **VestingVestOtherArgs** + +## Index + +### Properties + +* [target](_methods_vesting_vestother_.vestingvestotherargs.md#target) + +## Properties + +### target + +• **target**: *string* + +*Defined in [src/methods/vesting/vestOther.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/vesting/vestOther.ts#L13)* + +The account whose vested funds should be unlocked. Must have funds still +locked under this module. diff --git a/docs/interfaces/_util_types_.basetxinfo.md b/docs/interfaces/_util_types_.basetxinfo.md index 2a195120..90a381ce 100644 --- a/docs/interfaces/_util_types_.basetxinfo.md +++ b/docs/interfaces/_util_types_.basetxinfo.md @@ -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/230d329/src/util/types.ts#L21)* +*Defined in [src/util/types.ts:21](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/util/types.ts#L25)* +*Defined in [src/util/types.ts:25](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/util/types.ts#L29)* +*Defined in [src/util/types.ts:29](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/util/types.ts#L33)* +*Defined in [src/util/types.ts:33](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/util/types.ts#L38)* +*Defined in [src/util/types.ts:38](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/util/types.ts#L42)* +*Defined in [src/util/types.ts:42](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/util/types.ts#L46)* +*Defined in [src/util/types.ts:46](https://github.com/paritytech/txwrapper/blob/79435da/src/util/types.ts#L46)* The current spec version for the runtime. @@ -99,7 +99,7 @@ ___ • **tip**? : *undefined | number* -*Defined in [src/util/types.ts:52](https://github.com/paritytech/txwrapper/blob/230d329/src/util/types.ts#L52)* +*Defined in [src/util/types.ts:52](https://github.com/paritytech/txwrapper/blob/79435da/src/util/types.ts#L52)* The tip for this transaction, in hex. @@ -111,7 +111,7 @@ ___ • **validityPeriod**? : *undefined | number* -*Defined in [src/util/types.ts:59](https://github.com/paritytech/txwrapper/blob/230d329/src/util/types.ts#L59)* +*Defined in [src/util/types.ts:59](https://github.com/paritytech/txwrapper/blob/79435da/src/util/types.ts#L59)* The amount of time (in second) the transaction is valid for. Will be translated into a mortal era. Defaults to 5 minutes. diff --git a/docs/interfaces/_util_types_.unsignedtransaction.md b/docs/interfaces/_util_types_.unsignedtransaction.md index 5c4eb4a4..2ef888c3 100644 --- a/docs/interfaces/_util_types_.unsignedtransaction.md +++ b/docs/interfaces/_util_types_.unsignedtransaction.md @@ -92,7 +92,7 @@ ___ • **metadataRpc**: *string* -*Defined in [src/util/types.ts:11](https://github.com/paritytech/txwrapper/blob/230d329/src/util/types.ts#L11)* +*Defined in [src/util/types.ts:11](https://github.com/paritytech/txwrapper/blob/79435da/src/util/types.ts#L11)* The SCALE-encoded metadata, as a hex string. Can be retrieved via the RPC call `state_getMetadata`. diff --git a/docs/modules/_createsignedtx_.md b/docs/modules/_createsignedtx_.md index 4b0727b8..aeee7776 100644 --- a/docs/modules/_createsignedtx_.md +++ b/docs/modules/_createsignedtx_.md @@ -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/230d329/src/createSignedTx.ts#L14)* +*Defined in [src/createSignedTx.ts:14](https://github.com/paritytech/txwrapper/blob/79435da/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 diff --git a/docs/modules/_createsigningpayload_.md b/docs/modules/_createsigningpayload_.md index 3b71ca57..cbbeaffb 100644 --- a/docs/modules/_createsigningpayload_.md +++ b/docs/modules/_createsigningpayload_.md @@ -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/230d329/src/createSigningPayload.ts#L11)* +*Defined in [src/createSigningPayload.ts:11](https://github.com/paritytech/txwrapper/blob/79435da/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"). diff --git a/docs/modules/_decode_decode_.md b/docs/modules/_decode_decode_.md index 78838a3d..c16edd68 100644 --- a/docs/modules/_decode_decode_.md +++ b/docs/modules/_decode_decode_.md @@ -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/230d329/src/decode/decode.ts#L18)* +*Defined in [src/decode/decode.ts:18](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/decode/decode.ts#L32)* +*Defined in [src/decode/decode.ts:32](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/decode/decode.ts#L46)* +*Defined in [src/decode/decode.ts:46](https://github.com/paritytech/txwrapper/blob/79435da/src/decode/decode.ts#L46)* Parse the transaction information from a signing payload, an unsigned tx, or a signed tx. diff --git a/docs/modules/_deriveaddress_.md b/docs/modules/_deriveaddress_.md index 235eba39..fcd7995d 100644 --- a/docs/modules/_deriveaddress_.md +++ b/docs/modules/_deriveaddress_.md @@ -14,7 +14,7 @@ ▸ **deriveAddress**(`publicKey`: string | Uint8Array, `ss58Format`: number): *string* -*Defined in [src/deriveAddress.ts:11](https://github.com/paritytech/txwrapper/blob/230d329/src/deriveAddress.ts#L11)* +*Defined in [src/deriveAddress.ts:11](https://github.com/paritytech/txwrapper/blob/79435da/src/deriveAddress.ts#L11)* Derive an address from a cryptographic public key offline. diff --git a/docs/modules/_gettxhash_.md b/docs/modules/_gettxhash_.md index 4bf97caf..073bd5f7 100644 --- a/docs/modules/_gettxhash_.md +++ b/docs/modules/_gettxhash_.md @@ -14,7 +14,7 @@ ▸ **getTxHash**(`signedTx`: string): *string* -*Defined in [src/getTxHash.ts:8](https://github.com/paritytech/txwrapper/blob/230d329/src/getTxHash.ts#L8)* +*Defined in [src/getTxHash.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/getTxHash.ts#L8)* Derive the tx hash of a signed transaction offline. diff --git a/docs/modules/_importprivatekey_.md b/docs/modules/_importprivatekey_.md index 7b7d5133..a16b9acf 100644 --- a/docs/modules/_importprivatekey_.md +++ b/docs/modules/_importprivatekey_.md @@ -18,7 +18,7 @@ Ƭ **KeyringPair**: *KeyringPairBase* -*Defined in [src/importPrivateKey.ts:10](https://github.com/paritytech/txwrapper/blob/230d329/src/importPrivateKey.ts#L10)* +*Defined in [src/importPrivateKey.ts:10](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/importPrivateKey.ts#L18)* +*Defined in [src/importPrivateKey.ts:18](https://github.com/paritytech/txwrapper/blob/79435da/src/importPrivateKey.ts#L18)* Import a private key and create a KeyringPair. diff --git a/docs/modules/_methods_balances_transfer_.md b/docs/modules/_methods_balances_transfer_.md index 744e55b2..007cbaa1 100644 --- a/docs/modules/_methods_balances_transfer_.md +++ b/docs/modules/_methods_balances_transfer_.md @@ -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/230d329/src/methods/balances/transfer.ts#L24)* +*Defined in [src/methods/balances/transfer.ts:24](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/balances/transfer.ts#L24)* Construct a balance transfer transaction offline. diff --git a/docs/modules/_methods_balances_transferkeepalive_.md b/docs/modules/_methods_balances_transferkeepalive_.md index aba6b548..570b0835 100644 --- a/docs/modules/_methods_balances_transferkeepalive_.md +++ b/docs/modules/_methods_balances_transferkeepalive_.md @@ -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/230d329/src/methods/balances/transferKeepAlive.ts#L4)* +*Defined in [src/methods/balances/transferKeepAlive.ts:4](https://github.com/paritytech/txwrapper/blob/79435da/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/230d329/src/methods/balances/transferKeepAlive.ts#L11)* +*Defined in [src/methods/balances/transferKeepAlive.ts:11](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/balances/transferKeepAlive.ts#L11)* Construct a balance transfer transaction offline. diff --git a/docs/modules/_methods_democracy_activateproxy_.md b/docs/modules/_methods_democracy_activateproxy_.md new file mode 100644 index 00000000..614136ff --- /dev/null +++ b/docs/modules/_methods_democracy_activateproxy_.md @@ -0,0 +1,32 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/activateProxy"](_methods_democracy_activateproxy_.md) + +# External module: "methods/democracy/activateProxy" + +## Index + +### Interfaces + +* [DemocracyActivateProxyArgs](../interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md) + +### Functions + +* [activateProxy](_methods_democracy_activateproxy_.md#activateproxy) + +## Functions + +### activateProxy + +▸ **activateProxy**(`args`: [DemocracyActivateProxyArgs](../interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* + +*Defined in [src/methods/democracy/activateProxy.ts:20](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/activateProxy.ts#L20)* + +Specify a proxy. Called by the stash. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | [DemocracyActivateProxyArgs](../interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md) | - | +`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | + +**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_democracy_closeproxy_.md b/docs/modules/_methods_democracy_closeproxy_.md new file mode 100644 index 00000000..a284c704 --- /dev/null +++ b/docs/modules/_methods_democracy_closeproxy_.md @@ -0,0 +1,28 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/closeProxy"](_methods_democracy_closeproxy_.md) + +# External module: "methods/democracy/closeProxy" + +## Index + +### Functions + +* [closeProxy](_methods_democracy_closeproxy_.md#closeproxy) + +## Functions + +### closeProxy + +▸ **closeProxy**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* + +*Defined in [src/methods/democracy/closeProxy.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/closeProxy.ts#L8)* + +Clear the proxy. Called by the proxy. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | object | - | +`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | + +**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_democracy_deactivateproxy_.md b/docs/modules/_methods_democracy_deactivateproxy_.md new file mode 100644 index 00000000..292d1176 --- /dev/null +++ b/docs/modules/_methods_democracy_deactivateproxy_.md @@ -0,0 +1,32 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/deactivateProxy"](_methods_democracy_deactivateproxy_.md) + +# External module: "methods/democracy/deactivateProxy" + +## Index + +### Interfaces + +* [DemocracyDeactivateProxyArgs](../interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md) + +### Functions + +* [deactivateProxy](_methods_democracy_deactivateproxy_.md#deactivateproxy) + +## Functions + +### deactivateProxy + +▸ **deactivateProxy**(`args`: [DemocracyDeactivateProxyArgs](../interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* + +*Defined in [src/methods/democracy/deactivateProxy.ts:20](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/deactivateProxy.ts#L20)* + +Clear the proxy. Called by the stash. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | [DemocracyDeactivateProxyArgs](../interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md) | - | +`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | + +**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_democracy_openproxy_.md b/docs/modules/_methods_democracy_openproxy_.md new file mode 100644 index 00000000..4225ecde --- /dev/null +++ b/docs/modules/_methods_democracy_openproxy_.md @@ -0,0 +1,32 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/openProxy"](_methods_democracy_openproxy_.md) + +# External module: "methods/democracy/openProxy" + +## Index + +### Interfaces + +* [DemocracyOpenProxyArgs](../interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md) + +### Functions + +* [openProxy](_methods_democracy_openproxy_.md#openproxy) + +## Functions + +### openProxy + +▸ **openProxy**(`args`: [DemocracyOpenProxyArgs](../interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* + +*Defined in [src/methods/democracy/openProxy.ts:20](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/openProxy.ts#L20)* + +Become a proxy. This must be called prior to a later `activate_proxy`. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | [DemocracyOpenProxyArgs](../interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md) | - | +`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | + +**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_democracy_proxyvote_.md b/docs/modules/_methods_democracy_proxyvote_.md index f57dbdd3..f89fb00c 100644 --- a/docs/modules/_methods_democracy_proxyvote_.md +++ b/docs/modules/_methods_democracy_proxyvote_.md @@ -18,7 +18,7 @@ ▸ **proxyVote**(`args`: [DemocracyProxyVoteArgs](../interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/proxyVote.ts:26](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/proxyVote.ts#L26)* +*Defined in [src/methods/democracy/proxyVote.ts:26](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/proxyVote.ts#L26)* Vote in a referendum on behalf of a stash. diff --git a/docs/modules/_methods_democracy_removeproxy_.md b/docs/modules/_methods_democracy_removeproxy_.md deleted file mode 100644 index 40d9fffc..00000000 --- a/docs/modules/_methods_democracy_removeproxy_.md +++ /dev/null @@ -1,32 +0,0 @@ -[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/removeProxy"](_methods_democracy_removeproxy_.md) - -# External module: "methods/democracy/removeProxy" - -## Index - -### Interfaces - -* [DemocracyRemoveProxyArgs](../interfaces/_methods_democracy_removeproxy_.democracyremoveproxyargs.md) - -### Functions - -* [removeProxy](_methods_democracy_removeproxy_.md#removeproxy) - -## Functions - -### removeProxy - -▸ **removeProxy**(`args`: [DemocracyRemoveProxyArgs](../interfaces/_methods_democracy_removeproxy_.democracyremoveproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* - -*Defined in [src/methods/democracy/removeProxy.ts:20](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/removeProxy.ts#L20)* - -Clear the proxy. Called by the stash. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`args` | [DemocracyRemoveProxyArgs](../interfaces/_methods_democracy_removeproxy_.democracyremoveproxyargs.md) | - | -`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | - -**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_democracy_resignproxy_.md b/docs/modules/_methods_democracy_resignproxy_.md deleted file mode 100644 index f23e8707..00000000 --- a/docs/modules/_methods_democracy_resignproxy_.md +++ /dev/null @@ -1,28 +0,0 @@ -[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/resignProxy"](_methods_democracy_resignproxy_.md) - -# External module: "methods/democracy/resignProxy" - -## Index - -### Functions - -* [resignProxy](_methods_democracy_resignproxy_.md#resignproxy) - -## Functions - -### resignProxy - -▸ **resignProxy**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* - -*Defined in [src/methods/democracy/resignProxy.ts:8](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/resignProxy.ts#L8)* - -Clear the proxy. Called by the proxy. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`args` | object | - | -`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | - -**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_democracy_setproxy_.md b/docs/modules/_methods_democracy_setproxy_.md deleted file mode 100644 index 49261008..00000000 --- a/docs/modules/_methods_democracy_setproxy_.md +++ /dev/null @@ -1,32 +0,0 @@ -[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/democracy/setProxy"](_methods_democracy_setproxy_.md) - -# External module: "methods/democracy/setProxy" - -## Index - -### Interfaces - -* [DemocracySetProxyArgs](../interfaces/_methods_democracy_setproxy_.democracysetproxyargs.md) - -### Functions - -* [setProxy](_methods_democracy_setproxy_.md#setproxy) - -## Functions - -### setProxy - -▸ **setProxy**(`args`: [DemocracySetProxyArgs](../interfaces/_methods_democracy_setproxy_.democracysetproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* - -*Defined in [src/methods/democracy/setProxy.ts:20](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/setProxy.ts#L20)* - -Specify a proxy. Called by the stash. - -**Parameters:** - -Name | Type | Description | ------- | ------ | ------ | -`args` | [DemocracySetProxyArgs](../interfaces/_methods_democracy_setproxy_.democracysetproxyargs.md) | - | -`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | - -**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_democracy_types_.md b/docs/modules/_methods_democracy_types_.md index 99e827fd..0f887359 100644 --- a/docs/modules/_methods_democracy_types_.md +++ b/docs/modules/_methods_democracy_types_.md @@ -14,7 +14,7 @@ Ƭ **Vote**: *object* -*Defined in [src/methods/democracy/types.ts:4](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/types.ts#L4)* +*Defined in [src/methods/democracy/types.ts:4](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/types.ts#L4)* A vote in a referendum diff --git a/docs/modules/_methods_democracy_vote_.md b/docs/modules/_methods_democracy_vote_.md index 1f12931e..593545d9 100644 --- a/docs/modules/_methods_democracy_vote_.md +++ b/docs/modules/_methods_democracy_vote_.md @@ -18,7 +18,7 @@ ▸ **vote**(`args`: [DemocracyVoteArgs](../interfaces/_methods_democracy_vote_.democracyvoteargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/vote.ts:26](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/democracy/vote.ts#L26)* +*Defined in [src/methods/democracy/vote.ts:26](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/vote.ts#L26)* Vote in a referendum. diff --git a/docs/modules/_methods_session_setkeys_.md b/docs/modules/_methods_session_setkeys_.md index b57946a2..c10ce829 100644 --- a/docs/modules/_methods_session_setkeys_.md +++ b/docs/modules/_methods_session_setkeys_.md @@ -18,7 +18,7 @@ ▸ **setKeys**(`args`: [SessionSetKeysArgs](../interfaces/_methods_session_setkeys_.sessionsetkeysargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/session/setKeys.ts:24](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/session/setKeys.ts#L24)* +*Defined in [src/methods/session/setKeys.ts:24](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/session/setKeys.ts#L24)* Sets the session key(s) of the function caller to `key`. diff --git a/docs/modules/_methods_staking_bond_.md b/docs/modules/_methods_staking_bond_.md index fe84fd80..77741a1b 100644 --- a/docs/modules/_methods_staking_bond_.md +++ b/docs/modules/_methods_staking_bond_.md @@ -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/230d329/src/methods/staking/bond.ts#L28)* +*Defined in [src/methods/staking/bond.ts:28](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/bond.ts#L28)* Construct a transaction to bond funds and create a Stash account. diff --git a/docs/modules/_methods_staking_bondextra_.md b/docs/modules/_methods_staking_bondextra_.md index faa31473..ff4408f3 100644 --- a/docs/modules/_methods_staking_bondextra_.md +++ b/docs/modules/_methods_staking_bondextra_.md @@ -18,7 +18,7 @@ ▸ **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/paritytech/txwrapper/blob/230d329/src/methods/staking/bondExtra.ts#L21)* +*Defined in [src/methods/staking/bondExtra.ts:21](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/bondExtra.ts#L21)* Add some extra amount that have appeared in the stash `free_balance` into the balance up for staking. diff --git a/docs/modules/_methods_staking_chill_.md b/docs/modules/_methods_staking_chill_.md index d062b568..2459e622 100644 --- a/docs/modules/_methods_staking_chill_.md +++ b/docs/modules/_methods_staking_chill_.md @@ -14,7 +14,7 @@ ▸ **chill**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/chill.ts:8](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/staking/chill.ts#L8)* +*Defined in [src/methods/staking/chill.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/chill.ts#L8)* Declare the desire to cease validating or nominating. Does not unbond funds. diff --git a/docs/modules/_methods_staking_nominate_.md b/docs/modules/_methods_staking_nominate_.md index b5e62c93..4be668b8 100644 --- a/docs/modules/_methods_staking_nominate_.md +++ b/docs/modules/_methods_staking_nominate_.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/230d329/src/methods/staking/nominate.ts#L23)* +*Defined in [src/methods/staking/nominate.ts:23](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/nominate.ts#L23)* Construct a transaction to nominate. This must be called by the _Controller_ account. diff --git a/docs/modules/_methods_staking_payoutnominator_.md b/docs/modules/_methods_staking_payoutnominator_.md new file mode 100644 index 00000000..0a1eb9a8 --- /dev/null +++ b/docs/modules/_methods_staking_payoutnominator_.md @@ -0,0 +1,35 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/staking/payoutNominator"](_methods_staking_payoutnominator_.md) + +# External module: "methods/staking/payoutNominator" + +## Index + +### Interfaces + +* [StakingPayoutNominatorArgs](../interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md) + +### Functions + +* [payoutNominator](_methods_staking_payoutnominator_.md#payoutnominator) + +## Functions + +### payoutNominator + +▸ **payoutNominator**(`args`: [StakingPayoutNominatorArgs](../interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* + +*Defined in [src/methods/staking/payoutNominator.ts:31](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutNominator.ts#L31)* + +Make one nominator's payout for one era. +WARNING: once an era is payed for a validator such validator can't claim the +payout of previous era. +WARNING: Incorrect arguments here can result in loss of payout. Be very careful. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | [StakingPayoutNominatorArgs](../interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md) | - | +`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | + +**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_staking_payoutvalidator_.md b/docs/modules/_methods_staking_payoutvalidator_.md new file mode 100644 index 00000000..4cacf12a --- /dev/null +++ b/docs/modules/_methods_staking_payoutvalidator_.md @@ -0,0 +1,35 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/staking/payoutValidator"](_methods_staking_payoutvalidator_.md) + +# External module: "methods/staking/payoutValidator" + +## Index + +### Interfaces + +* [StakingPayoutValidatorArgs](../interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md) + +### Functions + +* [payoutValidator](_methods_staking_payoutvalidator_.md#payoutvalidator) + +## Functions + +### payoutValidator + +▸ **payoutValidator**(`args`: [StakingPayoutValidatorArgs](../interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* + +*Defined in [src/methods/staking/payoutValidator.ts:25](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutValidator.ts#L25)* + +Make one nominator's payout for one era. +WARNING: once an era is payed for a validator such validator can't claim the +payout of previous era. +WARNING: Incorrect arguments here can result in loss of payout. Be very careful. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | [StakingPayoutValidatorArgs](../interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md) | - | +`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | + +**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_staking_setcontroller_.md b/docs/modules/_methods_staking_setcontroller_.md new file mode 100644 index 00000000..46e9f432 --- /dev/null +++ b/docs/modules/_methods_staking_setcontroller_.md @@ -0,0 +1,33 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/staking/setController"](_methods_staking_setcontroller_.md) + +# External module: "methods/staking/setController" + +## Index + +### Interfaces + +* [StakingSetControllerArgs](../interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md) + +### Functions + +* [setController](_methods_staking_setcontroller_.md#setcontroller) + +## Functions + +### setController + +▸ **setController**(`args`: [StakingSetControllerArgs](../interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* + +*Defined in [src/methods/staking/setController.ts:21](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/setController.ts#L21)* + +(Re-)set the controller of a stash. Effects will be felt at the beginning o +the next era. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | [StakingSetControllerArgs](../interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md) | - | +`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | + +**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_staking_unbond_.md b/docs/modules/_methods_staking_unbond_.md index bf036c6e..16d5af37 100644 --- a/docs/modules/_methods_staking_unbond_.md +++ b/docs/modules/_methods_staking_unbond_.md @@ -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/230d329/src/methods/staking/unbond.ts#L21)* +*Defined in [src/methods/staking/unbond.ts:21](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/unbond.ts#L21)* Construct a transaction to unbond funds from a Stash account. This must be called by the _Controller_ account. diff --git a/docs/modules/_methods_staking_validate_.md b/docs/modules/_methods_staking_validate_.md index faf7f385..9cc0f514 100644 --- a/docs/modules/_methods_staking_validate_.md +++ b/docs/modules/_methods_staking_validate_.md @@ -18,7 +18,7 @@ ▸ **validate**(`args`: [StakingValidateArgs](../interfaces/_methods_staking_validate_.stakingvalidateargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/validate.ts:22](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/staking/validate.ts#L22)* +*Defined in [src/methods/staking/validate.ts:22](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/validate.ts#L22)* Declare the desire to validate for the origin controller. diff --git a/docs/modules/_methods_staking_withdrawunbonded_.md b/docs/modules/_methods_staking_withdrawunbonded_.md index cf1c1a8d..11494464 100644 --- a/docs/modules/_methods_staking_withdrawunbonded_.md +++ b/docs/modules/_methods_staking_withdrawunbonded_.md @@ -14,7 +14,7 @@ ▸ **withdrawUnbonded**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/withdrawUnbonded.ts:8](https://github.com/paritytech/txwrapper/blob/230d329/src/methods/staking/withdrawUnbonded.ts#L8)* +*Defined in [src/methods/staking/withdrawUnbonded.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/withdrawUnbonded.ts#L8)* Remove any unlocked chunks from the `unlocking` queue from our management. diff --git a/docs/modules/_methods_vesting_vest_.md b/docs/modules/_methods_vesting_vest_.md new file mode 100644 index 00000000..72984b80 --- /dev/null +++ b/docs/modules/_methods_vesting_vest_.md @@ -0,0 +1,28 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/vesting/vest"](_methods_vesting_vest_.md) + +# External module: "methods/vesting/vest" + +## Index + +### Functions + +* [vest](_methods_vesting_vest_.md#vest) + +## Functions + +### vest + +▸ **vest**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* + +*Defined in [src/methods/vesting/vest.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/vesting/vest.ts#L8)* + +Unlock any vested funds of the sender account. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | object | - | +`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | + +**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_methods_vesting_vestother_.md b/docs/modules/_methods_vesting_vestother_.md new file mode 100644 index 00000000..377ff0eb --- /dev/null +++ b/docs/modules/_methods_vesting_vestother_.md @@ -0,0 +1,32 @@ +[@substrate/txwrapper](../README.md) › [Globals](../globals.md) › ["methods/vesting/vestOther"](_methods_vesting_vestother_.md) + +# External module: "methods/vesting/vestOther" + +## Index + +### Interfaces + +* [VestingVestOtherArgs](../interfaces/_methods_vesting_vestother_.vestingvestotherargs.md) + +### Functions + +* [vestOther](_methods_vesting_vestother_.md#vestother) + +## Functions + +### vestOther + +▸ **vestOther**(`args`: [VestingVestOtherArgs](../interfaces/_methods_vesting_vestother_.vestingvestotherargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* + +*Defined in [src/methods/vesting/vestOther.ts:21](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/vesting/vestOther.ts#L21)* + +Unlock any vested funds of the sender account. + +**Parameters:** + +Name | Type | Description | +------ | ------ | ------ | +`args` | [VestingVestOtherArgs](../interfaces/_methods_vesting_vestother_.vestingvestotherargs.md) | - | +`info` | [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md) | Information required to construct the transaction. | + +**Returns:** *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* diff --git a/docs/modules/_util_constants_.md b/docs/modules/_util_constants_.md index 17792d92..b2213579 100644 --- a/docs/modules/_util_constants_.md +++ b/docs/modules/_util_constants_.md @@ -16,7 +16,7 @@ • **EXTRINSIC_VERSION**: *4* = 4 -*Defined in [src/util/constants.ts:13](https://github.com/paritytech/txwrapper/blob/230d329/src/util/constants.ts#L13)* +*Defined in [src/util/constants.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/util/constants.ts#L13)* Latest extrinsic version. @@ -26,7 +26,7 @@ ___ • **KUSAMA_SS58_FORMAT**: *2* = 2 -*Defined in [src/util/constants.ts:4](https://github.com/paritytech/txwrapper/blob/230d329/src/util/constants.ts#L4)* +*Defined in [src/util/constants.ts:4](https://github.com/paritytech/txwrapper/blob/79435da/src/util/constants.ts#L4)* Prefix for SS58-encoded addresses on Kusama. @@ -36,6 +36,6 @@ ___ • **POLKADOT_SS58_FORMAT**: *0* = 0 -*Defined in [src/util/constants.ts:8](https://github.com/paritytech/txwrapper/blob/230d329/src/util/constants.ts#L8)* +*Defined in [src/util/constants.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/util/constants.ts#L8)* Prefix for SS58-encoded addresses on Polkadot. diff --git a/docs/modules/_util_registry_.md b/docs/modules/_util_registry_.md index 1bc02ae1..447c32e5 100644 --- a/docs/modules/_util_registry_.md +++ b/docs/modules/_util_registry_.md @@ -14,7 +14,7 @@ ▸ **getRegistry**(`specName`: "kusama", `specVersion`: number): *TypeRegistry* -*Defined in [src/util/registry.ts:13](https://github.com/paritytech/txwrapper/blob/230d329/src/util/registry.ts#L13)* +*Defined in [src/util/registry.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/util/registry.ts#L13)* Create a specific TypeRegistry for a current chain. The reason we have this is, depending on different runtime versions, we have different types (e.g.: From d8b519054c7cffebb991e4e144c2a1525449feb4 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 11:45:51 +0100 Subject: [PATCH 05/12] Use github actions again (it's faster) --- .github/workflows/pr.yml | 21 +++++++++++++++++ .gitlab-ci.yml | 49 ---------------------------------------- 2 files changed, 21 insertions(+), 49 deletions(-) create mode 100644 .github/workflows/pr.yml delete mode 100644 .gitlab-ci.yml diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml new file mode 100644 index 00000000..b3a9e65d --- /dev/null +++ b/.github/workflows/pr.yml @@ -0,0 +1,21 @@ +name: pr + +on: [pull_request, push] + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - name: Lint + run: | + yarn install + yarn lint + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - name: Test + run: | + yarn install + yarn test diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index dba77558..00000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,49 +0,0 @@ -# .gitlab-ci.yml -# -# txwrapper -# -# pipelines can be triggered manually in the web - -stages: - - test - -variables: - GIT_DEPTH: 3 - REGISTRY: "registry.parity.io/parity/infrastructure/scripts" - -.docker-env: &docker-env - image: ${REGISTRY}/parity-ci-docs:latest - before_script: - - bash --version - - yarn --version - only: - - master - - /^v[0-9]+\.[0-9]+.*$/ # i.e. v1.0, v2.1rc1 - - schedules - - web - - /^[0-9]+$/ # PRs - dependencies: [] - interruptible: true - retry: - max: 2 - when: - - runner_system_failure - - unknown_failure - - api_failure - tags: - - linux-docker - -cache: - key: '${CI_JOB_NAME}' - paths: - - node_modules/ - -### stage: test - -linux-test: - stage: test - <<: *docker-env - script: - - yarn install - - yarn test - - yarn lint From f96c3e43117bccd22c036c85f51ca1ce5bcb87dd Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 11:48:07 +0100 Subject: [PATCH 06/12] Change on --- .github/workflows/pr.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index b3a9e65d..11553716 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -1,6 +1,12 @@ name: pr -on: [pull_request, push] +on: + push: + branches: + - master + pull_request: + branches: + - master jobs: lint: From 562ba6e6dd1b07cd7b9dd737e2be4670aae42e83 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 12:01:06 +0100 Subject: [PATCH 07/12] Better comments --- src/methods/democracy/activateProxy.ts | 2 +- src/methods/democracy/deactivateProxy.ts | 3 ++- src/methods/staking/payoutValidator.ts | 2 +- src/methods/vesting/vestOther.ts | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/methods/democracy/activateProxy.ts b/src/methods/democracy/activateProxy.ts index 83fb69c7..cf4de1a1 100644 --- a/src/methods/democracy/activateProxy.ts +++ b/src/methods/democracy/activateProxy.ts @@ -13,7 +13,7 @@ export interface DemocracyActivateProxyArgs extends Args { } /** - * Specify a proxy. Called by the stash. + * Specify a proxy that is already open to us. Called by the stash. * * @param info - Information required to construct the transaction. */ diff --git a/src/methods/democracy/deactivateProxy.ts b/src/methods/democracy/deactivateProxy.ts index a0504bd3..807907b6 100644 --- a/src/methods/democracy/deactivateProxy.ts +++ b/src/methods/democracy/deactivateProxy.ts @@ -13,7 +13,8 @@ export interface DemocracyDeactivateProxyArgs extends Args { } /** - * Clear the proxy. Called by the stash. + * Deactivate the proxy, but leave open to this account. Called by the stash. + * The proxy must already be active. * * @param info - Information required to construct the transaction. */ diff --git a/src/methods/staking/payoutValidator.ts b/src/methods/staking/payoutValidator.ts index b536532f..0c990df5 100644 --- a/src/methods/staking/payoutValidator.ts +++ b/src/methods/staking/payoutValidator.ts @@ -15,7 +15,7 @@ export interface StakingPayoutValidatorArgs extends Args { } /** - * Make one nominator's payout for one era. + * Make one validator's payout for one era. * WARNING: once an era is payed for a validator such validator can't claim the * payout of previous era. * WARNING: Incorrect arguments here can result in loss of payout. Be very careful. diff --git a/src/methods/vesting/vestOther.ts b/src/methods/vesting/vestOther.ts index 671e432e..f24f8a04 100644 --- a/src/methods/vesting/vestOther.ts +++ b/src/methods/vesting/vestOther.ts @@ -14,7 +14,7 @@ export interface VestingVestOtherArgs extends Args { } /** - * Unlock any vested funds of the sender account. + * Unlock any vested funds of a `target` account. * * @param info - Information required to construct the transaction. */ From 59ff27e2ffdf750c50601d0e786763ddd3c767c8 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 12:01:42 +0100 Subject: [PATCH 08/12] Docs --- ..._balances_transfer_.balancestransferargs.md | 4 ++-- ...ctivateproxy_.democracyactivateproxyargs.md | 2 +- ...ivateproxy_.democracydeactivateproxyargs.md | 2 +- ...ocracy_openproxy_.democracyopenproxyargs.md | 2 +- ...ocracy_proxyvote_.democracyproxyvoteargs.md | 4 ++-- ...ethods_democracy_vote_.democracyvoteargs.md | 4 ++-- ...hods_session_setkeys_.sessionsetkeysargs.md | 4 ++-- .../_methods_staking_bond_.stakingbondargs.md | 6 +++--- ..._staking_bondextra_.stakingbondextraargs.md | 2 +- ...ds_staking_nominate_.stakingnominateargs.md | 2 +- ...outnominator_.stakingpayoutnominatorargs.md | 4 ++-- ...outvalidator_.stakingpayoutvalidatorargs.md | 2 +- ..._setcontroller_.stakingsetcontrollerargs.md | 2 +- ...ethods_staking_unbond_.stakingunbondargs.md | 2 +- ...ds_staking_validate_.stakingvalidateargs.md | 2 +- ..._vesting_vestother_.vestingvestotherargs.md | 2 +- docs/interfaces/_util_types_.basetxinfo.md | 18 +++++++++--------- .../_util_types_.unsignedtransaction.md | 2 +- docs/modules/_createsignedtx_.md | 2 +- docs/modules/_createsigningpayload_.md | 2 +- docs/modules/_decode_decode_.md | 6 +++--- docs/modules/_deriveaddress_.md | 2 +- docs/modules/_gettxhash_.md | 2 +- docs/modules/_importprivatekey_.md | 4 ++-- docs/modules/_methods_balances_transfer_.md | 2 +- .../_methods_balances_transferkeepalive_.md | 4 ++-- .../_methods_democracy_activateproxy_.md | 4 ++-- docs/modules/_methods_democracy_closeproxy_.md | 2 +- .../_methods_democracy_deactivateproxy_.md | 5 +++-- docs/modules/_methods_democracy_openproxy_.md | 2 +- docs/modules/_methods_democracy_proxyvote_.md | 2 +- docs/modules/_methods_democracy_types_.md | 2 +- docs/modules/_methods_democracy_vote_.md | 2 +- docs/modules/_methods_session_setkeys_.md | 2 +- docs/modules/_methods_staking_bond_.md | 2 +- docs/modules/_methods_staking_bondextra_.md | 2 +- docs/modules/_methods_staking_chill_.md | 2 +- docs/modules/_methods_staking_nominate_.md | 2 +- .../_methods_staking_payoutnominator_.md | 2 +- .../_methods_staking_payoutvalidator_.md | 4 ++-- .../modules/_methods_staking_setcontroller_.md | 2 +- docs/modules/_methods_staking_unbond_.md | 2 +- docs/modules/_methods_staking_validate_.md | 2 +- .../_methods_staking_withdrawunbonded_.md | 2 +- docs/modules/_methods_vesting_vest_.md | 2 +- docs/modules/_methods_vesting_vestother_.md | 4 ++-- docs/modules/_util_constants_.md | 6 +++--- docs/modules/_util_registry_.md | 2 +- 48 files changed, 74 insertions(+), 73 deletions(-) diff --git a/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md b/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md index 521370fd..54eed8b4 100644 --- a/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md +++ b/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md @@ -21,7 +21,7 @@ • **dest**: *string* -*Defined in [src/methods/balances/transfer.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/balances/transfer.ts#L12)* +*Defined in [src/methods/balances/transfer.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/methods/balances/transfer.ts#L16)* +*Defined in [src/methods/balances/transfer.ts:16](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/balances/transfer.ts#L16)* The amount to send. diff --git a/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md b/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md index 86358d6b..41662d7a 100644 --- a/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md +++ b/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md @@ -20,6 +20,6 @@ • **proxy**: *string* -*Defined in [src/methods/democracy/activateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/activateProxy.ts#L12)* +*Defined in [src/methods/democracy/activateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/activateProxy.ts#L12)* Address to set as proxy, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md b/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md index 7e802745..4e24e941 100644 --- a/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md +++ b/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md @@ -20,6 +20,6 @@ • **proxy**: *string* -*Defined in [src/methods/democracy/deactivateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/deactivateProxy.ts#L12)* +*Defined in [src/methods/democracy/deactivateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/deactivateProxy.ts#L12)* The address of the proxy to remove, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md b/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md index 06e1d569..7343643b 100644 --- a/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md +++ b/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md @@ -20,6 +20,6 @@ • **target**: *string* -*Defined in [src/methods/democracy/openProxy.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/openProxy.ts#L12)* +*Defined in [src/methods/democracy/openProxy.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/openProxy.ts#L12)* The address of the proxy to remove, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md b/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md index b7db1f2a..1819f487 100644 --- a/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md +++ b/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md @@ -21,7 +21,7 @@ • **refIndex**: *number* -*Defined in [src/methods/democracy/proxyVote.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/proxyVote.ts#L13)* +*Defined in [src/methods/democracy/proxyVote.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/proxyVote.ts#L13)* ___ @@ -29,6 +29,6 @@ ___ • **vote**: *[Vote](../modules/_methods_democracy_types_.md#vote)* -*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/proxyVote.ts#L18)* +*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/proxyVote.ts#L18)* Vote diff --git a/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md b/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md index b37ec6f2..d441d4da 100644 --- a/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md +++ b/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md @@ -21,7 +21,7 @@ • **refIndex**: *number* -*Defined in [src/methods/democracy/vote.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/vote.ts#L13)* +*Defined in [src/methods/democracy/vote.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/vote.ts#L13)* ___ @@ -29,6 +29,6 @@ ___ • **vote**: *[Vote](../modules/_methods_democracy_types_.md#vote)* -*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/vote.ts#L18)* +*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/vote.ts#L18)* Vote diff --git a/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md b/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md index 579f0985..9474bb9f 100644 --- a/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md +++ b/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md @@ -21,7 +21,7 @@ • **keys**: *string[]* -*Defined in [src/methods/session/setKeys.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/session/setKeys.ts#L12)* +*Defined in [src/methods/session/setKeys.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/session/setKeys.ts#L12)* The 5 keys to set. @@ -31,6 +31,6 @@ ___ • **proof**? : *undefined | string* -*Defined in [src/methods/session/setKeys.ts:16](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/session/setKeys.ts#L16)* +*Defined in [src/methods/session/setKeys.ts:16](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/session/setKeys.ts#L16)* Proof (unused for now). diff --git a/docs/interfaces/_methods_staking_bond_.stakingbondargs.md b/docs/interfaces/_methods_staking_bond_.stakingbondargs.md index d01a55f0..7b09d8b6 100644 --- a/docs/interfaces/_methods_staking_bond_.stakingbondargs.md +++ b/docs/interfaces/_methods_staking_bond_.stakingbondargs.md @@ -22,7 +22,7 @@ • **controller**: *string* -*Defined in [src/methods/staking/bond.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/bond.ts#L12)* +*Defined in [src/methods/staking/bond.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/methods/staking/bond.ts#L20)* +*Defined in [src/methods/staking/bond.ts:20](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/methods/staking/bond.ts#L16)* +*Defined in [src/methods/staking/bond.ts:16](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/bond.ts#L16)* The number of tokens to bond. diff --git a/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md b/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md index d9712f2a..298ed4d0 100644 --- a/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md +++ b/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md @@ -20,6 +20,6 @@ • **maxAdditional**: *number* -*Defined in [src/methods/staking/bondExtra.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/bondExtra.ts#L12)* +*Defined in [src/methods/staking/bondExtra.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/bondExtra.ts#L12)* The maximum amount to bond. diff --git a/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md b/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md index ba61bc86..42725ed0 100644 --- a/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md +++ b/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md @@ -20,7 +20,7 @@ • **targets**: *Array‹string›* -*Defined in [src/methods/staking/nominate.ts:15](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/nominate.ts#L15)* +*Defined in [src/methods/staking/nominate.ts:15](https://github.com/paritytech/txwrapper/blob/562ba6e/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. diff --git a/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md b/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md index 373ae142..b204e396 100644 --- a/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md +++ b/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md @@ -21,7 +21,7 @@ • **era**: *number* -*Defined in [src/methods/staking/payoutNominator.ts:14](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutNominator.ts#L14)* +*Defined in [src/methods/staking/payoutNominator.ts:14](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutNominator.ts#L14)* 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 @@ -33,7 +33,7 @@ ___ • **validators**: *[string, number][]* -*Defined in [src/methods/staking/payoutNominator.ts:20](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutNominator.ts#L20)* +*Defined in [src/methods/staking/payoutNominator.ts:20](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutNominator.ts#L20)* List of all validators that `who` had exposure to during `era`. If it is incomplete, then less than the full reward will be paid out. It must not diff --git a/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md b/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md index 4794e4bb..6b5bdd84 100644 --- a/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md +++ b/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md @@ -20,7 +20,7 @@ • **era**: *number* -*Defined in [src/methods/staking/payoutValidator.ts:14](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutValidator.ts#L14)* +*Defined in [src/methods/staking/payoutValidator.ts:14](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutValidator.ts#L14)* 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 diff --git a/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md b/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md index 1835dfcc..e009688a 100644 --- a/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md +++ b/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md @@ -20,6 +20,6 @@ • **controller**: *string* -*Defined in [src/methods/staking/setController.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/setController.ts#L12)* +*Defined in [src/methods/staking/setController.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/setController.ts#L12)* The SS-58 encoded controller address. diff --git a/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md b/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md index 74a086f2..2d88fefe 100644 --- a/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md +++ b/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md @@ -20,6 +20,6 @@ • **value**: *number* -*Defined in [src/methods/staking/unbond.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/unbond.ts#L12)* +*Defined in [src/methods/staking/unbond.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/unbond.ts#L12)* The number of tokens to unbond. diff --git a/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md b/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md index 7581930d..fddff34e 100644 --- a/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md +++ b/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md @@ -20,7 +20,7 @@ • **prefs**: *object* -*Defined in [src/methods/staking/validate.ts:12](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/validate.ts#L12)* +*Defined in [src/methods/staking/validate.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/validate.ts#L12)* Set the desired commission for the validator. Value is Perbill. diff --git a/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md b/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md index a94da0f3..c10c9eff 100644 --- a/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md +++ b/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md @@ -20,7 +20,7 @@ • **target**: *string* -*Defined in [src/methods/vesting/vestOther.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/vesting/vestOther.ts#L13)* +*Defined in [src/methods/vesting/vestOther.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/vesting/vestOther.ts#L13)* The account whose vested funds should be unlocked. Must have funds still locked under this module. diff --git a/docs/interfaces/_util_types_.basetxinfo.md b/docs/interfaces/_util_types_.basetxinfo.md index 90a381ce..0dc6ab5e 100644 --- a/docs/interfaces/_util_types_.basetxinfo.md +++ b/docs/interfaces/_util_types_.basetxinfo.md @@ -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/79435da/src/util/types.ts#L21)* +*Defined in [src/util/types.ts:21](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/util/types.ts#L25)* +*Defined in [src/util/types.ts:25](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/util/types.ts#L29)* +*Defined in [src/util/types.ts:29](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/util/types.ts#L33)* +*Defined in [src/util/types.ts:33](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/util/types.ts#L38)* +*Defined in [src/util/types.ts:38](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/util/types.ts#L42)* +*Defined in [src/util/types.ts:42](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/util/types.ts#L46)* +*Defined in [src/util/types.ts:46](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/types.ts#L46)* The current spec version for the runtime. @@ -99,7 +99,7 @@ ___ • **tip**? : *undefined | number* -*Defined in [src/util/types.ts:52](https://github.com/paritytech/txwrapper/blob/79435da/src/util/types.ts#L52)* +*Defined in [src/util/types.ts:52](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/types.ts#L52)* The tip for this transaction, in hex. @@ -111,7 +111,7 @@ ___ • **validityPeriod**? : *undefined | number* -*Defined in [src/util/types.ts:59](https://github.com/paritytech/txwrapper/blob/79435da/src/util/types.ts#L59)* +*Defined in [src/util/types.ts:59](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/types.ts#L59)* The amount of time (in second) the transaction is valid for. Will be translated into a mortal era. Defaults to 5 minutes. diff --git a/docs/interfaces/_util_types_.unsignedtransaction.md b/docs/interfaces/_util_types_.unsignedtransaction.md index 2ef888c3..78242156 100644 --- a/docs/interfaces/_util_types_.unsignedtransaction.md +++ b/docs/interfaces/_util_types_.unsignedtransaction.md @@ -92,7 +92,7 @@ ___ • **metadataRpc**: *string* -*Defined in [src/util/types.ts:11](https://github.com/paritytech/txwrapper/blob/79435da/src/util/types.ts#L11)* +*Defined in [src/util/types.ts:11](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/types.ts#L11)* The SCALE-encoded metadata, as a hex string. Can be retrieved via the RPC call `state_getMetadata`. diff --git a/docs/modules/_createsignedtx_.md b/docs/modules/_createsignedtx_.md index aeee7776..d7d1f8cc 100644 --- a/docs/modules/_createsignedtx_.md +++ b/docs/modules/_createsignedtx_.md @@ -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/79435da/src/createSignedTx.ts#L14)* +*Defined in [src/createSignedTx.ts:14](https://github.com/paritytech/txwrapper/blob/562ba6e/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 diff --git a/docs/modules/_createsigningpayload_.md b/docs/modules/_createsigningpayload_.md index cbbeaffb..6b1bca85 100644 --- a/docs/modules/_createsigningpayload_.md +++ b/docs/modules/_createsigningpayload_.md @@ -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/79435da/src/createSigningPayload.ts#L11)* +*Defined in [src/createSigningPayload.ts:11](https://github.com/paritytech/txwrapper/blob/562ba6e/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"). diff --git a/docs/modules/_decode_decode_.md b/docs/modules/_decode_decode_.md index c16edd68..4a5f0c39 100644 --- a/docs/modules/_decode_decode_.md +++ b/docs/modules/_decode_decode_.md @@ -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/79435da/src/decode/decode.ts#L18)* +*Defined in [src/decode/decode.ts:18](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/decode/decode.ts#L32)* +*Defined in [src/decode/decode.ts:32](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/decode/decode.ts#L46)* +*Defined in [src/decode/decode.ts:46](https://github.com/paritytech/txwrapper/blob/562ba6e/src/decode/decode.ts#L46)* Parse the transaction information from a signing payload, an unsigned tx, or a signed tx. diff --git a/docs/modules/_deriveaddress_.md b/docs/modules/_deriveaddress_.md index fcd7995d..4b5cd76a 100644 --- a/docs/modules/_deriveaddress_.md +++ b/docs/modules/_deriveaddress_.md @@ -14,7 +14,7 @@ ▸ **deriveAddress**(`publicKey`: string | Uint8Array, `ss58Format`: number): *string* -*Defined in [src/deriveAddress.ts:11](https://github.com/paritytech/txwrapper/blob/79435da/src/deriveAddress.ts#L11)* +*Defined in [src/deriveAddress.ts:11](https://github.com/paritytech/txwrapper/blob/562ba6e/src/deriveAddress.ts#L11)* Derive an address from a cryptographic public key offline. diff --git a/docs/modules/_gettxhash_.md b/docs/modules/_gettxhash_.md index 073bd5f7..a318902d 100644 --- a/docs/modules/_gettxhash_.md +++ b/docs/modules/_gettxhash_.md @@ -14,7 +14,7 @@ ▸ **getTxHash**(`signedTx`: string): *string* -*Defined in [src/getTxHash.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/getTxHash.ts#L8)* +*Defined in [src/getTxHash.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/getTxHash.ts#L8)* Derive the tx hash of a signed transaction offline. diff --git a/docs/modules/_importprivatekey_.md b/docs/modules/_importprivatekey_.md index a16b9acf..cbae5065 100644 --- a/docs/modules/_importprivatekey_.md +++ b/docs/modules/_importprivatekey_.md @@ -18,7 +18,7 @@ Ƭ **KeyringPair**: *KeyringPairBase* -*Defined in [src/importPrivateKey.ts:10](https://github.com/paritytech/txwrapper/blob/79435da/src/importPrivateKey.ts#L10)* +*Defined in [src/importPrivateKey.ts:10](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/importPrivateKey.ts#L18)* +*Defined in [src/importPrivateKey.ts:18](https://github.com/paritytech/txwrapper/blob/562ba6e/src/importPrivateKey.ts#L18)* Import a private key and create a KeyringPair. diff --git a/docs/modules/_methods_balances_transfer_.md b/docs/modules/_methods_balances_transfer_.md index 007cbaa1..489aa93c 100644 --- a/docs/modules/_methods_balances_transfer_.md +++ b/docs/modules/_methods_balances_transfer_.md @@ -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/79435da/src/methods/balances/transfer.ts#L24)* +*Defined in [src/methods/balances/transfer.ts:24](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/balances/transfer.ts#L24)* Construct a balance transfer transaction offline. diff --git a/docs/modules/_methods_balances_transferkeepalive_.md b/docs/modules/_methods_balances_transferkeepalive_.md index 570b0835..1d162abf 100644 --- a/docs/modules/_methods_balances_transferkeepalive_.md +++ b/docs/modules/_methods_balances_transferkeepalive_.md @@ -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/79435da/src/methods/balances/transferKeepAlive.ts#L4)* +*Defined in [src/methods/balances/transferKeepAlive.ts:4](https://github.com/paritytech/txwrapper/blob/562ba6e/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/79435da/src/methods/balances/transferKeepAlive.ts#L11)* +*Defined in [src/methods/balances/transferKeepAlive.ts:11](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/balances/transferKeepAlive.ts#L11)* Construct a balance transfer transaction offline. diff --git a/docs/modules/_methods_democracy_activateproxy_.md b/docs/modules/_methods_democracy_activateproxy_.md index 614136ff..da465e00 100644 --- a/docs/modules/_methods_democracy_activateproxy_.md +++ b/docs/modules/_methods_democracy_activateproxy_.md @@ -18,9 +18,9 @@ ▸ **activateProxy**(`args`: [DemocracyActivateProxyArgs](../interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/activateProxy.ts:20](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/activateProxy.ts#L20)* +*Defined in [src/methods/democracy/activateProxy.ts:20](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/activateProxy.ts#L20)* -Specify a proxy. Called by the stash. +Specify a proxy that is already open to us. Called by the stash. **Parameters:** diff --git a/docs/modules/_methods_democracy_closeproxy_.md b/docs/modules/_methods_democracy_closeproxy_.md index a284c704..98ccb516 100644 --- a/docs/modules/_methods_democracy_closeproxy_.md +++ b/docs/modules/_methods_democracy_closeproxy_.md @@ -14,7 +14,7 @@ ▸ **closeProxy**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/closeProxy.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/closeProxy.ts#L8)* +*Defined in [src/methods/democracy/closeProxy.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/closeProxy.ts#L8)* Clear the proxy. Called by the proxy. diff --git a/docs/modules/_methods_democracy_deactivateproxy_.md b/docs/modules/_methods_democracy_deactivateproxy_.md index 292d1176..cf3d527e 100644 --- a/docs/modules/_methods_democracy_deactivateproxy_.md +++ b/docs/modules/_methods_democracy_deactivateproxy_.md @@ -18,9 +18,10 @@ ▸ **deactivateProxy**(`args`: [DemocracyDeactivateProxyArgs](../interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/deactivateProxy.ts:20](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/deactivateProxy.ts#L20)* +*Defined in [src/methods/democracy/deactivateProxy.ts:21](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/deactivateProxy.ts#L21)* -Clear the proxy. Called by the stash. +Deactivate the proxy, but leave open to this account. Called by the stash. +The proxy must already be active. **Parameters:** diff --git a/docs/modules/_methods_democracy_openproxy_.md b/docs/modules/_methods_democracy_openproxy_.md index 4225ecde..34bceca9 100644 --- a/docs/modules/_methods_democracy_openproxy_.md +++ b/docs/modules/_methods_democracy_openproxy_.md @@ -18,7 +18,7 @@ ▸ **openProxy**(`args`: [DemocracyOpenProxyArgs](../interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/openProxy.ts:20](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/openProxy.ts#L20)* +*Defined in [src/methods/democracy/openProxy.ts:20](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/openProxy.ts#L20)* Become a proxy. This must be called prior to a later `activate_proxy`. diff --git a/docs/modules/_methods_democracy_proxyvote_.md b/docs/modules/_methods_democracy_proxyvote_.md index f89fb00c..d6c669e7 100644 --- a/docs/modules/_methods_democracy_proxyvote_.md +++ b/docs/modules/_methods_democracy_proxyvote_.md @@ -18,7 +18,7 @@ ▸ **proxyVote**(`args`: [DemocracyProxyVoteArgs](../interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/proxyVote.ts:26](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/proxyVote.ts#L26)* +*Defined in [src/methods/democracy/proxyVote.ts:26](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/proxyVote.ts#L26)* Vote in a referendum on behalf of a stash. diff --git a/docs/modules/_methods_democracy_types_.md b/docs/modules/_methods_democracy_types_.md index 0f887359..89736ef7 100644 --- a/docs/modules/_methods_democracy_types_.md +++ b/docs/modules/_methods_democracy_types_.md @@ -14,7 +14,7 @@ Ƭ **Vote**: *object* -*Defined in [src/methods/democracy/types.ts:4](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/types.ts#L4)* +*Defined in [src/methods/democracy/types.ts:4](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/types.ts#L4)* A vote in a referendum diff --git a/docs/modules/_methods_democracy_vote_.md b/docs/modules/_methods_democracy_vote_.md index 593545d9..d309fb98 100644 --- a/docs/modules/_methods_democracy_vote_.md +++ b/docs/modules/_methods_democracy_vote_.md @@ -18,7 +18,7 @@ ▸ **vote**(`args`: [DemocracyVoteArgs](../interfaces/_methods_democracy_vote_.democracyvoteargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/vote.ts:26](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/democracy/vote.ts#L26)* +*Defined in [src/methods/democracy/vote.ts:26](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/vote.ts#L26)* Vote in a referendum. diff --git a/docs/modules/_methods_session_setkeys_.md b/docs/modules/_methods_session_setkeys_.md index c10ce829..da069832 100644 --- a/docs/modules/_methods_session_setkeys_.md +++ b/docs/modules/_methods_session_setkeys_.md @@ -18,7 +18,7 @@ ▸ **setKeys**(`args`: [SessionSetKeysArgs](../interfaces/_methods_session_setkeys_.sessionsetkeysargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/session/setKeys.ts:24](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/session/setKeys.ts#L24)* +*Defined in [src/methods/session/setKeys.ts:24](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/session/setKeys.ts#L24)* Sets the session key(s) of the function caller to `key`. diff --git a/docs/modules/_methods_staking_bond_.md b/docs/modules/_methods_staking_bond_.md index 77741a1b..91a4cce5 100644 --- a/docs/modules/_methods_staking_bond_.md +++ b/docs/modules/_methods_staking_bond_.md @@ -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/79435da/src/methods/staking/bond.ts#L28)* +*Defined in [src/methods/staking/bond.ts:28](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/bond.ts#L28)* Construct a transaction to bond funds and create a Stash account. diff --git a/docs/modules/_methods_staking_bondextra_.md b/docs/modules/_methods_staking_bondextra_.md index ff4408f3..6c67631b 100644 --- a/docs/modules/_methods_staking_bondextra_.md +++ b/docs/modules/_methods_staking_bondextra_.md @@ -18,7 +18,7 @@ ▸ **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/paritytech/txwrapper/blob/79435da/src/methods/staking/bondExtra.ts#L21)* +*Defined in [src/methods/staking/bondExtra.ts:21](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/bondExtra.ts#L21)* Add some extra amount that have appeared in the stash `free_balance` into the balance up for staking. diff --git a/docs/modules/_methods_staking_chill_.md b/docs/modules/_methods_staking_chill_.md index 2459e622..d51dc631 100644 --- a/docs/modules/_methods_staking_chill_.md +++ b/docs/modules/_methods_staking_chill_.md @@ -14,7 +14,7 @@ ▸ **chill**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/chill.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/chill.ts#L8)* +*Defined in [src/methods/staking/chill.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/chill.ts#L8)* Declare the desire to cease validating or nominating. Does not unbond funds. diff --git a/docs/modules/_methods_staking_nominate_.md b/docs/modules/_methods_staking_nominate_.md index 4be668b8..f82047a8 100644 --- a/docs/modules/_methods_staking_nominate_.md +++ b/docs/modules/_methods_staking_nominate_.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/79435da/src/methods/staking/nominate.ts#L23)* +*Defined in [src/methods/staking/nominate.ts:23](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/nominate.ts#L23)* Construct a transaction to nominate. This must be called by the _Controller_ account. diff --git a/docs/modules/_methods_staking_payoutnominator_.md b/docs/modules/_methods_staking_payoutnominator_.md index 0a1eb9a8..3ddf217e 100644 --- a/docs/modules/_methods_staking_payoutnominator_.md +++ b/docs/modules/_methods_staking_payoutnominator_.md @@ -18,7 +18,7 @@ ▸ **payoutNominator**(`args`: [StakingPayoutNominatorArgs](../interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/payoutNominator.ts:31](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutNominator.ts#L31)* +*Defined in [src/methods/staking/payoutNominator.ts:31](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutNominator.ts#L31)* Make one nominator's payout for one era. WARNING: once an era is payed for a validator such validator can't claim the diff --git a/docs/modules/_methods_staking_payoutvalidator_.md b/docs/modules/_methods_staking_payoutvalidator_.md index 4cacf12a..43d11ac1 100644 --- a/docs/modules/_methods_staking_payoutvalidator_.md +++ b/docs/modules/_methods_staking_payoutvalidator_.md @@ -18,9 +18,9 @@ ▸ **payoutValidator**(`args`: [StakingPayoutValidatorArgs](../interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/payoutValidator.ts:25](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/payoutValidator.ts#L25)* +*Defined in [src/methods/staking/payoutValidator.ts:25](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutValidator.ts#L25)* -Make one nominator's payout for one era. +Make one validator's payout for one era. WARNING: once an era is payed for a validator such validator can't claim the payout of previous era. WARNING: Incorrect arguments here can result in loss of payout. Be very careful. diff --git a/docs/modules/_methods_staking_setcontroller_.md b/docs/modules/_methods_staking_setcontroller_.md index 46e9f432..b6e52c4f 100644 --- a/docs/modules/_methods_staking_setcontroller_.md +++ b/docs/modules/_methods_staking_setcontroller_.md @@ -18,7 +18,7 @@ ▸ **setController**(`args`: [StakingSetControllerArgs](../interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/setController.ts:21](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/setController.ts#L21)* +*Defined in [src/methods/staking/setController.ts:21](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/setController.ts#L21)* (Re-)set the controller of a stash. Effects will be felt at the beginning o the next era. diff --git a/docs/modules/_methods_staking_unbond_.md b/docs/modules/_methods_staking_unbond_.md index 16d5af37..d78c3ac8 100644 --- a/docs/modules/_methods_staking_unbond_.md +++ b/docs/modules/_methods_staking_unbond_.md @@ -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/79435da/src/methods/staking/unbond.ts#L21)* +*Defined in [src/methods/staking/unbond.ts:21](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/unbond.ts#L21)* Construct a transaction to unbond funds from a Stash account. This must be called by the _Controller_ account. diff --git a/docs/modules/_methods_staking_validate_.md b/docs/modules/_methods_staking_validate_.md index 9cc0f514..3ab7450d 100644 --- a/docs/modules/_methods_staking_validate_.md +++ b/docs/modules/_methods_staking_validate_.md @@ -18,7 +18,7 @@ ▸ **validate**(`args`: [StakingValidateArgs](../interfaces/_methods_staking_validate_.stakingvalidateargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/validate.ts:22](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/validate.ts#L22)* +*Defined in [src/methods/staking/validate.ts:22](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/validate.ts#L22)* Declare the desire to validate for the origin controller. diff --git a/docs/modules/_methods_staking_withdrawunbonded_.md b/docs/modules/_methods_staking_withdrawunbonded_.md index 11494464..202a65eb 100644 --- a/docs/modules/_methods_staking_withdrawunbonded_.md +++ b/docs/modules/_methods_staking_withdrawunbonded_.md @@ -14,7 +14,7 @@ ▸ **withdrawUnbonded**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/withdrawUnbonded.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/staking/withdrawUnbonded.ts#L8)* +*Defined in [src/methods/staking/withdrawUnbonded.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/withdrawUnbonded.ts#L8)* Remove any unlocked chunks from the `unlocking` queue from our management. diff --git a/docs/modules/_methods_vesting_vest_.md b/docs/modules/_methods_vesting_vest_.md index 72984b80..c4475b73 100644 --- a/docs/modules/_methods_vesting_vest_.md +++ b/docs/modules/_methods_vesting_vest_.md @@ -14,7 +14,7 @@ ▸ **vest**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/vesting/vest.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/vesting/vest.ts#L8)* +*Defined in [src/methods/vesting/vest.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/vesting/vest.ts#L8)* Unlock any vested funds of the sender account. diff --git a/docs/modules/_methods_vesting_vestother_.md b/docs/modules/_methods_vesting_vestother_.md index 377ff0eb..102727a8 100644 --- a/docs/modules/_methods_vesting_vestother_.md +++ b/docs/modules/_methods_vesting_vestother_.md @@ -18,9 +18,9 @@ ▸ **vestOther**(`args`: [VestingVestOtherArgs](../interfaces/_methods_vesting_vestother_.vestingvestotherargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/vesting/vestOther.ts:21](https://github.com/paritytech/txwrapper/blob/79435da/src/methods/vesting/vestOther.ts#L21)* +*Defined in [src/methods/vesting/vestOther.ts:21](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/vesting/vestOther.ts#L21)* -Unlock any vested funds of the sender account. +Unlock any vested funds of a `target` account. **Parameters:** diff --git a/docs/modules/_util_constants_.md b/docs/modules/_util_constants_.md index b2213579..b0caa499 100644 --- a/docs/modules/_util_constants_.md +++ b/docs/modules/_util_constants_.md @@ -16,7 +16,7 @@ • **EXTRINSIC_VERSION**: *4* = 4 -*Defined in [src/util/constants.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/util/constants.ts#L13)* +*Defined in [src/util/constants.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/constants.ts#L13)* Latest extrinsic version. @@ -26,7 +26,7 @@ ___ • **KUSAMA_SS58_FORMAT**: *2* = 2 -*Defined in [src/util/constants.ts:4](https://github.com/paritytech/txwrapper/blob/79435da/src/util/constants.ts#L4)* +*Defined in [src/util/constants.ts:4](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/constants.ts#L4)* Prefix for SS58-encoded addresses on Kusama. @@ -36,6 +36,6 @@ ___ • **POLKADOT_SS58_FORMAT**: *0* = 0 -*Defined in [src/util/constants.ts:8](https://github.com/paritytech/txwrapper/blob/79435da/src/util/constants.ts#L8)* +*Defined in [src/util/constants.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/constants.ts#L8)* Prefix for SS58-encoded addresses on Polkadot. diff --git a/docs/modules/_util_registry_.md b/docs/modules/_util_registry_.md index 447c32e5..4bea95fb 100644 --- a/docs/modules/_util_registry_.md +++ b/docs/modules/_util_registry_.md @@ -14,7 +14,7 @@ ▸ **getRegistry**(`specName`: "kusama", `specVersion`: number): *TypeRegistry* -*Defined in [src/util/registry.ts:13](https://github.com/paritytech/txwrapper/blob/79435da/src/util/registry.ts#L13)* +*Defined in [src/util/registry.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/registry.ts#L13)* Create a specific TypeRegistry for a current chain. The reason we have this is, depending on different runtime versions, we have different types (e.g.: From 03b3d0e149ebfad8034e96647540365672fb1aee Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 15:18:54 +0100 Subject: [PATCH 09/12] Update src/methods/democracy/openProxy.ts Co-Authored-By: joe petrowski <25483142+joepetrowski@users.noreply.github.com> --- src/methods/democracy/openProxy.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/methods/democracy/openProxy.ts b/src/methods/democracy/openProxy.ts index 7f0cabe4..d52f619e 100644 --- a/src/methods/democracy/openProxy.ts +++ b/src/methods/democracy/openProxy.ts @@ -13,7 +13,7 @@ export interface DemocracyOpenProxyArgs extends Args { } /** - * Become a proxy. This must be called prior to a later `activate_proxy`. + * Become a proxy. This must be called prior to a later `activateProxy`. * * @param info - Information required to construct the transaction. */ From 2ef02a5ec4ec6f02fdeee68eec35b4efab09a544 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 15:19:52 +0100 Subject: [PATCH 10/12] Update src/methods/staking/setController.ts Co-Authored-By: joe petrowski <25483142+joepetrowski@users.noreply.github.com> --- src/methods/staking/setController.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/methods/staking/setController.ts b/src/methods/staking/setController.ts index 564fd9ac..2e89114f 100644 --- a/src/methods/staking/setController.ts +++ b/src/methods/staking/setController.ts @@ -13,7 +13,7 @@ export interface StakingSetControllerArgs extends Args { } /** - * (Re-)set the controller of a stash. Effects will be felt at the beginning o + * (Re-)set the controller of a stash. Effects will be felt at the beginning of * the next era. * * @param info - Information required to construct the transaction. From a7b5a5587d7b9bc7b30e6b1aa21529b751be24a6 Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 15:23:18 +0100 Subject: [PATCH 11/12] docs --- ..._balances_transfer_.balancestransferargs.md | 4 ++-- ...ctivateproxy_.democracyactivateproxyargs.md | 2 +- ...ivateproxy_.democracydeactivateproxyargs.md | 2 +- ...ocracy_openproxy_.democracyopenproxyargs.md | 2 +- ...ocracy_proxyvote_.democracyproxyvoteargs.md | 4 ++-- ...ethods_democracy_vote_.democracyvoteargs.md | 4 ++-- ...hods_session_setkeys_.sessionsetkeysargs.md | 4 ++-- .../_methods_staking_bond_.stakingbondargs.md | 6 +++--- ..._staking_bondextra_.stakingbondextraargs.md | 2 +- ...ds_staking_nominate_.stakingnominateargs.md | 2 +- ...outnominator_.stakingpayoutnominatorargs.md | 4 ++-- ...outvalidator_.stakingpayoutvalidatorargs.md | 2 +- ..._setcontroller_.stakingsetcontrollerargs.md | 2 +- ...ethods_staking_unbond_.stakingunbondargs.md | 2 +- ...ds_staking_validate_.stakingvalidateargs.md | 2 +- ..._vesting_vestother_.vestingvestotherargs.md | 2 +- docs/interfaces/_util_types_.basetxinfo.md | 18 +++++++++--------- .../_util_types_.unsignedtransaction.md | 2 +- docs/modules/_createsignedtx_.md | 2 +- docs/modules/_createsigningpayload_.md | 2 +- docs/modules/_decode_decode_.md | 6 +++--- docs/modules/_deriveaddress_.md | 2 +- docs/modules/_gettxhash_.md | 2 +- docs/modules/_importprivatekey_.md | 4 ++-- docs/modules/_methods_balances_transfer_.md | 2 +- .../_methods_balances_transferkeepalive_.md | 4 ++-- .../_methods_democracy_activateproxy_.md | 2 +- docs/modules/_methods_democracy_closeproxy_.md | 2 +- .../_methods_democracy_deactivateproxy_.md | 2 +- docs/modules/_methods_democracy_openproxy_.md | 4 ++-- docs/modules/_methods_democracy_proxyvote_.md | 2 +- docs/modules/_methods_democracy_types_.md | 2 +- docs/modules/_methods_democracy_vote_.md | 2 +- docs/modules/_methods_session_setkeys_.md | 2 +- docs/modules/_methods_staking_bond_.md | 2 +- docs/modules/_methods_staking_bondextra_.md | 2 +- docs/modules/_methods_staking_chill_.md | 2 +- docs/modules/_methods_staking_nominate_.md | 2 +- .../_methods_staking_payoutnominator_.md | 2 +- .../_methods_staking_payoutvalidator_.md | 2 +- .../modules/_methods_staking_setcontroller_.md | 4 ++-- docs/modules/_methods_staking_unbond_.md | 2 +- docs/modules/_methods_staking_validate_.md | 2 +- .../_methods_staking_withdrawunbonded_.md | 2 +- docs/modules/_methods_vesting_vest_.md | 2 +- docs/modules/_methods_vesting_vestother_.md | 2 +- docs/modules/_util_constants_.md | 6 +++--- docs/modules/_util_registry_.md | 2 +- 48 files changed, 71 insertions(+), 71 deletions(-) diff --git a/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md b/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md index 54eed8b4..cbed51a9 100644 --- a/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md +++ b/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md @@ -21,7 +21,7 @@ • **dest**: *string* -*Defined in [src/methods/balances/transfer.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/balances/transfer.ts#L12)* +*Defined in [src/methods/balances/transfer.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/methods/balances/transfer.ts#L16)* +*Defined in [src/methods/balances/transfer.ts:16](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/balances/transfer.ts#L16)* The amount to send. diff --git a/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md b/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md index 41662d7a..79d4b2dc 100644 --- a/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md +++ b/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md @@ -20,6 +20,6 @@ • **proxy**: *string* -*Defined in [src/methods/democracy/activateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/activateProxy.ts#L12)* +*Defined in [src/methods/democracy/activateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/activateProxy.ts#L12)* Address to set as proxy, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md b/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md index 4e24e941..dca59f02 100644 --- a/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md +++ b/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md @@ -20,6 +20,6 @@ • **proxy**: *string* -*Defined in [src/methods/democracy/deactivateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/deactivateProxy.ts#L12)* +*Defined in [src/methods/democracy/deactivateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/deactivateProxy.ts#L12)* The address of the proxy to remove, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md b/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md index 7343643b..2328aeb6 100644 --- a/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md +++ b/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md @@ -20,6 +20,6 @@ • **target**: *string* -*Defined in [src/methods/democracy/openProxy.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/openProxy.ts#L12)* +*Defined in [src/methods/democracy/openProxy.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/openProxy.ts#L12)* The address of the proxy to remove, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md b/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md index 1819f487..48457928 100644 --- a/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md +++ b/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md @@ -21,7 +21,7 @@ • **refIndex**: *number* -*Defined in [src/methods/democracy/proxyVote.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/proxyVote.ts#L13)* +*Defined in [src/methods/democracy/proxyVote.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/proxyVote.ts#L13)* ___ @@ -29,6 +29,6 @@ ___ • **vote**: *[Vote](../modules/_methods_democracy_types_.md#vote)* -*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/proxyVote.ts#L18)* +*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/proxyVote.ts#L18)* Vote diff --git a/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md b/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md index d441d4da..6fc39b65 100644 --- a/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md +++ b/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md @@ -21,7 +21,7 @@ • **refIndex**: *number* -*Defined in [src/methods/democracy/vote.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/vote.ts#L13)* +*Defined in [src/methods/democracy/vote.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/vote.ts#L13)* ___ @@ -29,6 +29,6 @@ ___ • **vote**: *[Vote](../modules/_methods_democracy_types_.md#vote)* -*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/vote.ts#L18)* +*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/vote.ts#L18)* Vote diff --git a/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md b/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md index 9474bb9f..e2155e92 100644 --- a/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md +++ b/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md @@ -21,7 +21,7 @@ • **keys**: *string[]* -*Defined in [src/methods/session/setKeys.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/session/setKeys.ts#L12)* +*Defined in [src/methods/session/setKeys.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/session/setKeys.ts#L12)* The 5 keys to set. @@ -31,6 +31,6 @@ ___ • **proof**? : *undefined | string* -*Defined in [src/methods/session/setKeys.ts:16](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/session/setKeys.ts#L16)* +*Defined in [src/methods/session/setKeys.ts:16](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/session/setKeys.ts#L16)* Proof (unused for now). diff --git a/docs/interfaces/_methods_staking_bond_.stakingbondargs.md b/docs/interfaces/_methods_staking_bond_.stakingbondargs.md index 7b09d8b6..f1fa51eb 100644 --- a/docs/interfaces/_methods_staking_bond_.stakingbondargs.md +++ b/docs/interfaces/_methods_staking_bond_.stakingbondargs.md @@ -22,7 +22,7 @@ • **controller**: *string* -*Defined in [src/methods/staking/bond.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/bond.ts#L12)* +*Defined in [src/methods/staking/bond.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/methods/staking/bond.ts#L20)* +*Defined in [src/methods/staking/bond.ts:20](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/methods/staking/bond.ts#L16)* +*Defined in [src/methods/staking/bond.ts:16](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/bond.ts#L16)* The number of tokens to bond. diff --git a/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md b/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md index 298ed4d0..9cabb65b 100644 --- a/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md +++ b/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md @@ -20,6 +20,6 @@ • **maxAdditional**: *number* -*Defined in [src/methods/staking/bondExtra.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/bondExtra.ts#L12)* +*Defined in [src/methods/staking/bondExtra.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/bondExtra.ts#L12)* The maximum amount to bond. diff --git a/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md b/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md index 42725ed0..f8bdfadf 100644 --- a/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md +++ b/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md @@ -20,7 +20,7 @@ • **targets**: *Array‹string›* -*Defined in [src/methods/staking/nominate.ts:15](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/nominate.ts#L15)* +*Defined in [src/methods/staking/nominate.ts:15](https://github.com/paritytech/txwrapper/blob/2ef02a5/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. diff --git a/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md b/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md index b204e396..615d1e72 100644 --- a/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md +++ b/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md @@ -21,7 +21,7 @@ • **era**: *number* -*Defined in [src/methods/staking/payoutNominator.ts:14](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutNominator.ts#L14)* +*Defined in [src/methods/staking/payoutNominator.ts:14](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutNominator.ts#L14)* 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 @@ -33,7 +33,7 @@ ___ • **validators**: *[string, number][]* -*Defined in [src/methods/staking/payoutNominator.ts:20](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutNominator.ts#L20)* +*Defined in [src/methods/staking/payoutNominator.ts:20](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutNominator.ts#L20)* List of all validators that `who` had exposure to during `era`. If it is incomplete, then less than the full reward will be paid out. It must not diff --git a/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md b/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md index 6b5bdd84..deec51c8 100644 --- a/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md +++ b/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md @@ -20,7 +20,7 @@ • **era**: *number* -*Defined in [src/methods/staking/payoutValidator.ts:14](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutValidator.ts#L14)* +*Defined in [src/methods/staking/payoutValidator.ts:14](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutValidator.ts#L14)* 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 diff --git a/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md b/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md index e009688a..1329a178 100644 --- a/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md +++ b/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md @@ -20,6 +20,6 @@ • **controller**: *string* -*Defined in [src/methods/staking/setController.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/setController.ts#L12)* +*Defined in [src/methods/staking/setController.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/setController.ts#L12)* The SS-58 encoded controller address. diff --git a/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md b/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md index 2d88fefe..bcd66a40 100644 --- a/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md +++ b/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md @@ -20,6 +20,6 @@ • **value**: *number* -*Defined in [src/methods/staking/unbond.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/unbond.ts#L12)* +*Defined in [src/methods/staking/unbond.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/unbond.ts#L12)* The number of tokens to unbond. diff --git a/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md b/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md index fddff34e..e756f7a9 100644 --- a/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md +++ b/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md @@ -20,7 +20,7 @@ • **prefs**: *object* -*Defined in [src/methods/staking/validate.ts:12](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/validate.ts#L12)* +*Defined in [src/methods/staking/validate.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/validate.ts#L12)* Set the desired commission for the validator. Value is Perbill. diff --git a/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md b/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md index c10c9eff..aed85e8d 100644 --- a/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md +++ b/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md @@ -20,7 +20,7 @@ • **target**: *string* -*Defined in [src/methods/vesting/vestOther.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/vesting/vestOther.ts#L13)* +*Defined in [src/methods/vesting/vestOther.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/vesting/vestOther.ts#L13)* The account whose vested funds should be unlocked. Must have funds still locked under this module. diff --git a/docs/interfaces/_util_types_.basetxinfo.md b/docs/interfaces/_util_types_.basetxinfo.md index 0dc6ab5e..80ccbb70 100644 --- a/docs/interfaces/_util_types_.basetxinfo.md +++ b/docs/interfaces/_util_types_.basetxinfo.md @@ -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/562ba6e/src/util/types.ts#L21)* +*Defined in [src/util/types.ts:21](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/util/types.ts#L25)* +*Defined in [src/util/types.ts:25](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/util/types.ts#L29)* +*Defined in [src/util/types.ts:29](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/util/types.ts#L33)* +*Defined in [src/util/types.ts:33](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/util/types.ts#L38)* +*Defined in [src/util/types.ts:38](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/util/types.ts#L42)* +*Defined in [src/util/types.ts:42](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/util/types.ts#L46)* +*Defined in [src/util/types.ts:46](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/types.ts#L46)* The current spec version for the runtime. @@ -99,7 +99,7 @@ ___ • **tip**? : *undefined | number* -*Defined in [src/util/types.ts:52](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/types.ts#L52)* +*Defined in [src/util/types.ts:52](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/types.ts#L52)* The tip for this transaction, in hex. @@ -111,7 +111,7 @@ ___ • **validityPeriod**? : *undefined | number* -*Defined in [src/util/types.ts:59](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/types.ts#L59)* +*Defined in [src/util/types.ts:59](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/types.ts#L59)* The amount of time (in second) the transaction is valid for. Will be translated into a mortal era. Defaults to 5 minutes. diff --git a/docs/interfaces/_util_types_.unsignedtransaction.md b/docs/interfaces/_util_types_.unsignedtransaction.md index 78242156..912adace 100644 --- a/docs/interfaces/_util_types_.unsignedtransaction.md +++ b/docs/interfaces/_util_types_.unsignedtransaction.md @@ -92,7 +92,7 @@ ___ • **metadataRpc**: *string* -*Defined in [src/util/types.ts:11](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/types.ts#L11)* +*Defined in [src/util/types.ts:11](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/types.ts#L11)* The SCALE-encoded metadata, as a hex string. Can be retrieved via the RPC call `state_getMetadata`. diff --git a/docs/modules/_createsignedtx_.md b/docs/modules/_createsignedtx_.md index d7d1f8cc..f48f7014 100644 --- a/docs/modules/_createsignedtx_.md +++ b/docs/modules/_createsignedtx_.md @@ -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/562ba6e/src/createSignedTx.ts#L14)* +*Defined in [src/createSignedTx.ts:14](https://github.com/paritytech/txwrapper/blob/2ef02a5/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 diff --git a/docs/modules/_createsigningpayload_.md b/docs/modules/_createsigningpayload_.md index 6b1bca85..782cdb57 100644 --- a/docs/modules/_createsigningpayload_.md +++ b/docs/modules/_createsigningpayload_.md @@ -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/562ba6e/src/createSigningPayload.ts#L11)* +*Defined in [src/createSigningPayload.ts:11](https://github.com/paritytech/txwrapper/blob/2ef02a5/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"). diff --git a/docs/modules/_decode_decode_.md b/docs/modules/_decode_decode_.md index 4a5f0c39..afd07977 100644 --- a/docs/modules/_decode_decode_.md +++ b/docs/modules/_decode_decode_.md @@ -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/562ba6e/src/decode/decode.ts#L18)* +*Defined in [src/decode/decode.ts:18](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/decode/decode.ts#L32)* +*Defined in [src/decode/decode.ts:32](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/decode/decode.ts#L46)* +*Defined in [src/decode/decode.ts:46](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/decode/decode.ts#L46)* Parse the transaction information from a signing payload, an unsigned tx, or a signed tx. diff --git a/docs/modules/_deriveaddress_.md b/docs/modules/_deriveaddress_.md index 4b5cd76a..59da22ef 100644 --- a/docs/modules/_deriveaddress_.md +++ b/docs/modules/_deriveaddress_.md @@ -14,7 +14,7 @@ ▸ **deriveAddress**(`publicKey`: string | Uint8Array, `ss58Format`: number): *string* -*Defined in [src/deriveAddress.ts:11](https://github.com/paritytech/txwrapper/blob/562ba6e/src/deriveAddress.ts#L11)* +*Defined in [src/deriveAddress.ts:11](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/deriveAddress.ts#L11)* Derive an address from a cryptographic public key offline. diff --git a/docs/modules/_gettxhash_.md b/docs/modules/_gettxhash_.md index a318902d..e8e26b27 100644 --- a/docs/modules/_gettxhash_.md +++ b/docs/modules/_gettxhash_.md @@ -14,7 +14,7 @@ ▸ **getTxHash**(`signedTx`: string): *string* -*Defined in [src/getTxHash.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/getTxHash.ts#L8)* +*Defined in [src/getTxHash.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/getTxHash.ts#L8)* Derive the tx hash of a signed transaction offline. diff --git a/docs/modules/_importprivatekey_.md b/docs/modules/_importprivatekey_.md index cbae5065..1c03c451 100644 --- a/docs/modules/_importprivatekey_.md +++ b/docs/modules/_importprivatekey_.md @@ -18,7 +18,7 @@ Ƭ **KeyringPair**: *KeyringPairBase* -*Defined in [src/importPrivateKey.ts:10](https://github.com/paritytech/txwrapper/blob/562ba6e/src/importPrivateKey.ts#L10)* +*Defined in [src/importPrivateKey.ts:10](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/importPrivateKey.ts#L18)* +*Defined in [src/importPrivateKey.ts:18](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/importPrivateKey.ts#L18)* Import a private key and create a KeyringPair. diff --git a/docs/modules/_methods_balances_transfer_.md b/docs/modules/_methods_balances_transfer_.md index 489aa93c..1a3ae5d7 100644 --- a/docs/modules/_methods_balances_transfer_.md +++ b/docs/modules/_methods_balances_transfer_.md @@ -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/562ba6e/src/methods/balances/transfer.ts#L24)* +*Defined in [src/methods/balances/transfer.ts:24](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/balances/transfer.ts#L24)* Construct a balance transfer transaction offline. diff --git a/docs/modules/_methods_balances_transferkeepalive_.md b/docs/modules/_methods_balances_transferkeepalive_.md index 1d162abf..fd7b316a 100644 --- a/docs/modules/_methods_balances_transferkeepalive_.md +++ b/docs/modules/_methods_balances_transferkeepalive_.md @@ -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/562ba6e/src/methods/balances/transferKeepAlive.ts#L4)* +*Defined in [src/methods/balances/transferKeepAlive.ts:4](https://github.com/paritytech/txwrapper/blob/2ef02a5/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/562ba6e/src/methods/balances/transferKeepAlive.ts#L11)* +*Defined in [src/methods/balances/transferKeepAlive.ts:11](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/balances/transferKeepAlive.ts#L11)* Construct a balance transfer transaction offline. diff --git a/docs/modules/_methods_democracy_activateproxy_.md b/docs/modules/_methods_democracy_activateproxy_.md index da465e00..515bac92 100644 --- a/docs/modules/_methods_democracy_activateproxy_.md +++ b/docs/modules/_methods_democracy_activateproxy_.md @@ -18,7 +18,7 @@ ▸ **activateProxy**(`args`: [DemocracyActivateProxyArgs](../interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/activateProxy.ts:20](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/activateProxy.ts#L20)* +*Defined in [src/methods/democracy/activateProxy.ts:20](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/activateProxy.ts#L20)* Specify a proxy that is already open to us. Called by the stash. diff --git a/docs/modules/_methods_democracy_closeproxy_.md b/docs/modules/_methods_democracy_closeproxy_.md index 98ccb516..ccbacd3a 100644 --- a/docs/modules/_methods_democracy_closeproxy_.md +++ b/docs/modules/_methods_democracy_closeproxy_.md @@ -14,7 +14,7 @@ ▸ **closeProxy**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/closeProxy.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/closeProxy.ts#L8)* +*Defined in [src/methods/democracy/closeProxy.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/closeProxy.ts#L8)* Clear the proxy. Called by the proxy. diff --git a/docs/modules/_methods_democracy_deactivateproxy_.md b/docs/modules/_methods_democracy_deactivateproxy_.md index cf3d527e..530ca035 100644 --- a/docs/modules/_methods_democracy_deactivateproxy_.md +++ b/docs/modules/_methods_democracy_deactivateproxy_.md @@ -18,7 +18,7 @@ ▸ **deactivateProxy**(`args`: [DemocracyDeactivateProxyArgs](../interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/deactivateProxy.ts:21](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/deactivateProxy.ts#L21)* +*Defined in [src/methods/democracy/deactivateProxy.ts:21](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/deactivateProxy.ts#L21)* Deactivate the proxy, but leave open to this account. Called by the stash. The proxy must already be active. diff --git a/docs/modules/_methods_democracy_openproxy_.md b/docs/modules/_methods_democracy_openproxy_.md index 34bceca9..532854fc 100644 --- a/docs/modules/_methods_democracy_openproxy_.md +++ b/docs/modules/_methods_democracy_openproxy_.md @@ -18,9 +18,9 @@ ▸ **openProxy**(`args`: [DemocracyOpenProxyArgs](../interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/openProxy.ts:20](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/openProxy.ts#L20)* +*Defined in [src/methods/democracy/openProxy.ts:20](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/openProxy.ts#L20)* -Become a proxy. This must be called prior to a later `activate_proxy`. +Become a proxy. This must be called prior to a later `activateProxy`. **Parameters:** diff --git a/docs/modules/_methods_democracy_proxyvote_.md b/docs/modules/_methods_democracy_proxyvote_.md index d6c669e7..b9e7b7c5 100644 --- a/docs/modules/_methods_democracy_proxyvote_.md +++ b/docs/modules/_methods_democracy_proxyvote_.md @@ -18,7 +18,7 @@ ▸ **proxyVote**(`args`: [DemocracyProxyVoteArgs](../interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/proxyVote.ts:26](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/proxyVote.ts#L26)* +*Defined in [src/methods/democracy/proxyVote.ts:26](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/proxyVote.ts#L26)* Vote in a referendum on behalf of a stash. diff --git a/docs/modules/_methods_democracy_types_.md b/docs/modules/_methods_democracy_types_.md index 89736ef7..98066b18 100644 --- a/docs/modules/_methods_democracy_types_.md +++ b/docs/modules/_methods_democracy_types_.md @@ -14,7 +14,7 @@ Ƭ **Vote**: *object* -*Defined in [src/methods/democracy/types.ts:4](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/types.ts#L4)* +*Defined in [src/methods/democracy/types.ts:4](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/types.ts#L4)* A vote in a referendum diff --git a/docs/modules/_methods_democracy_vote_.md b/docs/modules/_methods_democracy_vote_.md index d309fb98..4617e315 100644 --- a/docs/modules/_methods_democracy_vote_.md +++ b/docs/modules/_methods_democracy_vote_.md @@ -18,7 +18,7 @@ ▸ **vote**(`args`: [DemocracyVoteArgs](../interfaces/_methods_democracy_vote_.democracyvoteargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/vote.ts:26](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/democracy/vote.ts#L26)* +*Defined in [src/methods/democracy/vote.ts:26](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/vote.ts#L26)* Vote in a referendum. diff --git a/docs/modules/_methods_session_setkeys_.md b/docs/modules/_methods_session_setkeys_.md index da069832..0076fa49 100644 --- a/docs/modules/_methods_session_setkeys_.md +++ b/docs/modules/_methods_session_setkeys_.md @@ -18,7 +18,7 @@ ▸ **setKeys**(`args`: [SessionSetKeysArgs](../interfaces/_methods_session_setkeys_.sessionsetkeysargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/session/setKeys.ts:24](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/session/setKeys.ts#L24)* +*Defined in [src/methods/session/setKeys.ts:24](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/session/setKeys.ts#L24)* Sets the session key(s) of the function caller to `key`. diff --git a/docs/modules/_methods_staking_bond_.md b/docs/modules/_methods_staking_bond_.md index 91a4cce5..932549f9 100644 --- a/docs/modules/_methods_staking_bond_.md +++ b/docs/modules/_methods_staking_bond_.md @@ -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/562ba6e/src/methods/staking/bond.ts#L28)* +*Defined in [src/methods/staking/bond.ts:28](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/bond.ts#L28)* Construct a transaction to bond funds and create a Stash account. diff --git a/docs/modules/_methods_staking_bondextra_.md b/docs/modules/_methods_staking_bondextra_.md index 6c67631b..812865d7 100644 --- a/docs/modules/_methods_staking_bondextra_.md +++ b/docs/modules/_methods_staking_bondextra_.md @@ -18,7 +18,7 @@ ▸ **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/paritytech/txwrapper/blob/562ba6e/src/methods/staking/bondExtra.ts#L21)* +*Defined in [src/methods/staking/bondExtra.ts:21](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/bondExtra.ts#L21)* Add some extra amount that have appeared in the stash `free_balance` into the balance up for staking. diff --git a/docs/modules/_methods_staking_chill_.md b/docs/modules/_methods_staking_chill_.md index d51dc631..32c2fde2 100644 --- a/docs/modules/_methods_staking_chill_.md +++ b/docs/modules/_methods_staking_chill_.md @@ -14,7 +14,7 @@ ▸ **chill**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/chill.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/chill.ts#L8)* +*Defined in [src/methods/staking/chill.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/chill.ts#L8)* Declare the desire to cease validating or nominating. Does not unbond funds. diff --git a/docs/modules/_methods_staking_nominate_.md b/docs/modules/_methods_staking_nominate_.md index f82047a8..c827f293 100644 --- a/docs/modules/_methods_staking_nominate_.md +++ b/docs/modules/_methods_staking_nominate_.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/562ba6e/src/methods/staking/nominate.ts#L23)* +*Defined in [src/methods/staking/nominate.ts:23](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/nominate.ts#L23)* Construct a transaction to nominate. This must be called by the _Controller_ account. diff --git a/docs/modules/_methods_staking_payoutnominator_.md b/docs/modules/_methods_staking_payoutnominator_.md index 3ddf217e..5d6560b8 100644 --- a/docs/modules/_methods_staking_payoutnominator_.md +++ b/docs/modules/_methods_staking_payoutnominator_.md @@ -18,7 +18,7 @@ ▸ **payoutNominator**(`args`: [StakingPayoutNominatorArgs](../interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/payoutNominator.ts:31](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutNominator.ts#L31)* +*Defined in [src/methods/staking/payoutNominator.ts:31](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutNominator.ts#L31)* Make one nominator's payout for one era. WARNING: once an era is payed for a validator such validator can't claim the diff --git a/docs/modules/_methods_staking_payoutvalidator_.md b/docs/modules/_methods_staking_payoutvalidator_.md index 43d11ac1..d00ed180 100644 --- a/docs/modules/_methods_staking_payoutvalidator_.md +++ b/docs/modules/_methods_staking_payoutvalidator_.md @@ -18,7 +18,7 @@ ▸ **payoutValidator**(`args`: [StakingPayoutValidatorArgs](../interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/payoutValidator.ts:25](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/payoutValidator.ts#L25)* +*Defined in [src/methods/staking/payoutValidator.ts:25](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutValidator.ts#L25)* Make one validator's payout for one era. WARNING: once an era is payed for a validator such validator can't claim the diff --git a/docs/modules/_methods_staking_setcontroller_.md b/docs/modules/_methods_staking_setcontroller_.md index b6e52c4f..867d3471 100644 --- a/docs/modules/_methods_staking_setcontroller_.md +++ b/docs/modules/_methods_staking_setcontroller_.md @@ -18,9 +18,9 @@ ▸ **setController**(`args`: [StakingSetControllerArgs](../interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/setController.ts:21](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/setController.ts#L21)* +*Defined in [src/methods/staking/setController.ts:21](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/setController.ts#L21)* -(Re-)set the controller of a stash. Effects will be felt at the beginning o +(Re-)set the controller of a stash. Effects will be felt at the beginning of the next era. **Parameters:** diff --git a/docs/modules/_methods_staking_unbond_.md b/docs/modules/_methods_staking_unbond_.md index d78c3ac8..6f8d7b0d 100644 --- a/docs/modules/_methods_staking_unbond_.md +++ b/docs/modules/_methods_staking_unbond_.md @@ -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/562ba6e/src/methods/staking/unbond.ts#L21)* +*Defined in [src/methods/staking/unbond.ts:21](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/unbond.ts#L21)* Construct a transaction to unbond funds from a Stash account. This must be called by the _Controller_ account. diff --git a/docs/modules/_methods_staking_validate_.md b/docs/modules/_methods_staking_validate_.md index 3ab7450d..4ff900f2 100644 --- a/docs/modules/_methods_staking_validate_.md +++ b/docs/modules/_methods_staking_validate_.md @@ -18,7 +18,7 @@ ▸ **validate**(`args`: [StakingValidateArgs](../interfaces/_methods_staking_validate_.stakingvalidateargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/validate.ts:22](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/validate.ts#L22)* +*Defined in [src/methods/staking/validate.ts:22](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/validate.ts#L22)* Declare the desire to validate for the origin controller. diff --git a/docs/modules/_methods_staking_withdrawunbonded_.md b/docs/modules/_methods_staking_withdrawunbonded_.md index 202a65eb..76ffade7 100644 --- a/docs/modules/_methods_staking_withdrawunbonded_.md +++ b/docs/modules/_methods_staking_withdrawunbonded_.md @@ -14,7 +14,7 @@ ▸ **withdrawUnbonded**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/withdrawUnbonded.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/staking/withdrawUnbonded.ts#L8)* +*Defined in [src/methods/staking/withdrawUnbonded.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/withdrawUnbonded.ts#L8)* Remove any unlocked chunks from the `unlocking` queue from our management. diff --git a/docs/modules/_methods_vesting_vest_.md b/docs/modules/_methods_vesting_vest_.md index c4475b73..7910b6bf 100644 --- a/docs/modules/_methods_vesting_vest_.md +++ b/docs/modules/_methods_vesting_vest_.md @@ -14,7 +14,7 @@ ▸ **vest**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/vesting/vest.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/vesting/vest.ts#L8)* +*Defined in [src/methods/vesting/vest.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/vesting/vest.ts#L8)* Unlock any vested funds of the sender account. diff --git a/docs/modules/_methods_vesting_vestother_.md b/docs/modules/_methods_vesting_vestother_.md index 102727a8..42b563ab 100644 --- a/docs/modules/_methods_vesting_vestother_.md +++ b/docs/modules/_methods_vesting_vestother_.md @@ -18,7 +18,7 @@ ▸ **vestOther**(`args`: [VestingVestOtherArgs](../interfaces/_methods_vesting_vestother_.vestingvestotherargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/vesting/vestOther.ts:21](https://github.com/paritytech/txwrapper/blob/562ba6e/src/methods/vesting/vestOther.ts#L21)* +*Defined in [src/methods/vesting/vestOther.ts:21](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/vesting/vestOther.ts#L21)* Unlock any vested funds of a `target` account. diff --git a/docs/modules/_util_constants_.md b/docs/modules/_util_constants_.md index b0caa499..edac67d3 100644 --- a/docs/modules/_util_constants_.md +++ b/docs/modules/_util_constants_.md @@ -16,7 +16,7 @@ • **EXTRINSIC_VERSION**: *4* = 4 -*Defined in [src/util/constants.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/constants.ts#L13)* +*Defined in [src/util/constants.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/constants.ts#L13)* Latest extrinsic version. @@ -26,7 +26,7 @@ ___ • **KUSAMA_SS58_FORMAT**: *2* = 2 -*Defined in [src/util/constants.ts:4](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/constants.ts#L4)* +*Defined in [src/util/constants.ts:4](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/constants.ts#L4)* Prefix for SS58-encoded addresses on Kusama. @@ -36,6 +36,6 @@ ___ • **POLKADOT_SS58_FORMAT**: *0* = 0 -*Defined in [src/util/constants.ts:8](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/constants.ts#L8)* +*Defined in [src/util/constants.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/constants.ts#L8)* Prefix for SS58-encoded addresses on Polkadot. diff --git a/docs/modules/_util_registry_.md b/docs/modules/_util_registry_.md index 4bea95fb..5015f707 100644 --- a/docs/modules/_util_registry_.md +++ b/docs/modules/_util_registry_.md @@ -14,7 +14,7 @@ ▸ **getRegistry**(`specName`: "kusama", `specVersion`: number): *TypeRegistry* -*Defined in [src/util/registry.ts:13](https://github.com/paritytech/txwrapper/blob/562ba6e/src/util/registry.ts#L13)* +*Defined in [src/util/registry.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/registry.ts#L13)* Create a specific TypeRegistry for a current chain. The reason we have this is, depending on different runtime versions, we have different types (e.g.: From c40a0e3eee2fe6dc768fc1d09e8c76ec857ab1ff Mon Sep 17 00:00:00 2001 From: Amaury Martiny Date: Tue, 10 Mar 2020 15:26:17 +0100 Subject: [PATCH 12/12] docs (again) --- ..._balances_transfer_.balancestransferargs.md | 4 ++-- ...ctivateproxy_.democracyactivateproxyargs.md | 2 +- ...ivateproxy_.democracydeactivateproxyargs.md | 2 +- ...ocracy_openproxy_.democracyopenproxyargs.md | 2 +- ...ocracy_proxyvote_.democracyproxyvoteargs.md | 4 ++-- ...ethods_democracy_vote_.democracyvoteargs.md | 4 ++-- ...hods_session_setkeys_.sessionsetkeysargs.md | 4 ++-- .../_methods_staking_bond_.stakingbondargs.md | 6 +++--- ..._staking_bondextra_.stakingbondextraargs.md | 2 +- ...ds_staking_nominate_.stakingnominateargs.md | 2 +- ...outnominator_.stakingpayoutnominatorargs.md | 4 ++-- ...outvalidator_.stakingpayoutvalidatorargs.md | 2 +- ..._setcontroller_.stakingsetcontrollerargs.md | 2 +- ...ethods_staking_unbond_.stakingunbondargs.md | 2 +- ...ds_staking_validate_.stakingvalidateargs.md | 2 +- ..._vesting_vestother_.vestingvestotherargs.md | 2 +- docs/interfaces/_util_types_.basetxinfo.md | 18 +++++++++--------- .../_util_types_.unsignedtransaction.md | 2 +- docs/modules/_createsignedtx_.md | 2 +- docs/modules/_createsigningpayload_.md | 2 +- docs/modules/_decode_decode_.md | 6 +++--- docs/modules/_deriveaddress_.md | 2 +- docs/modules/_gettxhash_.md | 2 +- docs/modules/_importprivatekey_.md | 4 ++-- docs/modules/_methods_balances_transfer_.md | 2 +- .../_methods_balances_transferkeepalive_.md | 4 ++-- .../_methods_democracy_activateproxy_.md | 2 +- docs/modules/_methods_democracy_closeproxy_.md | 2 +- .../_methods_democracy_deactivateproxy_.md | 2 +- docs/modules/_methods_democracy_openproxy_.md | 2 +- docs/modules/_methods_democracy_proxyvote_.md | 2 +- docs/modules/_methods_democracy_types_.md | 2 +- docs/modules/_methods_democracy_vote_.md | 2 +- docs/modules/_methods_session_setkeys_.md | 2 +- docs/modules/_methods_staking_bond_.md | 2 +- docs/modules/_methods_staking_bondextra_.md | 2 +- docs/modules/_methods_staking_chill_.md | 2 +- docs/modules/_methods_staking_nominate_.md | 2 +- .../_methods_staking_payoutnominator_.md | 2 +- .../_methods_staking_payoutvalidator_.md | 2 +- .../modules/_methods_staking_setcontroller_.md | 2 +- docs/modules/_methods_staking_unbond_.md | 2 +- docs/modules/_methods_staking_validate_.md | 2 +- .../_methods_staking_withdrawunbonded_.md | 2 +- docs/modules/_methods_vesting_vest_.md | 2 +- docs/modules/_methods_vesting_vestother_.md | 2 +- docs/modules/_util_constants_.md | 6 +++--- docs/modules/_util_registry_.md | 2 +- 48 files changed, 69 insertions(+), 69 deletions(-) diff --git a/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md b/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md index cbed51a9..198c980e 100644 --- a/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md +++ b/docs/interfaces/_methods_balances_transfer_.balancestransferargs.md @@ -21,7 +21,7 @@ • **dest**: *string* -*Defined in [src/methods/balances/transfer.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/balances/transfer.ts#L12)* +*Defined in [src/methods/balances/transfer.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/methods/balances/transfer.ts#L16)* +*Defined in [src/methods/balances/transfer.ts:16](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/balances/transfer.ts#L16)* The amount to send. diff --git a/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md b/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md index 79d4b2dc..a1af30c8 100644 --- a/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md +++ b/docs/interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md @@ -20,6 +20,6 @@ • **proxy**: *string* -*Defined in [src/methods/democracy/activateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/activateProxy.ts#L12)* +*Defined in [src/methods/democracy/activateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/activateProxy.ts#L12)* Address to set as proxy, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md b/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md index dca59f02..9b98f11a 100644 --- a/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md +++ b/docs/interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md @@ -20,6 +20,6 @@ • **proxy**: *string* -*Defined in [src/methods/democracy/deactivateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/deactivateProxy.ts#L12)* +*Defined in [src/methods/democracy/deactivateProxy.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/deactivateProxy.ts#L12)* The address of the proxy to remove, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md b/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md index 2328aeb6..45ad1eaf 100644 --- a/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md +++ b/docs/interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md @@ -20,6 +20,6 @@ • **target**: *string* -*Defined in [src/methods/democracy/openProxy.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/openProxy.ts#L12)* +*Defined in [src/methods/democracy/openProxy.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/openProxy.ts#L12)* The address of the proxy to remove, SS-58 encoded. diff --git a/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md b/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md index 48457928..2044d5e4 100644 --- a/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md +++ b/docs/interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md @@ -21,7 +21,7 @@ • **refIndex**: *number* -*Defined in [src/methods/democracy/proxyVote.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/proxyVote.ts#L13)* +*Defined in [src/methods/democracy/proxyVote.ts:13](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/proxyVote.ts#L13)* ___ @@ -29,6 +29,6 @@ ___ • **vote**: *[Vote](../modules/_methods_democracy_types_.md#vote)* -*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/proxyVote.ts#L18)* +*Defined in [src/methods/democracy/proxyVote.ts:18](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/proxyVote.ts#L18)* Vote diff --git a/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md b/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md index 6fc39b65..74cb9cb3 100644 --- a/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md +++ b/docs/interfaces/_methods_democracy_vote_.democracyvoteargs.md @@ -21,7 +21,7 @@ • **refIndex**: *number* -*Defined in [src/methods/democracy/vote.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/vote.ts#L13)* +*Defined in [src/methods/democracy/vote.ts:13](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/vote.ts#L13)* ___ @@ -29,6 +29,6 @@ ___ • **vote**: *[Vote](../modules/_methods_democracy_types_.md#vote)* -*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/vote.ts#L18)* +*Defined in [src/methods/democracy/vote.ts:18](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/vote.ts#L18)* Vote diff --git a/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md b/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md index e2155e92..985a8a36 100644 --- a/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md +++ b/docs/interfaces/_methods_session_setkeys_.sessionsetkeysargs.md @@ -21,7 +21,7 @@ • **keys**: *string[]* -*Defined in [src/methods/session/setKeys.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/session/setKeys.ts#L12)* +*Defined in [src/methods/session/setKeys.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/session/setKeys.ts#L12)* The 5 keys to set. @@ -31,6 +31,6 @@ ___ • **proof**? : *undefined | string* -*Defined in [src/methods/session/setKeys.ts:16](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/session/setKeys.ts#L16)* +*Defined in [src/methods/session/setKeys.ts:16](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/session/setKeys.ts#L16)* Proof (unused for now). diff --git a/docs/interfaces/_methods_staking_bond_.stakingbondargs.md b/docs/interfaces/_methods_staking_bond_.stakingbondargs.md index f1fa51eb..8e0885ea 100644 --- a/docs/interfaces/_methods_staking_bond_.stakingbondargs.md +++ b/docs/interfaces/_methods_staking_bond_.stakingbondargs.md @@ -22,7 +22,7 @@ • **controller**: *string* -*Defined in [src/methods/staking/bond.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/bond.ts#L12)* +*Defined in [src/methods/staking/bond.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/methods/staking/bond.ts#L20)* +*Defined in [src/methods/staking/bond.ts:20](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/methods/staking/bond.ts#L16)* +*Defined in [src/methods/staking/bond.ts:16](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/bond.ts#L16)* The number of tokens to bond. diff --git a/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md b/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md index 9cabb65b..bb10c8e8 100644 --- a/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md +++ b/docs/interfaces/_methods_staking_bondextra_.stakingbondextraargs.md @@ -20,6 +20,6 @@ • **maxAdditional**: *number* -*Defined in [src/methods/staking/bondExtra.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/bondExtra.ts#L12)* +*Defined in [src/methods/staking/bondExtra.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/bondExtra.ts#L12)* The maximum amount to bond. diff --git a/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md b/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md index f8bdfadf..28590f18 100644 --- a/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md +++ b/docs/interfaces/_methods_staking_nominate_.stakingnominateargs.md @@ -20,7 +20,7 @@ • **targets**: *Array‹string›* -*Defined in [src/methods/staking/nominate.ts:15](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/nominate.ts#L15)* +*Defined in [src/methods/staking/nominate.ts:15](https://github.com/paritytech/txwrapper/blob/a7b5a55/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. diff --git a/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md b/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md index 615d1e72..cb2d13fd 100644 --- a/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md +++ b/docs/interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md @@ -21,7 +21,7 @@ • **era**: *number* -*Defined in [src/methods/staking/payoutNominator.ts:14](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutNominator.ts#L14)* +*Defined in [src/methods/staking/payoutNominator.ts:14](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/payoutNominator.ts#L14)* 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 @@ -33,7 +33,7 @@ ___ • **validators**: *[string, number][]* -*Defined in [src/methods/staking/payoutNominator.ts:20](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutNominator.ts#L20)* +*Defined in [src/methods/staking/payoutNominator.ts:20](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/payoutNominator.ts#L20)* List of all validators that `who` had exposure to during `era`. If it is incomplete, then less than the full reward will be paid out. It must not diff --git a/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md b/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md index deec51c8..7449fe62 100644 --- a/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md +++ b/docs/interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md @@ -20,7 +20,7 @@ • **era**: *number* -*Defined in [src/methods/staking/payoutValidator.ts:14](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutValidator.ts#L14)* +*Defined in [src/methods/staking/payoutValidator.ts:14](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/payoutValidator.ts#L14)* 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 diff --git a/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md b/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md index 1329a178..a58b9103 100644 --- a/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md +++ b/docs/interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md @@ -20,6 +20,6 @@ • **controller**: *string* -*Defined in [src/methods/staking/setController.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/setController.ts#L12)* +*Defined in [src/methods/staking/setController.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/setController.ts#L12)* The SS-58 encoded controller address. diff --git a/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md b/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md index bcd66a40..b426cff0 100644 --- a/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md +++ b/docs/interfaces/_methods_staking_unbond_.stakingunbondargs.md @@ -20,6 +20,6 @@ • **value**: *number* -*Defined in [src/methods/staking/unbond.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/unbond.ts#L12)* +*Defined in [src/methods/staking/unbond.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/unbond.ts#L12)* The number of tokens to unbond. diff --git a/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md b/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md index e756f7a9..a62fc035 100644 --- a/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md +++ b/docs/interfaces/_methods_staking_validate_.stakingvalidateargs.md @@ -20,7 +20,7 @@ • **prefs**: *object* -*Defined in [src/methods/staking/validate.ts:12](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/validate.ts#L12)* +*Defined in [src/methods/staking/validate.ts:12](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/validate.ts#L12)* Set the desired commission for the validator. Value is Perbill. diff --git a/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md b/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md index aed85e8d..559853a7 100644 --- a/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md +++ b/docs/interfaces/_methods_vesting_vestother_.vestingvestotherargs.md @@ -20,7 +20,7 @@ • **target**: *string* -*Defined in [src/methods/vesting/vestOther.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/vesting/vestOther.ts#L13)* +*Defined in [src/methods/vesting/vestOther.ts:13](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/vesting/vestOther.ts#L13)* The account whose vested funds should be unlocked. Must have funds still locked under this module. diff --git a/docs/interfaces/_util_types_.basetxinfo.md b/docs/interfaces/_util_types_.basetxinfo.md index 80ccbb70..9c3c12d9 100644 --- a/docs/interfaces/_util_types_.basetxinfo.md +++ b/docs/interfaces/_util_types_.basetxinfo.md @@ -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/2ef02a5/src/util/types.ts#L21)* +*Defined in [src/util/types.ts:21](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/util/types.ts#L25)* +*Defined in [src/util/types.ts:25](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/util/types.ts#L29)* +*Defined in [src/util/types.ts:29](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/util/types.ts#L33)* +*Defined in [src/util/types.ts:33](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/util/types.ts#L38)* +*Defined in [src/util/types.ts:38](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/util/types.ts#L42)* +*Defined in [src/util/types.ts:42](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/util/types.ts#L46)* +*Defined in [src/util/types.ts:46](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/util/types.ts#L46)* The current spec version for the runtime. @@ -99,7 +99,7 @@ ___ • **tip**? : *undefined | number* -*Defined in [src/util/types.ts:52](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/types.ts#L52)* +*Defined in [src/util/types.ts:52](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/util/types.ts#L52)* The tip for this transaction, in hex. @@ -111,7 +111,7 @@ ___ • **validityPeriod**? : *undefined | number* -*Defined in [src/util/types.ts:59](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/types.ts#L59)* +*Defined in [src/util/types.ts:59](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/util/types.ts#L59)* The amount of time (in second) the transaction is valid for. Will be translated into a mortal era. Defaults to 5 minutes. diff --git a/docs/interfaces/_util_types_.unsignedtransaction.md b/docs/interfaces/_util_types_.unsignedtransaction.md index 912adace..5bf5ff09 100644 --- a/docs/interfaces/_util_types_.unsignedtransaction.md +++ b/docs/interfaces/_util_types_.unsignedtransaction.md @@ -92,7 +92,7 @@ ___ • **metadataRpc**: *string* -*Defined in [src/util/types.ts:11](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/types.ts#L11)* +*Defined in [src/util/types.ts:11](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/util/types.ts#L11)* The SCALE-encoded metadata, as a hex string. Can be retrieved via the RPC call `state_getMetadata`. diff --git a/docs/modules/_createsignedtx_.md b/docs/modules/_createsignedtx_.md index f48f7014..0fca7280 100644 --- a/docs/modules/_createsignedtx_.md +++ b/docs/modules/_createsignedtx_.md @@ -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/2ef02a5/src/createSignedTx.ts#L14)* +*Defined in [src/createSignedTx.ts:14](https://github.com/paritytech/txwrapper/blob/a7b5a55/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 diff --git a/docs/modules/_createsigningpayload_.md b/docs/modules/_createsigningpayload_.md index 782cdb57..58be903a 100644 --- a/docs/modules/_createsigningpayload_.md +++ b/docs/modules/_createsigningpayload_.md @@ -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/2ef02a5/src/createSigningPayload.ts#L11)* +*Defined in [src/createSigningPayload.ts:11](https://github.com/paritytech/txwrapper/blob/a7b5a55/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"). diff --git a/docs/modules/_decode_decode_.md b/docs/modules/_decode_decode_.md index afd07977..24fe9deb 100644 --- a/docs/modules/_decode_decode_.md +++ b/docs/modules/_decode_decode_.md @@ -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/2ef02a5/src/decode/decode.ts#L18)* +*Defined in [src/decode/decode.ts:18](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/decode/decode.ts#L32)* +*Defined in [src/decode/decode.ts:32](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/decode/decode.ts#L46)* +*Defined in [src/decode/decode.ts:46](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/decode/decode.ts#L46)* Parse the transaction information from a signing payload, an unsigned tx, or a signed tx. diff --git a/docs/modules/_deriveaddress_.md b/docs/modules/_deriveaddress_.md index 59da22ef..d55372a2 100644 --- a/docs/modules/_deriveaddress_.md +++ b/docs/modules/_deriveaddress_.md @@ -14,7 +14,7 @@ ▸ **deriveAddress**(`publicKey`: string | Uint8Array, `ss58Format`: number): *string* -*Defined in [src/deriveAddress.ts:11](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/deriveAddress.ts#L11)* +*Defined in [src/deriveAddress.ts:11](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/deriveAddress.ts#L11)* Derive an address from a cryptographic public key offline. diff --git a/docs/modules/_gettxhash_.md b/docs/modules/_gettxhash_.md index e8e26b27..d802e042 100644 --- a/docs/modules/_gettxhash_.md +++ b/docs/modules/_gettxhash_.md @@ -14,7 +14,7 @@ ▸ **getTxHash**(`signedTx`: string): *string* -*Defined in [src/getTxHash.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/getTxHash.ts#L8)* +*Defined in [src/getTxHash.ts:8](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/getTxHash.ts#L8)* Derive the tx hash of a signed transaction offline. diff --git a/docs/modules/_importprivatekey_.md b/docs/modules/_importprivatekey_.md index 1c03c451..df5a5ca1 100644 --- a/docs/modules/_importprivatekey_.md +++ b/docs/modules/_importprivatekey_.md @@ -18,7 +18,7 @@ Ƭ **KeyringPair**: *KeyringPairBase* -*Defined in [src/importPrivateKey.ts:10](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/importPrivateKey.ts#L10)* +*Defined in [src/importPrivateKey.ts:10](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/importPrivateKey.ts#L18)* +*Defined in [src/importPrivateKey.ts:18](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/importPrivateKey.ts#L18)* Import a private key and create a KeyringPair. diff --git a/docs/modules/_methods_balances_transfer_.md b/docs/modules/_methods_balances_transfer_.md index 1a3ae5d7..eba913f6 100644 --- a/docs/modules/_methods_balances_transfer_.md +++ b/docs/modules/_methods_balances_transfer_.md @@ -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/2ef02a5/src/methods/balances/transfer.ts#L24)* +*Defined in [src/methods/balances/transfer.ts:24](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/balances/transfer.ts#L24)* Construct a balance transfer transaction offline. diff --git a/docs/modules/_methods_balances_transferkeepalive_.md b/docs/modules/_methods_balances_transferkeepalive_.md index fd7b316a..55586fcd 100644 --- a/docs/modules/_methods_balances_transferkeepalive_.md +++ b/docs/modules/_methods_balances_transferkeepalive_.md @@ -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/2ef02a5/src/methods/balances/transferKeepAlive.ts#L4)* +*Defined in [src/methods/balances/transferKeepAlive.ts:4](https://github.com/paritytech/txwrapper/blob/a7b5a55/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/2ef02a5/src/methods/balances/transferKeepAlive.ts#L11)* +*Defined in [src/methods/balances/transferKeepAlive.ts:11](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/balances/transferKeepAlive.ts#L11)* Construct a balance transfer transaction offline. diff --git a/docs/modules/_methods_democracy_activateproxy_.md b/docs/modules/_methods_democracy_activateproxy_.md index 515bac92..856ac554 100644 --- a/docs/modules/_methods_democracy_activateproxy_.md +++ b/docs/modules/_methods_democracy_activateproxy_.md @@ -18,7 +18,7 @@ ▸ **activateProxy**(`args`: [DemocracyActivateProxyArgs](../interfaces/_methods_democracy_activateproxy_.democracyactivateproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/activateProxy.ts:20](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/activateProxy.ts#L20)* +*Defined in [src/methods/democracy/activateProxy.ts:20](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/activateProxy.ts#L20)* Specify a proxy that is already open to us. Called by the stash. diff --git a/docs/modules/_methods_democracy_closeproxy_.md b/docs/modules/_methods_democracy_closeproxy_.md index ccbacd3a..4ac9bf03 100644 --- a/docs/modules/_methods_democracy_closeproxy_.md +++ b/docs/modules/_methods_democracy_closeproxy_.md @@ -14,7 +14,7 @@ ▸ **closeProxy**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/closeProxy.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/closeProxy.ts#L8)* +*Defined in [src/methods/democracy/closeProxy.ts:8](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/closeProxy.ts#L8)* Clear the proxy. Called by the proxy. diff --git a/docs/modules/_methods_democracy_deactivateproxy_.md b/docs/modules/_methods_democracy_deactivateproxy_.md index 530ca035..cf9f61e0 100644 --- a/docs/modules/_methods_democracy_deactivateproxy_.md +++ b/docs/modules/_methods_democracy_deactivateproxy_.md @@ -18,7 +18,7 @@ ▸ **deactivateProxy**(`args`: [DemocracyDeactivateProxyArgs](../interfaces/_methods_democracy_deactivateproxy_.democracydeactivateproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/deactivateProxy.ts:21](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/deactivateProxy.ts#L21)* +*Defined in [src/methods/democracy/deactivateProxy.ts:21](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/deactivateProxy.ts#L21)* Deactivate the proxy, but leave open to this account. Called by the stash. The proxy must already be active. diff --git a/docs/modules/_methods_democracy_openproxy_.md b/docs/modules/_methods_democracy_openproxy_.md index 532854fc..587c552f 100644 --- a/docs/modules/_methods_democracy_openproxy_.md +++ b/docs/modules/_methods_democracy_openproxy_.md @@ -18,7 +18,7 @@ ▸ **openProxy**(`args`: [DemocracyOpenProxyArgs](../interfaces/_methods_democracy_openproxy_.democracyopenproxyargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/openProxy.ts:20](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/openProxy.ts#L20)* +*Defined in [src/methods/democracy/openProxy.ts:20](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/openProxy.ts#L20)* Become a proxy. This must be called prior to a later `activateProxy`. diff --git a/docs/modules/_methods_democracy_proxyvote_.md b/docs/modules/_methods_democracy_proxyvote_.md index b9e7b7c5..f9723969 100644 --- a/docs/modules/_methods_democracy_proxyvote_.md +++ b/docs/modules/_methods_democracy_proxyvote_.md @@ -18,7 +18,7 @@ ▸ **proxyVote**(`args`: [DemocracyProxyVoteArgs](../interfaces/_methods_democracy_proxyvote_.democracyproxyvoteargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/proxyVote.ts:26](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/proxyVote.ts#L26)* +*Defined in [src/methods/democracy/proxyVote.ts:26](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/proxyVote.ts#L26)* Vote in a referendum on behalf of a stash. diff --git a/docs/modules/_methods_democracy_types_.md b/docs/modules/_methods_democracy_types_.md index 98066b18..d9f5a7fe 100644 --- a/docs/modules/_methods_democracy_types_.md +++ b/docs/modules/_methods_democracy_types_.md @@ -14,7 +14,7 @@ Ƭ **Vote**: *object* -*Defined in [src/methods/democracy/types.ts:4](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/types.ts#L4)* +*Defined in [src/methods/democracy/types.ts:4](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/types.ts#L4)* A vote in a referendum diff --git a/docs/modules/_methods_democracy_vote_.md b/docs/modules/_methods_democracy_vote_.md index 4617e315..8c689927 100644 --- a/docs/modules/_methods_democracy_vote_.md +++ b/docs/modules/_methods_democracy_vote_.md @@ -18,7 +18,7 @@ ▸ **vote**(`args`: [DemocracyVoteArgs](../interfaces/_methods_democracy_vote_.democracyvoteargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/democracy/vote.ts:26](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/democracy/vote.ts#L26)* +*Defined in [src/methods/democracy/vote.ts:26](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/democracy/vote.ts#L26)* Vote in a referendum. diff --git a/docs/modules/_methods_session_setkeys_.md b/docs/modules/_methods_session_setkeys_.md index 0076fa49..aa3d14e8 100644 --- a/docs/modules/_methods_session_setkeys_.md +++ b/docs/modules/_methods_session_setkeys_.md @@ -18,7 +18,7 @@ ▸ **setKeys**(`args`: [SessionSetKeysArgs](../interfaces/_methods_session_setkeys_.sessionsetkeysargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/session/setKeys.ts:24](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/session/setKeys.ts#L24)* +*Defined in [src/methods/session/setKeys.ts:24](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/session/setKeys.ts#L24)* Sets the session key(s) of the function caller to `key`. diff --git a/docs/modules/_methods_staking_bond_.md b/docs/modules/_methods_staking_bond_.md index 932549f9..a957d678 100644 --- a/docs/modules/_methods_staking_bond_.md +++ b/docs/modules/_methods_staking_bond_.md @@ -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/2ef02a5/src/methods/staking/bond.ts#L28)* +*Defined in [src/methods/staking/bond.ts:28](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/bond.ts#L28)* Construct a transaction to bond funds and create a Stash account. diff --git a/docs/modules/_methods_staking_bondextra_.md b/docs/modules/_methods_staking_bondextra_.md index 812865d7..85d545c2 100644 --- a/docs/modules/_methods_staking_bondextra_.md +++ b/docs/modules/_methods_staking_bondextra_.md @@ -18,7 +18,7 @@ ▸ **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/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/bondExtra.ts#L21)* +*Defined in [src/methods/staking/bondExtra.ts:21](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/bondExtra.ts#L21)* Add some extra amount that have appeared in the stash `free_balance` into the balance up for staking. diff --git a/docs/modules/_methods_staking_chill_.md b/docs/modules/_methods_staking_chill_.md index 32c2fde2..55a6b372 100644 --- a/docs/modules/_methods_staking_chill_.md +++ b/docs/modules/_methods_staking_chill_.md @@ -14,7 +14,7 @@ ▸ **chill**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/chill.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/chill.ts#L8)* +*Defined in [src/methods/staking/chill.ts:8](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/chill.ts#L8)* Declare the desire to cease validating or nominating. Does not unbond funds. diff --git a/docs/modules/_methods_staking_nominate_.md b/docs/modules/_methods_staking_nominate_.md index c827f293..9c631015 100644 --- a/docs/modules/_methods_staking_nominate_.md +++ b/docs/modules/_methods_staking_nominate_.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/2ef02a5/src/methods/staking/nominate.ts#L23)* +*Defined in [src/methods/staking/nominate.ts:23](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/nominate.ts#L23)* Construct a transaction to nominate. This must be called by the _Controller_ account. diff --git a/docs/modules/_methods_staking_payoutnominator_.md b/docs/modules/_methods_staking_payoutnominator_.md index 5d6560b8..04fc332d 100644 --- a/docs/modules/_methods_staking_payoutnominator_.md +++ b/docs/modules/_methods_staking_payoutnominator_.md @@ -18,7 +18,7 @@ ▸ **payoutNominator**(`args`: [StakingPayoutNominatorArgs](../interfaces/_methods_staking_payoutnominator_.stakingpayoutnominatorargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/payoutNominator.ts:31](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutNominator.ts#L31)* +*Defined in [src/methods/staking/payoutNominator.ts:31](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/payoutNominator.ts#L31)* Make one nominator's payout for one era. WARNING: once an era is payed for a validator such validator can't claim the diff --git a/docs/modules/_methods_staking_payoutvalidator_.md b/docs/modules/_methods_staking_payoutvalidator_.md index d00ed180..c9d54973 100644 --- a/docs/modules/_methods_staking_payoutvalidator_.md +++ b/docs/modules/_methods_staking_payoutvalidator_.md @@ -18,7 +18,7 @@ ▸ **payoutValidator**(`args`: [StakingPayoutValidatorArgs](../interfaces/_methods_staking_payoutvalidator_.stakingpayoutvalidatorargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/payoutValidator.ts:25](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/payoutValidator.ts#L25)* +*Defined in [src/methods/staking/payoutValidator.ts:25](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/payoutValidator.ts#L25)* Make one validator's payout for one era. WARNING: once an era is payed for a validator such validator can't claim the diff --git a/docs/modules/_methods_staking_setcontroller_.md b/docs/modules/_methods_staking_setcontroller_.md index 867d3471..83360416 100644 --- a/docs/modules/_methods_staking_setcontroller_.md +++ b/docs/modules/_methods_staking_setcontroller_.md @@ -18,7 +18,7 @@ ▸ **setController**(`args`: [StakingSetControllerArgs](../interfaces/_methods_staking_setcontroller_.stakingsetcontrollerargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/setController.ts:21](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/setController.ts#L21)* +*Defined in [src/methods/staking/setController.ts:21](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/setController.ts#L21)* (Re-)set the controller of a stash. Effects will be felt at the beginning of the next era. diff --git a/docs/modules/_methods_staking_unbond_.md b/docs/modules/_methods_staking_unbond_.md index 6f8d7b0d..e8c0a7bd 100644 --- a/docs/modules/_methods_staking_unbond_.md +++ b/docs/modules/_methods_staking_unbond_.md @@ -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/2ef02a5/src/methods/staking/unbond.ts#L21)* +*Defined in [src/methods/staking/unbond.ts:21](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/unbond.ts#L21)* Construct a transaction to unbond funds from a Stash account. This must be called by the _Controller_ account. diff --git a/docs/modules/_methods_staking_validate_.md b/docs/modules/_methods_staking_validate_.md index 4ff900f2..4e73254b 100644 --- a/docs/modules/_methods_staking_validate_.md +++ b/docs/modules/_methods_staking_validate_.md @@ -18,7 +18,7 @@ ▸ **validate**(`args`: [StakingValidateArgs](../interfaces/_methods_staking_validate_.stakingvalidateargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/validate.ts:22](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/validate.ts#L22)* +*Defined in [src/methods/staking/validate.ts:22](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/validate.ts#L22)* Declare the desire to validate for the origin controller. diff --git a/docs/modules/_methods_staking_withdrawunbonded_.md b/docs/modules/_methods_staking_withdrawunbonded_.md index 76ffade7..87fc28df 100644 --- a/docs/modules/_methods_staking_withdrawunbonded_.md +++ b/docs/modules/_methods_staking_withdrawunbonded_.md @@ -14,7 +14,7 @@ ▸ **withdrawUnbonded**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/staking/withdrawUnbonded.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/staking/withdrawUnbonded.ts#L8)* +*Defined in [src/methods/staking/withdrawUnbonded.ts:8](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/staking/withdrawUnbonded.ts#L8)* Remove any unlocked chunks from the `unlocking` queue from our management. diff --git a/docs/modules/_methods_vesting_vest_.md b/docs/modules/_methods_vesting_vest_.md index 7910b6bf..d0987246 100644 --- a/docs/modules/_methods_vesting_vest_.md +++ b/docs/modules/_methods_vesting_vest_.md @@ -14,7 +14,7 @@ ▸ **vest**(`args`: object, `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/vesting/vest.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/vesting/vest.ts#L8)* +*Defined in [src/methods/vesting/vest.ts:8](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/vesting/vest.ts#L8)* Unlock any vested funds of the sender account. diff --git a/docs/modules/_methods_vesting_vestother_.md b/docs/modules/_methods_vesting_vestother_.md index 42b563ab..98a5ecc4 100644 --- a/docs/modules/_methods_vesting_vestother_.md +++ b/docs/modules/_methods_vesting_vestother_.md @@ -18,7 +18,7 @@ ▸ **vestOther**(`args`: [VestingVestOtherArgs](../interfaces/_methods_vesting_vestother_.vestingvestotherargs.md), `info`: [BaseTxInfo](../interfaces/_util_types_.basetxinfo.md)): *[UnsignedTransaction](../interfaces/_util_types_.unsignedtransaction.md)* -*Defined in [src/methods/vesting/vestOther.ts:21](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/methods/vesting/vestOther.ts#L21)* +*Defined in [src/methods/vesting/vestOther.ts:21](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/methods/vesting/vestOther.ts#L21)* Unlock any vested funds of a `target` account. diff --git a/docs/modules/_util_constants_.md b/docs/modules/_util_constants_.md index edac67d3..22b09007 100644 --- a/docs/modules/_util_constants_.md +++ b/docs/modules/_util_constants_.md @@ -16,7 +16,7 @@ • **EXTRINSIC_VERSION**: *4* = 4 -*Defined in [src/util/constants.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/constants.ts#L13)* +*Defined in [src/util/constants.ts:13](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/util/constants.ts#L13)* Latest extrinsic version. @@ -26,7 +26,7 @@ ___ • **KUSAMA_SS58_FORMAT**: *2* = 2 -*Defined in [src/util/constants.ts:4](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/constants.ts#L4)* +*Defined in [src/util/constants.ts:4](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/util/constants.ts#L4)* Prefix for SS58-encoded addresses on Kusama. @@ -36,6 +36,6 @@ ___ • **POLKADOT_SS58_FORMAT**: *0* = 0 -*Defined in [src/util/constants.ts:8](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/constants.ts#L8)* +*Defined in [src/util/constants.ts:8](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/util/constants.ts#L8)* Prefix for SS58-encoded addresses on Polkadot. diff --git a/docs/modules/_util_registry_.md b/docs/modules/_util_registry_.md index 5015f707..d9e1ae4d 100644 --- a/docs/modules/_util_registry_.md +++ b/docs/modules/_util_registry_.md @@ -14,7 +14,7 @@ ▸ **getRegistry**(`specName`: "kusama", `specVersion`: number): *TypeRegistry* -*Defined in [src/util/registry.ts:13](https://github.com/paritytech/txwrapper/blob/2ef02a5/src/util/registry.ts#L13)* +*Defined in [src/util/registry.ts:13](https://github.com/paritytech/txwrapper/blob/a7b5a55/src/util/registry.ts#L13)* Create a specific TypeRegistry for a current chain. The reason we have this is, depending on different runtime versions, we have different types (e.g.: