@polkadot/jsonrpc - npm Package Compare versions

Comparing version 0.1.5 to 0.1.6

docs/chain.md

 # chain
 
+Methods to retrieve chain data.
+
 - [chain_getHeader](#chain_getHeader)
@@ -7,2 +9,4 @@
 
+Retrieve the header for a specific block as specified by `hash`.
+
 `chain_getHeader(hash: HeaderHash) => Header`

docs/state.md

 # state
 
+Query the state and state storage
+
 - [state_call](#state_call)
@@ -8,2 +10,4 @@ - [state_getStorage](#state_getStorage)
 
+Call a `method` at a specific `address`, passing the encoded `data`. The query is executed at the block specified by `block`.
+
 `state_call(address: Address, method: String, data: CallData, block: HeaderHash) => OutData`
@@ -13,2 +17,4 @@
 
+Get the storage `key` at a specific `address`, executing the query at a specific `block`.
+
 `state_getStorage(address: Address, key: H256, block: HeaderHash) => StorageData`

lib/rpc/chain.js

 'use strict';
 
 module.exports = {
+  description: 'Methods to retrieve chain data.',
   methods: {
     getHeader: {
+      description: 'Retrieve the header for a specific block as specified by `hash`.',
       inputs: [{ name: 'hash', type: 'HeaderHash' }],
@@ -7,0 +9,0 @@ output: { type: 'Header' }

lib/rpc/state.js

 'use strict';
 
 module.exports = {
+  description: 'Query the state and state storage',
   methods: {
     call: {
+      description: 'Call a `method` at a specific `address`, passing the encoded `data`. The query is executed at the block specified by `block`.',
       inputs: [{ name: 'address', type: 'Address' }, { name: 'method', type: 'String' }, { name: 'data', type: 'CallData' }, { name: 'block', type: 'HeaderHash' }],
@@ -12,2 +14,3 @@ output: {
     getStorage: {
+      description: 'Get the storage `key` at a specific `address`, executing the query at a specific `block`.',
       inputs: [{ name: 'address', type: 'Address' }, { name: 'key', type: 'H256' }, { name: 'block', type: 'HeaderHash' }],
@@ -14,0 +17,0 @@ output: {

package.json

 {
   "name": "@polkadot/jsonrpc",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Method definitions for the Polkador RPC layer",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

src/rpc/chain.js

@@ -7,4 +7,6 @@ // ISC, Copyright 2017 Jaco Greeff
 module.exports = ({
+  description: 'Methods to retrieve chain data.',
   methods: {
     getHeader: {
+      description: 'Retrieve the header for a specific block as specified by `hash`.',
       inputs: [
@@ -11,0 +13,0 @@ { name: 'hash', type: 'HeaderHash' }

src/rpc/state.js

@@ -7,4 +7,6 @@ // ISC, Copyright 2017 Jaco Greeff
 module.exports = ({
+  description: 'Query the state and state storage',
   methods: {
     call: {
+      description: 'Call a `method` at a specific `address`, passing the encoded `data`. The query is executed at the block specified by `block`.',
       inputs: [
@@ -21,2 +23,3 @@ { name: 'address', type: 'Address' },
     getStorage: {
+      description: 'Get the storage `key` at a specific `address`, executing the query at a specific `block`.',
       inputs: [
@@ -23,0 +26,0 @@ { name: 'address', type: 'Address' },

src/types.js

@@ -18,2 +18,3 @@ // ISC, Copyright 2017 Jaco Greeff
   deprecated?: boolean,
+  description: string,
   inputs: Array<InterfaceInputType>,
@@ -24,2 +25,3 @@ output: InterfaceOutputType
 export type InterfaceDefinition = {
+  description: string,
   methods: {
@@ -26,0 +28,0 @@ [string]: InterfaceMethodDefinition

No alert changes

Improved metrics

Total package byte prevSize

10013

increased by14.87%

Lines of code

155

increased by8.39%

No dependency changes