From eb394383d881e5d30da64d3fd8d7a32ec43ae2f5 Mon Sep 17 00:00:00 2001 From: Kyu Date: Wed, 24 Aug 2022 09:30:52 +0900 Subject: [PATCH] chore: Deprecate `asset-swapper` [TKR-484] (#559) * Add asset-swapper deprecation notice in README.md * Remove asset-swapper references from the top-level README * Remove asset-swapper from circleci config * Set asset-swapper private to prevent it from being published * Remove asset-swapper from `nonContractPackages` * Disable asset-swapper build and test scripts --- .circleci/config.yml | 1 - README.md | 13 ++++++------- package.json | 2 +- packages/asset-swapper/README.md | 4 ++++ packages/asset-swapper/package.json | 9 +++++---- 5 files changed, 16 insertions(+), 13 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 72a6d2c181..ba862fea4d 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -132,7 +132,6 @@ jobs: - run: yarn wsrun -p @0x/contract-artifacts -m --serial -c test:circleci - run: yarn wsrun -p @0x/contract-wrappers-test -m --serial -c test:circleci - run: yarn wsrun -p @0x/order-utils -m --serial -c test:circleci - - run: yarn wsrun -p @0x/asset-swapper -m --serial -c test:circleci - save_cache: key: coverage-contract-wrappers-test-{{ .Environment.CIRCLE_SHA1 }} paths: diff --git a/README.md b/README.md index 50e6947050..7b1387ad63 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,6 @@ These packages are all under development. See [/contracts/README.md](/contracts/ | Package | Version | Description | | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`@0x/asset-swapper`](/packages/asset-swapper) | [![npm](https://img.shields.io/npm/v/@0x/asset-swapper.svg)](https://www.npmjs.com/package/@0x/asset-swapper) | Package used to find and create aggregated swaps | | [`@0x/protocol-utils`](/packages/protocol-utils) | [![npm](https://img.shields.io/npm/v/@0x/protocol-utils.svg)](https://www.npmjs.com/package/@0x/protocol-utils) | A set of utilities for generating, parsing, signing and validating 0x orders | | [`@0x/contract-addresses`](/packages/contract-addresses) | [![npm](https://img.shields.io/npm/v/@0x/contract-addresses.svg)](https://www.npmjs.com/package/@0x/contract-addresses) | A tiny utility library for getting known deployed contract addresses for a particular network. | | [`@0x/contract-wrappers`](/packages/contract-wrappers) | [![npm](https://img.shields.io/npm/v/@0x/contract-wrappers.svg)](https://www.npmjs.com/package/@0x/contract-wrappers) | JS/TS wrappers for interacting with the 0x smart contracts | @@ -82,7 +81,7 @@ yarn build To build a specific package: ```bash -PKG=@0x/asset-swapper yarn build +PKG=@0x/protocol-utils yarn build ``` To build all contracts packages: @@ -105,7 +104,7 @@ To watch a specific package and all it's dependent packages: PKG=[NPM_PACKAGE_NAME] yarn watch e.g -PKG=@0x/asset-swapper yarn watch +PKG=@0x/protocol-utils yarn watch ``` ### Clean @@ -119,7 +118,7 @@ yarn clean Clean a specific package ```bash -PKG=@0x/asset-swapper yarn clean +PKG=@0x/protocol-utils yarn clean ``` ### Rebuild @@ -133,7 +132,7 @@ yarn rebuild To re-build (clean & build) a specific package & it's deps: ```bash -PKG=@0x/asset-swapper yarn rebuild +PKG=@0x/protocol-utils yarn rebuild ``` ### Lint @@ -147,7 +146,7 @@ yarn lint Lint a specific package: ```bash -PKG=@0x/asset-swapper yarn lint +PKG=@0x/protocol-utils yarn lint ``` ### Run Tests @@ -161,7 +160,7 @@ yarn test Run a specific package's test: ```bash -PKG=@0x/asset-swapper yarn test +PKG=@0x/protocol-utils yarn test ``` Run all contracts packages tests: diff --git a/package.json b/package.json index d1c5cbb969..501fb10fe4 100644 --- a/package.json +++ b/package.json @@ -52,7 +52,7 @@ }, "config": { "contractsPackages": "@0x/contracts-erc20 @0x/contracts-test-utils @0x/contracts-utils @0x/contracts-zero-ex @0x/contracts-treasury", - "nonContractPackages": "@0x/contract-wrappers @0x/contract-addresses @0x/contract-artifacts @0x/contract-wrappers-test @0x/asset-swapper", + "nonContractPackages": "@0x/contract-wrappers @0x/contract-addresses @0x/contract-artifacts @0x/contract-wrappers-test", "ignoreTestsForPackages": "", "mnemonic": "concert load couple harbor equip island argue ramp clarify fence smart topic", "packagesWithDocPages": "@0x/contract-wrappers", diff --git a/packages/asset-swapper/README.md b/packages/asset-swapper/README.md index 6d097f6ee9..d11c54deed 100644 --- a/packages/asset-swapper/README.md +++ b/packages/asset-swapper/README.md @@ -1,3 +1,7 @@ +``` + :warning: **@0x/asset-swapper has been deprecated!** The `asset-swapper` code has been moved to [0x-api](https://github.com/0xProject/0x-api). Please do not open a PR with `asset-swapper` changes. +``` + ## @0x/asset-swapper Convenience package for swapping assets represented on the Ethereum blockchain using 0x. The package helps to perform all the off-chain computations to execute a marketBuy or marketSell function execution with 0x exchange contracts, or 0x extension contracts. Given some liquidity (0x signed orders), it helps estimate the cost of buying or selling a certain asset (giving a range) and then provide varying consumable outputs to execute the buy or sell. diff --git a/packages/asset-swapper/package.json b/packages/asset-swapper/package.json index 94b253f573..738c097ba0 100644 --- a/packages/asset-swapper/package.json +++ b/packages/asset-swapper/package.json @@ -1,6 +1,7 @@ { "name": "@0x/asset-swapper", "version": "16.66.4", + "private": true, "engines": { "node": ">=6.12" }, @@ -8,8 +9,8 @@ "main": "lib/src/index.js", "types": "lib/src/index.d.ts", "scripts": { - "build": "yarn pre_build && tsc -b", - "build:ts": "tsc -b", + "build": "#yarn pre_build && tsc -b", + "build:ts": "#tsc -b", "watch": "tsc -w -p tsconfig.json", "watch:contracts": "sol-compiler -w", "build:ci": "yarn build", @@ -19,11 +20,11 @@ "lint-contracts": "#solhint -c .solhint.json contracts/**/**/**/**/*.sol", "prettier": "prettier --write '**/*.{ts,tsx,json}' --config ../../.prettierrc --ignore-path ../../.prettierignore", "fix": "tslint --fix --format stylish --project . --exclude ./generated-wrappers/**/* --exclude ./generated-artifacts/**/* --exclude ./test/generated-wrappers/**/* --exclude ./test/generated-artifacts/**/* --exclude **/lib/**/* && yarn lint-contracts", - "test": "yarn run_mocha", + "test": "#yarn run_mocha", "rebuild_and_test": "run-s clean build test", "test:coverage": "nyc npm run test --all && yarn coverage:report:lcov", "coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info", - "test:circleci": "yarn test:coverage", + "test:circleci": "#yarn test:coverage", "run_mocha": "mocha --require source-map-support/register --require make-promises-safe 'lib/test/**/*_test.js' lib/test/global_hooks.js --timeout 30000 --bail --exit", "clean": "shx rm -rf lib test_temp generated_docs test/generated-artifacts test/generated-wrappers generated-artifacts generated-wrappers", "diff_docs": "git diff --exit-code ./docs",