@rosen-bridge/utils 0.3.0 → 2.0.0

package/jest.config.json

@@ -1,7 +0,0 @@
-{
-  "coverageReporters": ["lcov", "cobertura", "text", "text-summary"],
-  "preset": "ts-jest/presets/js-with-babel",
-  "setupFiles": ["./tests/setup.ts"],
-  "testEnvironment": "node",
-  "verbose": true
-}

package/lib/constants.ts

@@ -1,2 +0,0 @@
-export const DEFAULT_RELEASES_FETCHING_PAGE_SIZE = 5;
-export const ROSEN_BRIDGE_ORGANIZATION = 'rosen-bridge';

package/lib/downloadRosenAssets.ts

@@ -1,67 +0,0 @@
-import download from 'download';
-
-import {
-  findLatestRelease,
-  findLatestStableRelease,
-  getReleaseByTag,
-} from './utils/github';
-import { isValidAssetName, truncateAssetName } from './utils/rosen';
-
-import { RosenAssetsDownloadError } from './error';
-
-const repo = 'contract';
-
-/**
- * Download all required Rosen assets (tokenMap and all chain address files) to a specific path
- * @param chainType chain type (e.g. mainnet, testnet, etc.)
- * @param includePrereleases weather to include prereleases into account when searching for a matching release in GitHub
- * @param config configs for including prereleases, adding name suffix, and getting specific release by tag
- */
-const downloadRosenAssets = async (
-  chainType: string,
-  destinationPath: string,
-  config?: {
-    includePrereleases?: boolean;
-    nameSuffix?: string;
-    tag?: string;
-  }
-) => {
-  const getRelease = () => {
-    if (config?.tag) return getReleaseByTag(repo, config.tag);
-    if (config?.includePrereleases) return findLatestRelease(repo, chainType);
-    return findLatestStableRelease(repo, chainType);
-  };
-  try {
-    const release = await getRelease();
-
-    if (release) {
-      await Promise.all([
-        ...(release &&
-          release.assets
-            .filter((asset) => isValidAssetName(chainType)(asset.name))
-            .map(async (asset) =>
-              download(asset.browser_download_url, destinationPath, {
-                filename: truncateAssetName(asset.name, config?.nameSuffix),
-              })
-            )),
-      ]);
-    } else {
-      console.error(`No release found for [${chainType}] chain type.`);
-      if (!config?.includePrereleases) {
-        console.error(
-          'Please note that `includePrereleases` is set to false. There may be some matching releases in prereleases.'
-        );
-      }
-    }
-  } catch (error) {
-    console.error(
-      `An error occurred while trying to download Rosen assets: ${error}`
-    );
-    if (error instanceof Error) {
-      console.error(error.stack);
-    }
-    throw new RosenAssetsDownloadError('', { cause: error });
-  }
-};
-
-export default downloadRosenAssets;

package/lib/downloadTssBinary.ts

@@ -1,61 +0,0 @@
-import download from 'download';
-
-import {
-  findLatestReleaseByPrefixTag,
-  findLatestStableReleaseByPrefixTag,
-  getReleaseByTag,
-} from './utils/github';
-import { isValidOS } from './utils/rosen';
-
-import { RosenAssetsDownloadError } from './error';
-
-const repo = 'sign-protocols';
-
-/**
- * Download release asset by tag to a specific path
- * @param destinationPath where writes files
- * @param config configs for including prereleases, set osName, getting specific release by tag or by regex tag
- */
-const downloadTssBinary = async (
-  destinationPath: string,
-  config: {
-    osName: string;
-    tag: string;
-    regex: boolean;
-    includePrereleases?: boolean;
-  }
-) => {
-  const getRelease = () => {
-    if (config.regex) {
-      if (config?.includePrereleases)
-        return findLatestReleaseByPrefixTag(repo, config.tag);
-      else return findLatestStableReleaseByPrefixTag(repo, config.tag);
-    } else return getReleaseByTag(repo, config.tag);
-  };
-  try {
-    const release = await getRelease();
-
-    if (release) {
-      await Promise.all([
-        ...(release &&
-          release.assets
-            .filter((asset) => isValidOS(config.osName)(asset.name))
-            .map(async (asset) =>
-              download(asset.browser_download_url, destinationPath)
-            )),
-      ]);
-    } else {
-      console.error(`No release found for [${config.osName}] OS name.`);
-    }
-  } catch (error) {
-    console.error(
-      `An error occurred while trying to download release assets: ${error}`
-    );
-    if (error instanceof Error) {
-      console.error(error.stack);
-    }
-    throw new RosenAssetsDownloadError('', { cause: error });
-  }
-};
-
-export { downloadTssBinary };

