From b1fe871f4e8d052dbc70a5f7d550b5885ce6ec84 Mon Sep 17 00:00:00 2001 From: kylezs Date: Tue, 17 Oct 2023 00:11:00 +1100 Subject: [PATCH] feat: bouncer command for submitting runtime upgrades (#4122) * feat: bouncer command for submitting runtime upgrades * chore: linting --- bouncer/commands/submit_runtime_upgrade.ts | 31 ++++++++++++++++++++ bouncer/shared/submit_runtime_upgrade.ts | 33 ++++++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100755 bouncer/commands/submit_runtime_upgrade.ts create mode 100755 bouncer/shared/submit_runtime_upgrade.ts diff --git a/bouncer/commands/submit_runtime_upgrade.ts b/bouncer/commands/submit_runtime_upgrade.ts new file mode 100755 index 0000000000..e2a4f012b8 --- /dev/null +++ b/bouncer/commands/submit_runtime_upgrade.ts @@ -0,0 +1,31 @@ +#!/usr/bin/env -S pnpm tsx +// INSTRUCTIONS +// +// This command takes 1 mandatory argument, and 2 optional arguments. +// Arguments: +// 1. Path to the runtime wasm file +// 2. Optional: A JSON string representing the semver restriction for the upgrade. If not provided, the upgrade will not be restricted by semver. +// 3. Optional: A number representing the percentage of nodes that must be upgraded before the upgrade will be allowed to proceed. If not provided, the upgrade will not be restricted by the number of nodes that have upgraded. +// +// For example: ./commands/submit_runtime_upgrade.ts /path/to/state_chain_runtime.compact.compressed.wasm '{"major": 1, "minor": 2, "patch": 3}' 50 + +import { submitRuntimeUpgrade } from '../shared/submit_runtime_upgrade'; +import { runWithTimeout } from '../shared/utils'; + +async function main() { + const wasmPath = process.argv[2]; + + const arg3 = process.argv[3].trim(); + const semverRestriction = arg3 ? JSON.parse(arg3) : undefined; + + const arg4 = process.argv[4].trim(); + const percentNodesUpgraded = arg4 ? Number(arg4) : undefined; + + await submitRuntimeUpgrade(wasmPath, semverRestriction, percentNodesUpgraded); + process.exit(0); +} + +runWithTimeout(main(), 20000).catch((error) => { + console.error(error); + process.exit(-1); +}); diff --git a/bouncer/shared/submit_runtime_upgrade.ts b/bouncer/shared/submit_runtime_upgrade.ts new file mode 100755 index 0000000000..c23a928efa --- /dev/null +++ b/bouncer/shared/submit_runtime_upgrade.ts @@ -0,0 +1,33 @@ +import { compactAddLength } from '@polkadot/util'; +import { promises as fs } from 'fs'; +import { submitGovernanceExtrinsic } from './cf_governance'; +import { getChainflipApi } from '../shared/utils'; + +async function readRuntimeWasmFromFile(filePath: string): Promise { + return compactAddLength(new Uint8Array(await fs.readFile(filePath))); +} + +// By default we don't want to restrict that any of the nodes need to be upgraded. +export async function submitRuntimeUpgrade( + wasmPath: string, + semverRestriction?: Record, + percentNodesUpgraded = 0, +) { + const runtimeWasm = await readRuntimeWasmFromFile(wasmPath); + + console.log('Submitting runtime upgrade.'); + const chainflip = await getChainflipApi(); + + let versionPercentRestriction; + if (semverRestriction && percentNodesUpgraded) { + versionPercentRestriction = [semverRestriction, percentNodesUpgraded]; + } else { + versionPercentRestriction = undefined; + } + + await submitGovernanceExtrinsic( + chainflip.tx.governance.chainflipRuntimeUpgrade(versionPercentRestriction, runtimeWasm), + ); + + console.log('Runtime upgrade completed.'); +}