add new apps/ directory for deployable apps (#888)

* add new apps/ directory for deployable apps
updated ts config to modern flags

* fix regex capture

.github/CODEOWNERS

@@ -1,29 +1,27 @@
 # Define individuals that are responsible for code in this repository.
 # More details are here: https://help.github.com/articles/about-codeowners/
 
-/.github/                                       @fuxingloh @monstrobishi
-/.husky/                                        @fuxingloh @monstrobishi
-
-/examples/                                      @fuxingloh
+/.github/                                       @fuxingloh
+/.husky/                                        @fuxingloh
 
 /packages/jellyfish-address/                    @fuxingloh @ivan-zynesis
 
-/packages/jellyfish-api-core/                   @fuxingloh @canonbrother @jingyi2811 @ivan-zynesis @surangap @Jouzo
+/packages/jellyfish-api-core/                   @fuxingloh @canonbrother @jingyi2811 @ivan-zynesis @surangap
 
 /packages/jellyfish-api-jsonrpc/                @fuxingloh @thedoublejay
 
-/packages/jellyfish-block/                      @fuxingloh @ivan-zynesis @canonbrother @monstrobishi @surangap @Jouzo @jingyi2811
+/packages/jellyfish-block/                      @fuxingloh @ivan-zynesis @canonbrother @monstrobishi @surangap @jingyi2811
 
-/packages/jellyfish-buffer/                     @fuxingloh @ivan-zynesis @canonbrother @monstrobishi @surangap @Jouzo @jingyi2811
+/packages/jellyfish-buffer/                     @fuxingloh @ivan-zynesis @canonbrother @monstrobishi @surangap @jingyi2811
 
 /packages/jellyfish-crypto/                     @fuxingloh @ivan-zynesis @surangap
 /packages/jellyfish-json/                       @fuxingloh @canonbrother
 /packages/jellyfish-network/                    @fuxingloh @ivan-zynesis
 
-/packages/jellyfish-testing/                    @fuxingloh @canonbrother @jingyi2811 @surangap @Jouzo
+/packages/jellyfish-testing/                    @fuxingloh @canonbrother @jingyi2811 @surangap
 
-/packages/jellyfish-transaction/                @fuxingloh @ivan-zynesis @canonbrother @monstrobishi @surangap @Jouzo @jingyi2811
-/packages/jellyfish-transaction-builder/        @fuxingloh @ivan-zynesis @canonbrother @monstrobishi @surangap @Jouzo @jingyi2811
+/packages/jellyfish-transaction/                @fuxingloh @ivan-zynesis @canonbrother @monstrobishi @surangap @jingyi2811
+/packages/jellyfish-transaction-builder/        @fuxingloh @ivan-zynesis @canonbrother @monstrobishi @surangap @jingyi2811
 /packages/jellyfish-transaction-signature/      @fuxingloh @ivan-zynesis @surangap
 
 /packages/jellyfish-wallet/                     @fuxingloh @ivan-zynesis @monstrobishi @surangap

README.md

@@ -13,7 +13,7 @@ DeFiChain Jellyfish SDK. A collection of TypeScript + JavaScript tools and libra
 <details>
 <summary><b>Watch this space!</b></summary>
 
-We are consolidating all jellyfish ecosystem projects ocean, whale, playground, and salmon into this repository.
+We are consolidating all jellyfish ecosystem projects ocean, whale and playground into this repository.
 
 - For better synergy of DeFiChain open source development across all concerns.
 - Consistent versioning for all ecosystem releases with a single source of truth.
@@ -28,27 +28,6 @@ We are consolidating all jellyfish ecosystem projects ocean, whale, playground,
 DeFi Jellyfish follows a monorepo methodology, all maintained packages are in the same repo and published with the same
 version tag.
 
-| Package                                      | Description                                                                                                            |
-|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
-| `@defichain/jellyfish-address`               | Provide address builder, parser, validator utility library for DeFi Blockchain.                                        |
-| `@defichain/jellyfish-api-core`              | A protocol agnostic DeFi Blockchain client interfaces, with a "foreign function interface" design.                     |
-| `@defichain/jellyfish-api-jsonrpc`           | Implements the [JSON-RPC 1.0](https://www.jsonrpc.org/specification_v1) specification for api-core.                    |
-| `@defichain/jellyfish-block`                 | Stateless raw block composer for the DeFi Blockchain.                                                                  |
-| `@defichain/jellyfish-buffer`                | Buffer composer for jellyfish.                                                                                         |
-| `@defichain/jellyfish-crypto`                | Cryptography operations for jellyfish, includes a simple 'secp256k1' EllipticPair.                                     |
-| `@defichain/jellyfish-json`                  | Allows parsing of JSON with 'lossless', 'bignumber' and 'number' numeric precision.                                    |
-| `@defichain/jellyfish-network`               | Contains DeFi Blockchain various network configuration for mainnet, testnet and regtest.                               |
-| `@defichain/jellyfish-testing`               | Provides many abstractions for various commonly used setup pattern for DeFi Blockchain.                                |
-| `@defichain/jellyfish-transaction`           | Dead simple modern stateless raw transaction composer for the DeFi Blockchain.                                         |
-| `@defichain/jellyfish-transaction-builder`   | Provides a high-high level abstraction for constructing transaction ready to be broadcast for DeFi Blockchain.         |
-| `@defichain/jellyfish-transaction-signature` | Stateless utility library to perform transaction signing.                                                              |
-| `@defichain/jellyfish-wallet`                | Jellyfish wallet is a managed wallet, where account can get discovered from an HD seed.                                |
-| `@defichain/jellyfish-wallet-classic`        | WalletClassic implements a simple, single elliptic pair wallet.                                                        |
-| `@defichain/jellyfish-wallet-encrypted`      | Library to encrypt MnemonicHdNode as EncryptedMnemonicHdNode. Able to perform as MnemonicHdNode with passphrase known. |
-| `@defichain/jellyfish-wallet-mnemonic`       | MnemonicHdNode implements the WalletHdNode from jellyfish-wallet; a CoinType-agnostic HD Wallet for noncustodial DeFi. |
-| `@defichain/testcontainers`                  | Provides a lightweight, throw away instances for DeFiD node provisioned automatically in a Docker container.           |
-| ~~@defichain/testing~~                       | (deprecated) ~~Provides rich test fixture setup functions for effective and effortless testing.~~                      |
-
 ## Developing & Contributing
 
 Thanks for contributing, appreciate all the help we can get. Feel free to make a pull-request, we will guide you along

website/README.md → apps/website/README.md

@@ -1,7 +1,5 @@
-# jellyfish/website
-
-`/website/*` contains the documentation for jellyfish; built using [Docusaurus 2](https://v2.docusaurus.io/), a modern
-static website generator.
+`/apps/website/*` contains the documentation for jellyfish; built using [Docusaurus 2](https://v2.docusaurus.io/), a
+modern static website generator.
 
 ## Writing documentations
 
@@ -15,5 +13,5 @@ having to restart the server.
 
 ```console
 npm i
-npm run start
+npm run start --workspace=apps/website
 ```

website/docusaurus.config.js → apps/website/docusaurus.config.js

@@ -128,7 +128,7 @@ module.exports = {
       '@docusaurus/preset-classic',
       {
         docs: {
-          path: '../docs/ecosystem',
+          path: '../../docs/ecosystem',
           routeBasePath: 'ecosystem',
           editUrl: 'https://github.com/DeFiCh/jellyfish/tree/main/website',
           sidebarCollapsed: false,
@@ -144,7 +144,7 @@ module.exports = {
       '@docusaurus/plugin-content-docs',
       {
         id: 'node',
-        path: '../docs/node',
+        path: '../../docs/node',
         routeBasePath: 'node',
         editUrl: 'https://github.com/DeFiCh/jellyfish/tree/main/website',
         sidebarCollapsed: false,
@@ -154,7 +154,7 @@ module.exports = {
       '@docusaurus/plugin-content-docs',
       {
         id: 'ocean',
-        path: '../docs/ocean',
+        path: '../../docs/ocean',
         routeBasePath: 'ocean',
         editUrl: 'https://github.com/DeFiCh/jellyfish/tree/main/website',
         sidebarCollapsed: false,
@@ -164,7 +164,7 @@ module.exports = {
       '@docusaurus/plugin-content-docs',
       {
         id: 'testing',
-        path: '../docs/testing',
+        path: '../../docs/testing',
         routeBasePath: 'testing',
         editUrl: 'https://github.com/DeFiCh/jellyfish/tree/main/website',
         sidebarCollapsed: false,

website/package.json → apps/website/package.json

@@ -22,11 +22,11 @@
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "^2.0.0-beta.13",
-    "@docusaurus/types": "^2.0.0-beta.9",
+    "@docusaurus/types": "^2.0.0-beta.13",
     "@tsconfig/docusaurus": "^1.0.4",
     "@types/react": "^17.0.37",
     "@types/react-helmet": "^6.1.4",
-    "@types/react-router-dom": "^5.3.1"
+    "@types/react-router-dom": "^5.3.2"
   },
   "browserslist": {
     "production": [

jest.config.js

@@ -3,17 +3,16 @@ module.exports = {
   testRegex: '((\\.|/)(e2e|test|spec))\\.[jt]sx?$',
   testSequencer: require.resolve('./jest.sequencer'),
   moduleNameMapper: {
-    '@defichain/jellyfish-(.*)': '<rootDir>/packages/jellyfish-$1/src',
-    '@defichain/testcontainers': '<rootDir>/packages/testcontainers/src',
-    '@defichain/testing': '<rootDir>/packages/testing/src'
+    '@defichain/(.*)': '<rootDir>/packages/$1/src'
   },
   verbose: true,
   clearMocks: true,
   testTimeout: 180000,
   coveragePathIgnorePatterns: [
     '/node_modules/',
-    '.*/__tests__/.*',
     '/examples/',
-    '/website/'
+    '/apps/website/',
+    '.*/__tests__/.*',
+    '.*/testing/.*'
   ]
 }

lerna.json

@@ -1,7 +1,8 @@
 {
   "version": "0.0.0",
   "packages": [
-    "packages/*",
-    "./"
+    "./",
+    "apps/*",
+    "packages/*"
   ]
 }

netlify.toml

@@ -1,5 +1,5 @@
 [build]
-publish = "website/build/"
+publish = "apps/website/build/"
 command = "npm run website:build"
 
 [[headers]]

package.json

@@ -9,16 +9,16 @@
   "files": [],
   "workspaces": [
     "./",
-    "./packages/*",
-    "./website"
+    "./apps/*",
+    "./packages/*"
   ],
   "engines": {
     "node": ">=14.x"
   },
   "scripts": {
-    "clean": "rm -rf ./packages/**/dist && rm -rf ./packages/**/tsconfig.build.tsbuildinfo",
+    "clean": "rm -rf ./packages/**/dist && rm -rf ./apps/**/dist && rm -rf ./packages/**/tsconfig.build.tsbuildinfo",
     "prepare": "husky install",
-    "website:build": "npm run build --workspace=website",
+    "website:build": "npm run build --workspace=apps/website",
     "build": "lerna run --scope '@defichain/*' build",
     "version:set": "lerna version $1 --yes --no-push --no-git-tag-version --exact",
     "publish:latest": "lerna exec -- npm publish --tag latest --access public",
@@ -37,6 +37,7 @@
     "lerna": "^4.0.0",
     "lint-staged": "^12.1.2",
     "shuffle-seed": "^1.1.6",
+    "nock": "^13.1.3",
     "ts-jest": "^27.1.1",
     "typescript": "4.2.4",
     "wait-for-expect": "^3.0.2"

packages/jellyfish-api-jsonrpc/package.json

@@ -28,8 +28,5 @@
   },
   "peerDependencies": {
     "defichain": "^0.0.0"
-  },
-  "devDependencies": {
-    "nock": "^13.2.1"
   }
 }

tsconfig.base.json

@@ -1,10 +1,17 @@
 {
   "compilerOptions": {
-    "lib": ["es2020"],
-    "target": "es6",
+    "lib": [
+      "es2020"
+    ],
+    "target": "esnext",
     "module": "commonjs",
     "moduleResolution": "node",
     "strict": true,
-    "esModuleInterop": true
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "incremental": true,
+    "allowSyntheticDefaultImports": true,
+    "emitDecoratorMetadata": true,
+    "resolveJsonModule": true
   }
 }

tsconfig.build.json

@@ -4,6 +4,6 @@
     "composite": true,
     "declaration": true,
     "declarationMap": true,
-    "sourceMap": true,
+    "sourceMap": true
   }
 }