package/lib/error.ts

@@ -1,3 +0,0 @@
-class RosenAssetsDownloadError extends Error {}
-
-export { RosenAssetsDownloadError };

package/lib/index.ts

@@ -1,4 +0,0 @@
-export { default as downloadRosenAssets } from './downloadRosenAssets';
-export * from './downloadTssBinary';
-
-export { RosenAssetsDownloadError } from './error';

package/lib/types/index.ts

@@ -1,13 +0,0 @@
-import { Octokit } from 'octokit';
-
-export type ArrayElement<T extends any[]> = T extends (infer Element)[]
-  ? Element
-  : never;
-
-type GithubReleases = Awaited<
-  ReturnType<InstanceType<typeof Octokit>['rest']['repos']['listReleases']>
->['data'];
-
-export type GithubRelease = ArrayElement<GithubReleases>;
-
-export type SupportedRepo = 'contract' | 'sign-protocols';

package/lib/utils/github.ts

@@ -1,169 +0,0 @@
-import { Octokit } from 'octokit';
-
-import { isValidAssetName } from './rosen';
-
-import {
-  DEFAULT_RELEASES_FETCHING_PAGE_SIZE,
-  ROSEN_BRIDGE_ORGANIZATION,
-} from '../constants';
-
-import { GithubRelease, SupportedRepo } from '../types';
-
-/**
- * Fetch a page of releases from Github Api in each iteration until there are no
- * more releases.
- * @param repoName
- * @param pageSize
- */
-async function* fetchReleasesPage(
-  repoName: SupportedRepo,
-  pageSize = DEFAULT_RELEASES_FETCHING_PAGE_SIZE
-) {
-  const octokit = new Octokit();
-
-  let currentPage = 1;
-
-  while (true) {
-    const releasesPage = await octokit.rest.repos.listReleases({
-      owner: ROSEN_BRIDGE_ORGANIZATION,
-      repo: repoName,
-      per_page: pageSize,
-      page: currentPage,
-    });
-
-    if (releasesPage.data.length) {
-      yield releasesPage.data;
-      currentPage += 1;
-    } else {
-      return;
-    }
-  }
-}
-
-/**
- * Find the last release matching the predicate. If all releases are iterated and
- * no matching release is found, return null.
- * @param repoName
- * @param predicate
- */
-const findLastRelease = async (
-  repoName: SupportedRepo,
-  predicate: (release: GithubRelease) => boolean = () => true
-) => {
-  const releasesPageIterator = fetchReleasesPage(repoName);
-
-  for await (const releasesPage of releasesPageIterator) {
-    const foundRelease = releasesPage.find(predicate);
-
-    if (foundRelease) {
-      return foundRelease;
-    }
-  }
-  return null;
-};
-
-/**
- * get a GitHub release by its tag
- * @param repoName
- * @param tag
- */
-const getReleaseByTag = async (repoName: SupportedRepo, tag: string) => {
-  const octokit = new Octokit();
-  const release = await octokit.rest.repos.getReleaseByTag({
-    owner: ROSEN_BRIDGE_ORGANIZATION,
-    repo: repoName,
-    tag,
-  });
-
-  return release.data;
-};
-
-/**
- * Return a function which checks if a release has at least one asset for a
- * specific chain type
- * @param chainType
- * @param release
- */
-const hasAssetForChainType = (chainType: string) => (release: GithubRelease) =>
-  release.assets.map((asset) => asset.name).some(isValidAssetName(chainType));
-
-/**
- * Return a function which checks if a release is a stable (that is, non-prerelease)
- * and has some asset matching a specific chain type
- * @param chainType
- */
-const isStableReleaseForChainType =
-  (chainType: string) => (release: GithubRelease) =>
-    !release.prerelease && hasAssetForChainType(chainType)(release);
-
-/**
- * Return a function which checks if tagPrefix is matched with release tag_name
- * @param tagPrefix
- */
-const hasMatchedTagPrefix = (tagPrefix: string) => (release: GithubRelease) => {
-  const regex = new RegExp(`^${tagPrefix}`);
-  return regex.test(release.tag_name);
-};
-
-/**
- * Return a function which checks if a release is a stable (that is, non-prerelease),
- * and tagPrefix is matched with release tag_name
- * @param tagPrefix
- */
-const isStableReleaseForRegexTagType =
-  (tagPrefix: string) => (release: GithubRelease) =>
-    !release.prerelease && hasMatchedTagPrefix(tagPrefix)(release);
-
-/**
- * Find latest release (prerelease or non-prerelease) having some asset matching
- * a specific chain type
- * @param repoName
- * @param chainType
- */
-const findLatestRelease = async (repoName: SupportedRepo, chainType: string) =>
-  findLastRelease(repoName, hasAssetForChainType(chainType));
-
-/**
- * Find latest stable (that is, non-prerelease) release having some asset matching
- * a specific chain type
- * @param repoName
- * @param chainType
- */
-const findLatestStableRelease = async (
-  repoName: SupportedRepo,
-  chainType: string
-) => findLastRelease(repoName, isStableReleaseForChainType(chainType));
-
-/**
- * Find the latest stable (that is, non-prerelease) release that tagPrefix is matched with release tag_name
- * @param repoName
- * @param tagPrefix
- */
-const findLatestStableReleaseByPrefixTag = async (
-  repoName: SupportedRepo,
-  tagPrefix: string
-) => findLastRelease(repoName, isStableReleaseForRegexTagType(tagPrefix));
-
-/**
- * Find the latest release that tagPrefix is matched with release tag_name
- * @param repoName
- * @param tagPrefix
- */
-const findLatestReleaseByPrefixTag = async (
-  repoName: SupportedRepo,
-  tagPrefix: string
-) => findLastRelease(repoName, hasMatchedTagPrefix(tagPrefix));
-
-export {
-  fetchReleasesPage,
-  findLastRelease,
-  findLatestRelease,
-  findLatestStableRelease,
-  findLatestStableReleaseByPrefixTag,
-  findLatestReleaseByPrefixTag,
-  getReleaseByTag,
-  hasAssetForChainType,
-  isStableReleaseForChainType,
-  isStableReleaseForRegexTagType,
-  hasMatchedTagPrefix,
-};

