@rosen-bridge/utils 1.0.0 → 2.0.1

package/tests/data/octokit.data.ts

@@ -1,210 +0,0 @@
-import { GithubRelease } from '../../lib/types';
-
-export type PartialReleases = Partial<GithubRelease>[];
-
-export const mainNetPrereleaseRelease = {
-  id: 1,
-  tag_name: '2.0.1-0b08047',
-  prerelease: true,
-  assets: [
-    {
-      browser_download_url:
-        'https://example.com/contracts-awesomechain-mainnet-2.0.1-0b08047.json',
-      name: 'contracts-awesomechain-mainnet-2.0.1-0b08047.json',
-    } as any,
-    {
-      browser_download_url:
-        'https://example.com/tokensMap-mainnet-2.0.1-0b08047.json',
-      name: 'tokensMap-mainnet-2.0.1-0b08047.json',
-    } as any,
-  ],
-};
-
-export const mainNetStableRelease = {
-  id: 2,
-  tag_name: '2.0.1-0b08046',
-  prerelease: false,
-  assets: [
-    {
-      browser_download_url:
-        'https://example.com/contracts-awesomechain-mainnet-2.0.1-0b08046.json',
-      name: 'contracts-awesomechain-mainnet-2.0.1-0b08046.json',
-    } as any,
-    {
-      browser_download_url:
-        'https://example.com/tokensMap-mainnet-2.0.1-0b08046.json',
-      name: 'tokensMap-mainnet-2.0.1-0b08046.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: '2.0.1-0b08041',
-  prerelease: true,
-  assets: [
-    {
-      browser_download_url:
-        'https://example.com/contracts-awesomechain-testnet-2.0.1-0b08041.json',
-      name: 'contracts-awesomechain-testnet-2.0.1-0b08041.json',
-    } as any,
-  ],
-};
-
-export const testNetStableRelease = {
-  id: 5,
-  tag_name: '2.0.1-0b08042',
-  prerelease: false,
-  assets: [
-    {
-      browser_download_url:
-        'https://example.com/contracts-awesomechain-testnet-2.0.1-0b08042.json',
-      name: 'contracts-awesomechain-testnet-2.0.1-0b08042.json',
-    } as any,
-  ],
-};
-
-export const contractReleases = [
-  mainNetPrereleaseRelease,
-  mainNetStableRelease,
-  {
-    id: 3,
-    tag_name: '2.0.1-0b08045',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-2.0.1-0b08045.json',
-        name: 'contracts-awesomechain-mainnet-2.0.1-0b08045.json',
-      } as any,
-    ],
-  },
-  testNetPrereleaseRelease,
-  testNetStableRelease,
-  {
-    id: 6,
-    tag_name: '2.0.1-0b08044',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-2.0.1-0b08044.json',
-        name: 'contracts-awesomechain-mainnet-2.0.1-0b08044.json',
-      } as any,
-    ],
-  },
-  {
-    id: 7,
-    tag_name: '2.0.1-0b08043',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-2.0.1-0b08043.json',
-        name: 'contracts-awesomechain-mainnet-2.0.1-0b08043.json',
-      } as any,
-    ],
-  },
-  {
-    id: 8,
-    tag_name: '2.0.1-0b08042',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-2.0.1-0b08042.json',
-        name: 'contracts-awesomechain-mainnet-2.0.1-0b08042.json',
-      } as any,
-    ],
-  },
-  {
-    id: 9,
-    tag_name: '2.0.1-0b08041',
-    prerelease: false,
-    assets: [
-      {
-        browser_download_url:
-          'https://example.com/contracts-awesomechain-mainnet-2.0.1-0b08041.json',
-        name: 'contracts-awesomechain-mainnet-2.0.1-0b08041.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;

package/tests/downloadRosenAssets.spec.ts

@@ -1,200 +0,0 @@
-import download from 'download';
-
-import downloadRosenAssets from '../lib/downloadRosenAssets';
-
-import { RosenAssetsDownloadError } from '../lib';
-
-import {
-  mainNetPrereleaseRelease,
-  mainNetStableRelease,
-  contractReleases,
-} from './data/octokit.data';
-
-import { mockOctokit, mockOctokitGetReleaseByTag } from './mocks/octokit.mock';
-
-jest.mock('download');
-
-describe('downloadRosenAssets', () => {
-  beforeEach(() => {
-    mockOctokit(contractReleases);
-  });
-
-  /**
-   * @target `downloadRosenAssets` should download Rosen assets correctly
-   * @dependencies
-   * - mocked Octokit
-   * @scenario
-   * - mock Octokit `listReleases` to return 9 contractReleases
-   * - call `downloadRosenAssets` with mainnet chain type and `rosen` download
-   *   directory
-   * @expected
-   * - `download` function should be called with first asset of mainnet stable
-   *    release download url, `rosen` download directory and corresponding
-   *    truncated asset name
-   * - `download` function should be called with second asset of mainnet stable
-   *    release download url, `rosen` download directory and corresponding
-   *    truncated asset name
-   */
-  it('should download Rosen assets correctly', async () => {
-    await downloadRosenAssets('mainnet', 'rosen');
-
-    expect(download).toHaveBeenCalledWith(
-      mainNetStableRelease.assets[0].browser_download_url,
-      'rosen',
-      {
-        filename: 'contracts-awesomechain.json',
-      }
-    );
-    expect(download).toHaveBeenCalledWith(
-      mainNetStableRelease.assets[1].browser_download_url,
-      'rosen',
-      {
-        filename: 'tokensMap.json',
-      }
-    );
-  });
-
-  /**
-   * @target `downloadRosenAssets` should download Rosen assets correctly when
-   * including prereleases
-   * @dependencies
-   * - mocked Octokit
-   * @scenario
-   * - mock Octokit `listReleases` to return 9 contractReleases
-   * - call `downloadRosenAssets` with mainnet chain type, `rosen` download
-   *   directory and including prereleases
-   * @expected
-   * - `download` function should be called with first asset of mainnet
-   *    prerelease release download url, `rosen` download directory and
-   *    corresponding truncated asset name
-   * - `download` function should be called with second asset of mainnet
-   *    prerelease release download url, `rosen` download directory and
-   *    corresponding truncated asset name
-   */
-  it('should download Rosen assets correctly when including prereleases', async () => {
-    jest.mocked(download).mockClear();
-    await downloadRosenAssets('mainnet', 'rosen', {
-      includePrereleases: true,
-    });
-
-    expect(download).toHaveBeenCalledWith(
-      mainNetPrereleaseRelease.assets[0].browser_download_url,
-      'rosen',
-      {
-        filename: 'contracts-awesomechain.json',
-      }
-    );
-    expect(download).toHaveBeenCalledWith(
-      mainNetPrereleaseRelease.assets[1].browser_download_url,
-      'rosen',
-      {
-        filename: 'tokensMap.json',
-      }
-    );
-  });
-
-  /**
-   * @target `downloadRosenAssets` should download Rosen assets and add a suffix
-   * correctly
-   * @dependencies
-   * - mocked Octokit
-   * @scenario
-   * - mock Octokit `listReleases` to return 9 contractReleases
-   * - call `downloadRosenAssets` with mainnet chain type, `rosen` download
-   *   directory, including prereleases and a providing a suffix
-   * @expected
-   * - `download` function should be called with first asset of mainnet stable
-   *    release download url, `rosen` download directory and corresponding
-   *    truncated asset name
-   * - `download` function should be called with second asset of mainnet stable
-   *    release download url, `rosen` download directory and corresponding
-   *    truncated asset name
-   */
-  it('should download Rosen assets and add a suffix correctly', async () => {
-    await downloadRosenAssets('mainnet', 'rosen', {
-      nameSuffix: 'suffix',
-    });
-
-    expect(download).toHaveBeenCalledWith(
-      mainNetStableRelease.assets[0].browser_download_url,
-      'rosen',
-      {
-        filename: 'contracts-awesomechain-suffix.json',
-      }
-    );
-    expect(download).toHaveBeenCalledWith(
-      mainNetStableRelease.assets[1].browser_download_url,
-      'rosen',
-      {
-        filename: 'tokensMap-suffix.json',
-      }
-    );
-  });
-
-  /**
-   * @target `downloadRosenAssets` should download a Rosen asset by tag
-   * @dependencies
-   * - mocked `getReleaseByTag` of Octokit
-   * @scenario
-   * - call `downloadRosenAssets` with a specific tag
-   * @expected
-   * - `download` should be called with the assets of "3" tag release
-   */
-  it('should download a Rosen asset by tag', async () => {
-    mockOctokitGetReleaseByTag(contractReleases);
-    await downloadRosenAssets('mainnet', 'rosen', {
-      tag: '2.0.1-0b08045',
-    });
-
-    expect(download).toHaveBeenCalledWith(
-      contractReleases[2].assets[0].browser_download_url,
-      'rosen',
-      {
-        filename: 'contracts-awesomechain.json',
-      }
-    );
-  });
-
-  /**
-   * @target `downloadRosenAssets` should not call `download` function when no
-   * matching release is found
-   * @dependencies
-   * - mocked Octokit
-   * - emptied mocked download package
-   * @scenario
-   * - mock Octokit `listReleases` to return 9 contractReleases
-   * - clear download package mock data (so that we can check calls count)
-   * - call `downloadRosenAssets` with "no-release-net" chain type and `rosen`
-   *   download directory
-   * @expected
-   * - `download` function should not get called
-   */
-  it('should not call `download` function when no matching release is found', async () => {
-    jest.mocked(download).mockClear();
-
-    await downloadRosenAssets('no-release-net', 'rosen');
-
-    expect(download).toHaveBeenCalledTimes(0);
-  });
-
-  /**
-   * @target `downloadRosenAssets` should throw an error when an error happens
-   * @dependencies
-   * - mocked Octokit
-   * - mocked download package
-   * @scenario
-   * - mock Octokit `listReleases` to return 9 contractReleases
-   * - mock download package to throw an error
-   * - call `downloadRosenAssets` with mainnet chain type and `rosen` download
-   *   directory
-   * @expected
-   * - `download` function should throw `RosenAssetsDownloadError`
-   */
-  it('should throw an error when an error happens', async () => {
-    jest.mocked(download).mockRejectedValue(new Error('Bad!'));
-
-    const downloadPromise = downloadRosenAssets('mainnet', 'rosen');
-
-    await expect(downloadPromise).rejects.toThrow(RosenAssetsDownloadError);
-  });
-});

package/tests/downloadTssBinary.spec.ts

@@ -1,153 +0,0 @@
-import download from 'download';
-
-import { downloadTssBinary } from '../lib';
-import { RosenAssetsDownloadError } from '../lib';
-
-import {
-  tssReleases,
-  tssTag1,
-  tssTag2,
-  tssTag3PreRelease,
-} from './data/octokit.data';
-
-import { mockOctokit, mockOctokitGetReleaseByTag } from './mocks/octokit.mock';
-
-jest.mock('download');
-
-describe('downloadTssBinary', () => {
-  beforeEach(() => {
-    mockOctokit(tssReleases);
-  });
-
-  /**
-   * @target `downloadTssBinary` should download Tss binary correctly by specific tag
-   * @dependencies
-   * - mocked Octokit
-   * - mocked Octokit GetReleaseByTag
-   * @scenario
-   * - mock Octokit `listReleases` to return tssReleases
-   * - mock Octokit GetReleaseByTag to return desired release
-   * - call `downloadTssBinary` with Windows OS name, `tss-api-1.0.0` and `rosen` download
-   *   directory
-   * @expected
-   * - `download` function should be called with third asset of tss-api stable
-   *    release (windows) download url and `bin` download directory
-   */
-  it('should download Tss binary correctly with specific tag', async () => {
-    mockOctokitGetReleaseByTag(tssReleases);
-    await downloadTssBinary('bin', {
-      osName: 'windows',
-      tag: 'tss-api-1.0.0',
-      regex: false,
-    });
-
-    expect(download).toHaveBeenCalledWith(
-      tssTag1.assets[2].browser_download_url,
-      'bin'
-    );
-  });
-
-  /**
-   * @target `downloadTssBinary` should download Tss binary correctly by
-   *  prefix of a tag
-   * @dependencies
-   * - mocked Octokit
-   * @scenario
-   * - mock Octokit `listReleases` to return tssReleases
-   * - call `downloadTssBinary` with linux OS name, prefix tag `tss-api` and
-   * regex should be true
-   * @expected
-   * - `download` function should be called with first asset of tss-api stable
-   *    release (linux) download url and `bin` download directory
-   */
-  it('should download Tss binary correctly with prefix of tag', async () => {
-    await downloadTssBinary('bin', {
-      osName: 'linux',
-      tag: 'tss-api',
-      regex: true,
-    });
-
-    expect(download).toHaveBeenCalledWith(
-      tssTag2.assets[0].browser_download_url,
-      'bin'
-    );
-  });
-
-  /**
-   * @target `downloadTssBinary` should download Tss binary correctly by
-   *  prefix of a tag for an included prereleases release
-   * @dependencies
-   * - mocked Octokit
-   * @scenario
-   * - mock Octokit `listReleases` to return tssReleases
-   * - call `downloadTssBinary` with linux OS name, prefix tag `tss-api`,
-   *  enable includePrereleases and regex should be true
-   * @expected
-   * - `download` function should be called with first asset of tss-api prerelease
-   *    release (linux) download url and `bin` download directory
-   */
-  it('should download prerelease Tss binary correctly with prefix of tag', async () => {
-    await downloadTssBinary('bin', {
-      osName: 'linux',
-      tag: 'tss-api',
-      regex: true,
-      includePrereleases: true,
-    });
-
-    expect(download).toHaveBeenCalledWith(
-      tssTag3PreRelease.assets[0].browser_download_url,
-      'bin'
-    );
-  });
-
-  /**
-   * @target `downloadTssBinary` should not call `download` function when no
-   * matching release is found
-   * @dependencies
-   * - mocked Octokit
-   * - emptied mocked download package
-   * @scenario
-   * - mock Octokit `listReleases` to return tssReleases
-   * - clear download package mock data (so that we can check calls count)
-   * - call `downloadTssBinary` with "no-release-tag", osName linux and `bin`
-   *   download directory
-   * @expected
-   * - `download` function should not get called
-   */
-  it('should not call `download` function when no matching release is found', async () => {
-    jest.mocked(download).mockClear();
-
-    await downloadTssBinary('bin', {
-      osName: 'linux',
-      tag: 'no-release-tag',
-      regex: true,
-    });
-
-    expect(download).toHaveBeenCalledTimes(0);
-  });
-
-  /**
-   * @target `downloadTssBinary` should throw an error when an error happens
-   * @dependencies
-   * - mocked Octokit
-   * - mocked download package
-   * @scenario
-   * - mock Octokit `listReleases` to return tssReleases
-   * - mock download package to throw an error
-   * - call `downloadTssBinary` with linux OS name, prefix tag `tss-api` and
-   *    regex should be true
-   * @expected
-   * - `download` function should throw `RosenAssetsDownloadError`
-   */
-  it('should throw an error when an error happens', async () => {
-    jest.mocked(download).mockRejectedValue(new Error('Bad!'));
-
-    const downloadPromise = downloadTssBinary('bin', {
-      osName: 'linux',
-      tag: 'tss-api',
-      regex: true,
-    });
-
-    await expect(downloadPromise).rejects.toThrow(RosenAssetsDownloadError);
-  });
-});

package/tests/mocks/octokit.mock.ts

@@ -1,41 +0,0 @@
-import { Octokit } from 'octokit';
-
-import { contractReleases, PartialReleases } from '../data/octokit.data';
-
-import { DEFAULT_RELEASES_FETCHING_PAGE_SIZE } from '../../lib/constants';
-
-export const mockOctokit = (releases: any[]) =>
-  jest.mocked(Octokit).mockImplementation(() => {
-    let page = 0;
-    return {
-      rest: {
-        repos: {
-          listReleases: async () => {
-            const currentIndex = DEFAULT_RELEASES_FETCHING_PAGE_SIZE * page;
-            page += 1;
-            return {
-              data: releases.slice(currentIndex, currentIndex + 5),
-            };
-          },
-        },
-      },
-    } as any;
-  });
-
-/**
- * mock `getReleaseByTag` of Octokit
- */
-export const mockOctokitGetReleaseByTag = (releases: PartialReleases) =>
-  jest.mocked(Octokit).mockImplementation(() => {
-    return {
-      rest: {
-        repos: {
-          getReleaseByTag: async ({ tag }: { tag: string }) => {
-            return {
-              data: releases.find((release) => release.tag_name === tag),
-            };
-          },
-        },
-      },
-    } as any;
-  });

package/tests/setup.ts

@@ -1 +0,0 @@
-jest.mock('octokit');