chore: rebranding to @plugnet

This commit is contained in:
ian.he
2019-04-26 16:43:32 +12:00
parent 1f4e7638d5
commit 6b6b7fe145
68 changed files with 143 additions and 177 deletions
-6
View File
@@ -1,6 +0,0 @@
exclude_patterns:
- "**/*.spec.js"
- "**/*.spec.ts"
- "**/*.test.js"
- "**/*.test.ts"
- "docs/**/*.js"
-20
View File
@@ -1,20 +0,0 @@
language: node_js
node_js:
- "10"
env:
- GH_PAGES_SRC="build-docs"
cache:
yarn: true
directories:
- node_modules
before_install:
- curl -o- -L https://yarnpkg.com/install.sh | bash
- export PATH=$HOME/.yarn/bin::$(yarn global bin):$PATH
script:
- yarn plugnet-dev-travis-build
deploy:
skip_cleanup: true
provider: script
script: yarn plugnet-dev-travis-deploy
on:
branch: master
+14 -14
View File
@@ -1,37 +1,37 @@
# @plugnet/api
This library provides a clean wrapper around all the methods exposed by a Polkadot/Subtrate network client and defines all the types exposed by a node. For complete documentation around the classes, interfaces and their use, visit the [documentation portal](https://polkadot.js.org/api/).
This library provides a clean wrapper around all the methods exposed by a Plugnet/Subtrate network client and defines all the types exposed by a node. For complete documentation around the classes, interfaces and their use, visit the [documentation portal](https://www.poweredbyplug.com/).
## tutorials
Looking for tutorials to get started? Look at [examples](https://polkadot.js.org/api/examples/promise/) for guides on how to use the API to make queries and submit transactions.
Looking for tutorials to get started? Look at [examples](https://www.poweredbyplug.com/) for guides on how to use the API to make queries and submit transactions.
## overview
The API is split up into a number of internal packages -
- [@polkadot/api](packages/api/) The API library, providing both Promise and RxJS Observable-based interfaces. This is the main user-facing entry point.
- [@polkadot/api-derive](packages/api-derive/) Derived results that are injected into the API, allowing for combinations of various query results (only used internally and exposed on the Api instances via `api.derive.*`)
- [@polkadot/rpc-core](packages/rpc-core/) Wrapper around all [JSON-RPC methods](https://polkadot.js.org/api/METHODS_RPC.html) exposed by a Polkadot network client
- [@polkadot/rpc-provider](packages/rpc-provider/) Providers for connecting to nodes, including WebSockets and Http
- [@polkadot/rpc-rx](packages/rpc-rx/) A RxJs Observable wrapper around [@polkadot/rpc-provider](packages/rpc-provider)
- [@plugnet/api](packages/api/) The API library, providing both Promise and RxJS Observable-based interfaces. This is the main user-facing entry point.
- [@plugnet/api-derive](packages/api-derive/) Derived results that are injected into the API, allowing for combinations of various query results (only used internally and exposed on the Api instances via `api.derive.*`)
- [@plugnet/rpc-core](packages/rpc-core/) Wrapper around all [JSON-RPC methods](https://www.poweredbyplug.com/) exposed by a Plugnet network client
- [@plugnet/rpc-provider](packages/rpc-provider/) Providers for connecting to nodes, including WebSockets and Http
- [@plugnet/rpc-rx](packages/rpc-rx/) A RxJs Observable wrapper around [@plugnet/rpc-provider](packages/rpc-provider)
Type definitions for interfaces as exposed by Polkadot & Substrate clients -
Type definitions for interfaces as exposed by Plugnet & Substrate clients -
- [@polkadot/extrinsics](packages/type-extrinsics/) Base extrinsic definitions & codecs
- [@polkadot/jsonrpc](packages/type-jsonrpc/) Definitions for JSONRPC endpoints
- [@polkadot/storage](packages/type-storage/) Definitions for storage entries
- [@polkadot/types](packages/types/) Codecs for all Polkadot primitives
- [@plugnet/extrinsics](packages/type-extrinsics/) Base extrinsic definitions & codecs
- [@plugnet/jsonrpc](packages/type-jsonrpc/) Definitions for JSONRPC endpoints
- [@plugnet/storage](packages/type-storage/) Definitions for storage entries
- [@plugnet/types](packages/types/) Codecs for all Plugnet primitives
## development
Contributions are welcome!
To start off, this repo (along with others in the [@polkadot](https://github.com/polkadot-js/) family) uses yarn workspaces to organise the code. As such, after cloning, its dependencies _should_ be installed via `yarn`, not via npm; the latter will result in broken dependencies.
To start off, this repo (along with others in the [@plugnet](https://github.com/plugblockchain/) family) uses yarn workspaces to organise the code. As such, after cloning, its dependencies _should_ be installed via `yarn`, not via npm; the latter will result in broken dependencies.
To get started -
1. Clone the repo locally, via `git clone https://github.com/polkadot-js/api <optional local path>`
1. Clone the repo locally, via `git clone https://github.com/plugblockchain/api.js <optional local path>`
2. Ensure that you have a recent version of Node.js, for development purposes [Node 10](https://nodejs.org/en/) is recommended.
3. Ensure that you have a recent version of Yarn, for development purposes [Yarn >=1.10.1](https://yarnpkg.com/docs/install) is required.
4. Install the dependencies by running `yarn`
@@ -1,5 +1,5 @@
# Simple Connect
The following example shows how to instantiate a Polkadot API object and use it to connect to a node using ApiPromise.
The following example shows how to instantiate a Plugnet API object and use it to connect to a node using ApiPromise.
<<< @/docs/examples/promise/01_simple_connect/index.js
@@ -1,6 +1,6 @@
// @ts-check
// Required imports
const { ApiPromise, WsProvider } = require('@polkadot/api');
const { ApiPromise, WsProvider } = require('@plugnet/api');
async function main () {
// Initialise the provider to connect to the local node
@@ -11,7 +11,7 @@
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,6 +1,6 @@
// @ts-check
// Import the API
const { ApiPromise } = require('@polkadot/api');
const { ApiPromise } = require('@plugnet/api');
async function main () {
// Here we don't pass the (optional) provider, connecting directly to the default
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.45.14"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,5 +1,5 @@
# Listen to balance changes
This example shows how to instantiate a Polkadot API object and use it to connect to a node and retrieve balance updates.
This example shows how to instantiate a Plugnet API object and use it to connect to a node and retrieve balance updates.
<<< @/docs/examples/promise/03_listen_to_balance_change/index.js
@@ -1,6 +1,6 @@
// @ts-check
// Import the API
const { ApiPromise } = require('@polkadot/api');
const { ApiPromise } = require('@plugnet/api');
// Known account we want to use (available on dev chain, with funds)
const Alice = '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY';
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,6 +1,6 @@
// @ts-check
// Import the API
const { ApiPromise } = require('@polkadot/api');
const { ApiPromise } = require('@plugnet/api');
async function main () {
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.45.14"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,6 +1,6 @@
// @ts-check
// Import the API
const { ApiPromise } = require('@polkadot/api');
const { ApiPromise } = require('@plugnet/api');
// Our address for Alice on the dev chain
const Alice = '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY';
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,7 +1,7 @@
// @ts-check
// Import the API, Keyring and some utility functions
const { ApiPromise } = require('@polkadot/api');
const { Keyring } = require('@polkadot/keyring');
const { ApiPromise } = require('@plugnet/api');
const { Keyring } = require('@plugnet/keyring');
const BOB = '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty';
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,6 +1,6 @@
// @ts-check
// Import the API
const { ApiPromise } = require('@polkadot/api');
const { ApiPromise } = require('@plugnet/api');
async function main () {
// Create our API with a default connection to the local node
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,12 +1,12 @@
// @ts-check
// Import the API & Provider and some utility functions
const { ApiPromise } = require('@polkadot/api');
const { ApiPromise } = require('@plugnet/api');
// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
const testKeyring = require('@polkadot/keyring/testing');
const testKeyring = require('@plugnet/keyring/testing');
// utility function for random values
const { randomAsU8a } = require('@polkadot/util-crypto');
const { randomAsU8a } = require('@plugnet/util-crypto');
// some constants we are using in this sample
const ALICE = '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY';
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,9 +1,9 @@
// @ts-check
// Import the API & Provider and some utility functions
const { ApiPromise, WsProvider } = require('@polkadot/api');
const { ApiPromise, WsProvider } = require('@plugnet/api');
// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
const testKeyring = require('@polkadot/keyring/testing');
const testKeyring = require('@plugnet/keyring/testing');
const fs = require('fs');
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
+1 -1
View File
@@ -1,5 +1,5 @@
# Simple Connect
The following example shows how to instantiate a Polkadot API object and use it to connect to a node using ApiRx.
The following example shows how to instantiate a Plugnet API object and use it to connect to a node using ApiRx.
<<< @/docs/examples/rx/01_simple_connect/index.js
+2 -2
View File
@@ -1,7 +1,7 @@
// Required imports
const { zip } = require('rxjs');
const { ApiRx } = require('@polkadot/api');
const { WsProvider } = require('@polkadot/rpc-provider');
const { ApiRx } = require('@plugnet/api');
const { WsProvider } = require('@plugnet/rpc-provider');
function main () {
// Initialise the provider to connect to the local node
@@ -11,7 +11,7 @@
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,5 +1,5 @@
// Import the API
const { ApiRx } = require('@polkadot/api');
const { ApiRx } = require('@plugnet/api');
const { switchMap } = require('rxjs/operators');
async function main () {
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
@@ -1,5 +1,5 @@
# Listen to balance changes
This example shows how to instantiate a Polkadot API object and use it to connect to a node and retrieve balance updates.
This example shows how to instantiate a Plugnet API object and use it to connect to a node and retrieve balance updates.
<<< @/docs/examples/rx/03_listent_to_balance_change/index.js
@@ -1,5 +1,5 @@
// Import the API and operators from RxJs
const { ApiRx } = require('@polkadot/api');
const { ApiRx } = require('@plugnet/api');
const { pairwise, startWith } = require('rxjs/operators');
// Known account we want to use (available on dev chain, with funds)
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
+1 -1
View File
@@ -1,5 +1,5 @@
// Import the API
const { ApiRx } = require('@polkadot/api');
const { ApiRx } = require('@plugnet/api');
const { switchMap } = require('rxjs/operators');
async function main () {
+1 -1
View File
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
+1 -1
View File
@@ -1,5 +1,5 @@
// Import the API
const { ApiRx } = require('@polkadot/api');
const { ApiRx } = require('@plugnet/api');
// Import dependencies from RxJs
const { combineLatest, of } = require('rxjs');
const { first, switchMap } = require('rxjs/operators');
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
+2 -2
View File
@@ -1,6 +1,6 @@
// Import the API, Keyring and some utility functions
const { ApiRx } = require('@polkadot/api');
const { Keyring } = require('@polkadot/keyring');
const { ApiRx } = require('@plugnet/api');
const { Keyring } = require('@plugnet/keyring');
const BOB = '5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty';
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
+1 -1
View File
@@ -1,6 +1,6 @@
// Import the API and selected RxJs operators
const { switchMap } = require('rxjs/operators');
const { ApiRx } = require('@polkadot/api');
const { ApiRx } = require('@plugnet/api');
async function main () {
// Create our API with a default connection to the local node
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
+3 -3
View File
@@ -1,11 +1,11 @@
// Import the API and some utility functions
const { ApiRx } = require('@polkadot/api');
const { ApiRx } = require('@plugnet/api');
// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
const testKeyring = require('@polkadot/keyring/testing');
const testKeyring = require('@plugnet/keyring/testing');
// utility function for random values
const { randomAsU8a } = require('@polkadot/util-crypto');
const { randomAsU8a } = require('@plugnet/util-crypto');
// some constants we are using in this sample
const ALICE = '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY';
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
+2 -2
View File
@@ -1,7 +1,7 @@
// Import the API & Provider and some utility functions
const { ApiRx, WsPovider } = require('@polkadot/api');
const { ApiRx, WsPovider } = require('@plugnet/api');
// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
const testKeyring = require('@polkadot/keyring/testing');
const testKeyring = require('@plugnet/keyring/testing');
const fs = require('fs');
async function main () {
@@ -10,7 +10,7 @@
"start": "node index.js"
},
"dependencies": {
"@polkadot/api": "^0.53.1"
"@plugnet/api": "^0.76.102"
},
"devDependencies": {
"rimraf": "^2.6.2"
+1 -1
View File
@@ -15,7 +15,7 @@
"vuepress": "1.0.0-alpha.44"
},
"scripts": {
"build": "plugnet-dev-build-ts && yarn run build:methodsdoc && plugnet-dev-build-docs",
"build": "plugnet-dev-build-ts && yarn run build:methodsdoc",
"build:htmldoc": "yarn clean && typedoc --theme default --out docs/html",
"build:methodsdoc": "node packages/types/src/scripts/MetadataMdWrapper.js",
"check": "yarn lint",
+2 -2
View File
@@ -1,6 +1,6 @@
# @polkadot/api-derive
# @plugnet/api-derive
Common functions used across Polkadot, derived from RPC calls and storage queries.
Common functions used across Plugnet, derived from RPC calls and storage queries.
## Classes
+6 -6
View File
@@ -1,16 +1,16 @@
{
"name": "@plugnet/api-derive",
"version": "0.76.102",
"description": "Common functions used across Polkadot, derived from RPC calls and storage queries.",
"description": "Common functions used across Plugnet, derived from RPC calls and storage queries.",
"main": "index.js",
"keywords": [
"Polkadot",
"Plugnet",
"Promise",
"RxJs"
],
"author": "Jaco Greeff <jacogr@gmail.com>",
"maintainers": [
"Jaco Greeff <jacogr@gmail.com>"
"Ian He <ian.he@centrality.ai>"
],
"contributors": [],
"license": "Apache-2.0",
@@ -23,12 +23,12 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/polkadot-js/api.git"
"url": "git+https://github.com/plugblockchain/api.js.git"
},
"bugs": {
"url": "https://github.com/polkadot-js/api/issues"
"url": "https://github.com/plugblockchain/api.js/issues"
},
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/api-derive#readme",
"homepage": "https://github.com/plugblockchain/api.js/tree/master/packages/api-derive#readme",
"dependencies": {
"@babel/runtime": "^7.4.3",
"@plugnet/api": "^0.76.102",
+1 -1
View File
@@ -22,7 +22,7 @@ describe.skip('derive e2e', () => {
});
it('returns correct results', async () => {
// https://github.com/polkadot-js/api/issues/777
// https://github.com/plugblockchain/api.js/issues/777
const block1 = await api.derive.chain.bestNumber();
await new Promise((resolve) => setTimeout(resolve, 15000));
const block2 = await api.derive.chain.bestNumber();
+6 -14
View File
@@ -1,6 +1,6 @@
# @plugnet/api
The Polkadot-JS API provides easy-to-use wrappers around JSONRPC calls that flow from an application to a node. It handles all the encoding and decoding or parameters, provides access to RPC functions and allows for the query of chain state and the submission of transactions.
The Plugnet-JS API provides easy-to-use wrappers around JSONRPC calls that flow from an application to a node. It handles all the encoding and decoding or parameters, provides access to RPC functions and allows for the query of chain state and the submission of transactions.
The API wrappers provide a standard interface for use -
@@ -22,7 +22,7 @@ There are two flavours of the API provided, one allowing a standard interface vi
## Dynamic by default
Substrate (upon which Polkadot is built) uses on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain.
Substrate (upon which Plugnet is built) uses on-chain WASM runtimes, allowing for upgradability. Each runtime defining the actual chain extrinsics (submitted transactions and block intrinsics) as well as available entries in the chain state. Due to this, the API endpoints for queries and transactions are dynamically populated from the running chain.
Due to this dynamic nature, this API departs from traditional APIs which only has fixed endpoints, driving use by what is available by the runtime. As a start, this generic nature has a learning curve, although the provided documentation, examples and linked documentation tries to make that experience as seamless as possible.
@@ -31,13 +31,13 @@ Due to this dynamic nature, this API departs from traditional APIs which only ha
Installation -
```
npm install --save @polkadot/api
npm install --save @plugnet/api
```
Subscribing to blocks via Promise-based API -
```javascript
import { ApiPromise } from '@polkadot/api';
import { ApiPromise } from '@plugnet/api';
// initialise via static create
const api = await ApiPromise.create();
@@ -51,7 +51,7 @@ api.rpc.chain.subscribeNewHead((header) => {
Subscribing to blocks via RxJS-based API -
```javascript
import { ApiRx } from '@polkadot/api';
import { ApiRx } from '@plugnet/api';
// initialise via static create
const api = await ApiRx.create().toPromise();
@@ -67,7 +67,7 @@ api.rpc.chain.subscribeNewHead().subscribe((header) => {
Additional types used by runtime modules can be added when a new instance of the API is created. This is necessary if the runtime modules use types which are not available in the base Substrate runtime.
```javascript
import { ApiPromise } from '@polkadot/api';
import { ApiPromise } from '@plugnet/api';
// initialise via static create and register custom types
const api = await ApiPromise.create({
@@ -85,14 +85,6 @@ const api = await ApiPromise.create({
});
```
## Users
Some of the users of the API (let us know if you are missing from the list), include -
- [Polkadot-JS UI](https://github.com/polkadot-js/apps) A user-interface that allows you to make transactions, query the network or participate in actions on the network such as referendums and staking
- [Polkabot](https://gitlab.com/Polkabot) Polkabot is a Matrix chatbot that keeps an eye on the Polkadot network. You can see Polkabot in action in https://matrix.to/#/#polkadot-network-status:matrix.org
- [Polkawallet.io](https://polkawallet.io) and [Polkawallet (Github)](https://github.com/polkawallet-io/polkawallet-RN/) A mobile wallet for the Polkadot network to manage funds and make transactions, available on both Androind and iOS
## Classes
[Classes](SUMMARY.md)
+6 -6
View File
@@ -1,15 +1,15 @@
{
"name": "@plugnet/api",
"version": "0.76.102",
"description": "Promise and RxJS wrappers around the Polkadot JS RPC",
"description": "Promise and RxJS wrappers around the Plugnet JS RPC",
"main": "index.js",
"keywords": [
"Polkadot",
"Plugnet",
"RxJs"
],
"author": "Jaco Greeff <jacogr@gmail.com>",
"maintainers": [
"Jaco Greeff <jacogr@gmail.com>"
"Ian He <ian.he@centrality.ai>"
],
"contributors": [],
"license": "Apache-2.0",
@@ -22,12 +22,12 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/polkadot-js/api.git"
"url": "git+https://github.com/plugblockchain/api.js.git"
},
"bugs": {
"url": "https://github.com/polkadot-js/api/issues"
"url": "https://github.com/plugblockchain/api.js/issues"
},
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/api#readme",
"homepage": "https://github.com/plugblockchain/api.js/tree/master/packages/api#readme",
"dependencies": {
"@babel/runtime": "^7.4.3",
"@plugnet/api-derive": "^0.76.102",
+2 -2
View File
@@ -23,9 +23,9 @@ import Combinator, { CombinatorCallback, CombinatorFunction } from './Combinator
* @name ApiPromise
*
* @description
* ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Polkadot network. As a full Promise-based, all interface calls return Promises, including the static `.create(...)`. Subscription calls utilise `(value) => {}` callbacks to pass through the latest values.
* ApiPromise is a standard JavaScript wrapper around the RPC and interfaces on the Plugnet network. As a full Promise-based, all interface calls return Promises, including the static `.create(...)`. Subscription calls utilise `(value) => {}` callbacks to pass through the latest values.
*
* The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Polkadot (and Substrate) clients.
* The API is well suited to real-time applications where either the single-shot state is needed or use is to be made of the subscription-based features of Plugnet (and Substrate) clients.
*
* @see [[ApiRx]]
*
+2 -2
View File
@@ -19,9 +19,9 @@ import ApiBase from '../Base';
* @name ApiRx
*
* @description
* ApiRx is a powerfull RxJS Observable wrapper around the RPC and interfaces on the Polkadot network. As a full Observable API, all interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion and subscription-based methods return long-running Observables that update with the latest values.
* ApiRx is a powerfull RxJS Observable wrapper around the RPC and interfaces on the Plugnet network. As a full Observable API, all interface calls return RxJS Observables, including the static `.create(...)`. In the same fashion and subscription-based methods return long-running Observables that update with the latest values.
*
* The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Polkadot (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding `.subscribe` and `.pipe` on Observables will unlock full-scale use thereof.
* The API is well suited to real-time applications where the latest state is needed, unlocking the subscription-based features of Plugnet (and Substrate) clients. Some familiarity with RxJS is a requirement to use the API, however just understanding `.subscribe` and `.pipe` on Observables will unlock full-scale use thereof.
*
* @see [[ApiPromise]]
*
+4 -4
View File
@@ -1,20 +1,20 @@
# @plugnet/rpc-core
This library provides a clean wrapper around all the methods exposed by a Polkadot network client.
This library provides a clean wrapper around all the methods exposed by a Plugnet network client.
## Usage
Installation -
```
yarn add @polkadot/rpc-core
yarn add @plugnet/rpc-core
```
Initialisation -
```js
import Rpc from '@polkadot/rpc-core';
import WsProvider from '@polkadot/rpc-provider/ws';
import Rpc from '@plugnet/rpc-core';
import WsProvider from '@plugnet/rpc-provider/ws';
const provider = new WsProvider('http://127.0.0.1:9944');
const api = new Rpc(provider);
+6 -6
View File
@@ -1,15 +1,15 @@
{
"name": "@plugnet/rpc-core",
"version": "0.76.102",
"description": "A JavaScript wrapper for the Polkadot JsonRPC interface",
"description": "A JavaScript wrapper for the Plugnet JsonRPC interface",
"main": "index.js",
"keywords": [
"Polkadot",
"Plugnet",
"JsonRPC"
],
"author": "Jaco Greeff <jacogr@gmail.com>",
"maintainers": [
"Jaco Greeff <jacogr@gmail.com>"
"Ian He <ian.he@centrality.ai>"
],
"contributors": [],
"license": "Apache-2.0",
@@ -22,12 +22,12 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/polkadot-js/api.git"
"url": "git+https://github.com/plugblockchain/api.js.git"
},
"bugs": {
"url": "https://github.com/polkadot-js/api/issues"
"url": "https://github.com/plugblockchain/api.js/issues"
},
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-core#readme",
"homepage": "https://github.com/plugblockchain/api.js/tree/master/packages/rpc-core#readme",
"dependencies": {
"@babel/runtime": "^7.4.3",
"@plugnet/jsonrpc": "^0.76.102",
+1 -1
View File
@@ -17,7 +17,7 @@ const l = logger('rpc-core');
/**
* @name Rpc
* @summary The API may use a HTTP or WebSockets provider.
* @description It allows for querying a Polkadot Client Node.
* @description It allows for querying a Plugnet Client Node.
* WebSockets provider is recommended since HTTP provider only supports basic querying.
*
* ```mermaid
+5 -5
View File
@@ -1,6 +1,6 @@
# @polkadot/rpc-provider
# @plugnet/rpc-provider
Generic transport providers to handle the transport of method calls to and from Polkadot clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface.
Generic transport providers to handle the transport of method calls to and from Plugnet clients from applications interacting with it. It provides an interface to making RPC calls and is generally, unless you are operating at a low-level and taking care of encoding and decoding of parameters/results, it won't be directly used, rather only passed to a higher-level interface.
## Provider Selection
@@ -13,13 +13,13 @@ Both providers are usable (as is the API), in both browser-based and Node.js env
Installation -
```
yarn add @polkadot/rpc-provider
yarn add @plugnet/rpc-provider
```
WebSocket Initialisation -
```javascript
import WsProvider from '@polkadot/rpc-provider/ws';
import WsProvider from '@plugnet/rpc-provider/ws';
// this is the actual default endpoint
const provider = new WsProvider('ws://127.0.0.1:9944');
@@ -31,7 +31,7 @@ console.log('client version', version);
HTTP Initialisation -
```javascript
import { HttpProvider } from '@polkadot/rpc-provider';
import { HttpProvider } from '@plugnet/rpc-provider';
// this is the actual default endpoint
const provider = new HttpProvider('http://127.0.0.1:9933');
+5 -5
View File
@@ -4,12 +4,12 @@
"description": "Transport providers for the API",
"main": "index.js",
"keywords": [
"Polkadot",
"Plugnet",
"JsonRPC"
],
"author": "Jaco Greeff <jacogr@gmail.com>",
"maintainers": [
"Jaco Greeff <jacogr@gmail.com>"
"Ian He <ian.he@centrality.ai>"
],
"contributors": [],
"license": "Apache-2.0",
@@ -22,12 +22,12 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/polkadot-js/api.git"
"url": "git+https://github.com/plugblockchain/api.js.git"
},
"bugs": {
"url": "https://github.com/polkadot-js/api/issues"
"url": "https://github.com/plugblockchain/api.js/issues"
},
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-provider#readme",
"homepage": "https://github.com/plugblockchain/api.js/tree/master/packages/rpc-provider#readme",
"dependencies": {
"@babel/runtime": "^7.4.3",
"@plugnet/keyring": "^0.76.2-beta.0",
+6 -6
View File
@@ -1,15 +1,15 @@
{
"name": "@plugnet/rpc-rx",
"version": "0.76.102",
"description": "An RxJs wrapper around the Polkadot JS API",
"description": "An RxJs wrapper around the Plugnet JS API",
"main": "index.js",
"keywords": [
"Polkadot",
"Plugnet",
"RxJs"
],
"author": "Jaco Greeff <jacogr@gmail.com>",
"maintainers": [
"Jaco Greeff <jacogr@gmail.com>"
"Ian He <ian.he@centrality.ai>"
],
"contributors": [],
"license": "Apache-2.0",
@@ -22,12 +22,12 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/polkadot-js/api.git"
"url": "git+https://github.com/plugblockchain/api.js.git"
},
"bugs": {
"url": "https://github.com/polkadot-js/api/issues"
"url": "https://github.com/plugblockchain/api.js/issues"
},
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/rpc-rx#readme",
"homepage": "https://github.com/plugblockchain/api.js/tree/master/packages/rpc-rx#readme",
"dependencies": {
"@babel/runtime": "^7.4.3",
"@plugnet/rpc-core": "^0.76.102",
+1 -1
View File
@@ -1,4 +1,4 @@
# @polkadot/extrinsics
# @plugnet/extrinsics
Base extrinsic definitions & codecs
+2 -2
View File
@@ -2,10 +2,10 @@
"name": "@plugnet/extrinsics",
"version": "0.76.102",
"main": "index.js",
"repository": "https://github.com/polkadot-js/api.git",
"repository": "https://github.com/plugblockchain/api.js.git",
"author": "Jaco Greeff <jacogr@gmail.com>",
"maintainers": [
"Jaco Greeff <jacogr@gmail.com>"
"Ian He <ian.he@centrality.ai>"
],
"contributors": [],
"license": "Apache-2.0",
+3 -3
View File
@@ -1,6 +1,6 @@
# @polkadot/jsonrpc
# @plugnet/jsonrpc
A definition 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.
A definition of all the methods exposed in a general Plugnet 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/METHODS_RPC.md).
@@ -9,7 +9,7 @@ For a list of currently exposed methods, see the [method documentation](docs/MET
Installation -
```
yarn add @polkadot/jsonrpc
yarn add @plugnet/jsonrpc
```
## Adding methods
+6 -6
View File
@@ -1,7 +1,7 @@
{
"name": "@plugnet/jsonrpc",
"version": "0.76.102",
"description": "Method definitions for the Polkadot RPC layer",
"description": "Method definitions for the Plugnet RPC layer",
"main": "index.js",
"engines": {
"node": ">=6.4"
@@ -12,22 +12,22 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/polkadot-js/api.git"
"url": "git+https://github.com/plugblockchain/api.js.git"
},
"keywords": [
"Polkadot",
"Plugnet",
"JsonRPC"
],
"author": "Jaco Greeff <jacogr@gmail.com>",
"maintainers": [
"Jaco Greeff <jacogr@gmail.com>"
"Ian He <ian.he@centrality.ai>"
],
"contributors": [],
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/polkadot-js/api/issues"
"url": "https://github.com/plugblockchain/api.js/issues"
},
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/type-jsonrpc#readme",
"homepage": "https://github.com/plugblockchain/api.js/tree/master/packages/type-jsonrpc#readme",
"dependencies": {
"@babel/runtime": "^7.4.3"
}
+1 -1
View File
@@ -1,4 +1,4 @@
# @polkadot/storage
# @plugnet/storage
An base interface to the storage layer
+5 -5
View File
@@ -12,22 +12,22 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/polkadot-js/api.git"
"url": "git+https://github.com/plugblockchain/api.js.git"
},
"keywords": [
"Polkadot",
"Plugnet",
"Merkel Patricia Tree"
],
"author": "Jaco Greeff <jacogr@gmail.com>",
"maintainers": [
"Jaco Greeff <jacogr@gmail.com>"
"Ian He <ian.he@centrality.ai>"
],
"contributors": [],
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/polkadot-js/api/issues"
"url": "https://github.com/plugblockchain/api.js/issues"
},
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/type-storage#readme",
"homepage": "https://github.com/plugblockchain/api.js/tree/master/packages/type-storage#readme",
"dependencies": {
"@babel/runtime": "^7.4.3",
"@plugnet/keyring": "^0.76.2-beta.0",
+1 -1
View File
@@ -1,4 +1,4 @@
# @polkadot/types
# @plugnet/types
Implementation of the types and their (de-)serialisation via [parity-codec](https://github.com/paritytech/parity-codec).
+5 -5
View File
@@ -4,12 +4,12 @@
"description": "Implementation of the Parity codec",
"main": "index.js",
"keywords": [
"Polkadot",
"Plugnet",
"JsonRPC"
],
"author": "Jaco Greeff <jacogr@gmail.com>",
"maintainers": [
"Jaco Greeff <jacogr@gmail.com>"
"Ian He <ian.he@centrality.ai>"
],
"contributors": [],
"license": "Apache-2.0",
@@ -22,12 +22,12 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/polkadot-js/api.git"
"url": "git+https://github.com/plugblockchain/api.js.git"
},
"bugs": {
"url": "https://github.com/polkadot-js/api/issues"
"url": "https://github.com/plugblockchain/api.js/issues"
},
"homepage": "https://github.com/polkadot-js/api/tree/master/packages/types#readme",
"homepage": "https://github.com/plugblockchain/api.js/tree/master/packages/types#readme",
"dependencies": {
"@babel/runtime": "^7.4.3",
"@plugnet/keyring": "^0.76.2-beta.0",
+1 -1
View File
@@ -176,7 +176,7 @@ describe('Struct', () => {
});
it('allows toString with large numbers', () => {
// replicate https://github.com/polkadot-js/api/issues/640
// replicate https://github.com/plugblockchain/api.js/issues/640
expect(
new Struct({
blockNumber: Option.with(BlockNumber)
+1 -1
View File
@@ -7,7 +7,7 @@
import { assertSingletonPackage } from '@plugnet/util';
assertSingletonPackage('@polkadot/types');
assertSingletonPackage('@plugnet/types');
export { default as ContractAbi } from './ContractAbi';
export * from './codec';
+1 -1
View File
@@ -1,5 +1,5 @@
module.exports = {
name: 'Polkadot JS API',
name: 'Plugnet JS API',
exclude: '**/*+(index|e2e|spec).ts',
excludeExternals: true,
excludeNotExported: true,