package/lib/utils/rosen.ts

@@ -1,29 +0,0 @@
-/**
- * Check if an asset name is a valid Rosen asset name and matches a specific
- * chain type
- * @param chainType
- */
-export const isValidAssetName = (chainType: string) => (assetName: string) =>
-  new RegExp(`(contracts-.+|tokensMap)-${chainType}-.+.json`).test(assetName);
-
-/**
- * Check if an OS name is a valid supported tss OS
- * @param OSName
- */
-export const isValidOS = (OSName: string) => (releaseAssetName: string) =>
-  new RegExp(`(rosenTss-${OSName}-.+).zip`).test(releaseAssetName);
-
-/**
- * Remove chain type and tag from the asset name and optionally replaces them
- * with a suffix
- * @param assetName
- * @param alternativeSuffix a suffix which will be added before `.json` (if provided)
- */
-export const truncateAssetName = (
-  assetName: string,
-  alternativeSuffix?: string
-) =>
-  assetName.replace(
-    /(contracts-.+?|tokensMap)-.+.json/,
-    alternativeSuffix ? `$1-${alternativeSuffix}.json` : '$1.json'
-  );

package/tests/data/octokit.data.ts

@@ -1,208 +0,0 @@
-import { GithubRelease } from '../../lib/types';
-
-export type PartialReleases = Partial<GithubRelease>[];
-
-export const mainNetPrereleaseRelease = {
-  id: 1,
-  tag_name: '1',
-  prerelease: true,
-  assets: [
-    {
-      browser_download_url:
-        'https://example.com/contracts-awesomechain-mainnet-7.json',
-      name: 'contracts-awesomechain-mainnet-7.json',
-    } as any,
-    {
-      browser_download_url: 'https://example.com/tokensMap-mainnet-7.json',
-      name: 'tokensMap-mainnet-6.json',
-    } as any,
-  ],
-};
-
-export const mainNetStableRelease = {
-  id: 2,
-  tag_name: '2',
-  prerelease: false,
-  assets: [
-    {
-      browser_download_url:
-        'https://example.com/contracts-awesomechain-mainnet-6.json',
-      name: 'contracts-awesomechain-mainnet-6.json',
-    } as any,
-    {
-      browser_download_url: 'https://example.com/tokensMap-mainnet-6.json',
-      name: 'tokensMap-mainnet-6.json',
-    } as any,
-  ],
-};
-
-export const tssTag1 = {
-  id: 1,
-  tag_name: 'tss-api-1.0.0',
-  name: 'tss-api-1.0.0',
-  prerelease: false,
-  assets: [
-    {
-      name: 'rosenTss-linux-tss-api-1.0.0.zip',
-      browser_download_url:
-        'https://example.com/sign-protocols/releases/download/tss-api-1.0.0/rosenTss-linux-tss-api-1.0.0.zip',
-    } as any,
-    {
-      name: 'rosenTss-macOS-tss-api-1.0.0.zip',
-      browser_download_url:
-        'https://example.com/sign-protocols/releases/download/tss-api-1.0.0/rosenTss-macOS-tss-api-1.0.0.zip',
-    } as any,
-    {
-      name: 'rosenTss-windows-tss-api-1.0.0.zip',
-      browser_download_url:
-        'https://example.com/sign-protocols/releases/download/tss-api-1.0.0/rosenTss-windows-tss-api-1.0.0.zip',
-    } as any,
-  ],
-};
-export const tssTag2 = {
-  id: 2,
-  tag_name: 'tss-api-2.0.0',
-  name: 'tss-api-2.0.0',
-  prerelease: false,
-  assets: [
-    {
-      name: 'rosenTss-linux-tss-api-2.0.0.zip',
-      browser_download_url:
-        'https://example.com/sign-protocols/releases/download/tss-api-2.0.0/rosenTss-linux-tss-api-2.0.0.zip',
-    } as any,
-    {
-      name: 'rosenTss-macOS-tss-api-2.0.0.zip',
-      browser_download_url:
-        'https://example.com/sign-protocols/releases/download/tss-api-2.0.0/rosenTss-macOS-tss-api-2.0.0.zip',
-    } as any,
-    {
-      name: 'rosenTss-windows-tss-api-2.0.0.zip',
-      browser_download_url:
-        'https://example.com/sign-protocols/releases/download/tss-api-2.0.0/rosenTss-windows-tss-api-2.0.0.zip',
-    } as any,
-  ],
-};
-
-export const tssTag3PreRelease = {
-  id: 3,
-  tag_name: 'tss-api-3.0.0',
-  name: 'tss-api-3.0.0',
-  prerelease: true,
-  assets: [
-    {
-      name: 'rosenTss-linux-tss-api-3.0.0.zip',
-      browser_download_url:
-        'https://example.com/sign-protocols/releases/download/tss-api-3.0.0/rosenTss-linux-tss-api-3.0.0.zip',
-    } as any,
-    {
-      name: 'rosenTss-macOS-tss-api-3.0.0.zip',
-      browser_download_url:
-        'https://example.com/sign-protocols/releases/download/tss-api-3.0.0/rosenTss-macOS-tss-api-3.0.0.zip',
-    } as any,
-    {
-      name: 'rosenTss-windows-tss-api-3.0.0.zip',
-      browser_download_url:
-        'https://example.com/sign-protocols/releases/download/tss-api-3.0.0/rosenTss-windows-tss-api-3.0.0.zip',
-    } as any,
-  ],
-};
-
-export const testNetPrereleaseRelease = {
-  id: 4,
-  tag_name: '4',
-  prerelease: true,
-  assets: [
-    {
-      browser_download_url:
-        'https://example.com/contracts-awesomechain-testnet-1.json',
-      name: 'contracts-awesomechain-testnet-1.json',
-    } as any,
-  ],
-};
-
-export const testNetStableRelease = {
-  id: 5,
-  tag_name: '5',
-  prerelease: false,
-  assets: [
-    {
-      browser_download_url:
-        'https://example.com/contracts-awesomechain-testnet-1.json',
-      name: 'contracts-awesomechain-testnet-1.json',
-    } as any,
-  ],
-};
-
-export const contractReleases = [
-  mainNetPrereleaseRelease,
-  mainNetStableRelease,
-  {
-    id: 3,
-    tag_name: '3',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-5.json',
-        name: 'contracts-awesomechain-mainnet-5.json',
-      } as any,
-    ],
-  },
-  testNetPrereleaseRelease,
-  testNetStableRelease,
-  {
-    id: 6,
-    tag_name: '6',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-4.json',
-        name: 'contracts-awesomechain-mainnet-4.json',
-      } as any,
-    ],
-  },
-  {
-    id: 7,
-    tag_name: '7',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-3.json',
-        name: 'contracts-awesomechain-mainnet-3.json',
-      } as any,
-    ],
-  },
-  {
-    id: 8,
-    tag_name: '8',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-2.json',
-        name: 'contracts-awesomechain-mainnet-2.json',
-      } as any,
-    ],
-  },
-  {
-    id: 9,
-    tag_name: '9',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-1.json',
-        name: 'contracts-awesomechain-mainnet-1.json',
-      } as any,
-    ],
-  },
-] satisfies PartialReleases;
-
-export const tssReleases = [
-  mainNetStableRelease, // in case of sign-protocols mono repo we have other tags
-  tssTag3PreRelease,
-  tssTag2,
-  tssTag1,
-] satisfies PartialReleases;