@polkadot/jsonrpc - npm Package Compare versions

Comparing version 0.4.1 to 0.15.1

index.js

@@ -1,1 +0,22 @@
-console.error('FATAL ERROR: @polkadot/jsonrpc has been deprecated and replaced with @polkadot/api-jsonrpc');
+"use strict";
+
+// Copyright 2017-2018 Jaco Greeff
+// This software may be modified and distributed under the terms
+// of the ISC license. See the LICENSE file for details.
+const author = require('./author');
+
+const chain = require('./chain');
+
+const state = require('./state');
+
+const createShape = require('./shape');
+/**
+  @summary Exposes the definition for the RPC endpoints for a Polkadot client node
+*/
+
+
+module.exports = createShape({
+  author,
+  chain,
+  state
+});

package.json

 {
   "name": "@polkadot/jsonrpc",
-  "version": "0.4.1",
-  "description": "DEPRECATED",
+  "version": "0.15.1",
+  "description": "Method definitions for the Polkadot RPC layer",
   "main": "index.js",
@@ -15,19 +15,23 @@ "engines": {
     "type": "git",
-    "url": "git+https://github.com/polkadot-js/jsonrpc.git"
+    "url": "git+https://github.com/polkadot-js/api.git"
   },
-  "keywords": [],
+  "keywords": [
+    "Polkadot",
+    "JsonRPC"
+  ],
   "author": "Jaco Greeff <[e-mail]>",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/polkadot-js/jsonrpc/issues"
+    "url": "https://github.com/polkadot-js/api/issues"
   },
-  "homepage": "https://github.com/polkadot-js/jsonrpc#readme",
+  "homepage": "https://github.com/polkadot-js/api/tree/master/packages/jsonrpc#readme",
   "scripts": {
-    "build": "echo \"skipped\"",
-    "check": "echo \"skipped\"",
-    "test": "echo \"skipped\""
+    "build": "polkadot-dev-build-babel && polkadot-dev-build-docs",
+    "check": "eslint src && flow check",
+    "test": "echo \"Tests only available from root wrapper\""
   },
-  "devDependencies": {
-    "@polkadot/dev": "^0.9.2"
+  "dependencies": {
+    "@polkadot/params": "^0.15.1",
+    "babel-runtime": "^6.26.0"
   }
 }

README.md

@@ -0,3 +1,30 @@
+[![polkadotjs](https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square)](https://polkadot.js.org)
+![isc](https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square)
+[![style](https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square)](https://github.com/Flet/semistandard)
+[![npm](https://img.shields.io/npm/v/@polkadot/jsonrpc.svg?style=flat-square)](https://www.npmjs.com/package/@polkadot/jsonrpc)
+[![travis](https://img.shields.io/travis/polkadot-js/types.svg?style=flat-square)](https://travis-ci.org/polkadot-js/types)
+[![maintainability](https://img.shields.io/codeclimate/maintainability/polkadot-js/types.svg?style=flat-square)](https://codeclimate.com/github/polkadot-js/types/maintainability)
+[![coverage](https://img.shields.io/coveralls/polkadot-js/types.svg?style=flat-square)](https://coveralls.io/github/polkadot-js/types?branch=master)
+[![dependency](https://david-dm.org/polkadot-js/types.svg?style=flat-square&path=packages/jsonrpc)](https://david-dm.org/polkadot-js/types?path=packages/jsonrpc)
+[![devDependency](https://david-dm.org/polkadot-js/types/dev-status.svg?style=flat-square&path=packages/jsonrpc)](https://david-dm.org/polkadot-js/types?path=packages/jsonrpc#info=devDependencies)
+
 # @polkadot/jsonrpc
 
-Deprecated and replaced in favour of [@polkadot/api-jsonrpc](https://github.com/polkadot-js/api/tree/master/packages/api-jsonrpc).
+A defintion of all the methods exposed in a general Polkadot client application. These are used not only to provide a comprehensive code-generated document of the available methods, but are also used in the API to auto-generate endpoints with the required type-checking.
+
+For a list of currently exposed methods, see the [method documentation](docs/README.md).
+
+## Usage
+
+Installation -
+
+```
+npm install --save @polkadot/jsonrpc
+```
+
+## Adding methods
+
+As methods are added, simply adding the name, inputs & output will prepare it for use.
+
+- Add the method to the correct file in [src/rpc/](src/rpc/) (Input/Output types as cross-referenced from the canonical implementation and match one-to-one)
+- Should a new type be required, add it to the type list, [src/types.js](src/types.js) (Required for flow type checking)

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17030

increased by758.37%

Dev dependency count

0

decreased by-100%

Number of package files

27

increased by440%

Lines of code

193

increased by19200%

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

31

increased by675%

Worsened metrics

Dependency count

2

increased byInfinity%

Dependency changes

• + Added@polkadot/params@^0.15.1

• + Addedbabel-runtime@^6.26.0

• + Added@babel/runtime@7.26.9(transitive)

• + Added@polkadot/extrinsics@0.15.8(transitive)

• + Added@polkadot/extrinsics-substrate@0.15.8(transitive)

• + Added@polkadot/params@0.15.8(transitive)

• + Added@polkadot/primitives@0.15.8(transitive)

• + Added@polkadot/util@0.21.3(transitive)

• + Addedbabel-runtime@6.26.0(transitive)

• + Addedbindings@1.5.0(transitive)

• + Addedbn.js@4.12.1(transitive)

• + Addedcore-js@2.6.12(transitive)

• + Addeddeasync@0.1.30(transitive)

• + Addedfile-uri-to-path@1.0.0(transitive)

• + Addedip-regex@2.1.0(transitive)

• + Addednode-addon-api@1.7.2(transitive)

• + Addedregenerator-runtime@0.11.10.14.1(transitive)