`e56969b4a76e`

source

tests/src/util/frankenstein.ts14.8 KiBsource history
1// Copyright 2019-2023 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617import {ApiPromise} from '@polkadot/api';18import {blake2AsHex, cryptoWaitReady} from '@polkadot/util-crypto';19import zombie from '@zombienet/orchestrator/dist';20import {readNetworkConfig} from '@zombienet/utils/dist';21import {resolve} from 'path';22import {usingPlaygrounds} from '.';23import {migrations} from './frankensteinMigrate';24import fs from 'fs';2526const ZOMBIENET_CREDENTIALS = process.env.ZOMBIENET_CREDENTIALS || '../.env';27const NETWORK_CONFIG_FILE = process.argv[2] ?? '../launch-zombienet.toml';28const PARA_DIR = process.env.PARA_DIR || '../';29const RELAY_DIR = process.env.RELAY_DIR || '../../polkadot/';30const REPLICA_FROM = process.env.REPLICA_FROM || 'wss://ws-opal.unique.network:443';31const NEW_RELAY_BIN = process.env.NEW_RELAY_BIN;32const NEW_RELAY_WASM = process.env.NEW_RELAY_WASM;33const NEW_PARA_BIN = process.env.NEW_PARA_BIN;34const NEW_PARA_WASM = process.env.NEW_PARA_WASM;35const DESTINATION_SPEC_VERSION = process.env.DESTINATION_SPEC_VERSION!;36const PARACHAIN_BLOCK_TIME = 12_000;37const SUPERUSER_KEY = '//Alice';3839let network: zombie.Network | undefined;4041// Stop the network if it is running42const stop = async () => {43  await network?.stop();44};4546// Promise of a timeout47function delay(ms: number) {48  return new Promise(resolve => setTimeout(resolve, ms));49}5051// Countdown with time left on display52async function waitWithTimer(time: number) {53  const secondsTotal = Math.ceil(time / 1000);54  for(let i = secondsTotal; i > 0; i--) {55    // could also introduce hours, but wth56    const seconds = i % 60;57    const text = `Time left: ${Math.floor(i / 60)}:${seconds < 10 ? '0' + seconds : seconds}`;58    if(process.stdout.isTTY)59      process.stdout.write(text);60    else if(seconds % 10 == 0)61      console.log(text);62    await delay(1000);63    if(process.stdout.isTTY) {64      process.stdout.clearLine(0);65      process.stdout.cursorTo(0);66    }67  }68}6970// Get the runtime's current version71function getSpecVersion(api: ApiPromise): number {72  return (api.consts.system.version as any).specVersion.toNumber();73}7475// Get the required information on the relay chain76function getRelayInfo(api: ApiPromise): {specVersion: number, epochBlockLength: number, blockTime: number, epochTime: number} {77  const info = {78    specVersion: getSpecVersion(api),79    epochBlockLength: (api.consts.babe.epochDuration as any).toNumber(),80    blockTime: (api.consts.babe.expectedBlockTime as any).toNumber(),81    epochTime: 0,82  };83  info.epochTime = info.epochBlockLength * info.blockTime;84  return info;85}8687// Enable or disable maintenance mode if present on the chain88async function toggleMaintenanceMode(value: boolean, wsUri: string) {89  await usingPlaygrounds(async (helper, privateKey) => {90    const superuser = await privateKey(SUPERUSER_KEY);91    try {92      const toggle = value ? 'enable' : 'disable';93      await helper.getSudo().executeExtrinsic(superuser, `api.tx.maintenance.${toggle}`, []);94      console.log(`Maintenance mode ${value ? 'engaged' : 'disengaged'}.`);95    } catch (e) {96      console.error('Couldn\'t set maintenance mode. The maintenance pallet probably does not exist. Log:', e);97    }98  }, wsUri);99}100101const raiseZombienet = async (): Promise<void> => {102  const isUpgradeTesting = !!NEW_RELAY_BIN || !!NEW_RELAY_WASM || !!NEW_PARA_BIN || !!NEW_PARA_WASM;103  /*104  // If there is nothing to upgrade, what is the point105  if (!isUpgradeTesting) {106    console.warn('\nNeither the relay nor the parachain were selected for an upgrade! ' +107      'Please pass environment vars `NEW_RELAY_BIN`, `NEW_RELAY_WASM`, `NEW_PARA_BIN`, `NEW_PARA_WASM`.');108    process.exit(1);109  }110  */111112  // an unsavory practice, but very convenient, mwahahah113  process.env.PARA_DIR = PARA_DIR;114  process.env.RELAY_DIR = RELAY_DIR;115  process.env.REPLICA_FROM = REPLICA_FROM;116117  const configPath = resolve(NETWORK_CONFIG_FILE);118  const networkConfig = readNetworkConfig(configPath);119  // console.log(networkConfig);120  if(networkConfig.settings.provider !== 'native') {121    throw new Error(`Oh no! Expected native network, got ${networkConfig.settings.provider}.`);122  }123124  await cryptoWaitReady();125126  // Launch Zombienet!127  network = await zombie.start(ZOMBIENET_CREDENTIALS, networkConfig, {silent: false});128129  // Get the relay chain info like the epoch length and spec version130  // Then restart each parachain's binaries131  // // Stop and restart each node132  // // Send specified keys to parachain nodes in case the parachain requires it133  // If it is not needed to upgrade runtimes themselves, the job is done!134135  // Record some required information regarding the relay chain136  await network.relay[0].connectApi();137  let relayInfo = getRelayInfo((network.relay[0] as any).apiInstance!);138  await network.relay[0].apiInstance!.disconnect();139  if(isUpgradeTesting) {140    console.log('Relay stats:', relayInfo);141  }142143  // non-exported functionality of NativeClient144  const networkClient = (network.client as any);145146  if(NEW_RELAY_BIN) {147    console.log('\n🧶 Restarting relay nodes');148149    for(const [index, node] of network.relay.entries()) {150      await node.apiInstance?.disconnect();151152      console.log(`\n🚦 Starting timeout for the epoch change (node ${index + 1}/${network.relay.length})...`);153      await waitWithTimer(relayInfo.epochTime);154155      // Replace the node-starting command with the new binary156      const cmd = networkClient.processMap[node.name].cmd[0].split(' ')[0];157      networkClient.processMap[node.name].cmd = networkClient.processMap[node.name].cmd.map((arg: string) => arg.replace(cmd, NEW_RELAY_BIN));158159      await node.restart();160    }161162    console.log('\n🌒 All relay nodes restarted with the new binaries.');163  }164165  if(NEW_PARA_BIN) {166    for(const paraId in network.paras) {167      const para = network.paras[paraId];168      console.log(`\n🧶 Restarting collator nodes of parachain ${paraId}`);169170      for(const [_index, node] of para.nodes.entries()) {171        await node.apiInstance?.disconnect();172173        // Replace the node-starting command with the new binary174        const cmd = networkClient.processMap[node.name].cmd[0].split(' ')[0];175        networkClient.processMap[node.name].cmd = networkClient.processMap[node.name].cmd.map((arg: string) => arg.replace(cmd, NEW_PARA_BIN));176177        await node.restart();178        // applyaurakey?179        // Zombienet handles it on first-time node creation180      }181    }182183    console.log('\n🌗 All parachain collators restarted with the new binaries.');184  }185186  // Re-establish connection to the relay node and get the runtime upgrade validation delay for parachains187  // For the relay, connect and set the new runtime code188  // For each parachain, connect, authorize and upgrade its runtime189  // Ping the the chains for the runtime upgrade after the minimal time and then every few blocks190  // // For each parachain, re-connect and verify that the runtime upgrade is successful191192  let relayUpgradeCompleted = false, paraUpgradeCompleted = false;193194  if(NEW_RELAY_WASM) {195    const relayOldVersion = relayInfo.specVersion;196    console.log('\n🚦 Starting timeout for the next epoch before upgrading the relay runtime code...');197    await waitWithTimer(relayInfo.epochTime);198199    console.log('--- Upgrading the relay chain runtime \t---');200201    // Read the new WASM code and set it as the relay's new code202    const code = fs.readFileSync(NEW_RELAY_WASM).toString('hex');203    await usingPlaygrounds(async (helper, privateKey) => {204      const superuser = await privateKey(SUPERUSER_KEY);205206      const result = await helper.executeExtrinsic(207        superuser,208        'api.tx.sudo.sudoUncheckedWeight',209        [helper.constructApiCall('api.tx.system.setCode', [`0x${code}`]), {}],210      );211212      if(result.status == 'Fail') {213        console.error('Failed to upgrade the runtime:', result);214      }215216      // Get the updated information from the relay's new runtime217      relayInfo = getRelayInfo(helper.getApi());218    }, network.relay[0].wsUri);219220    if(relayOldVersion != relayInfo.specVersion) {221      // eslint-disable-next-line no-useless-escape222      console.log(`\n\🛰️ The relay has successfully upgraded from version ${relayOldVersion} to ${relayInfo.specVersion}!`);223      relayUpgradeCompleted = true;224    } else {225      console.error(`\nThe relay did not upgrade from version ${relayOldVersion}!`);226    }227  } else {228    // If the relay did not need to be upgraded, it's already technically completed229    relayUpgradeCompleted = true;230  }231232  if(NEW_PARA_WASM) {233    let codeValidationDelayBlocks = 0;234    const upgradingParas: {[id: string]: {version: number, upgraded: boolean}} = {};235    // Calculate the code validation delay of the relay chain,236    // so that we know how much to wait before the parachains can be upgraded after the extrinsic237    await usingPlaygrounds(async (helper) => {238      const {validationUpgradeDelay, minimumValidationUpgradeDelay} =239        (await helper.callRpc('api.query.configuration.activeConfig', [])).toJSON() as any;240241      codeValidationDelayBlocks = Math.max(validationUpgradeDelay ?? 0, minimumValidationUpgradeDelay ?? 0);242    }, network.relay[0].wsUri);243244    // Wait for the next epoch so that the parachains will start cooperating with the relay245    if(relayUpgradeCompleted && NEW_RELAY_WASM) {246      console.log('\n🚥 Starting timeout for the next epoch before upgrading the parachains code...');247      await waitWithTimer(relayInfo.epochTime);248    }249250    const migration = migrations[DESTINATION_SPEC_VERSION];251    console.log('⭐️⭐️⭐️ DESTINATION_SPEC_VERSION ⭐️⭐️⭐️', DESTINATION_SPEC_VERSION);252    for(const paraId in network.paras) {253      console.log(`\n--- Upgrading the runtime of parachain ${paraId} \t---`);254      const para = network.paras[paraId];255256      // Enable maintenance mode if present257      await toggleMaintenanceMode(true, para.nodes[0].wsUri);258      if(migration) {259        console.log('⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️');260        console.log('⭐️⭐️⭐️ Running pre-upgrade scripts... ⭐️⭐️⭐️');261        console.log('⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️⭐️');262        await migration.before();263      }264265      // Read the WASM code and authorize the upgrade with its hash and set it as the new runtime266      const code = fs.readFileSync(NEW_PARA_WASM);267      const codeHash = blake2AsHex(code);268      await usingPlaygrounds(async (helper, privateKey) => {269        const superuser = await privateKey(SUPERUSER_KEY);270271        upgradingParas[paraId] = {version: getSpecVersion(helper.getApi()), upgraded: false};272273        console.log('--- Authorizing the parachain runtime upgrade \t---');274        let result = await helper.executeExtrinsic(275          superuser,276          'api.tx.sudo.sudoUncheckedWeight',277          [helper.constructApiCall('api.tx.parachainSystem.authorizeUpgrade', [codeHash, false]), {}],278        );279280        if(result.status == 'Fail') {281          console.error('Failed to authorize the upgrade:', result);282          return;283        }284285        console.log('--- Enacting the parachain runtime upgrade \t---');286        result = await helper.executeExtrinsic(287          superuser,288          'api.tx.sudo.sudoUncheckedWeight',289          [helper.constructApiCall('api.tx.parachainSystem.enactAuthorizedUpgrade', [`0x${code.toString('hex')}`]), {}],290        );291292        if(result.status == 'Fail') {293          console.error('Failed to upgrade the runtime:', result);294        }295      }, para.nodes[0].wsUri);296    }297298    // Check the upgrades of the parachains, first after the minimum code validation delay, and then after some block time increments299    let firstPass = true;300    for(let attempt = 0; attempt < 3 && !paraUpgradeCompleted; attempt++) {301      if(firstPass) {302        console.log('\nCode validation delay:', codeValidationDelayBlocks, 'blocks');303        console.log('🚥 Waiting for the minimum code validation delay before the parachain can upgrade...');304        await waitWithTimer(relayInfo.blockTime * codeValidationDelayBlocks);305        firstPass = false;306      } else {307        console.log('\n🚥 Waiting for a few blocks more to verify that the parachain upgrades are successful...');308        await waitWithTimer(PARACHAIN_BLOCK_TIME * 3);309      }310311      // Ping the parachains' nodes for new runtime versions312      let upgradeFailed = false;313      for(const paraId in network.paras) {314        if(upgradingParas[paraId].upgraded) continue;315316        const para = network.paras[paraId];317        // eslint-disable-next-line require-await318        await usingPlaygrounds(async (helper) => {319          const specVersion = getSpecVersion(helper.getApi());320321          if(specVersion != upgradingParas[paraId].version) {322            // eslint-disable-next-line no-useless-escape323            console.log(`\n\🛰️  Parachain ${paraId} has successfully upgraded from version ${upgradingParas[paraId].version} to ${specVersion}!`);324            upgradingParas[paraId].upgraded = true;325          } else {326            console.error(`\nParachain ${paraId} failed to upgrade from version ${upgradingParas[paraId].version}!`);327            upgradeFailed = true;328          }329        }, para.nodes[0].wsUri);330331        paraUpgradeCompleted = !upgradeFailed;332      }333    }334335    // Disable maintenance mode if present336    for(const paraId in network.paras) {337      // TODO only if our parachain338      if(migration) {339        console.log('⭐️⭐️⭐️ Running post-upgrade scripts... ⭐️⭐️⭐️');340        await migration.after();341      }342      await toggleMaintenanceMode(false, network.paras[paraId].nodes[0].wsUri);343    }344  } else {345    // If the relay did not need to be upgraded, it's already technically completed346    paraUpgradeCompleted = true;347  }348349  // await network.stop();350351  if(isUpgradeTesting) {352    if(paraUpgradeCompleted && relayUpgradeCompleted) {353      console.log("\n🛸 PARACHAINS' RUNTIME UPGRADE TESTING COMPLETE 🛸");354    } else {355      console.error("\n🚧 PARACHAINS' RUNTIME UPGRADE TESTING FAILED 🚧");356    }357  } else {358    console.log('🚀 ZOMBIENET RAISED 🚀');359  }360};361362raiseZombienet()/*.then(async () => await stop())*/.catch(async (e) => {363  console.error(e);364  await stop();365  process.exit(1);366});