[Docs] Go through and update existing ApiRx examples (#616)
* [Docs] Go through and update existing ApiRx examples * [Docs] update existing ApiRx examples -> formatting * [Docs] Fix name collision in package.json
This commit is contained in:
committed by
Jaco Greeff
parent
2d6001197b
commit
bc697d9449
@@ -1,5 +1,3 @@
|
|||||||
|
|
||||||
|
|
||||||
@polkadot/api/rx
|
@polkadot/api/rx
|
||||||
================
|
================
|
||||||
|
|
||||||
@@ -55,14 +53,15 @@ new ApiRx(provider)
|
|||||||
api.query.timestamp.now()
|
api.query.timestamp.now()
|
||||||
])
|
])
|
||||||
)
|
)
|
||||||
.subscribe(([blockPeriod, timestamp]) => {
|
)
|
||||||
const elapsed = last
|
.subscribe(([blockPeriod, timestamp]) => {
|
||||||
? `, ${timestamp.toNumber() - last}s since last`
|
const elapsed = last
|
||||||
: '';
|
? `, ${timestamp.toNumber() - last}s since last`
|
||||||
|
: '';
|
||||||
|
|
||||||
last = timestamp.toNumber();
|
last = timestamp.toNumber();
|
||||||
console.log(`timestamp ${timestamp}${elapsed} (${blockPeriod}s target)`);
|
console.log(`timestamp ${timestamp}${elapsed} (${blockPeriod}s target)`);
|
||||||
}));
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
@@ -70,8 +69,13 @@ new ApiRx(provider)
|
|||||||
Submitting a transaction -
|
Submitting a transaction -
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
|
import { first, switchMap } from 'rxjs/operators';
|
||||||
import ApiRx from '@polkadot/api/rx';
|
import ApiRx from '@polkadot/api/rx';
|
||||||
|
|
||||||
|
// import the test keyring (already has dev keys for Alice, Bob, Charlie, Eve & Ferdie)
|
||||||
|
import testingPairs from '@polkadot/keyring/testingPairs';
|
||||||
|
const keyring = testingPairs();
|
||||||
|
|
||||||
// get api via Promise
|
// get api via Promise
|
||||||
const api = await ApiRx.create().toPromise();
|
const api = await ApiRx.create().toPromise();
|
||||||
|
|
||||||
@@ -79,20 +83,23 @@ const api = await ApiRx.create().toPromise();
|
|||||||
api.query.system
|
api.query.system
|
||||||
.accountNonce(keyring.alice.address())
|
.accountNonce(keyring.alice.address())
|
||||||
.pipe(
|
.pipe(
|
||||||
// pipe nonce into transfer
|
first(),
|
||||||
switchMap((nonce) =>
|
// pipe nonce into transfer
|
||||||
api.tx.balances
|
switchMap((nonce) =>
|
||||||
// create transfer
|
api.tx.balances
|
||||||
.transfer(keyring.bob.address(), 12345)
|
// create transfer
|
||||||
// sign the transcation
|
.transfer(keyring.bob.address(), 12345)
|
||||||
.sign(keyring.alice, nonce)
|
// sign the transcation
|
||||||
// send the transaction
|
.sign(keyring.alice, nonce)
|
||||||
.send()
|
// send the transaction
|
||||||
)
|
.send()
|
||||||
|
)
|
||||||
)
|
)
|
||||||
// subscribe to overall result
|
// subscribe to overall result
|
||||||
.subscribe((hash) => {
|
.subscribe(({ status, type }) => {
|
||||||
console.log(`submitted with hash ${hash}`);
|
if (type === 'Finalised') {
|
||||||
|
console.log('Completed at block hash', status.asFinalised.toHex());
|
||||||
|
}
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -124,13 +131,17 @@ api.query.system
|
|||||||
*__example__*:
|
*__example__*:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
|
import { switchMap } from 'rxjs/operators';
|
||||||
import Api from '@polkadot/api/rx';
|
import Api from '@polkadot/api/rx';
|
||||||
|
|
||||||
new Api().isReady.subscribe((api) => {
|
new Api().isReady
|
||||||
api.rpc.subscribeNewHead().subscribe((header) => {
|
.pipe(
|
||||||
|
switchMap((api) =>
|
||||||
|
api.rpc.chain.subscribeNewHead()
|
||||||
|
))
|
||||||
|
.subscribe((header) => {
|
||||||
console.log(`new block #${header.blockNumber.toNumber()}`);
|
console.log(`new block #${header.blockNumber.toNumber()}`);
|
||||||
});
|
});
|
||||||
});
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
@@ -322,8 +333,8 @@ gettx(): [SubmittableExtrinsics](../interfaces/_types_.submittableextrinsics.md)
|
|||||||
api.tx.balances
|
api.tx.balances
|
||||||
.transfer(<recipientId>, <balance>)
|
.transfer(<recipientId>, <balance>)
|
||||||
.sign(<keyPair>, <accountNonce>, <blockHash (optional)>)
|
.sign(<keyPair>, <accountNonce>, <blockHash (optional)>)
|
||||||
.send((status) => {
|
.send(({status}) => {
|
||||||
console.log('tx status', status);
|
console.log('tx status', status.asFinalised.toHex());
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -414,13 +425,17 @@ ___
|
|||||||
*__example__*:
|
*__example__*:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
|
const { switchMap } = require('rxjs/operators');
|
||||||
import Api from '@polkadot/api/rx';
|
import Api from '@polkadot/api/rx';
|
||||||
|
|
||||||
Api.create().subscribe((api) => {
|
Api.create()
|
||||||
api.query.timestamp.now.subscribe((timestamp) => {
|
.pipe(
|
||||||
|
switchMap((api) =>
|
||||||
|
api.query.timestamp.now()
|
||||||
|
))
|
||||||
|
.subscribe((timestamp) => {
|
||||||
console.log(`lastest block timestamp ${timestamp}`);
|
console.log(`lastest block timestamp ${timestamp}`);
|
||||||
});
|
});
|
||||||
});
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
// Import the API
|
// Import the API
|
||||||
const { ApiRx } = require('@polkadot/api');
|
const { ApiRx } = require('@polkadot/api');
|
||||||
// Import dependencies from RxJs
|
// Import dependencies from RxJs
|
||||||
const { combineLatest, of, tap } = require('rxjs');
|
const { combineLatest, of } = require('rxjs');
|
||||||
const { first, switchMap } = require('rxjs/operators');
|
const { first, switchMap } = require('rxjs/operators');
|
||||||
|
|
||||||
// Our address for Alice on the dev chain
|
// Our address for Alice on the dev chain
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"name": "10_upgrade_chain",
|
"name": "rx_10_upgrade_chain",
|
||||||
"version": "0.2.0",
|
"version": "0.2.0",
|
||||||
"description": "Example showing how to upgrade via upgradeKey",
|
"description": "Example showing how to upgrade via upgradeKey",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
|
|||||||
Reference in New Issue
Block a user