Skip to content
  1. Aug 04, 2020
  3. Aug 01, 2020
  5. Jun 24, 2020
  7. Jun 16, 2020
    • Zeke Mostov's avatar
      feat: Add proxy methods and `staking.payoutStakers` (#172) · 51e5d775
      Zeke Mostov authored 
      

* Add proxy methods and delete democracy methods

* Bump @polkadot

* Tests proxy; Deprecated metadata for democracy tests; Add payoutStakers

add example back


add back democracy

Add back democracy methods

Add payoutStakers and remove payoutNominators and payoutValidators

Add old metadata and use for unit tests of deprecated democracy method

rename folder of examples tests for new functions

* Update doc comments for proxy methods to list proxy types

Incorporate joes comments

* Insert console warn deprecation for democracy proxy methods

* Rename TEST_OPTIONS to KUSAMA_TEST_OPTIONS

* Put back deprecated staking methods; More descriptive name for old metadata

Remeber export statements for old payout methods

* Generate docs with `yarn docs`

* Add @depcrated doc strings

* Apply suggestions from Joe's doc code review

Co-authored-by: default avatarjoe petrowski <[email protected]>

* Add docs indicating methods only callable when elections are closed

* Generate updated docs with `yarn docs`

* Update src/methods/proxy/proxy.ts

* Update src/methods/proxy/removeProxies.ts

* Update src/methods/proxy/removeProxy.ts

* Update src/methods/staking/payoutStakers.ts

* Bump @polkadot/api to 1.19.0-beta.3

* Remove temp examples; Correct bob address in test util;

* One more address

* tiny linting error

* Fix failing tests by using CC1 base tx info

* Ignore deprecated static metadata

* Explain deprecated metadata

* Tiny comment enhancement

Co-authored-by: default avatarjoe petrowski <[email protected]>
      51e5d775
  9. Jun 06, 2020
  11. May 26, 2020
  13. May 22, 2020
  15. May 21, 2020
  17. May 20, 2020
  19. May 18, 2020
  21. May 16, 2020
    • Amaury Martiny's avatar
      refactor!: Pass mandatory registry everywhere (#141) · bd14e848
      Amaury Martiny authored 
      BREAKING CHANGE:

This refactor breaks compatibility with v1, as all functions now require a `{ metadataRpc?, registry }` last argument.

#### Rationale

In v1, by not passing any last argument, we implicitly used Kusama's most recent TypeRegistry. This was a handy shortcut, but might create hard-to-debug issues down the road (e.g. using another chain, or using Kusama with an incompatible spec version).

In v2, we never default to Kusama anymore, and always require the user passing the registry (and sometimes the metadata too, if needed, see docs for details).

Example 1:

```diff
+ // Get Kusama's registry at `specVersion`
+ const registry = getRegistry('Kusama', 'kusama', specVersion);

const unsigned = methods.balances.transfer(
  { dest: '1F...', value: 23 },
  {
    // other info about tx
-    metadataRpc: metadataRpc,
- }
+  }, {
+    metadataRpc: metadataRpc,
+    registry: registry
+  }
);
```

Example 2:

```diff
const unsigned = {...};
const signature = '...';

+ // Get Kusama's registry at `specVersion`
+ const registry = getRegistry('Kusama', 'kusama', unsigned.specVersion);

- const signed = createSigned(unsigned, signature);
+ const signed = createSigned(unsigned, signature, {
+    metadataRpc: unsigned.metadata,
+    registry,
+ });
```

Here is the full list of breaking changes:
- `decode` function taking 3 arguments was deprecated in v1, in favor or 2 arguments. In v2, `decode` takes exactly 2 arguments.
- `createSigningPayload`, `createSignedTx`, `methods.*.*` functions all take a mandatory last argument `{ metadataRpc?, registry }`. Note that the `metadata` field has been renamed to `metadataRpc`. Whether a function needs `metadataRpc` is documented for each function.
- `deriveAddress`'s 2nd argument `ss58Format` is now mandatory, and does not default to Kusama's prefix anymore.
      bd14e848
  23. May 11, 2020
  25. Apr 30, 2020
  27. Apr 27, 2020