From 6b3ba22da7c9070c17811011809a52ff20197263 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Sun, 9 Dec 2018 14:30:09 +0100 Subject: [PATCH] Bump common, some additional cleanups (#453) --- packages/rpc-core/package.json | 2 +- packages/rpc-provider/package.json | 6 +- packages/type-extrinsics/package.json | 2 +- packages/type-storage/package.json | 6 +- packages/types/package.json | 4 +- packages/types/src/scripts/MetadataMd.ts | 100 ++++++++--------------- yarn.lock | 30 +++---- 7 files changed, 60 insertions(+), 90 deletions(-) diff --git a/packages/rpc-core/package.json b/packages/rpc-core/package.json index 5f4c00669b..6c42a9a8e1 100644 --- a/packages/rpc-core/package.json +++ b/packages/rpc-core/package.json @@ -33,6 +33,6 @@ "@polkadot/jsonrpc": "^0.33.7", "@polkadot/rpc-provider": "^0.33.7", "@polkadot/types": "^0.33.7", - "@polkadot/util": "^0.33.11" + "@polkadot/util": "^0.33.12" } } diff --git a/packages/rpc-provider/package.json b/packages/rpc-provider/package.json index 0afac46722..370a77c642 100644 --- a/packages/rpc-provider/package.json +++ b/packages/rpc-provider/package.json @@ -30,10 +30,10 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-provider#readme", "dependencies": { "@babel/runtime": "^7.1.5", - "@polkadot/keyring": "^0.33.11", + "@polkadot/keyring": "^0.33.12", "@polkadot/storage": "^0.33.7", - "@polkadot/util": "^0.33.11", - "@polkadot/util-crypto": "^0.33.11", + "@polkadot/util": "^0.33.12", + "@polkadot/util-crypto": "^0.33.12", "@types/nock": "^9.3.0", "eventemitter3": "^3.1.0", "isomorphic-fetch": "^2.2.1", diff --git a/packages/type-extrinsics/package.json b/packages/type-extrinsics/package.json index b6f874d7c5..c5abec8329 100644 --- a/packages/type-extrinsics/package.json +++ b/packages/type-extrinsics/package.json @@ -12,6 +12,6 @@ "dependencies": { "@babel/runtime": "^7.1.5", "@polkadot/types": "^0.33.7", - "@polkadot/util": "^0.33.11" + "@polkadot/util": "^0.33.12" } } diff --git a/packages/type-storage/package.json b/packages/type-storage/package.json index cf2bc468b5..e19cf999da 100644 --- a/packages/type-storage/package.json +++ b/packages/type-storage/package.json @@ -30,9 +30,9 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/type-storage#readme", "dependencies": { "@babel/runtime": "^7.1.5", - "@polkadot/keyring": "^0.33.11", + "@polkadot/keyring": "^0.33.12", "@polkadot/types": "^0.33.7", - "@polkadot/util": "^0.33.11", - "@polkadot/util-crypto": "^0.33.11" + "@polkadot/util": "^0.33.12", + "@polkadot/util-crypto": "^0.33.12" } } diff --git a/packages/types/package.json b/packages/types/package.json index 72c0e71d3d..f6536d3d93 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -30,7 +30,7 @@ "homepage": "https://github.com/polkadot-js/api/tree/master/packages/types#readme", "dependencies": { "@babel/runtime": "^7.1.5", - "@polkadot/keyring": "^0.33.11", - "@polkadot/util": "^0.33.11" + "@polkadot/keyring": "^0.33.12", + "@polkadot/util": "^0.33.12" } } diff --git a/packages/types/src/scripts/MetadataMd.ts b/packages/types/src/scripts/MetadataMd.ts index 6067a9b08a..808ff25f06 100644 --- a/packages/types/src/scripts/MetadataMd.ts +++ b/packages/types/src/scripts/MetadataMd.ts @@ -74,14 +74,12 @@ function addRpc () { }, renderHeading + renderAnchors); } -function sortExtrinsicsSectionMethods () { - return function (a: any, b: any) { - // ignore upper and lowercase - const nameA = a.name.toString().toUpperCase(); - const nameB = b.name.toString().toUpperCase(); +function sortExtrinsicsSectionMethods (a: any, b: any) { + // ignore upper and lowercase + const nameA = a.name.toString().toUpperCase(); + const nameB = b.name.toString().toUpperCase(); - return nameA.localeCompare(nameB); - }; + return nameA.localeCompare(nameB); } function addEvents (metadata: Metadata) { @@ -89,7 +87,7 @@ function addEvents (metadata: Metadata) { const orderedSections = metadata.events.map((i) => i).sort(); const renderAnchors = generateSectionLinks('events', metadata); - return orderedSections.reduce((md: string, meta: any) => { + return orderedSections.reduce((md, meta) => { if (!meta.events || !meta.events.length) { return md; } @@ -97,12 +95,12 @@ function addEvents (metadata: Metadata) { const sectionName = stringCamelCase(meta.name.toString()); const renderSection = generateSectionHeader(md, sectionName); - const orderedMethods = meta.events.map((i: any) => i).sort(sortExtrinsicsSectionMethods()); + const orderedMethods = meta.events.sort(sortExtrinsicsSectionMethods); - return orderedMethods.reduce((md: string, func: any) => { + return orderedMethods.reduce((md, func) => { const methodName = func.name.toString(); - const args = func.arguments.map((type: any) => '`' + type + '`').join(', '); - const doc = func.documentation.reduce((md: string, doc: string) => `${md} ${doc}`, ''); + const args = func.arguments.map((type) => '`' + type + '`').join(', '); + const doc = func.documentation.reduce((md, doc) => `${md} ${doc}`, ''); const renderSignature = `${md}\n▸ **${methodName}**(${args})`; const renderSummary = `${doc ? `\n- **summary**: ${doc}\n` : '\n'}`; @@ -116,19 +114,19 @@ function addExtrinsics (metadata: Metadata) { const orderedSections = metadata.modules.map((i) => i).sort(); const renderAnchors = generateSectionLinks('extrinsics', metadata); - return orderedSections.reduce((md: string, meta: any) => { + return orderedSections.reduce((md, meta) => { if (!meta.module.call || !meta.module.call.functions.length) { return md; } const sectionName = stringCamelCase(meta.prefix.toString()); const renderSection = generateSectionHeader(md, sectionName); - const orderedMethods = meta.module.call.functions.map((i: any) => i).sort(sortExtrinsicsSectionMethods()); + const orderedMethods = meta.module.call.functions.sort(sortExtrinsicsSectionMethods); - return orderedMethods.reduce((md: string, func: any) => { + return orderedMethods.reduce((md, func) => { const methodName = stringCamelCase(func.name.toString()); const args = Method.filterOrigin(func).map(({ name, type }) => `${name}: ` + '`' + type + '`').join(', '); - const doc = func.documentation.reduce((md: string, doc: string) => `${md} ${doc}`, ''); + const doc = func.documentation.reduce((md, doc) => `${md} ${doc}`, ''); const renderSignature = `${md}\n▸ **${methodName}**(${args})`; const renderSummary = `${doc ? `\n- **summary**: ${doc}\n` : '\n'}`; @@ -139,22 +137,22 @@ function addExtrinsics (metadata: Metadata) { function addStorage (metadata: Metadata) { const renderHeading = `## ${ANCHOR_TOP}Storage${DESC_STORAGE}`; - const orderedSections = metadata.modules.map((i: any) => i).sort(); + const orderedSections = metadata.modules.sort(); const renderAnchors = generateSectionLinks('storage', metadata); - return orderedSections.reduce((md: string, moduleMetadata: any) => { + return orderedSections.reduce((md, moduleMetadata) => { if (moduleMetadata.storage.isNone) { return md; } const sectionName = stringLowerFirst(moduleMetadata.storage.unwrap().prefix.toString()); const renderSection = generateSectionHeader(md, sectionName); - const orderedMethods = moduleMetadata.storage.unwrap().functions.map((i: any) => i).sort(); + const orderedMethods = moduleMetadata.storage.unwrap().functions.sort(); - return orderedMethods.reduce((md: string, func: any) => { + return orderedMethods.reduce((md, func) => { const methodName = stringLowerFirst(func.name.toString()); const arg = func.type.isMap ? ('`' + func.type.asMap.key.toString() + '`') : ''; - const doc = func.documentation.reduce((md: string, doc: string) => `${md} ${doc}`, ''); + const doc = func.documentation.reduce((md, doc) => `${md} ${doc}`, ''); const renderSignature = `${md}\n▸ **${methodName}**(${arg}): ` + '`' + func.type + '`'; const renderSummary = `${doc ? `\n- **summary**: ${doc}\n` : '\n'}`; @@ -163,66 +161,38 @@ function addStorage (metadata: Metadata) { }, renderHeading + renderAnchors); } -function writeToRpcMd () { +function writeFile (name: string, ...chunks: Array) { const options = { flags: 'w', encoding: 'utf8' }; - const writeStream = fs.createWriteStream('docs/METHODS_RPC.md', options); - - writeStream.write(addRpc()); + const writeStream = fs.createWriteStream(name, options); writeStream.on('finish', () => { - console.log('wrote all rpc method metadata to Gitbook Markdown file'); + console.log(`Completed writing ${name}`); }); + chunks.forEach((chunk) => + writeStream.write(chunk) + ); + writeStream.end(); } +function writeToRpcMd () { + writeFile('docs/METHODS_RPC.md', addRpc()); +} + function writeToStorageMd (metadata: Metadata) { - const optionsRead = { flags: 'r', encoding: 'utf8' }; - fs.readFile('packages/types/src/scripts/METHODS_STORAGE_SUBSTRATE.md', optionsRead, function read (err: Error, data: string) { - if (err) { - throw err; - } + const options = { flags: 'r', encoding: 'utf8' }; + const data = fs.readFileSync('packages/types/src/scripts/METHODS_STORAGE_SUBSTRATE.md', options); - // 'utf8', 'ascii', 'binary', 'hex', 'base64', or 'utf16le' - const options = { flags: 'w', encoding: 'utf8' }; - const writeStream = fs.createWriteStream('docs/METHODS_STORAGE.md', options); - - writeStream.write(addStorage(metadata)); - writeStream.write(data); - - // finish emitting event when all data flushed from stream - writeStream.on('finish', () => { - console.log('wrote all storage metadata to Gitbook Markdown file'); - }); - - writeStream.end(); - }); + writeFile('docs/METHODS_STORAGE.md', addStorage(metadata), data); } function writeToExtrinsicsMd (metadata: Metadata) { - const options = { flags: 'w', encoding: 'utf8' }; - const writeStream = fs.createWriteStream('docs/METHODS_EXTRINSICS.md', options); - - writeStream.write(addExtrinsics(metadata)); - - writeStream.on('finish', () => { - console.log('wrote all extrinsics metadata to Gitbook Markdown file'); - }); - - writeStream.end(); + writeFile('docs/METHODS_EXTRINSICS.md', addExtrinsics(metadata)); } function writeToEventsMd (metadata: Metadata) { - const options = { flags: 'w', encoding: 'utf8' }; - const writeStream = fs.createWriteStream('docs/METHODS_EVENTS.md', options); - - writeStream.write(addEvents(metadata)); - - writeStream.on('finish', () => { - console.log('wrote all event metadata to Gitbook Markdown file'); - }); - - writeStream.end(); + writeFile('docs/METHODS_EVENTS.md', addEvents(metadata)); } const metadata = new Metadata(rpcdata); diff --git a/yarn.lock b/yarn.lock index 84bcba4a46..881ddb72d4 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1349,14 +1349,14 @@ typedoc-plugin-no-inherit "^1.0.2" typescript "^3.2.1" -"@polkadot/keyring@^0.33.11": - version "0.33.11" - resolved "https://registry.yarnpkg.com/@polkadot/keyring/-/keyring-0.33.11.tgz#79c6174e9b27147ff69a2375f39a2462b2d581c7" - integrity sha512-AP98VfGbcdXo9Bp650klh0l734kcmrYM1kzDs+mpGmpwMQtjRrEuitWwAvb84Sl6Snq6qMOadLXVAxU8PtOtgA== +"@polkadot/keyring@^0.33.12": + version "0.33.12" + resolved "https://registry.yarnpkg.com/@polkadot/keyring/-/keyring-0.33.12.tgz#7e5d8e5ad996981790b76c4741b89eea4ce8988d" + integrity sha512-qClQCGtP6zMZzi6WZbToyyaifbpX3D25UAgEl4wyGn+G1NM8anRVRcjtRFOBRSE+WFZU6SPyMtmyMWI+roQ42A== dependencies: "@babel/runtime" "^7.1.5" - "@polkadot/util" "^0.33.11" - "@polkadot/util-crypto" "^0.33.11" + "@polkadot/util" "^0.33.12" + "@polkadot/util-crypto" "^0.33.12" "@types/bs58" "^3.0.30" bs58 "^4.0.1" @@ -1365,13 +1365,13 @@ resolved "https://registry.yarnpkg.com/@polkadot/ts/-/ts-0.1.41.tgz#647b44b038f94a7acf76633b25cb72df897872fc" integrity sha512-/vYpjqKU+QKHNAlFdLgFZAAr54wxQMgIuszZ5BxaayUoq7ukDlvCPhUGQ3fNoyBSEaL7uTCZ/5SVRc363IehoA== -"@polkadot/util-crypto@^0.33.11": - version "0.33.11" - resolved "https://registry.yarnpkg.com/@polkadot/util-crypto/-/util-crypto-0.33.11.tgz#25b30e69a4da1f6a42d3680536130ca4f9480db6" - integrity sha512-jL1TzlqHGKRu9SN80e0K/0H1ZZ6fRTv96s2f6s27GrGt6+tcPEVcmaQK5vjEDMw2pT9+b5TPwcx2gLwh56GLVg== +"@polkadot/util-crypto@^0.33.12": + version "0.33.12" + resolved "https://registry.yarnpkg.com/@polkadot/util-crypto/-/util-crypto-0.33.12.tgz#1f5ab4f6cda328ca4460be3c6d083671e815ff1e" + integrity sha512-iIY4qminRjWOrYhbl9DuJ6CjQC0sivrkGI1yV5wVxSVPwC9GHYL/3MKmw4FX7vhtaLlrcs0hTz/g/MOt66fX/Q== dependencies: "@babel/runtime" "^7.1.5" - "@polkadot/util" "^0.33.11" + "@polkadot/util" "^0.33.12" "@types/bip39" "^2.4.1" bip39 "^2.5.0" blakejs "^1.1.0" @@ -1379,10 +1379,10 @@ tweetnacl "^1.0.0" xxhashjs "^0.2.2" -"@polkadot/util@^0.33.11": - version "0.33.11" - resolved "https://registry.yarnpkg.com/@polkadot/util/-/util-0.33.11.tgz#3e2433e556ee14c685ebc5920c229cb76e0b985b" - integrity sha512-Tn+WYU+RxOaJhrUsPjBOk77MDKb6bsqVkcs5ysSc1HUDIRqZwGABnX1rhP2/DipS91hj8DQ2HZE18S7mCBv1bQ== +"@polkadot/util@^0.33.12": + version "0.33.12" + resolved "https://registry.yarnpkg.com/@polkadot/util/-/util-0.33.12.tgz#489fbe478887ec1bba0b7873b3cff39bf17899fb" + integrity sha512-8qAjFGR9IjS8CBEqvJyPUEFasJVCF/bB/vqZFKG/LPi3oL1y4kTIWnwp1GhLhXCVIjfoZOxaW5wpnRajbeHINQ== dependencies: "@babel/runtime" "^7.1.5" "@types/bn.js" "^4.11.3"