From 9975f58cfb0c504b8ada86ef5203a0ffe1057b94 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Tue, 21 Apr 2020 09:38:09 +0200 Subject: [PATCH] 1.11 (#2198) * 1.11 * isOptional is custom RPC sample * Names is one-liner for custom RPCs --- CHANGELOG.md | 2 +- docs/start/rpc.custom.md | 9 +++- lerna.json | 2 +- packages/api-contract/package.json | 8 ++-- packages/api-derive/package.json | 10 ++--- packages/api/package.json | 14 +++---- packages/metadata/package.json | 6 +-- packages/rpc-core/package.json | 8 ++-- packages/rpc-provider/package.json | 6 +-- packages/typegen/package.json | 10 ++--- packages/types-known/package.json | 4 +- packages/types/package.json | 4 +- yarn.lock | 66 +++++++++++++++--------------- 13 files changed, 78 insertions(+), 71 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e3cffd8798..a545ab69c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# 1.11.0-beta.x +# 1.11.1 Apr 21, 2020 - **Important** Substrate master has an updated `Weight` (to `u64`), on older chains apply `Weight: 'u32'` (This does affect event decoding if wrongly set) - Allow user type augmentation to work with different versions of rxjs (Thanks to https://github.com/monitz87) diff --git a/docs/start/rpc.custom.md b/docs/start/rpc.custom.md index 69d1d53b13..09dbb79278 100644 --- a/docs/start/rpc.custom.md +++ b/docs/start/rpc.custom.md @@ -17,6 +17,11 @@ const api = await ApiPromise.create({ { name: 'index', type: 'u64' + }, + { + name: 'at', + type: 'Hash', + isOptional: true } ], type: 'Balance' @@ -26,7 +31,9 @@ const api = await ApiPromise.create({ }); ``` -In the above example we have defined a new method, which is now available on the RPCs as `api.rpc.firstModule.testMethod(u64) => Promise`. Do be aware that while defined, the method will only appear if it is in the list as returned by `api.rpc.rpc.methods()`, which is the list of known RPCs the node exposes. When making changes to the node, always ensure that it does expose the RPC method correctly, otherwise it will not be decorated. +In the above example we have defined a new method, which is now available on the RPCs as `api.rpc.firstModule.testMethod(index: u64, at?: Hash) => Promise`. In the case of optional params, we have added the `isOptional: true` flag alongside the `name` & `type` in the param definition. + +Be aware that while defined, the method will only appear on the API if it is in the list as returned by `api.rpc.rpc.methods()`, which is the list of known RPCs the node exposes. When making changes to the node, always ensure that it does expose the RPC method correctly, otherwise it will not be decorated. ## Definition breakdown diff --git a/lerna.json b/lerna.json index 6c4af442b0..27eaaf781f 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "packages": [ "packages/*" ], - "version": "1.11.0-beta.35" + "version": "1.11.0" } diff --git a/packages/api-contract/package.json b/packages/api-contract/package.json index 3dbe8e872b..8065ac1a83 100644 --- a/packages/api-contract/package.json +++ b/packages/api-contract/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-contract", - "version": "1.11.0-beta.35", + "version": "1.11.0", "description": "Interfaces for interacting with contracts and contract ABIs", "main": "index.js", "keywords": [ @@ -27,9 +27,9 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-contract#readme", "dependencies": { "@babel/runtime": "^7.9.2", - "@polkadot/api": "1.11.0-beta.35", - "@polkadot/rpc-core": "1.11.0-beta.35", - "@polkadot/types": "1.11.0-beta.35", + "@polkadot/api": "1.11.0", + "@polkadot/rpc-core": "1.11.0", + "@polkadot/types": "1.11.0", "@polkadot/util": "^2.8.1", "bn.js": "^5.1.1", "rxjs": "^6.5.5" diff --git a/packages/api-derive/package.json b/packages/api-derive/package.json index bf2d3a221d..9bd672024e 100644 --- a/packages/api-derive/package.json +++ b/packages/api-derive/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api-derive", - "version": "1.11.0-beta.35", + "version": "1.11.0", "description": "Common functions used across Polkadot, derived from RPC calls and storage queries.", "main": "index.js", "keywords": [ @@ -28,10 +28,10 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-derive#readme", "dependencies": { "@babel/runtime": "^7.9.2", - "@polkadot/api": "1.11.0-beta.35", - "@polkadot/rpc-core": "1.11.0-beta.35", - "@polkadot/rpc-provider": "1.11.0-beta.35", - "@polkadot/types": "1.11.0-beta.35", + "@polkadot/api": "1.11.0", + "@polkadot/rpc-core": "1.11.0", + "@polkadot/rpc-provider": "1.11.0", + "@polkadot/types": "1.11.0", "@polkadot/util": "^2.8.1", "@polkadot/util-crypto": "^2.8.1", "bn.js": "^5.1.1", diff --git a/packages/api/package.json b/packages/api/package.json index ab6d0832c2..946a36c86b 100644 --- a/packages/api/package.json +++ b/packages/api/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/api", - "version": "1.11.0-beta.35", + "version": "1.11.0", "description": "Promise and RxJS wrappers around the Polkadot JS RPC", "main": "index.js", "keywords": [ @@ -27,13 +27,13 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme", "dependencies": { "@babel/runtime": "^7.9.2", - "@polkadot/api-derive": "1.11.0-beta.35", + "@polkadot/api-derive": "1.11.0", "@polkadot/keyring": "^2.8.1", - "@polkadot/metadata": "1.11.0-beta.35", - "@polkadot/rpc-core": "1.11.0-beta.35", - "@polkadot/rpc-provider": "1.11.0-beta.35", - "@polkadot/types": "1.11.0-beta.35", - "@polkadot/types-known": "1.11.0-beta.35", + "@polkadot/metadata": "1.11.0", + "@polkadot/rpc-core": "1.11.0", + "@polkadot/rpc-provider": "1.11.0", + "@polkadot/types": "1.11.0", + "@polkadot/types-known": "1.11.0", "@polkadot/util": "^2.8.1", "@polkadot/util-crypto": "^2.8.1", "bn.js": "^5.1.1", diff --git a/packages/metadata/package.json b/packages/metadata/package.json index ef2481822f..1c925bfd16 100644 --- a/packages/metadata/package.json +++ b/packages/metadata/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/metadata", - "version": "1.11.0-beta.35", + "version": "1.11.0", "description": "Helpers to extract information from runtime metadata", "main": "index.js", "publishConfig": { @@ -27,8 +27,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/type-metadata#readme", "dependencies": { "@babel/runtime": "^7.9.2", - "@polkadot/types": "1.11.0-beta.35", - "@polkadot/types-known": "1.11.0-beta.35", + "@polkadot/types": "1.11.0", + "@polkadot/types-known": "1.11.0", "@polkadot/util": "^2.8.1", "@polkadot/util-crypto": "^2.8.1", "bn.js": "^5.1.1" diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index d966ba955c..a0afee7e41 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-core", - "version": "1.11.0-beta.35", + "version": "1.11.0", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -27,9 +27,9 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme", "dependencies": { "@babel/runtime": "^7.9.2", - "@polkadot/metadata": "1.11.0-beta.35", - "@polkadot/rpc-provider": "1.11.0-beta.35", - "@polkadot/types": "1.11.0-beta.35", + "@polkadot/metadata": "1.11.0", + "@polkadot/rpc-provider": "1.11.0", + "@polkadot/types": "1.11.0", "@polkadot/util": "^2.8.1", "memoizee": "^0.4.14", "rxjs": "^6.5.5" diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index e40dbf8315..f9e66bdd98 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/rpc-provider", - "version": "1.11.0-beta.35", + "version": "1.11.0", "description": "Transport providers for the API", "main": "index.js", "keywords": [ @@ -27,8 +27,8 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-provider#readme", "dependencies": { "@babel/runtime": "^7.9.2", - "@polkadot/metadata": "1.11.0-beta.35", - "@polkadot/types": "1.11.0-beta.35", + "@polkadot/metadata": "1.11.0", + "@polkadot/types": "1.11.0", "@polkadot/util": "^2.8.1", "@polkadot/util-crypto": "^2.8.1", "bn.js": "^5.1.1", diff --git a/packages/typegen/package.json b/packages/typegen/package.json index 11d301a113..2700673d35 100644 --- a/packages/typegen/package.json +++ b/packages/typegen/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/typegen", - "version": "1.11.0-beta.35", + "version": "1.11.0", "description": "Type generation scripts", "main": "index.js", "bin": { @@ -36,10 +36,10 @@ "@babel/core": "^7.9.0", "@babel/register": "^7.9.0", "@babel/runtime": "^7.9.2", - "@polkadot/api": "1.11.0-beta.35", - "@polkadot/metadata": "1.11.0-beta.35", - "@polkadot/rpc-provider": "1.11.0-beta.35", - "@polkadot/types": "1.11.0-beta.35", + "@polkadot/api": "1.11.0", + "@polkadot/metadata": "1.11.0", + "@polkadot/rpc-provider": "1.11.0", + "@polkadot/types": "1.11.0", "@polkadot/util": "^2.8.1", "websocket": "^1.0.31", "yargs": "^15.3.1" diff --git a/packages/types-known/package.json b/packages/types-known/package.json index 96f025f420..fb30aea579 100644 --- a/packages/types-known/package.json +++ b/packages/types-known/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types-known", - "version": "1.11.0-beta.35", + "version": "1.11.0", "description": "A JavaScript wrapper for the Polkadot JsonRPC interface", "main": "index.js", "keywords": [ @@ -27,7 +27,7 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/types-known#readme", "dependencies": { "@babel/runtime": "^7.9.2", - "@polkadot/types": "1.11.0-beta.35", + "@polkadot/types": "1.11.0", "@polkadot/util": "^2.8.1", "bn.js": "^5.1.1" }, diff --git a/packages/types/package.json b/packages/types/package.json index 4751dfe3c1..f38584e078 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@polkadot/types", - "version": "1.11.0-beta.35", + "version": "1.11.0", "description": "Implementation of the Parity codec", "main": "index.js", "keywords": [ @@ -27,7 +27,7 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/types#readme", "dependencies": { "@babel/runtime": "^7.9.2", - "@polkadot/metadata": "1.11.0-beta.35", + "@polkadot/metadata": "1.11.0", "@polkadot/util": "^2.8.1", "@polkadot/util-crypto": "^2.8.1", "@types/bn.js": "^4.11.6", diff --git a/yarn.lock b/yarn.lock index af8da9c05d..b3ce3fcf75 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2607,25 +2607,25 @@ __metadata: resolution: "@polkadot/api-contract@workspace:packages/api-contract" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/api": 1.11.0-beta.35 - "@polkadot/rpc-core": 1.11.0-beta.35 - "@polkadot/types": 1.11.0-beta.35 + "@polkadot/api": 1.11.0 + "@polkadot/rpc-core": 1.11.0 + "@polkadot/types": 1.11.0 "@polkadot/util": ^2.8.1 bn.js: ^5.1.1 rxjs: ^6.5.5 languageName: unknown linkType: soft -"@polkadot/api-derive@1.11.0-beta.35, @polkadot/api-derive@workspace:packages/api-derive": +"@polkadot/api-derive@1.11.0, @polkadot/api-derive@workspace:packages/api-derive": version: 0.0.0-use.local resolution: "@polkadot/api-derive@workspace:packages/api-derive" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/api": 1.11.0-beta.35 + "@polkadot/api": 1.11.0 "@polkadot/keyring": ^2.8.1 - "@polkadot/rpc-core": 1.11.0-beta.35 - "@polkadot/rpc-provider": 1.11.0-beta.35 - "@polkadot/types": 1.11.0-beta.35 + "@polkadot/rpc-core": 1.11.0 + "@polkadot/rpc-provider": 1.11.0 + "@polkadot/types": 1.11.0 "@polkadot/util": ^2.8.1 "@polkadot/util-crypto": ^2.8.1 bn.js: ^5.1.1 @@ -2634,18 +2634,18 @@ __metadata: languageName: unknown linkType: soft -"@polkadot/api@1.11.0-beta.35, @polkadot/api@workspace:packages/api": +"@polkadot/api@1.11.0, @polkadot/api@workspace:packages/api": version: 0.0.0-use.local resolution: "@polkadot/api@workspace:packages/api" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/api-derive": 1.11.0-beta.35 + "@polkadot/api-derive": 1.11.0 "@polkadot/keyring": ^2.8.1 - "@polkadot/metadata": 1.11.0-beta.35 - "@polkadot/rpc-core": 1.11.0-beta.35 - "@polkadot/rpc-provider": 1.11.0-beta.35 - "@polkadot/types": 1.11.0-beta.35 - "@polkadot/types-known": 1.11.0-beta.35 + "@polkadot/metadata": 1.11.0 + "@polkadot/rpc-core": 1.11.0 + "@polkadot/rpc-provider": 1.11.0 + "@polkadot/types": 1.11.0 + "@polkadot/types-known": 1.11.0 "@polkadot/util": ^2.8.1 "@polkadot/util-crypto": ^2.8.1 bn.js: ^5.1.1 @@ -2752,43 +2752,43 @@ __metadata: languageName: node linkType: hard -"@polkadot/metadata@1.11.0-beta.35, @polkadot/metadata@workspace:packages/metadata": +"@polkadot/metadata@1.11.0, @polkadot/metadata@workspace:packages/metadata": version: 0.0.0-use.local resolution: "@polkadot/metadata@workspace:packages/metadata" dependencies: "@babel/runtime": ^7.9.2 "@polkadot/keyring": ^2.8.1 - "@polkadot/types": 1.11.0-beta.35 - "@polkadot/types-known": 1.11.0-beta.35 + "@polkadot/types": 1.11.0 + "@polkadot/types-known": 1.11.0 "@polkadot/util": ^2.8.1 "@polkadot/util-crypto": ^2.8.1 bn.js: ^5.1.1 languageName: unknown linkType: soft -"@polkadot/rpc-core@1.11.0-beta.35, @polkadot/rpc-core@workspace:packages/rpc-core": +"@polkadot/rpc-core@1.11.0, @polkadot/rpc-core@workspace:packages/rpc-core": version: 0.0.0-use.local resolution: "@polkadot/rpc-core@workspace:packages/rpc-core" dependencies: "@babel/runtime": ^7.9.2 "@polkadot/keyring": ^2.8.1 - "@polkadot/metadata": 1.11.0-beta.35 - "@polkadot/rpc-provider": 1.11.0-beta.35 - "@polkadot/types": 1.11.0-beta.35 + "@polkadot/metadata": 1.11.0 + "@polkadot/rpc-provider": 1.11.0 + "@polkadot/types": 1.11.0 "@polkadot/util": ^2.8.1 memoizee: ^0.4.14 rxjs: ^6.5.5 languageName: unknown linkType: soft -"@polkadot/rpc-provider@1.11.0-beta.35, @polkadot/rpc-provider@workspace:packages/rpc-provider": +"@polkadot/rpc-provider@1.11.0, @polkadot/rpc-provider@workspace:packages/rpc-provider": version: 0.0.0-use.local resolution: "@polkadot/rpc-provider@workspace:packages/rpc-provider" dependencies: "@babel/runtime": ^7.9.2 "@polkadot/keyring": ^2.8.1 - "@polkadot/metadata": 1.11.0-beta.35 - "@polkadot/types": 1.11.0-beta.35 + "@polkadot/metadata": 1.11.0 + "@polkadot/types": 1.11.0 "@polkadot/util": ^2.8.1 "@polkadot/util-crypto": ^2.8.1 bn.js: ^5.1.1 @@ -2816,10 +2816,10 @@ __metadata: "@babel/core": ^7.9.0 "@babel/register": ^7.9.0 "@babel/runtime": ^7.9.2 - "@polkadot/api": 1.11.0-beta.35 - "@polkadot/metadata": 1.11.0-beta.35 - "@polkadot/rpc-provider": 1.11.0-beta.35 - "@polkadot/types": 1.11.0-beta.35 + "@polkadot/api": 1.11.0 + "@polkadot/metadata": 1.11.0 + "@polkadot/rpc-provider": 1.11.0 + "@polkadot/types": 1.11.0 "@polkadot/util": ^2.8.1 "@types/websocket": ^1.0.0 "@types/yargs": ^15.0.4 @@ -2834,25 +2834,25 @@ __metadata: languageName: unknown linkType: soft -"@polkadot/types-known@1.11.0-beta.35, @polkadot/types-known@workspace:packages/types-known": +"@polkadot/types-known@1.11.0, @polkadot/types-known@workspace:packages/types-known": version: 0.0.0-use.local resolution: "@polkadot/types-known@workspace:packages/types-known" dependencies: "@babel/runtime": ^7.9.2 - "@polkadot/types": 1.11.0-beta.35 + "@polkadot/types": 1.11.0 "@polkadot/util": ^2.8.1 "@types/bn.js": ^4.11.6 bn.js: ^5.1.1 languageName: unknown linkType: soft -"@polkadot/types@1.11.0-beta.35, @polkadot/types@workspace:packages/types": +"@polkadot/types@1.11.0, @polkadot/types@workspace:packages/types": version: 0.0.0-use.local resolution: "@polkadot/types@workspace:packages/types" dependencies: "@babel/runtime": ^7.9.2 "@polkadot/keyring": ^2.8.1 - "@polkadot/metadata": 1.11.0-beta.35 + "@polkadot/metadata": 1.11.0 "@polkadot/util": ^2.8.1 "@polkadot/util-crypto": ^2.8.1 "@types/bn.js": ^4.11.6