[CI Skip] 0.40.22

docs/api-derive/modules/_accounts_idandindex_.md

@@ -8,7 +8,7 @@
 
 **Ƭ AccountIdAndIndex**: *[`undefined` | `AccountId`, `undefined` | `AccountIndex`]*
 
-*Defined in [accounts/idAndIndex.ts:15](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/accounts/idAndIndex.ts#L15)*
+*Defined in [accounts/idAndIndex.ts:15](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/accounts/idAndIndex.ts#L15)*
 
 ___
 
@@ -20,7 +20,7 @@ ___
 
 ▸ **idAndIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [accounts/idAndIndex.ts:17](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/accounts/idAndIndex.ts#L17)*
+*Defined in [accounts/idAndIndex.ts:17](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/accounts/idAndIndex.ts#L17)*
 
 **Parameters:**
 

docs/api-derive/modules/_accounts_idtoindex_.md

@@ -8,7 +8,7 @@
 
 ▸ **idToIndex**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/accounts/idToIndex.ts#L13)*
+*Defined in [accounts/idToIndex.ts:13](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/accounts/idToIndex.ts#L13)*
 
 **Parameters:**
 

docs/api-derive/modules/_accounts_indexes_.md

@@ -8,7 +8,7 @@
 
 **Ƭ AccountIndexes**: *`object`*
 
-*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/accounts/indexes.ts#L13)*
+*Defined in [accounts/indexes.ts:13](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/accounts/indexes.ts#L13)*
 
 #### Type declaration
 
@@ -24,7 +24,7 @@ ___
 
 ▸ **indexes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/accounts/indexes.ts#L15)*
+*Defined in [accounts/indexes.ts:15](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/accounts/indexes.ts#L15)*
 
 **Parameters:**
 

docs/api-derive/modules/_accounts_indextoid_.md

@@ -8,7 +8,7 @@
 
 ▸ **indexToId**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [accounts/indexToId.ts:14](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/accounts/indexToId.ts#L14)*
+*Defined in [accounts/indexToId.ts:14](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/accounts/indexToId.ts#L14)*
 
 **Parameters:**
 

docs/api-derive/modules/_balances_fees_.md

@@ -8,7 +8,7 @@
 
 ▸ **fees**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/balances/fees.ts#L13)*
+*Defined in [balances/fees.ts:13](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/balances/fees.ts#L13)*
 
 **Parameters:**
 

docs/api-derive/modules/_balances_validatingbalance_.md

@@ -8,7 +8,7 @@
 
 ▸ **validatingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/balances/validatingBalance.ts#L16)*
+*Defined in [balances/validatingBalance.ts:16](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/balances/validatingBalance.ts#L16)*
 
 **Parameters:**
 

docs/api-derive/modules/_balances_validatingbalances_.md

@@ -8,7 +8,7 @@
 
 ▸ **validatingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/balances/validatingBalances.ts#L14)*
+*Defined in [balances/validatingBalances.ts:14](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/balances/validatingBalances.ts#L14)*
 
 **Parameters:**
 

docs/api-derive/modules/_balances_votingbalance_.md

@@ -8,7 +8,7 @@
 
 ▸ **votingBalance**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/balances/votingBalance.ts#L16)*
+*Defined in [balances/votingBalance.ts:16](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/balances/votingBalance.ts#L16)*
 
 **Parameters:**
 

docs/api-derive/modules/_balances_votingbalances_.md

@@ -8,7 +8,7 @@
 
 ▸ **votingBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/balances/votingBalances.ts#L13)*
+*Defined in [balances/votingBalances.ts:13](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/balances/votingBalances.ts#L13)*
 
 **Parameters:**
 

docs/api-derive/modules/_balances_votingbalancesnominatorsfor_.md

@@ -8,7 +8,7 @@
 
 ▸ **votingBalancesNominatorsFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [balances/votingBalancesNominatorsFor.ts:15](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15)*
+*Defined in [balances/votingBalancesNominatorsFor.ts:15](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/balances/votingBalancesNominatorsFor.ts#L15)*
 
 **Parameters:**
 

docs/api-derive/modules/_chain_bestnumber_.md

@@ -8,9 +8,17 @@
 
 ▸ **bestNumber**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [chain/bestNumber.ts:15](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/chain/bestNumber.ts#L15)*
+*Defined in [chain/bestNumber.ts:23](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/chain/bestNumber.ts#L23)*
 
-Get the latest block number.
+*__description__*: Get the latest block number.
+
+*__example__*:   
+
+```javascript
+api.derive.chain.bestNumber((blockNumber) => {
+  console.log(`the current best block is #${blockNumber}`);
+});
+```
 
 **Parameters:**
 

docs/api-derive/modules/_chain_bestnumberfinalised_.md

@@ -8,9 +8,15 @@
 
 ▸ **bestNumberFinalised**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [chain/bestNumberFinalised.ts:15](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/chain/bestNumberFinalised.ts#L15)*
+*Defined in [chain/bestNumberFinalised.ts:23](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/chain/bestNumberFinalised.ts#L23)*
 
-Get the latest finalised block number.
+*__description__*: Get the latest finalised block number. example  
+
+```javascript
+api.derive.chain.bestNumberFinalised((blockNumber) => {
+  console.log(`the current finalised block is #${blockNumber}`);
+});
+```
 
 **Parameters:**
 

docs/api-derive/modules/_chain_bestnumberlag_.md

@@ -0,0 +1,32 @@
+
+
+# Functions
+
+<a id="bestnumberlag"></a>
+
+##  bestNumberLag
+
+▸ **bestNumberLag**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
+
+*Defined in [chain/bestNumberLag.ts:25](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/chain/bestNumberLag.ts#L25)*
+
+*__description__*: Calculates the lag between finalised head and best head
+
+*__example__*:   
+
+```javascript
+api.derive.chain.bestNumberLag((lag) => {
+  console.log(`finalised is ${lag} blocks behind head`);
+});
+```
+
+**Parameters:**
+
+| Name | Type |
+| ------ | ------ |
+| api | `ApiInterface$Rx` |
+
+**Returns:** `(Anonymous function)`
+
+___
+

docs/api-derive/modules/_chain_getheader_.md

@@ -8,9 +8,17 @@
 
 ▸ **getHeader**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [chain/getHeader.ts:17](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/chain/getHeader.ts#L17)*
+*Defined in [chain/getHeader.ts:26](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/chain/getHeader.ts#L26)*
 
-Get the a specific block header and extend it with the author
+*__description__*: Get the a specific block header and extend it with the author
+
+*__example__*:   
+
+```javascript
+const { author, blockNumber } = await api.derive.chain.getHeader('0x123...456');
+
+console.log(`block #${blockNumber} was authored by ${author}`);
+```
 
 **Parameters:**
 

docs/api-derive/modules/_chain_subscribenewhead_.md

@@ -8,7 +8,7 @@
 
 **Ƭ HeaderAndValidators**: *[`Header`, `Array`<`AccountId`>]*
 
-*Defined in [chain/subscribeNewHead.ts:13](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/chain/subscribeNewHead.ts#L13)*
+*Defined in [chain/subscribeNewHead.ts:13](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/chain/subscribeNewHead.ts#L13)*
 
 ___
 
@@ -20,9 +20,17 @@ ___
 
 ▸ **subscribeNewHead**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [chain/subscribeNewHead.ts:18](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/chain/subscribeNewHead.ts#L18)*
+*Defined in [chain/subscribeNewHead.ts:26](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/chain/subscribeNewHead.ts#L26)*
 
-Subscribe to block headers and extend it with the author
+*__description__*: Subscribe to block headers and extend it with the author
+
+*__example__*:   
+
+```javascript
+api.derive.chain.subscribeNewHead(({ author, blockNumber }) => {
+  console.log(`block #${blockNumber} was authored by ${author}`);
+});
+```
 
 **Parameters:**
 

docs/api-derive/modules/_democracy_referenduminfos_.md

@@ -8,7 +8,7 @@
 
 ▸ **referendumInfos**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/democracy/referendumInfos.ts#L13)*
+*Defined in [democracy/referendumInfos.ts:13](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/democracy/referendumInfos.ts#L13)*
 
 **Parameters:**
 

docs/api-derive/modules/_democracy_referendums_.md

@@ -8,7 +8,7 @@
 
 ▸ **referendums**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [democracy/referendums.ts:13](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/democracy/referendums.ts#L13)*
+*Defined in [democracy/referendums.ts:13](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/democracy/referendums.ts#L13)*
 
 **Parameters:**
 

docs/api-derive/modules/_democracy_referendumvotesfor_.md

@@ -8,7 +8,7 @@
 
 ▸ **referendumVotesFor**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)*
+*Defined in [democracy/referendumVotesFor.ts:17](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/democracy/referendumVotesFor.ts#L17)*
 
 **Parameters:**
 

docs/api-derive/modules/_democracy_votes_.md

@@ -8,7 +8,7 @@
 
 ▸ **votes**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/democracy/votes.ts#L12)*
+*Defined in [democracy/votes.ts:12](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/democracy/votes.ts#L12)*
 
 **Parameters:**
 

docs/api-derive/modules/_index_.md

@@ -20,7 +20,7 @@
 
 ▸ **decorateDerive**(api: *`ApiInterface$Rx`*): [Derive](../interfaces/_index_.derive.md)
 
-*Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/index.ts#L35)*
+*Defined in [index.ts:35](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/index.ts#L35)*
 
 **Parameters:**
 

docs/api-derive/modules/_session_eralength_.md

@@ -8,7 +8,7 @@
 
 ▸ **eraLength**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/session/eraLength.ts#L13)*
+*Defined in [session/eraLength.ts:13](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/session/eraLength.ts#L13)*
 
 **Parameters:**
 

docs/api-derive/modules/_session_eraprogress_.md

@@ -8,7 +8,7 @@
 
 ▸ **eraProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/session/eraProgress.ts#L14)*
+*Defined in [session/eraProgress.ts:14](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/session/eraProgress.ts#L14)*
 
 **Parameters:**
 

docs/api-derive/modules/_session_sessionprogress_.md

@@ -8,7 +8,7 @@
 
 ▸ **sessionProgress**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/session/sessionProgress.ts#L14)*
+*Defined in [session/sessionProgress.ts:14](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/session/sessionProgress.ts#L14)*
 
 **Parameters:**
 

docs/api-derive/modules/_staking_intentionsbalances_.md

@@ -8,7 +8,7 @@
 
 ▸ **intentionsBalances**(api: *`ApiInterface$Rx`*): `(Anonymous function)`
 
-*Defined in [staking/intentionsBalances.ts:18](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/staking/intentionsBalances.ts#L18)*
+*Defined in [staking/intentionsBalances.ts:18](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/staking/intentionsBalances.ts#L18)*
 
 Get the balances for all intentions and their nominators
 

docs/api-derive/modules/_types_.md

@@ -8,7 +8,7 @@
 
 **Ƭ DerivedBalances**: *`object`*
 
-*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/types.ts#L8)*
+*Defined in [types.ts:8](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/types.ts#L8)*
 
 #### Type declaration
 
@@ -19,7 +19,7 @@ ___
 
 **Ƭ DerivedBalancesMap**: *`object`*
 
-*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/types.ts#L26)*
+*Defined in [types.ts:26](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/types.ts#L26)*
 
 #### Type declaration
 
@@ -32,7 +32,7 @@ ___
 
 **Ƭ DerivedFees**: *`object`*
 
-*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/types.ts#L18)*
+*Defined in [types.ts:18](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/types.ts#L18)*
 
 #### Type declaration
 
@@ -43,7 +43,7 @@ ___
 
 **Ƭ DerivedReferendumVote**: *`object`*
 
-*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/types.ts#L30)*
+*Defined in [types.ts:30](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/types.ts#L30)*
 
 #### Type declaration
 

docs/api-derive/modules/_util_cache_.md

@@ -8,7 +8,7 @@
 
 ▸ **cache**(fn: *`Function`*, map?: *`WeakMap`<`object`, `any`>*): `(Anonymous function)`
 
-*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/767a197/packages/api-derive/src/util/cache.ts#L23)*
+*Defined in [util/cache.ts:23](https://github.com/polkadot-js/api/blob/843f374/packages/api-derive/src/util/cache.ts#L23)*
 
 Create memoization for a 2-currified function.