const Api = require ( '@polkadot/api' ) . default ;
-const WsProvider = require ( '@polkadot/api-provider/ws' ) . default ;
+const Rpc = require ( '@polkadot/rpc-core' ) . default ;
+const WsProvider = require ( '@polkadot/rpc-provider/ws' ) . default ;
const provider = new WsProvider ( 'ws://127.0.0.1:9944' ) ;
-const api = new Api ( provider ) ;
+const api = new Rpc ( provider ) ;
async function getChain ( ) {
return api . system . chain ( ) ;
@@ -431,7 +431,7 @@
diff --git a/docs/examples/02_listen_to_blocks/index.html b/docs/examples/02_listen_to_blocks/index.html
index c0dfa92982..0f3126daf9 100644
--- a/docs/examples/02_listen_to_blocks/index.html
+++ b/docs/examples/02_listen_to_blocks/index.html
@@ -104,12 +104,12 @@
-
+
-
+
- api
+ rpc-core
@@ -118,12 +118,12 @@
-
+
-
+
- Api
+ Rpc
@@ -136,12 +136,12 @@
-
+
-
+
- api-provider
+ rpc-provider
@@ -150,9 +150,9 @@
-
+
-
+
HttpProvider
@@ -163,9 +163,9 @@
-
+
-
+
WsProvider
@@ -181,12 +181,12 @@
-
+
-
+
- api-rx
+ rpc-rx
@@ -195,12 +195,12 @@
-
+
-
+
- ApiRx
+ RpcRx
@@ -374,10 +374,10 @@
It displays the block number every time a new block is seen by the node you are connected to.
NOTE: The example runs until you stop it with CTRL+C
const BN = require ( 'bn.js' ) ;
-const Api = require ( '@polkadot/api' ) . default ;
-const WsProvider = require ( '@polkadot/api-provider/ws' ) . default ;
+const Rpc = require ( '@polkadot/rpc-core' ) . default ;
+const WsProvider = require ( '@polkadot/rpc-provider/ws' ) . default ;
const provider = new WsProvider ( 'ws://127.0.0.1:9944' ) ;
-const api = new Api ( provider ) ;
+const api = new Rpc ( provider ) ;
function main ( ) {
console . log ( 'Blocks will be shown as they come in, CTRL+C to stop:' ) ;
@@ -433,7 +433,7 @@
diff --git a/docs/examples/03_listen_to_balance_change/index.html b/docs/examples/03_listen_to_balance_change/index.html
index 91f3067163..916ecf7226 100644
--- a/docs/examples/03_listen_to_balance_change/index.html
+++ b/docs/examples/03_listen_to_balance_change/index.html
@@ -104,12 +104,12 @@
-
+
-
+
- api
+ rpc-core
@@ -118,12 +118,12 @@
-
+
-
+
- Api
+ Rpc
@@ -136,12 +136,12 @@
-
+
-
+
- api-provider
+ rpc-provider
@@ -150,9 +150,9 @@
-
+
-
+
HttpProvider
@@ -163,9 +163,9 @@
-
+
-
+
WsProvider
@@ -181,12 +181,12 @@
-
+
-
+
- api-rx
+ rpc-rx
@@ -195,12 +195,12 @@
-
+
-
+
- ApiRx
+ RpcRx
@@ -372,11 +372,12 @@
Listen to balance changes
This example shows how to instantiate a Polkadot API object and use it to connect to a node.
const BN = require ( 'bn.js' ) ;
-const Api = require ( '@polkadot/api' ) . default ;
-const WsProvider = require ( '@polkadot/api-provider/ws' ) . default ;
+const Rpc = require ( '@polkadot/rpc-core' ) . default ;
+const WsProvider = require ( '@polkadot/rpc-provider/ws' ) . default ;
const storage = require ( '@polkadot/storage' ) . default ;
const provider = new WsProvider ( 'ws://127.0.0.1:9944' ) ;
-const api = new Api ( provider ) ;
+const api = new Rpc ( provider ) ;
+
const Alice = '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDtZ' ;
console . log ( 'You may leave this example running and start example 06 or send DOTs to ' + Alice ) ;
@@ -432,7 +433,7 @@
diff --git a/docs/examples/04_generate_account/index.html b/docs/examples/04_generate_account/index.html
index 19627f4658..f4d79eb7de 100644
--- a/docs/examples/04_generate_account/index.html
+++ b/docs/examples/04_generate_account/index.html
@@ -104,12 +104,12 @@
-
+
-
+
- api
+ rpc-core
@@ -118,12 +118,12 @@
-
+
-
+
- Api
+ Rpc
@@ -136,12 +136,12 @@
-
+
-
+
- api-provider
+ rpc-provider
@@ -150,9 +150,9 @@
-
+
-
+
- api
+ rpc-core
@@ -118,12 +118,12 @@
-
+
-
+
- Api
+ Rpc
@@ -136,12 +136,12 @@
-
+
-
+
- api-provider
+ rpc-provider
@@ -150,9 +150,9 @@
-
+
-
+
HttpProvider
@@ -163,9 +163,9 @@
-
+
-
+
WsProvider
@@ -181,12 +181,12 @@
-
+
-
+
- api-rx
+ rpc-rx
@@ -195,12 +195,12 @@
-
+
-
+
- ApiRx
+ RpcRx
@@ -372,12 +372,12 @@
Read storage
Many important variables are available through the storage API. This example shows how to call a few of those APIs.
const BN = require ( 'bn.js' ) ;
-const Api = require ( '@polkadot/api' ) . default ;
-const WsProvider = require ( '@polkadot/api-provider/ws' ) . default ;
+const Rpc = require ( '@polkadot/rpc-core' ) . default ;
+const WsProvider = require ( '@polkadot/rpc-provider/ws' ) . default ;
const storage = require ( '@polkadot/storage' ) . default ;
const provider = new WsProvider ( 'ws://127.0.0.1:9944' ) ;
-const api = new Api ( provider ) ;
+const api = new Rpc ( provider ) ;
async function getAccountIndex ( address ) {
return api . state . getStorage ( [ storage . system . public . accountIndexOf , address ] ) ;
@@ -447,7 +447,7 @@
diff --git a/docs/examples/06_craft_extrinsic/index.html b/docs/examples/06_craft_extrinsic/index.html
index 48d1e6fe90..61065f4bc6 100644
--- a/docs/examples/06_craft_extrinsic/index.html
+++ b/docs/examples/06_craft_extrinsic/index.html
@@ -104,12 +104,12 @@
-
+
-
+
- api
+ rpc-core
@@ -118,12 +118,12 @@
-
+
-
+
- Api
+ Rpc
@@ -136,12 +136,12 @@
-
+
-
+
- api-provider
+ rpc-provider
@@ -150,9 +150,9 @@
-
+
-
+
HttpProvider
@@ -163,9 +163,9 @@
-
+
-
+
WsProvider
@@ -181,12 +181,12 @@
-
+
-
+
- api-rx
+ rpc-rx
@@ -195,12 +195,12 @@
-
+
-
+
- ApiRx
+ RpcRx
@@ -372,8 +372,8 @@
Craft Extrinsic
In the current version, crafting an extrinsic is a rather cumbersome process. This sample guides you through it and shows how to tranfer DOTs from one an account to another.
const BN = require ( 'bn.js' ) ;
-const Api = require ( '@polkadot/api' ) . default ;
-const WsProvider = require ( '@polkadot/api-provider/ws' ) . default ;
+const Rpc = require ( '@polkadot/rpc-core' ) . default ;
+const WsProvider = require ( '@polkadot/rpc-provider/ws' ) . default ;
const extrinsics = require ( '@polkadot/extrinsics' ) . default ;
const encodeExtrinsic = require ( '@polkadot/extrinsics/codec/encode' ) . default ;
const encodeLength = require ( '@polkadot/extrinsics/codec/encode/length' ) . default ;
@@ -383,7 +383,7 @@
const Encoder = new TextEncoder ( ) ;
const keyring = new Keyring ( ) ;
const provider = new WsProvider ( 'ws://127.0.0.1:9944' ) ;
-const api = new Api ( provider ) ;
+const api = new Rpc ( provider ) ;
async function getAccountIndex ( address ) {
return api . state . getStorage ( [ storage . system . public . accountIndexOf , address ] ) ;
@@ -471,7 +471,7 @@
diff --git a/docs/examples/07_transfer_dots/index.html b/docs/examples/07_transfer_dots/index.html
index c526a35e87..a754a1702e 100644
--- a/docs/examples/07_transfer_dots/index.html
+++ b/docs/examples/07_transfer_dots/index.html
@@ -102,12 +102,12 @@
-
+
-
+
- api
+ rpc-core
@@ -116,12 +116,12 @@
-
+
-
+
- Api
+ Rpc
@@ -134,12 +134,12 @@
-
+
-
+
- api-provider
+ rpc-provider
@@ -148,9 +148,9 @@
-
+
-
+
HttpProvider
@@ -161,9 +161,9 @@
-
+
-
+
WsProvider
@@ -179,12 +179,12 @@
-
+
-
+
- api-rx
+ rpc-rx
@@ -193,12 +193,12 @@
-
+
-
+
- ApiRx
+ RpcRx
@@ -370,8 +370,8 @@
Tranfer DOTs
This sample is more 'straight to the point' and shows the easiest way to transfer DOTs from one an account to another.
const BN = require ( 'bn.js' ) ;
-const Api = require ( '@polkadot/api' ) . default ;
-const WsProvider = require ( '@polkadot/api-provider/ws' ) . default ;
+const Rpc = require ( '@polkadot/rpc-core' ) . default ;
+const WsProvider = require ( '@polkadot/rpc-provider/ws' ) . default ;
const extrinsics = require ( '@polkadot/extrinsics' ) . default ;
const encodeExtrinsic = require ( '@polkadot/extrinsics/codec/encode/uncheckedLength' ) . default ;
const Keyring = require ( '@polkadot/util-keyring' ) . default ;
@@ -380,7 +380,7 @@
const Encoder = new TextEncoder ( ) ;
const keyring = new Keyring ( ) ;
const provider = new WsProvider ( 'ws://127.0.0.1:9944' ) ;
-const api = new Api ( provider ) ;
+const api = new Rpc ( provider ) ;
async function getAccountIndex ( address ) {
return api . state . getStorage ( [ storage . system . public . accountIndexOf , address ] ) ;
@@ -451,7 +451,7 @@
diff --git a/docs/examples/index.html b/docs/examples/index.html
index 8227058894..e240a09b8d 100644
--- a/docs/examples/index.html
+++ b/docs/examples/index.html
@@ -60,7 +60,7 @@
-
+
@@ -104,12 +104,12 @@
-
+
-
+
- api
+ rpc-core
@@ -118,12 +118,12 @@
-
+
-
+
- Api
+ Rpc
@@ -136,12 +136,12 @@
-
+
-
+
- api-provider
+ rpc-provider
@@ -150,9 +150,9 @@
-
+
-
+
HttpProvider
@@ -163,9 +163,9 @@
-
+
-
+
WsProvider
@@ -181,12 +181,12 @@
-
+
-
+
- api-rx
+ rpc-rx
@@ -195,12 +195,12 @@
-
+
-
+
- ApiRx
+ RpcRx
@@ -411,7 +411,7 @@
-
+
@@ -427,7 +427,7 @@
-
+
-
+
- api
+ rpc-core
@@ -116,12 +116,12 @@
-
+
-
+
- Api
+ Rpc
@@ -134,12 +134,12 @@
-
+
-
+
- api-provider
+ rpc-provider
@@ -148,9 +148,9 @@
-
+
-
+
HttpProvider
@@ -161,9 +161,9 @@
-
+
-
+
WsProvider
@@ -179,12 +179,12 @@
-
+
-
+
- api-rx
+ rpc-rx
@@ -193,12 +193,12 @@
-
+
-
+
- ApiRx
+ RpcRx
@@ -371,17 +371,17 @@
You can query a node and interact with the Polkadot network using Javascript. This guide describes the Polkadot Javascript API.
Packages
Rpc · Polkadot API Book
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ name
+summary
+description
+example
+import Api from '@polkadot/rpc-core' ;
+import WsProvider from '@polkadot/rpc-provider/ws' ;
+
+const provider = new WsProvider ( 'ws://127.0.0.1:9944' ) ;
+const api = new Api ( provider ) ;
+Hierarchy
+Rpc
+Implements
+
+Constructors
+
+constructor
+⊕ new Rpc (provider: ProviderInterfaceRpc
+Defined in index.ts:37
+constructor
+Parameters:
+
+
+
+Param
+Type
+Description
+
+
+
+
+provider
+ProviderInterfaceAn API provider using HTTP or WebSocket
+
+
+
+Returns: Rpc
+Properties
+
+author
+● author : RpcInterface$Section
+Defined in index.ts:34
+
+chain
+● chain : RpcInterface$Section
+Defined in index.ts:35
+
+state
+● state : RpcInterface$Section
+Defined in index.ts:36
+
+system
+● system : RpcInterface$Section
+Defined in index.ts:37
+Methods
+
+<Static> signature▸ signature (__namedParameters: objectstring
+Defined in index.ts:72
+name
+summary
+description
+example
+import Api from '@polkadot/rpc-core' ;
+
+Api . signature ( { name : 'test_method' , params : [ { name : 'dest' , type : 'Address' } ] , type : 'Address' } ) ;
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+__namedParameters
+object
+
+
+Returns: string
+
+
+
+
+
+
+
+
+
+
+
+
+
No results matching "
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
` signature
+
+▸ **signature**(__namedParameters: *`object`*): `string`
+
+*Defined in [index.ts:72](https://github.com/polkadot-js/api/blob/4344f33/packages/rpc-core/src/index.ts#L72)*
+
+*__name__*: signature
+
+*__summary__*: Returns a string representation of the method with inputs and outputs.
+
+*__description__*: Formats the name, inputs and outputs into a human-readable string. This contains the input parameter names input types and output type.
+
+*__example__*:
+```javascript
+import Api from '@polkadot/rpc-core';
+
+Api.signature({ name: 'test_method', params: [ { name: 'dest', type: 'Address' } ], type: 'Address' }); // => test_method (dest: Address): Address
+```
+
+**Parameters:**
+
+| Param | Type |
+| ------ | ------ |
+| __namedParameters | `object` |
+
+**Returns:** `string`
+
+___
+
diff --git a/docs/rpc-core/index.html b/docs/rpc-core/index.html
new file mode 100644
index 0000000000..8865c6b459
--- /dev/null
+++ b/docs/rpc-core/index.html
@@ -0,0 +1,500 @@
+
+
+
+
+ rpc-core · Polkadot API Book
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+@polkadot/api
+This library provides a clean wrapper around all the methods exposed by a Polkadot network client.
+Usage
+Installation -
+npm install --save @polkadot/rpc-core
+Initialisation -
+import Api from '@polkadot/rpc-core' ;
+import WsProvider from '@polkadot/rpc-provider/ws' ;
+
+const provider = new WsProvider ( 'http://127.0.0.1:9944' ) ;
+const api = new Api ( provider ) ;
+Making calls -
+api . chain
+ . getHeader ( '0x1234567890' )
+ . then ( ( header ) = > console . log ( header ) )
+ . catch ( ( error ) = > console . error ( error ) ) ;
+Retrieving the best block (once-off) -
+api . chain
+ . getHead ( )
+ . then ( ( headerHash ) = > {
+ return api . chain . getHeader ( headerHash ) ;
+ } )
+ . then ( ( header ) = > {
+ console . log ( ` best # $ { header . number . toString ( ) } ` ) ;
+ } )
+ . catch ( ( error ) = > {
+ console . error ( 'error:' , error ) ;
+ } ) ;
+Retrieving best header via subscription -
+api . chain
+ . newHead ( ( error , header ) = > {
+ if ( error ) {
+ console . error ( 'error:' , error ) ;
+ }
+
+ console . log ( ` best # $ { header . number . toString ( ) } ` ) ;
+ } )
+ . then ( ( subscriptionId ) = > {
+
+
+ } )
+ . catch ( ( error ) = > {
+ console . error ( 'error subscribing:' , error ) ;
+ } ) ;
+
+
+
+
+
+
+
+
+
+
+
+
+
No results matching "
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
HttpProvider · Polkadot API Book
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ name
+summary
+description WsProvider .
+example
+import Api from '@polkadot/rpc-core' ;
+import HttpProvider from '@polkadot/rpc-provider/http' ;
+
+const provider = new HttpProvider ( 'http://127.0.0.1:9933' ) ;
+const api = new Api ( provider ) ;
+see WsProvider
+Hierarchy
+HttpProvider
+Implements
+
+Constructors
+
+constructor
+⊕ new HttpProvider (endpoint: stringHttpProvider
+Defined in http/index.ts:40
+Parameters:
+
+
+
+Param
+Type
+Description
+
+
+
+
+endpoint
+stringThe endpoint url starting with http://
+
+
+
+Returns: HttpProvider
+Methods
+
+isConnected
+▸ isConnected (): boolean
+Implementation of ProviderInterface .isConnected
+Defined in http/index.ts:57
+summary
+Returns: boolean
+true if connected
+
+on
+▸ on (type: ProviderInterface$Emitted ProviderInterface$EmitCb void
+Implementation of ProviderInterface .on
+Defined in http/index.ts:65
+summary WsProvider .
+description
+Parameters:
+
+Returns: void
+
+send
+▸ send (method: stringArray<any>Promise<any>
+Implementation of ProviderInterface .send
+Defined in http/index.ts:72
+summary
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+method
+string
+
+params
+Array<any>
+
+
+Returns: Promise<any>
+
+subscribe
+▸ subscribe (types: stringstringArray<any>ProviderInterface$Callback Promise<number>
+Implementation of ProviderInterface .subscribe
+Defined in http/index.ts:94
+summary WsProvider .
+Parameters:
+
+Returns: Promise<number>
+
+unsubscribe
+▸ unsubscribe (type: stringstringnumberPromise<boolean>
+Implementation of ProviderInterface .unsubscribe
+Defined in http/index.ts:103
+summary WsProvider .
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+type
+string
+
+method
+string
+
+id
+number
+
+
+Returns: Promise<boolean>
+
+
+
+
+
+
+
+
+
+
+
+
+
No results matching "
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
WsProvider · Polkadot API Book
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ name
+summary
+description HttpProvider , it does support subscriptions and allows listening to events such as new blocks or balance changes.
+example
+import Api from '@polkadot/rpc-core' ;
+import WsProvider from '@polkadot/rpc-provider/ws' ;
+
+const provider = new WsProvider ( 'ws://127.0.0.1:9944' ) ;
+const api = new Api ( provider ) ;
+see HttpProvider
+Type parameters
+EventTypes : string | symbol
+Hierarchy
+ EventEmitter
+↳ WsProvider
+Implements
+
+Constructors
+
+constructor
+⊕ new WsProvider (endpoint: stringbooleanWsProvider
+Defined in ws/index.ts:73
+Parameters:
+
+
+
+Param
+Type
+Default value
+Description
+
+
+
+
+endpoint
+string-
+The endpoint url. Usually `ws://ip:9944` or `wss://ip:9944`
+
+
+Default value autoConnectbooleantrue
+Whether to connect automatically or not.
+
+
+
+Returns: WsProvider
+Properties
+
+<Static> prefixed● prefixed : string | boolean
+
+Inherited from EventEmitter.prefixed
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6
+Methods
+
+addListener
+▸ addListener (event: EventTypesListenerFnanythis
+Inherited from EventEmitter.addListener
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:33
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+event
+EventTypes
+
+fn
+ListenerFn
+
+Optional contextany
+
+
+Returns: this
+
+connect
+▸ connect (): void
+Defined in ws/index.ts:104
+summary
+description WsProvider connects automatically by default, however if you decided otherwise, you may connect manually using this method.
+Returns: void
+
+emit
+▸ emit (event: EventTypesArray<any>boolean
+Inherited from EventEmitter.emit
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:27
+Calls each of the listeners registered for a given event.
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+event
+EventTypes
+
+Rest argsArray<any>
+
+
+Returns: boolean
+
+eventNames
+▸ eventNames (): Array<EventTypes>
+Inherited from EventEmitter.eventNames
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:12
+Return an array listing the events for which the emitter has registered listeners.
+Returns: Array<EventTypes>
+
+isConnected
+▸ isConnected (): boolean
+Defined in ws/index.ts:121
+summary
+Returns: boolean
+true if connected
+
+listenerCount
+▸ listenerCount (event: EventTypesnumber
+Inherited from EventEmitter.listenerCount
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:22
+Return the number of listeners listening to a given event.
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+event
+EventTypes
+
+
+Returns: number
+
+listeners
+▸ listeners (event: EventTypesArray<ListenerFn>
+Inherited from EventEmitter.listeners
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:17
+Return the listeners registered for a given event.
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+event
+EventTypes
+
+
+Returns: Array<ListenerFn>
+
+off
+▸ off (event: EventTypesListenerFn any undefined | false | true ): this
+Inherited from EventEmitter.off
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:44
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+event
+EventTypes
+
+Optional fnListenerFn
+
+Optional contextany
+
+Optional onceundefined | false | true
+
+
+Returns: this
+
+on
+▸ on (type: ProviderInterface$Emitted ProviderInterface$EmitCb this
+Overrides EventEmitter.on
+Defined in ws/index.ts:131
+summary subscribe function.
+Parameters:
+
+Returns: this
+[description]
+
+once
+▸ once (event: EventTypesListenerFnanythis
+Inherited from EventEmitter.once
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:38
+Add a one-time listener for a given event.
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+event
+EventTypes
+
+fn
+ListenerFn
+
+Optional contextany
+
+
+Returns: this
+
+removeAllListeners
+▸ removeAllListeners (event?: EventTypes this
+Inherited from EventEmitter.removeAllListeners
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:49
+Remove all listeners, or those of the specified event.
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+Optional eventEventTypes
+
+
+Returns: this
+
+removeListener
+▸ removeListener (event: EventTypesListenerFn any undefined | false | true ): this
+Inherited from EventEmitter.removeListener
+Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:43
+Remove the listeners of a given event.
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+event
+EventTypes
+
+Optional fnListenerFn
+
+Optional contextany
+
+Optional onceundefined | false | true
+
+
+Returns: this
+
+send
+▸ send (method: stringArray<any>SubscriptionHandlerPromise<any>
+Defined in ws/index.ts:138
+summary
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+method
+string
+
+params
+Array<any>
+
+Optional subscriptionSubscriptionHandler
+
+
+Returns: Promise<any>
+
+subscribe
+▸ subscribe (type: stringstringArray<any>ProviderInterface$Callback Promise<number>
+Defined in ws/index.ts:194
+name
+summary
+example
+const provider = new WsProvider ( 'ws://127.0.0.1:9944' ) ;
+const api = new Api ( provider ) ;
+
+api . state . storage ( [ [ storage . balances . freeBalance , < Address > ] ] , ( _ , values ) = > {
+ console . log ( values )
+} ) . then ( ( subscriptionId ) = > {
+ console . log ( 'balance changes subscription id: ' , subscriptionId )
+} )
+Parameters:
+
+
+
+Param
+Type
+Description
+
+
+
+
+type
+stringSubscription type
+
+
+method
+stringSubscription method
+
+
+params
+Array<any>Parameters
+
+
+callback
+ProviderInterface$Callback Callback
+
+
+
+Returns: Promise<number>
+Promise resolving to the dd of the subscription you can use with [[unsubscribe]].
+
+unsubscribe
+▸ unsubscribe (type: stringstringnumberPromise<boolean>
+Defined in ws/index.ts:203
+summary subscribe .
+Parameters:
+
+
+
+Param
+Type
+
+
+
+
+type
+string
+
+method
+string
+
+id
+number
+
+
+Returns: Promise<boolean>
+
+
+
+
+
+
+
+
+
+
+
+
+
No results matching "
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
` prefixed
+
+**● prefixed**: * `string` | `boolean`
+*
+
+*Inherited from EventEmitter.prefixed*
+
+*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:6*
+
+___
+
+# Methods
+
+]], (_, values) => {
+ console.log(values)
+}).then((subscriptionId) => {
+ console.log('balance changes subscription id: ', subscriptionId)
+})
+```
+
+**Parameters:**
+
+| Param | Type | Description |
+| ------ | ------ | ------ |
+| type | `string` | Subscription type |
+| method | `string` | Subscription method |
+| params | `Array`<`any`> | Parameters |
+| callback | [ProviderInterface$Callback](../modules/_types_d_.md#providerinterface_callback) | Callback |
+
+**Returns:** `Promise`<`number`>
+Promise resolving to the dd of the subscription you can use with [[unsubscribe]].
+
+___
+rpc-provider · Polkadot API Book
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
No results matching "
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
` EventEmitter
+
+**● EventEmitter**: *`EventEmitterStatic`*
+
+*Defined in /home/travis/build/polkadot-js/api/node_modules/eventemitter3/index.d.ts:61*
+
+___
+
diff --git a/docs/rpc-provider/modules/_ws_polyfill_.md b/docs/rpc-provider/modules/_ws_polyfill_.md
new file mode 100644
index 0000000000..139597f9cb
--- /dev/null
+++ b/docs/rpc-provider/modules/_ws_polyfill_.md
@@ -0,0 +1,2 @@
+
+
diff --git a/docs/rpc-rx/README.md b/docs/rpc-rx/README.md
new file mode 100644
index 0000000000..3db16e1e86
--- /dev/null
+++ b/docs/rpc-rx/README.md
@@ -0,0 +1,8 @@
+
+[](https://polkadot.js.org)  [](https://github.com/Flet/semistandard) [](https://www.npmjs.com/package/@polkadot/rpc-rx) [](https://travis-ci.org/polkadot-js/api) [](https://codeclimate.com/github/polkadot-js/api/maintainability) [](https://coveralls.io/github/polkadot-js/api?branch=master) [](https://david-dm.org/polkadot-js/api?path=packages/rpc-rx) [](https://david-dm.org/polkadot-js/api?path=packages/rpc-rx#info=devDependencies)
+
+@polkadot/rpc-rx
+================
+
+An RxJs wrapper around the [@polkadot/api](../api).
+
diff --git a/docs/rpc-rx/SUMMARY.md b/docs/rpc-rx/SUMMARY.md
new file mode 100644
index 0000000000..2427286787
--- /dev/null
+++ b/docs/rpc-rx/SUMMARY.md
@@ -0,0 +1,4 @@
+* ["defaults"](modules/_defaults_.md)
+* ["index"](modules/_index_.md)
+ * [RpcRx](classes/_index_.rpcrx.md)
+* ["types.d"](modules/_types_d_.md)
diff --git a/docs/rpc-rx/classes/_index_.rpcrx.md b/docs/rpc-rx/classes/_index_.rpcrx.md
new file mode 100644
index 0000000000..74f223e98f
--- /dev/null
+++ b/docs/rpc-rx/classes/_index_.rpcrx.md
@@ -0,0 +1,98 @@
+
+
+*__name__*: RpcRx
+
+*__summary__*: The RxJS API is a wrapper around the API.
+
+*__description__*: It allows wrapping API components with observables using RxJS.
+
+*__example__*:
+```javascript
+import Rpc from '@polkadot/rpc-rx';
+import WsProvider from '@polkadot/rpc-provider/ws';
+
+const provider = new WsProvider('http://127.0.0.1:9944');
+const api = new Rpc(provider);
+```
+
+# Hierarchy
+
+**RpcRx**
+
+# Implements
+
+* `object`
+
+# Constructors
+
+rpc-rx · Polkadot API Book
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
No results matching "
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
` isUnhashed
+
+**● isUnhashed**: * `undefined` | `false` | `true`
+*
+
+*Defined in [utils/createFunction.ts:15](https://github.com/polkadot-js/api/blob/4344f33/packages/type-storage/src/utils/createFunction.ts#L15)*
+
+___
+` method
+
+**● method**: * `undefined` | `string`
+*
+
+*Defined in [utils/createFunction.ts:16](https://github.com/polkadot-js/api/blob/4344f33/packages/type-storage/src/utils/createFunction.ts#L16)*
+
+___
+
diff --git a/docs/type-storage/modules/_frommetadata_.md b/docs/type-storage/modules/_frommetadata_.md
new file mode 100644
index 0000000000..2f3169a462
--- /dev/null
+++ b/docs/type-storage/modules/_frommetadata_.md
@@ -0,0 +1,24 @@
+
+
+# Functions
+
+` storage
+
+**storage**: *`object`*
+
+*Defined in [storage.ts:8](https://github.com/polkadot-js/api/blob/4344f33/packages/type-storage/src/storage.ts#L8)*
+
+` authorityCount
+
+**● authorityCount**: *`StorageFunction`* = createRuntimeFunction('authorityCount', ':auth:len', {
+ documentation: 'Number of authorities.',
+ type: 'u32'
+})
+
+*Defined in [substrate.ts:44](https://github.com/polkadot-js/api/blob/4344f33/packages/type-storage/src/substrate.ts#L44)*
+
+___
+` authorityPrefix
+
+**● authorityPrefix**: *`StorageFunction`* = createRuntimeFunction('authorityPrefix', ':auth:', {
+ documentation: 'Prefix under which authorities are storied.',
+ type: 'u32'
+})
+
+*Defined in [substrate.ts:49](https://github.com/polkadot-js/api/blob/4344f33/packages/type-storage/src/substrate.ts#L49)*
+
+___
+` changesTrieConfig
+
+**● changesTrieConfig**: *`StorageFunction`* = createRuntimeFunction('changesTrieConfig', ':changes_trie', {
+ documentation: 'Changes trie configuration is stored under this key.',
+ type: 'u32'
+})
+
+*Defined in [substrate.ts:59](https://github.com/polkadot-js/api/blob/4344f33/packages/type-storage/src/substrate.ts#L59)*
+
+___
+` code
+
+**● code**: *`StorageFunction`* = createRuntimeFunction('code', ':code', {
+ documentation: 'Wasm code of the runtime.',
+ type: 'Bytes'
+})
+
+*Defined in [substrate.ts:34](https://github.com/polkadot-js/api/blob/4344f33/packages/type-storage/src/substrate.ts#L34)*
+
+___
+` extrinsicIndex
+
+**● extrinsicIndex**: *`StorageFunction`* = createRuntimeFunction('extrinsicIndex', ':extrinsic_index', {
+ documentation: 'Current extrinsic index (u32) is stored under this key.',
+ type: 'u32'
+})
+
+*Defined in [substrate.ts:54](https://github.com/polkadot-js/api/blob/4344f33/packages/type-storage/src/substrate.ts#L54)*
+
+___
+` heapPages
+
+**● heapPages**: *`StorageFunction`* = createRuntimeFunction('heapPages', ':heappages', {
+ documentation: 'Number of wasm linear memory pages required for execution of the runtime.',
+ type: 'u64'
+})
+
+*Defined in [substrate.ts:39](https://github.com/polkadot-js/api/blob/4344f33/packages/type-storage/src/substrate.ts#L39)*
+
+___
+
diff --git a/docs/type-storage/modules/_types_d_.md b/docs/type-storage/modules/_types_d_.md
new file mode 100644
index 0000000000..139597f9cb
--- /dev/null
+++ b/docs/type-storage/modules/_types_d_.md
@@ -0,0 +1,2 @@
+
+
diff --git a/docs/type-storage/modules/_utils_createfunction_.md b/docs/type-storage/modules/_utils_createfunction_.md
new file mode 100644
index 0000000000..376dd04d79
--- /dev/null
+++ b/docs/type-storage/modules/_utils_createfunction_.md
@@ -0,0 +1,27 @@
+
+
+# Functions
+
+",
diff --git a/packages/type-jsonrpc/package.json b/packages/type-jsonrpc/package.json
index e81ae7291f..404f62da9a 100644
--- a/packages/type-jsonrpc/package.json
+++ b/packages/type-jsonrpc/package.json
@@ -1,6 +1,6 @@
{
"name": "@polkadot/jsonrpc",
- "version": "0.31.0",
+ "version": "0.31.1",
"description": "Method definitions for the Polkadot RPC layer",
"main": "index.js",
"engines": {
diff --git a/packages/type-storage/package.json b/packages/type-storage/package.json
index f70bde397f..260e710d79 100644
--- a/packages/type-storage/package.json
+++ b/packages/type-storage/package.json
@@ -1,6 +1,6 @@
{
"name": "@polkadot/storage",
- "version": "0.31.0",
+ "version": "0.31.1",
"description": "Generic wrapper wrapper around state storage",
"main": "index.js",
"engines": {
@@ -32,7 +32,7 @@
"@babel/runtime": "^7.0.0",
"@polkadot/params": "^0.30.3",
"@polkadot/primitives": "^0.30.3",
- "@polkadot/types": "^0.31.0",
+ "@polkadot/types": "^0.31.1",
"@polkadot/util": "^0.30.7",
"@polkadot/util-crypto": "^0.30.7",
"@polkadot/util-keyring": "^0.30.7"
diff --git a/packages/types/package.json b/packages/types/package.json
index d5c222a041..702cd1d323 100644
--- a/packages/types/package.json
+++ b/packages/types/package.json
@@ -1,6 +1,6 @@
{
"name": "@polkadot/types",
- "version": "0.31.0",
+ "version": "0.31.1",
"description": "Implementation of the Parity codec",
"main": "index.js",
"keywords": [
diff --git a/yarn.lock b/yarn.lock
index d4d02fa6d2..7a0f6b998b 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -1170,29 +1170,6 @@
version "1.1.0"
resolved "https://registry.yarnpkg.com/@nodelib/fs.stat/-/fs.stat-1.1.0.tgz#50c1e2260ac0ed9439a181de3725a0168d59c48a"
-"@polkadot/api-provider@^0.30.44":
- version "0.30.44"
- resolved "https://registry.yarnpkg.com/@polkadot/api-provider/-/api-provider-0.30.44.tgz#bb6e93bb9cf3c89a29d3e3de8aefcf9a75e14e48"
- dependencies:
- "@babel/runtime" "^7.0.0"
- "@polkadot/storage" "^0.30.44"
- "@polkadot/util" "^0.30.7"
- "@polkadot/util-crypto" "^0.30.7"
- "@polkadot/util-keyring" "^0.30.7"
- "@types/nock" "^9.1.3"
- eventemitter3 "^3.1.0"
- isomorphic-fetch "^2.2.1"
- websocket "^1.0.25"
-
-"@polkadot/api@^0.30.44":
- version "0.30.44"
- resolved "https://registry.yarnpkg.com/@polkadot/api/-/api-0.30.44.tgz#a9519d9c4cc226b856e9248764a93e67d5c29987"
- dependencies:
- "@babel/runtime" "^7.0.0"
- "@polkadot/api-provider" "^0.30.44"
- "@polkadot/jsonrpc" "^0.30.44"
- "@polkadot/util" "^0.30.7"
-
"@polkadot/dev@^0.20.24":
version "0.20.24"
resolved "https://registry.yarnpkg.com/@polkadot/dev/-/dev-0.20.24.tgz#e88af950aa4e0e1a549d0a4860b2b3f8d63ce723"
@@ -1242,6 +1219,13 @@
typedoc-plugin-markdown "^1.1.15"
typescript "^3.0.1"
+"@polkadot/extrinsics@^0.30.3":
+ version "0.30.45"
+ resolved "https://registry.yarnpkg.com/@polkadot/extrinsics/-/extrinsics-0.30.45.tgz#f17db714420fd3350a94c09b6cde51848cadd58b"
+ dependencies:
+ "@babel/runtime" "^7.0.0"
+ "@polkadot/util" "^0.30.7"
+
"@polkadot/params@^0.30.3":
version "0.30.3"
resolved "https://registry.yarnpkg.com/@polkadot/params/-/params-0.30.3.tgz#1f94f938306e7e30c009d501c527dfc322622f5a"
