forked from hyperledger/cacti
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(quorum-connector): add script for checking connection status
- Simple script will check ledger connection by getting block through the connector. Closes: hyperledger#2309 Signed-off-by: Michal Bajer <michal.bajer@fujitsu.com>
- Loading branch information
Showing
3 changed files
with
123 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
113 changes: 113 additions & 0 deletions
113
packages/cactus-plugin-ledger-connector-quorum/src/scripts/get-quorum-connector-status.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| /** | ||
| * Simple command line tool to check ledger connection of running quorum connector. | ||
| * Will try to get latest block from the ledger. | ||
| * | ||
| * Usage: | ||
| * After installing the connector package... | ||
| * `npm install -g` in it's dir or directly from NPM - `npm install @hyperledger/cactus-plugin-ledger-connector-quorum` | ||
| * ...you can start the command line tool with npx: | ||
| * `npx cacti-quorum-connector-status <URL>:<PORT>` | ||
| * | ||
| * TODO: | ||
| * - Add healthcheck endpoint to quorum connector and query it instead of reading the latest block. | ||
| */ | ||
|
|
||
| import { | ||
| QuorumApiClient, | ||
| QuorumApiClientOptions, | ||
| } from "../main/typescript/public-api"; | ||
|
|
||
| import minimist from "minimist"; | ||
| import path from "path"; | ||
| import axios from "axios"; | ||
| import chalk from "chalk"; | ||
|
|
||
| type AuthOptions = { | ||
| apiKey?: string; | ||
| accessToken?: string; | ||
| username?: string; | ||
| password?: string; | ||
| }; | ||
|
|
||
| async function main(url: string, auth: AuthOptions = {}) { | ||
| try { | ||
| console.log(`Check Quorum connector ${url}...`); | ||
| const config = new QuorumApiClientOptions({ | ||
| basePath: url, | ||
| ...auth, | ||
| }); | ||
| const quorumApiClient = new QuorumApiClient(config); | ||
|
|
||
| // Get latest block | ||
| const connectorResponse = await quorumApiClient.invokeWeb3EthMethodV1({ | ||
| methodName: "getBlock", | ||
| params: ["latest"], | ||
| }); | ||
|
|
||
| // Check response | ||
| if ( | ||
| !connectorResponse || | ||
| !connectorResponse.data || | ||
| !connectorResponse.data.data || | ||
| connectorResponse.data.status !== 200 | ||
| ) { | ||
| console.log(connectorResponse.data); | ||
| throw new Error("Invalid response from the connector"); | ||
| } | ||
|
|
||
| const blockData = connectorResponse.data.data; | ||
| console.log( | ||
| chalk.green(`OK - Latest block #${blockData.number} ${blockData.hash}`), | ||
| ); | ||
| } catch (error: unknown) { | ||
| let errorMessage = `Error: ${error}`; | ||
| if (axios.isAxiosError(error)) { | ||
| errorMessage = `${error.name}: ${error.message}`; | ||
| } | ||
|
|
||
| console.error(chalk.red(errorMessage)); | ||
| process.exit(2); | ||
| } | ||
| } | ||
|
|
||
| function showHelp() { | ||
| const scriptName = path.basename(__filename); | ||
| console.log( | ||
| chalk.yellow( | ||
| `Usage: ${scriptName} <CONNECTOR_URL>:<PORT> [-h|--help] [--apiKey <KEY>] [--accessToken <KEY>] [--username <USERNAME> --password <PASSWORD>]`, | ||
| ), | ||
| ); | ||
| process.exit(1); | ||
| } | ||
|
|
||
| if (require.main === module) { | ||
| const argv = minimist(process.argv.slice(2)); | ||
| if ( | ||
| argv["h"] || | ||
| argv["help"] || | ||
| argv["_"].length !== 1 || | ||
| (argv["username"] && !argv["password"]) || | ||
| (argv["password"] && !argv["username"]) | ||
| ) { | ||
| showHelp(); | ||
| } | ||
| const connectorUrl = argv["_"][0]; | ||
|
|
||
| // Ensure valid URL was provided. | ||
| // Without it the connector request will hang indefinitely. | ||
| try { | ||
| new URL(connectorUrl); | ||
| } catch (err) { | ||
| console.error(chalk.red(err)); | ||
| showHelp(); | ||
| } | ||
|
|
||
| main(connectorUrl, { | ||
| apiKey: argv["apiKey"], | ||
| accessToken: argv["accessToken"], | ||
| username: argv["username"], | ||
| password: argv["password"], | ||
| }); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters