git.delta.rocks / unique-network / refs/commits / df9b2f8abb14

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034import * as path from 'path';5import * as crypto from 'crypto';6import {IKeyringPair} from '@polkadot/types/types/interfaces';7import chai from 'chai';8import chaiAsPromised from 'chai-as-promised';9import chaiSubset from 'chai-subset';10import {Context} from 'mocha';11import config from '../config';12import {ChainHelperBase} from './playgrounds/unique';13import {ILogger} from './playgrounds/types';14import {DevUniqueHelper, SilentLogger, SilentConsole, DevMoonbeamHelper, DevMoonriverHelper, DevAcalaHelper, DevKaruraHelper, DevRelayHelper, DevWestmintHelper, DevStatemineHelper, DevStatemintHelper, DevAstarHelper, DevShidenHelper} from './playgrounds/unique.dev';15import {dirname} from 'path';16import {fileURLToPath} from 'url';1718chai.use(chaiAsPromised);19chai.use(chaiSubset);20export const expect = chai.expect;2122const getTestHash = (filename: string) => {23  return crypto.createHash('md5').update(filename).digest('hex');24};2526export const getTestSeed = (filename: string) => {27  return `//Alice+${getTestHash(filename)}`;28};2930async function usingPlaygroundsGeneral<T extends ChainHelperBase>(helperType: new(logger: ILogger) => T, url: string, code: (helper: T, privateKey: (seed: string | {filename?: string, url?: string, ignoreFundsPresence?: boolean}) => Promise<IKeyringPair>) => Promise<void>) {31  const silentConsole = new SilentConsole();32  silentConsole.enable();3334  const helper = new helperType(new SilentLogger());3536  try {37    await helper.connect(url);38    const ss58Format = helper.chain.getChainProperties().ss58Format;39    const privateKey = async (seed: string | {filename?: string, url?: string, ignoreFundsPresence?: boolean}) => {40      if (typeof seed === 'string') {41        return helper.util.fromSeed(seed, ss58Format);42      }43      if (seed.url) {44        const {filename} = makeNames(seed.url);45        seed.filename = filename;46      } else if (seed.filename) {47        // Pass48      } else {49        throw new Error('no url nor filename set');50      }51      const actualSeed = getTestSeed(seed.filename);52      let account = helper.util.fromSeed(actualSeed, ss58Format);53      // here's to hoping that no54      if (!seed.ignoreFundsPresence && ((helper as any)['balance'] == undefined || await (helper as any).balance.getSubstrate(account.address) < MINIMUM_DONOR_FUND)) {55        console.warn(`${path.basename(seed.filename)}: Not enough funds present on the filename account. Using the default one as the donor instead.`);56        account = helper.util.fromSeed('//Alice', ss58Format);57      }58      return account;59    };60    await code(helper, privateKey);61  }62  finally {63    await helper.disconnect();64    silentConsole.disable();65  }66}6768export const usingPlaygrounds = (code: (helper: DevUniqueHelper, privateKey: (seed: string | {filename?: string, url?: string, ignoreFundsPresence?: boolean}) => Promise<IKeyringPair>) => Promise<void>, url: string = config.substrateUrl) => {69  return usingPlaygroundsGeneral<DevUniqueHelper>(DevUniqueHelper, url, code);70};7172export const usingWestmintPlaygrounds = (url: string, code: (helper: DevWestmintHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {73  return usingPlaygroundsGeneral<DevWestmintHelper>(DevWestmintHelper, url, code);74};7576export const usingStateminePlaygrounds = (url: string, code: (helper: DevWestmintHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {77  return usingPlaygroundsGeneral<DevStatemineHelper>(DevWestmintHelper, url, code);78};7980export const usingStatemintPlaygrounds = (url: string, code: (helper: DevWestmintHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {81  return usingPlaygroundsGeneral<DevStatemintHelper>(DevWestmintHelper, url, code);82};8384export const usingRelayPlaygrounds = (url: string, code: (helper: DevRelayHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {85  return usingPlaygroundsGeneral<DevRelayHelper>(DevRelayHelper, url, code);86};8788export const usingAcalaPlaygrounds = (url: string, code: (helper: DevAcalaHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {89  return usingPlaygroundsGeneral<DevAcalaHelper>(DevAcalaHelper, url, code);90};9192export const usingKaruraPlaygrounds = (url: string, code: (helper: DevKaruraHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {93  return usingPlaygroundsGeneral<DevKaruraHelper>(DevAcalaHelper, url, code);94};9596export const usingMoonbeamPlaygrounds = (url: string, code: (helper: DevMoonbeamHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {97  return usingPlaygroundsGeneral<DevMoonbeamHelper>(DevMoonbeamHelper, url, code);98};99100export const usingMoonriverPlaygrounds = (url: string, code: (helper: DevMoonbeamHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {101  return usingPlaygroundsGeneral<DevMoonriverHelper>(DevMoonriverHelper, url, code);102};103104export const usingAstarPlaygrounds = (url: string, code: (helper: DevAstarHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {105  return usingPlaygroundsGeneral<DevAstarHelper>(DevAstarHelper, url, code);106};107108export const usingShidenPlaygrounds = (url: string, code: (helper: DevShidenHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {109  return usingPlaygroundsGeneral<DevShidenHelper>(DevShidenHelper, url, code);110};111112export const MINIMUM_DONOR_FUND = 100_000n;113export const DONOR_FUNDING = 2_000_000n;114115// App-promotion periods:116export const LOCKING_PERIOD = 12n; // 12 blocks of relay117export const UNLOCKING_PERIOD = 6n; // 6 blocks of parachain118119// Native contracts120export const COLLECTION_HELPER = '0x6c4e9fe1ae37a41e93cee429e8e1881abdcbb54f';121export const CONTRACT_HELPER = '0x842899ECF380553E8a4de75bF534cdf6fBF64049';122123export enum Pallets {124  Inflation = 'inflation',125  ReFungible = 'refungible',126  Fungible = 'fungible',127  NFT = 'nonfungible',128  Scheduler = 'scheduler',129  AppPromotion = 'apppromotion',130  CollatorSelection = 'collatorselection',131  Session = 'session',132  Identity = 'identity',133  Preimage = 'preimage',134  Maintenance = 'maintenance',135  TestUtils = 'testutils',136}137138export function requirePalletsOrSkip(test: Context, helper: DevUniqueHelper, requiredPallets: string[]) {139  const missingPallets = helper.fetchMissingPalletNames(requiredPallets);140141  if (missingPallets.length > 0) {142    const skipMsg = `\tSkipping test '${test.test?.title}'.\n\tThe following pallets are missing:\n\t- ${missingPallets.join('\n\t- ')}`;143    console.warn('\x1b[38:5:208m%s\x1b[0m', skipMsg);144    test.skip();145  }146}147148export function itSub(name: string, cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any, opts: { only?: boolean, skip?: boolean, requiredPallets?: string[] } = {}) {149  (opts.only ? it.only :150    opts.skip ? it.skip : it)(name, async function () {151    await usingPlaygrounds(async (helper, privateKey) => {152      if (opts.requiredPallets) {153        requirePalletsOrSkip(this, helper, opts.requiredPallets);154      }155156      await cb({helper, privateKey});157    });158  });159}160export function itSubIfWithPallet(name: string, required: string[], cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any, opts: { only?: boolean, skip?: boolean, requiredPallets?: string[] } = {}) {161  return itSub(name, cb, {requiredPallets: required, ...opts});162}163itSub.only = (name: string, cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any) => itSub(name, cb, {only: true});164itSub.skip = (name: string, cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any) => itSub(name, cb, {skip: true});165166itSubIfWithPallet.only = (name: string, required: string[], cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any) => itSubIfWithPallet(name, required, cb, {only: true});167itSubIfWithPallet.skip = (name: string, required: string[], cb: (apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any) => itSubIfWithPallet(name, required, cb, {skip: true});168itSub.ifWithPallets = itSubIfWithPallet;169170export type SchedKind = 'anon' | 'named';171172export function itSched(173  name: string,174  cb: (schedKind: SchedKind, apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any,175  opts: { only?: boolean, skip?: boolean, requiredPallets?: string[] } = {},176) {177  itSub(name + ' (anonymous scheduling)', (apis) => cb('anon', apis), opts);178  itSub(name + ' (named scheduling)', (apis) => cb('named', apis), opts);179}180itSched.only = (name: string, cb: (schedKind: SchedKind, apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any) => itSched(name, cb, {only: true});181itSched.skip = (name: string, cb: (schedKind: SchedKind, apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any) => itSched(name, cb, {skip: true});182itSched.ifWithPallets = itSchedIfWithPallets;183184function itSchedIfWithPallets(name: string, required: string[], cb: (schedKind: SchedKind, apis: { helper: DevUniqueHelper, privateKey: (seed: string) => Promise<IKeyringPair> }) => any, opts: { only?: boolean, skip?: boolean, requiredPallets?: string[] } = {}) {185  return itSched(name, cb, {requiredPallets: required, ...opts});186}187188export function describeXCM(title: string, fn: (this: Mocha.Suite) => void, opts: {skip?: boolean} = {}) {189  (process.env.RUN_XCM_TESTS && !opts.skip190    ? describe191    : describe.skip)(title, fn);192}193194describeXCM.skip = (name: string, fn: (this: Mocha.Suite) => void) => describeXCM(name, fn, {skip: true});195196export function sizeOfInt(i: number) {197  if (i < 0 || i > 0xffffffff) throw new Error('out of range');198  if(i < 0b11_1111) {199    return 1;200  } else if (i < 0b11_1111_1111_1111) {201    return 2;202  } else if (i < 0b11_1111_1111_1111_1111_1111_1111_1111) {203    return 4;204  } else {205    return 5;206  }207}208209const UTF8_ENCODER = new TextEncoder();210export function sizeOfEncodedStr(v: string) {211  const encoded = UTF8_ENCODER.encode(v);212  return sizeOfInt(encoded.length) + encoded.length;213}214215export function sizeOfProperty(prop: {key: string, value: string}) {216  return sizeOfEncodedStr(prop.key) + sizeOfEncodedStr(prop.value);217}218219export function makeNames(url: string) {220  const filename = fileURLToPath(url);221  return {222    filename,223    dirname: dirname(filename),224  };225}