diff --git a/docs/METHODS_RPC.md b/docs/METHODS_RPC.md index 62dac0aaa5..134f46e882 100644 --- a/docs/METHODS_RPC.md +++ b/docs/METHODS_RPC.md @@ -40,7 +40,7 @@ _Retrieval of chain data_ - **summary**: Get the block hash for a specific block ▸ **getFinalizedHead**(): `Hash` -- **summary**: Get hash of the last finalised block in the canon chain +- **summary**: Get hash of the last finalized block in the canon chain ▸ **getHeader**(hash?: `Hash`): `Header` - **summary**: Retrieves the header for a specific block diff --git a/packages/api-derive/src/chain/bestNumberFinalized.ts b/packages/api-derive/src/chain/bestNumberFinalized.ts index bb0e889392..8a931b9b76 100644 --- a/packages/api-derive/src/chain/bestNumberFinalized.ts +++ b/packages/api-derive/src/chain/bestNumberFinalized.ts @@ -10,13 +10,13 @@ import { BlockNumber, Header } from '@polkadot/types'; import { drr } from '../util/drr'; /** - * @description Get the latest finalised block number. + * @description Get the latest finalized block number. * example *
* * ```javascript * api.derive.chain.bestNumberFinalized((blockNumber) => { - * console.log(`the current finalised block is #${blockNumber}`); + * console.log(`the current finalized block is #${blockNumber}`); * }); * ``` */ diff --git a/packages/api-derive/src/chain/bestNumberLag.ts b/packages/api-derive/src/chain/bestNumberLag.ts index 3bb17ad5d9..ab1731d63f 100644 --- a/packages/api-derive/src/chain/bestNumberLag.ts +++ b/packages/api-derive/src/chain/bestNumberLag.ts @@ -12,13 +12,13 @@ import { bestNumber } from './bestNumber'; import { bestNumberFinalized } from './bestNumberFinalized'; /** - * @description Calculates the lag between finalised head and best head + * @description Calculates the lag between finalized head and best head * @example *
* * ```javascript * api.derive.chain.bestNumberLag((lag) => { - * console.log(`finalised is ${lag} blocks behind head`); + * console.log(`finalized is ${lag} blocks behind head`); * }); * ``` */ diff --git a/packages/api/test/e2e/promise-alex.spec.js b/packages/api/test/e2e/promise-alex.spec.js index 1a67f96a42..4c7faf89ff 100644 --- a/packages/api/test/e2e/promise-alex.spec.js +++ b/packages/api/test/e2e/promise-alex.spec.js @@ -5,6 +5,8 @@ import Api from '../../src/promise'; import WsProvider from '../../../rpc-provider/src/ws'; +import { Hash, Header } from '@polkadot/types'; + describe.skip('alex queries', () => { let api; @@ -65,6 +67,20 @@ describe.skip('alex queries', () => { // done(); }); }); + + it('Gets the hash of the last finalized header', async (done) => { + api.rpc.chain.getFinalizedHead((head) => { + expect(head instanceof Hash).toBe(true); + done(); + }); + }); + + it('Subscribes to the best finalized header on ALEX', async (done) => { + api.rpc.chain.subscribeFinalizedHeads((heads) => { + expect(heads instanceof Header).toBe(true); + done(); + }); + }); }); describe.skip('Local archive queries (for debug)', () => { diff --git a/packages/rpc-provider/src/ws/Provider.ts b/packages/rpc-provider/src/ws/Provider.ts index d4e973c219..ab161dbef9 100644 --- a/packages/rpc-provider/src/ws/Provider.ts +++ b/packages/rpc-provider/src/ws/Provider.ts @@ -36,7 +36,9 @@ interface WSProviderInterface extends ProviderInterface { } const ALIASSES: { [index: string]: string } = { - 'chain_finalisedHead': 'chain_finalizedHead' + 'chain_finalisedHead': 'chain_finalizedHead', + 'chain_subscribeFinalisedHeads': 'chain_subscribeFinalizedHeads', + 'chain_unsubscribeFinalisedHeads': 'chain_unsubscribeFinalizedHeads' }; const l = logger('api-ws'); diff --git a/packages/type-jsonrpc/src/chain.ts b/packages/type-jsonrpc/src/chain.ts index ef7570f926..75b817936e 100644 --- a/packages/type-jsonrpc/src/chain.ts +++ b/packages/type-jsonrpc/src/chain.ts @@ -34,7 +34,7 @@ const getBlockHash: RpcMethodOpt = { }; const getFinalizedHead: RpcMethodOpt = { - description: 'Get hash of the last finalised block in the canon chain', + description: 'Get hash of the last finalized block in the canon chain', params: [], type: 'Hash' }; @@ -63,9 +63,8 @@ const subscribeFinalizedHeads: RpcMethodOpt = { params: [], pubsub: [ 'finalizedHead', - // TODO US spelling - 'subscribeFinalisedHeads', - 'unsubscribeFinalisedHeads' + 'subscribeFinalizedHeads', + 'unsubscribeFinalizedHeads' ], type: 'Header' }; @@ -95,11 +94,11 @@ export default { getBlock: createMethod(section, 'getBlock', getBlock), getBlockHash: createMethod(section, 'getBlockHash', getBlockHash), // TODO US spelling - getFinalizedHead: createMethod(section, 'getFinalisedHead', getFinalizedHead), + getFinalizedHead: createMethod(section, 'getFinalizedHead', getFinalizedHead), getHeader: createMethod(section, 'getHeader', getHeader), getRuntimeVersion: createMethod(section, 'getRuntimeVersion', getRuntimeVersion), // TODO US spelling - subscribeFinalizedHeads: createMethod(section, 'subscribeFinalisedHeads', subscribeFinalizedHeads), + subscribeFinalizedHeads: createMethod(section, 'subscribeFinalizedHeads', subscribeFinalizedHeads), subscribeRuntimeVersion: createMethod(section, 'subscribeRuntimeVersion', subscribeRuntimeVersion), subscribeNewHead: createMethod(section, 'subscribeNewHead', subscribeNewHead) }