@rosen-bridge/utils 0.1.0 → 0.3.0

package/lib/utils/rosen.ts

@@ -6,6 +6,13 @@
 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

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@rosen-bridge/utils",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Misc utility functions used inside Rosen bridge projects",
-  "main": "dist/lib/index.js",
-  "types": "dist/lib/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "type": "module",
   "scripts": {
     "prettify": "prettier --write . --ignore-path .gitignore",
@@ -18,20 +18,15 @@
     "type": "git",
     "url": "git+https://github.com/rosen-bridge/utils.git"
   },
-  "license": "GPL-3.0",
+  "license": "MIT",
   "devDependencies": {
-    "@types/download": "^8.0.2",
     "@babel/preset-env": "^7.19.0",
+    "@types/download": "^8.0.2",
     "@types/jest": "^29.1.2",
-    "@types/node": "^18.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.30.7",
-    "@typescript-eslint/parser": "^5.26.0",
-    "eslint": "^8.16.0",
-    "eslint-config-prettier": "^8.5.0",
+    "@types/node": "^20.11.0",
     "jest": "^29.2.0",
-    "prettier": "^2.8.4",
     "ts-jest": "^29.0.3",
-    "typescript": "^4.9.5"
+    "typescript": "^5.8.3"
   },
   "directories": {
     "lib": "lib",

package/tests/data/octokit.data.ts

@@ -4,7 +4,7 @@ export type PartialReleases = Partial<GithubRelease>[];
 
 export const mainNetPrereleaseRelease = {
   id: 1,
-  tag: '1',
+  tag_name: '1',
   prerelease: true,
   assets: [
     {
@@ -21,7 +21,7 @@ export const mainNetPrereleaseRelease = {
 
 export const mainNetStableRelease = {
   id: 2,
-  tag: '2',
+  tag_name: '2',
   prerelease: false,
   assets: [
     {
@@ -36,9 +36,80 @@ export const mainNetStableRelease = {
   ],
 };
 
+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: '4',
+  tag_name: '4',
   prerelease: true,
   assets: [
     {
@@ -51,7 +122,7 @@ export const testNetPrereleaseRelease = {
 
 export const testNetStableRelease = {
   id: 5,
-  tag: '5',
+  tag_name: '5',
   prerelease: false,
   assets: [
     {
@@ -62,12 +133,12 @@ export const testNetStableRelease = {
   ],
 };
 
-export const releases = [
+export const contractReleases = [
   mainNetPrereleaseRelease,
   mainNetStableRelease,
   {
     id: 3,
-    tag: '3',
+    tag_name: '3',
     prerelease: false,
     assets: [
       {
@@ -81,7 +152,7 @@ export const releases = [
   testNetStableRelease,
   {
     id: 6,
-    tag: '6',
+    tag_name: '6',
     prerelease: false,
     assets: [
       {
@@ -93,7 +164,7 @@ export const releases = [
   },
   {
     id: 7,
-    tag: '7',
+    tag_name: '7',
     prerelease: false,
     assets: [
       {
@@ -105,7 +176,7 @@ export const releases = [
   },
   {
     id: 8,
-    tag: '8',
+    tag_name: '8',
     prerelease: false,
     assets: [
       {
@@ -117,7 +188,7 @@ export const releases = [
   },
   {
     id: 9,
-    tag: '9',
+    tag_name: '9',
     prerelease: false,
     assets: [
       {
@@ -128,3 +199,10 @@ export const releases = [
     ],
   },
 ] 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

@@ -7,7 +7,7 @@ import { RosenAssetsDownloadError } from '../lib';
 import {
   mainNetPrereleaseRelease,
   mainNetStableRelease,
-  releases,
+  contractReleases,
 } from './data/octokit.data';
 
 import { mockOctokit, mockOctokitGetReleaseByTag } from './mocks/octokit.mock';
@@ -16,7 +16,7 @@ jest.mock('download');
 
 describe('downloadRosenAssets', () => {
   beforeEach(() => {
-    mockOctokit();
+    mockOctokit(contractReleases);
   });
 
   /**
@@ -24,7 +24,7 @@ describe('downloadRosenAssets', () => {
    * @dependencies
    * - mocked Octokit
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - mock Octokit `listReleases` to return 9 contractReleases
    * - call `downloadRosenAssets` with mainnet chain type and `rosen` download
    *   directory
    * @expected
@@ -60,7 +60,7 @@ describe('downloadRosenAssets', () => {
    * @dependencies
    * - mocked Octokit
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - mock Octokit `listReleases` to return 9 contractReleases
    * - call `downloadRosenAssets` with mainnet chain type, `rosen` download
    *   directory and including prereleases
    * @expected
@@ -99,7 +99,7 @@ describe('downloadRosenAssets', () => {
    * @dependencies
    * - mocked Octokit
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - mock Octokit `listReleases` to return 9 contractReleases
    * - call `downloadRosenAssets` with mainnet chain type, `rosen` download
    *   directory, including prereleases and a providing a suffix
    * @expected
@@ -141,13 +141,13 @@ describe('downloadRosenAssets', () => {
    * - `download` should be called with the assets of "3" tag release
    */
   it('should download a Rosen asset by tag', async () => {
-    mockOctokitGetReleaseByTag();
+    mockOctokitGetReleaseByTag(contractReleases);
     await downloadRosenAssets('mainnet', 'rosen', {
       tag: '3',
     });
 
     expect(download).toHaveBeenCalledWith(
-      releases[2].assets[0].browser_download_url,
+      contractReleases[2].assets[0].browser_download_url,
       'rosen',
       {
         filename: 'contracts-awesomechain.json',
@@ -162,7 +162,7 @@ describe('downloadRosenAssets', () => {
    * - mocked Octokit
    * - emptied mocked download package
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - 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
@@ -183,7 +183,7 @@ describe('downloadRosenAssets', () => {
    * - mocked Octokit
    * - mocked download package
    * @scenario
-   * - mock Octokit `listReleases` to return 9 releases
+   * - mock Octokit `listReleases` to return 9 contractReleases
    * - mock download package to throw an error
    * - call `downloadRosenAssets` with mainnet chain type and `rosen` download
    *   directory

package/tests/downloadTssBinary.spec.ts

@@ -0,0 +1,153 @@
+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,10 +1,10 @@
 import { Octokit } from 'octokit';
 
-import { releases } from '../data/octokit.data';
+import { contractReleases, PartialReleases } from '../data/octokit.data';
 
 import { DEFAULT_RELEASES_FETCHING_PAGE_SIZE } from '../../lib/constants';
 
-export const mockOctokit = () =>
+export const mockOctokit = (releases: any[]) =>
   jest.mocked(Octokit).mockImplementation(() => {
     let page = 0;
     return {
@@ -25,14 +25,14 @@ export const mockOctokit = () =>
 /**
  * mock `getReleaseByTag` of Octokit
  */
-export const mockOctokitGetReleaseByTag = () =>
+export const mockOctokitGetReleaseByTag = (releases: PartialReleases) =>
   jest.mocked(Octokit).mockImplementation(() => {
     return {
       rest: {
         repos: {
           getReleaseByTag: async ({ tag }: { tag: string }) => {
             return {
-              data: releases.find((release) => release.tag === tag),
+              data: releases.find((release) => release.tag_name === tag),
             };
           },
         },