From 99e5b75eccc54251359486d12d5419592e249739 Mon Sep 17 00:00:00 2001 From: Anderson Arboleya Date: Thu, 29 Jun 2023 10:46:09 -0300 Subject: [PATCH] feat: adding `@fuel-ts/fuel-core` package (#1074) --- .changeset/lucky-ties-dress.md | 5 + package.json | 13 +- packages/fuel-core/.gitignore | 2 + packages/fuel-core/LICENSE | 201 ++++++++++++++++++++++++++++++ packages/fuel-core/README.md | 3 + packages/fuel-core/VERSION | 1 + packages/fuel-core/fuel-core.js | 2 + packages/fuel-core/package.json | 24 ++++ packages/fuel-core/src/cli.ts | 8 ++ packages/fuel-core/src/index.ts | 5 + packages/fuel-core/src/install.ts | 57 +++++++++ packages/fuel-core/src/shared.ts | 49 ++++++++ packages/fuel-core/src/update.ts | 21 ++++ packages/fuel-core/tsconfig.json | 7 ++ packages/fuel-core/tsup.config.ts | 17 +++ pnpm-lock.yaml | 12 ++ 16 files changed, 421 insertions(+), 6 deletions(-) create mode 100644 .changeset/lucky-ties-dress.md create mode 100644 packages/fuel-core/.gitignore create mode 100644 packages/fuel-core/LICENSE create mode 100644 packages/fuel-core/README.md create mode 100644 packages/fuel-core/VERSION create mode 100755 packages/fuel-core/fuel-core.js create mode 100644 packages/fuel-core/package.json create mode 100644 packages/fuel-core/src/cli.ts create mode 100644 packages/fuel-core/src/index.ts create mode 100644 packages/fuel-core/src/install.ts create mode 100644 packages/fuel-core/src/shared.ts create mode 100644 packages/fuel-core/src/update.ts create mode 100644 packages/fuel-core/tsconfig.json create mode 100644 packages/fuel-core/tsup.config.ts diff --git a/.changeset/lucky-ties-dress.md b/.changeset/lucky-ties-dress.md new file mode 100644 index 0000000000..a68a2dee61 --- /dev/null +++ b/.changeset/lucky-ties-dress.md @@ -0,0 +1,5 @@ +--- +"@fuel-ts/fuel-core": patch +--- + +Adding `fuel-core` bin wrapper diff --git a/package.json b/package.json index 198c60000f..0a036214e9 100644 --- a/package.json +++ b/package.json @@ -53,18 +53,19 @@ "@changesets/cli": "^2.25.0", "@changesets/get-github-info": "^0.5.2", "@ethersproject/bytes": "^5.7.0", + "@fuel-ts/forc": "workspace:*", + "@fuel-ts/fuel-core": "workspace:*", "@internal/tsup": "workspace:*", "@jest/types": "^29.5.0", "@types/jest": "^29.5.0", - "@types/node": "18.15.3", "@types/node-fetch": "^2.6.2", + "@types/node": "18.15.3", "@types/shelljs": "^0.8.11", "@types/web": "^0.0.65", "@typescript-eslint/eslint-plugin": "^5.40.1", "@typescript-eslint/parser": "^5.40.1", "conventional-changelog-angular": "^5.0.13", "dotenv": "^9.0.2", - "eslint": "^8.26.0", "eslint-config-airbnb-base": "^15.0.0", "eslint-config-airbnb-typescript": "^16.2.0", "eslint-config-prettier": "^8.5.0", @@ -73,22 +74,22 @@ "eslint-plugin-jsdoc": "^37.9.7", "eslint-plugin-jsx-a11y": "^6.6.1", "eslint-plugin-prettier": "^4.2.1", - "eslint-plugin-react": "^7.31.10", "eslint-plugin-react-hooks": "^4.6.0", + "eslint-plugin-react": "^7.31.10", "eslint-plugin-tsdoc": "^0.2.17", + "eslint": "^8.26.0", "ethers": "^5.7.2", - "@fuel-ts/forc": "workspace:*", "glob": "^10.2.6", "husky": "^8.0.3", - "jest": "^29.5.0", "jest-text-transformer": "^1.0.4", + "jest": "^29.5.0", "nodemon": "^2.0.22", "npm-run-all": "^4.1.5", "open": "^8.4.0", "prettier": "^2.8.8", "shelljs": "^0.8.5", - "textlint": "^13.3.2", "textlint-rule-no-dead-link": "^5.1.2", + "textlint": "^13.3.2", "ts-generator": "^0.1.1", "ts-jest": "^29.0.3", "tsup": "^6.7.0", diff --git a/packages/fuel-core/.gitignore b/packages/fuel-core/.gitignore new file mode 100644 index 0000000000..480818acd0 --- /dev/null +++ b/packages/fuel-core/.gitignore @@ -0,0 +1,2 @@ +/fuel-core-binaries +/fuel-core-repo diff --git a/packages/fuel-core/LICENSE b/packages/fuel-core/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/packages/fuel-core/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/fuel-core/README.md b/packages/fuel-core/README.md new file mode 100644 index 0000000000..cb9e5b51d3 --- /dev/null +++ b/packages/fuel-core/README.md @@ -0,0 +1,3 @@ +# fuel-core + +Binary wrapper for [FuelCore](https://github.com/FuelLabs/fuel-core) diff --git a/packages/fuel-core/VERSION b/packages/fuel-core/VERSION new file mode 100644 index 0000000000..249afd517d --- /dev/null +++ b/packages/fuel-core/VERSION @@ -0,0 +1 @@ +0.18.1 diff --git a/packages/fuel-core/fuel-core.js b/packages/fuel-core/fuel-core.js new file mode 100755 index 0000000000..4c71731dcf --- /dev/null +++ b/packages/fuel-core/fuel-core.js @@ -0,0 +1,2 @@ +#!/usr/bin/env node +require('./dist/cli.js'); diff --git a/packages/fuel-core/package.json b/packages/fuel-core/package.json new file mode 100644 index 0000000000..a853539c7c --- /dev/null +++ b/packages/fuel-core/package.json @@ -0,0 +1,24 @@ +{ + "name": "@fuel-ts/fuel-core", + "version": "0.30.0", + "description": "", + "author": "Fuel Labs (https://fuel.network/)", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "files": [ + "dist" + ], + "license": "Apache-2.0", + "scripts": { + "preinstall": "tsup", + "install": "node ./dist/install.js", + "update": "node ./dist/update.js && node ./dist/install.js" + }, + "bin": { + "fuels-core": "./fuel-core.js" + }, + "dependencies": { + "node-fetch": "^2.6.7", + "shelljs": "^0.8.5" + } +} diff --git a/packages/fuel-core/src/cli.ts b/packages/fuel-core/src/cli.ts new file mode 100644 index 0000000000..2ee945aa90 --- /dev/null +++ b/packages/fuel-core/src/cli.ts @@ -0,0 +1,8 @@ +#!/usr/bin/env node + +import { spawn } from 'child_process'; + +import binPath from '.'; + +const args = process.argv.slice(2); +spawn(binPath, args, { stdio: 'inherit' }).on('exit', process.exit); diff --git a/packages/fuel-core/src/index.ts b/packages/fuel-core/src/index.ts new file mode 100644 index 0000000000..c97c9b1c90 --- /dev/null +++ b/packages/fuel-core/src/index.ts @@ -0,0 +1,5 @@ +import path from 'path'; + +const binPath = path.join(__dirname, '../fuel-core-binaries/fuel-core'); + +export default binPath; diff --git a/packages/fuel-core/src/install.ts b/packages/fuel-core/src/install.ts new file mode 100644 index 0000000000..88716e1c8e --- /dev/null +++ b/packages/fuel-core/src/install.ts @@ -0,0 +1,57 @@ +#!/usr/bin/env node + +import { execSync } from 'child_process'; +import { existsSync, rmSync, writeFileSync } from 'fs'; +import fetch from 'node-fetch'; +import { join } from 'path'; +import sh from 'shelljs'; + +import { buildFromGitBranch, getCurrentVersion, getPkgPlatform, isGitBranch } from './shared'; + +(async () => { + const { info } = console; + + const pkgPlatform = getPkgPlatform(); + const fuelCoreVersion = await getCurrentVersion(); + + // If a git branch is specified in the VERSION file, build from that branch + if (isGitBranch(fuelCoreVersion)) { + const branchName = fuelCoreVersion.split(':')[1]; + buildFromGitBranch(branchName); + return; + } + + const fileName = `fuel-core-${fuelCoreVersion}-${pkgPlatform}`; + const pkgName = `${fileName}.tar.gz`; + const pkgUrl = `https://github.com/FuelLabs/fuel-core/releases/download/v${fuelCoreVersion}/${pkgName}`; + + const pkgPath = join(__dirname, pkgName); + const rootDir = join(__dirname, '..'); + const binDir = join(rootDir, 'fuel-core-binaries'); + + const binPath = join(binDir, 'fuel-core'); + let versionMatches = false; + + if (existsSync(binPath)) { + const binRawVersion = execSync(`${binPath} --version`).toString().trim(); + const binVersion = binRawVersion.match(/([.0-9]+)/)?.[0]; + + versionMatches = binVersion === fuelCoreVersion; + info({ expected: fuelCoreVersion, received: binVersion }); + } + + if (versionMatches) { + info(`Fue-Core binary already installed, skipping.`); + } else { + // Download + const buf = await fetch(pkgUrl).then((r) => r.buffer()); + await writeFileSync(pkgPath, buf); + + // Extract + sh.exec(`tar xzf "${pkgPath}" -C "${rootDir}"`); + sh.mv(fileName, binDir); + + // Cleanup + await rmSync(pkgPath); + } +})(); diff --git a/packages/fuel-core/src/shared.ts b/packages/fuel-core/src/shared.ts new file mode 100644 index 0000000000..2b7b09a7ba --- /dev/null +++ b/packages/fuel-core/src/shared.ts @@ -0,0 +1,49 @@ +import fs from 'fs/promises'; +import path from 'path'; +import sh from 'shelljs'; + +const platforms = { + darwin: { + arm64: 'aarch64-apple-darwin', + x64: 'x86_64-apple-darwin', + }, + linux: { + arm64: 'aarch64-unknown-linux-gnu', + x64: 'x86_64-unknown-linux-gnu', + }, +}; +export const getPkgPlatform = () => { + if (process.platform !== 'darwin' && process.platform !== 'linux') { + throw new Error(`Unsupported platform ${process.platform}`); + } + if (process.arch !== 'arm64' && process.arch !== 'x64') { + throw new Error(`Unsupported arch ${process.arch}`); + } + return platforms[process.platform][process.arch]; +}; + +const versionFilePath = path.join(__dirname, '../VERSION'); + +export const getCurrentVersion = async () => { + const fuelCoreVersion = await fs.readFile(versionFilePath, 'utf8'); + return fuelCoreVersion.trim(); +}; + +export const setCurrentVersion = async (version: string) => { + await fs.writeFile(versionFilePath, version); +}; + +export const isGitBranch = (versionFileContents: string) => + versionFileContents.indexOf('git:') !== -1; + +const fuelCoreRepoUrl = 'https://github.com/fuellabs/fuel-core.git'; + +export const buildFromGitBranch = (branchName: string) => { + sh.exec('rm -rf fuel-core-repo'); + sh.exec('rm -rf fuel-core-binaries'); + sh.exec(`git clone --branch ${branchName} ${fuelCoreRepoUrl} fuel-core-repo`, { silent: true }); + sh.exec(`cd fuel-core-repo && cargo build`, { silent: true }); + sh.exec('mkdir fuel-core-binaries'); + sh.exec('cp fuel-core-repo/target/debug/fuel-core fuel-core-binaries/fuel-core'); + sh.exec(`rm -rf fuel-core-repo`); +}; diff --git a/packages/fuel-core/src/update.ts b/packages/fuel-core/src/update.ts new file mode 100644 index 0000000000..e0cf9081ef --- /dev/null +++ b/packages/fuel-core/src/update.ts @@ -0,0 +1,21 @@ +#!/usr/bin/env node + +import fetch from 'node-fetch'; + +import { getCurrentVersion, setCurrentVersion } from './shared'; + +(async () => { + // Get latest release + const latestUrl = `https://api.github.com/repos/FuelLabs/fuel-core/releases/latest`; + const latest = await fetch(latestUrl).then((r) => r.json()); + const latestVersion = latest.tag_name.replace(/^v/, ''); + + // Get current version + const currentVersion = await getCurrentVersion(); + + // Update Forc + if (currentVersion !== latestVersion) { + // Write latest version + await setCurrentVersion(latestVersion); + } +})(); diff --git a/packages/fuel-core/tsconfig.json b/packages/fuel-core/tsconfig.json new file mode 100644 index 0000000000..b0fced27d7 --- /dev/null +++ b/packages/fuel-core/tsconfig.json @@ -0,0 +1,7 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "./dist" + }, + "include": ["src"] +} diff --git a/packages/fuel-core/tsup.config.ts b/packages/fuel-core/tsup.config.ts new file mode 100644 index 0000000000..dbf12be2a7 --- /dev/null +++ b/packages/fuel-core/tsup.config.ts @@ -0,0 +1,17 @@ +/* + * We don't inherit from '@internal/tsup' for this + * case because at this point, the package might not + * have been built yet, since this config will probably + * be called before the `build` even starts. + */ +// import { index } from '@internal/tsup'; + +export default { + clean: true, + dts: true, + entry: ['src/index.ts', 'src/cli.ts', 'src/install.ts', 'src/update.ts'], + format: ['cjs', 'esm', 'iife'], + minify: false, + sourcemap: true, + splitting: false, +}; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f63e99f809..dd2fdd93be 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -20,6 +20,9 @@ importers: '@fuel-ts/forc': specifier: workspace:* version: link:packages/forc + '@fuel-ts/fuel-core': + specifier: workspace:* + version: link:packages/fuel-core '@internal/tsup': specifier: workspace:* version: link:internal/tsup @@ -560,6 +563,15 @@ importers: specifier: ^0.8.5 version: 0.8.5 + packages/fuel-core: + dependencies: + node-fetch: + specifier: ^2.6.7 + version: 2.6.7 + shelljs: + specifier: ^0.8.5 + version: 0.8.5 + packages/fuel-gauge: dependencies: fuels: