feat: Stacks monorepo refactor

.circleci/config.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/node:10.15.1
+      - image: circleci/node:14.6.0
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -20,28 +20,28 @@ jobs:
       - checkout
 
       # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "package.json" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
+      # - restore_cache:
+      #     keys:
+      #     - v1-dependencies-{{ checksum "package.json" }}
+      #     # fallback to using the latest cache if no exact match is found
+      #     - v1-dependencies-
 
-      - run: npm install
+      - run: npx lerna bootstrap
 
-      - save_cache:
-          paths:
-            - node_modules
-          key: v1-dependencies-{{ checksum "package.json" }}
+      # - save_cache:
+      #     paths:
+      #       - node_modules
+      #     key: v1-dependencies-{{ checksum "package.json" }}
 
-      # run tests!
-      - run: npm run lint:formatting
+      # run tests!  
+      #- run: npm run lint:formatting
 
-      - run: npm test
+      - run: npx lerna run build
 
-      - run: npm run build
+      - run: npx lerna run test
 
-      - run: npm run codecovUpload
+      - run: npx lerna run codecovUpload
 
       - store_artifacts:
           path: docs
-          destination: docs
+          destination: docs

.eslintrc.js

@@ -1,146 +1,9 @@
 module.exports = {
-  "extends": [
-    "eslint:recommended",
-    "airbnb-base",
-    "plugin:import/errors",
-    "plugin:import/warnings",
-    "plugin:import/typescript",
-    "plugin:@typescript-eslint/eslint-recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking",
-    "prettier/@typescript-eslint"
-
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": "./tsconfig.json",
-    "tsconfigRootDir": __dirname
-  },
-  "plugins": [
-    "import",
-    "@typescript-eslint"
-  ],
-  "settings": {
-    "import/parsers": {
-      "@typescript-eslint/parser": [ ".ts" ]
-    },
-    "import/resolver": { "typescript": {} }
-  },
-  "env": {
-    "browser": true,
-    "node": true
-  },
-  "rules": {
-    "no-tabs": 0,
-    "no-restricted-globals": 0,
-    "no-buffer-constructor": 0,
-    "no-mixed-operators": 0,
-    "no-plusplus": 0,
-    "no-bitwise": 0,
-    "prefer-promise-reject-errors": 0,
-    "class-methods-use-this": 0,
-    "prefer-destructuring": 0,
-    "no-prototype-builtins": 0,
-    "comma-dangle": "off",
-    "quotes": [2, "single"],
-    "eol-last": 2,
-    "no-debugger": 1,
-    "no-mixed-requires": 0,
-    "no-underscore-dangle": 0,
-    "no-multi-spaces": 0,
-    "no-trailing-spaces": 0,
-    "no-extra-boolean-cast": 0,
-    "no-undef": 2,
-    "no-var": 2,
-    "no-param-reassign": 0,
-    "no-else-return": 0,
-    "no-console": 0,
-    "prefer-const": 2,
-    "new-cap": 0,
-    "semi": 0,
-    "valid-jsdoc": "off",
-    "object-curly-newline": "off",    
-    "arrow-parens": "off",
-    "function-paren-newline": 0,
-    "max-classes-per-file": "off",
-    "prefer-object-spread": "off",
-    "no-multiple-empty-lines": "off",
-    "no-shadow": "off",
-    "no-use-before-define": "off",
-    "no-return-await": "off",
-    "no-useless-constructor": "off",
-    "indent": [2, 2, {
-      "FunctionDeclaration" : { "parameters": "first" },
-      "FunctionExpression" : { "parameters": "first" },
-      "ObjectExpression": "first",
-      "ArrayExpression": "first",
-      "ImportDeclaration": "first",
-      "CallExpression": { "arguments": "first" }
-    }],
-    "@typescript-eslint/explicit-member-accessibility": "off",
-    "@typescript-eslint/explicit-function-return-type": "off",
-    "@typescript-eslint/class-name-casing": "off",
-    "@typescript-eslint/camelcase": "off",
-    "@typescript-eslint/array-type": "off",
-    "@typescript-eslint/member-delimiter-style": "off",
-    "@typescript-eslint/no-angle-bracket-type-assertion": "off",
-    "@typescript-eslint/prefer-interface": "off",
-    "@typescript-eslint/no-use-before-define": "off",
-    "@typescript-eslint/no-inferrable-types": "off",
-    "@typescript-eslint/ban-ts-ignore": "off",
-    "@typescript-eslint/consistent-type-assertions": "off",
-    "@typescript-eslint/prefer-regexp-exec": "off",
-    "@typescript-eslint/no-useless-constructor": "error",
-    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/no-misused-promises": "error",
-    "@typescript-eslint/no-floating-promises": "error",
-    "@typescript-eslint/require-await": "error",
-    "@typescript-eslint/await-thenable": "error",
-
-
-    // TODO: enable these when reasonable
-    "@typescript-eslint/promise-function-async": "off",
-    "@typescript-eslint/prefer-includes": "off",
-    "@typescript-eslint/prefer-string-starts-ends-with": "off",
-    // ---
-
-
-    "import/no-unresolved": "error",
-    "import/named": "error",
-    "import/prefer-default-export": "off",
-
-    // TODO: enable these when reasonable -- these can help module dependencies be easier to bundle w/ tree-shaking.
-    "import/no-cycle": "off",
-    // ---
-
-    "import/no-self-import": "error",
-    "import/no-useless-path-segments": ["error", { noUselessIndex: true }],
-    "import/no-unused-modules": ["error", { "missingExports": true }],
-    "import/export": "error",
-    "import/no-extraneous-dependencies": "error",
-    "import/no-duplicates": "error",
-    "import/no-unassigned-import": "error",
-    "import/order": "error",
-
-    "import/no-nodejs-modules": ["error", { "allow": [
-
-    ]}],
-
-    // ---- Enforce some blockstack.js specific rules ----
-
-    "no-restricted-globals": ["error", {
-        "name": "fetch",
-        "message": "Use `privateFetch` instead."
-      }
-    ],
-
-    "no-restricted-modules": ["error", {
-        "name": "crypto",
-        "message": "Use a specific module from `./src/encryption/` "
-      }
-    ]
-
-    // ----
+  root: true,
+  reportUnusedDisableDirectives: true,
+  extends: ['@blockstack/eslint-config'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./packages/**/tsconfig.json', './tsconfig.json']
   }
-}
+};

.gitignore

@@ -41,4 +41,9 @@ src/testing/browser/blockstack-proofs.js
 
 lib
 dist
-docs
+
+.rts2_cache_cjs/
+.rts2_cache_esm/
+.rts2_cache_umd/
+.idea
+

README.md

@@ -1,104 +1,39 @@
-# blockstack.js [![CircleCI](https://img.shields.io/circleci/project/blockstack/blockstack.js/master.svg)](https://circleci.com/gh/blockstack/blockstack.js/tree/master) [![npm](https://img.shields.io/npm/v/blockstack.svg)](https://www.npmjs.com/package/blockstack) [![npm](https://img.shields.io/npm/dm/blockstack.svg)](https://www.npmjs.com/package/blockstack) [![npm](https://img.shields.io/npm/l/blockstack.svg)](https://www.npmjs.com/package/blockstack) [![Slack](https://img.shields.io/badge/join-slack-e32072.svg?style=flat)](http://slack.blockstack.org/)
+# Stacks.js Monorepo [![CircleCI](https://img.shields.io/circleci/project/blockstack/blockstack.js/master.svg)](https://circleci.com/gh/blockstack/blockstack.js/tree/master)
 
-Note: If you're looking for the Blockstack CLI repo it was merged with [Blockstack Core](https://github.com/blockstack/blockstack-core).
+This repo is home to the Stacks.js libraries which provide everything you need to work with the Stacks blockchain.
 
-  - [Installation](#installation)
-  - [About](#about)
-  - [Documentation](#documentation)
-  - [Compatibility](#compatibility)
-  - [Contributing](#contributing)
-  - [Maintainer](#maintainer)
-  - [Testing](#testing)
-    - [Testing in a browser](#testing-in-a-browser)
-  - [Releasing](#releasing)
+- [`@stacks/auth`](./packages/auth) Construct and decode authentication requests for Stacks apps.
+- [`@stacks/storage`](./packages/storage) Store and fetch files with Gaia, the decentralized storage system.
+- [`@stacks/transactions`](./packages/transactions) Construct, decode transactions and work with Clarity smart contracts on the Stacks blockchain.
+- [`@stacks/cli`](./packages/cli) Command line interface to interact with auth, storage and Stacks transactions.
+- [`@stacks/keychain`](./packages/keychain) Create and manage keys/wallets for the Stacks blockchain.
+- [`@stacks/network`](./packages/network) Network and API library for working with Stacks blockchain nodes.
+- [`@stacks/encryption`](./packages/encryption) Encryption functions used by Stacks.js packages.
+- [`@stacks/profile`](./packages/profile) Functions for manipulating user profiles.
+- [`@stacks/common`](./packages/common) Common utilities used by Stacks.js packages.
 
-## Installation
+See `README` in each package directory for installation instructions and usage.
 
-```
-$ npm install blockstack
-```
+## Migrating from blockstack.js
 
-### Using blockstack.js with a CDN
+To migrate your app from blockstack.js to stacks.js follow the steps in the [migration guide](./migration-guide.md).
 
-You can import `blockstack.js` as a script without using a package manager. 
-To securely use the latest distribution of blockstack.js from a CDN, use the following script in your application:
+## Development environment setup
 
-<!-- cdn -->
-```html
-<script src="https://unpkg.com/blockstack@21.1.1/dist/blockstack.js" integrity="sha384-QsRlJlLKvr/Vq4iv1MPwTqoMx5hd0StlnCBCTdwbb0ituqCGaTxjNIkdahGHlnwb" crossorigin="anonymous"></script>
-```
-<!-- cdnstop -->
-
-_Note: this is script is bundled as standalone (UMD) lib, targeting ES6 (ECMAScript 2015)._
-
-
-
-## About
-
-Blockstack JS is a library for profiles/identity, authentication, and storage.
-
-The authentication portion of this library can be used to:
-
-1.  create an authentication request
-2.  create an authentication response
-
-The profiles/identity portion of this library can be used to:
-
-1.  transform a JSON profile into cryptographically-signed tokens
-2.  recover a JSON profile from signed tokens
-3.  validate signed profile tokens
-
-The storage portion of this library can be used to:
-
-1. store and retrieve your app's data in storage that is controlled by the user
-
-_Note:_ this lib is written in Typescript and is compiled to ES6 (ECMAScript 2015)
-syntax and uses CommonJS modules. The NPM package works out of the box within the 
-Node.js runtime, and within browsers when using a common bundler (e.g. Webpack, 
-Browserify, Rollup, etc).
+To setup the development environment for this repository, follow these steps:
 
+1. Clone this package.
+2. Run `lerna bootstrap` to install dependencies
+3. Run `lerna run build` to build packages
+4. Run `lerna run test` to run tests
 
 ## Documentation
 
-[![Documentation](/docs-button.png)](http://blockstack.github.io/blockstack.js/index.html)
-
-## Compatibility
-
-_Note:_ blockstack.js 0.14.0 and newer versions use a new on-disk format that is not backward compatible with prior versions.
+[![Documentation](/docs-button.png)](https://docs.blockstack.org/)
 
 ## Contributing
 
-This repository uses the [git flow branching mode](http://nvie.com/posts/a-successful-git-branching-model/).
-
-The latest released code as deployed to npm is in `master` and the latest delivered development
-changes for the next release are in `develop`.
-
-We use the [git-flow-avh](https://github.com/petervanderdoes/gitflow-avh) plugin.
-
-Please send pull requests against `develop`. Pull requests should include tests,
-[flow static type annotations](https://flow.org) and be lint free. Open your pull request using the template in  `PULL_REQUEST_TEMPLATE.md`
-
-Github issues marked [help-wanted](https://github.com/blockstack/blockstack.js/labels/help-wanted)
-are great places to start. Please ask in a github issue or slack before embarking
+Github issues marked [help-wanted](https://github.com/blockstack/stacks.js/labels/help-wanted)
+are great places to start. Please ask in a github issue or discord before embarking
 on larger issues that aren't labeled as help wanted or adding additional
 functionality so that we can make sure your contribution can be included!
-
-## Maintainer
-
-This repository is maintained by [yukan.id](https://explorer.blockstack.org/name/yukan.id).
-
-## Testing
-
-    $ npm run test
-
-    We test on the "Active LTS" version of Node.
-
-### Testing in a browser
-
-_This test will only work with your browser's Cross-Origin Restrictions disabled._
-
-Run `npm run compile; npm run browserify` before opening the file `test.html`
-in your browser.
-
-## Releasing
-See `release-checklist.md`

babel.config.js

@@ -1,30 +1,29 @@
-module.exports = function (api) {
-
+module.exports = function(api) {
   // TODO: Should cache on api.caller and api.env for faster build times.
   api.cache.invalidate(() => true);
 
-  const isTestEnv = api.env("test");
-  const isDevEnv = api.env("development");
+  const isTestEnv = api.env('test');
+  const isDevEnv = api.env('development');
 
   // Babel config for web browser lib dist with wide-spread browser support.
   let opts = {
     presets: [
-      ["@babel/preset-env", {
-        "targets": {
-          "esmodules": true
-        }
-      }]
+      [
+        '@babel/preset-env',
+        {
+          targets: {
+            esmodules: true,
+          },
+        },
+      ],
     ],
-    plugins: [
-      "@babel/proposal-class-properties",
-      "@babel/proposal-object-rest-spread"
-    ]
+    plugins: ['@babel/proposal-class-properties', '@babel/proposal-object-rest-spread'],
   };
 
   // Use full source maps in development env.
   if (!opts.sourceMaps && isDevEnv) {
-    opts.sourceMaps = "both";
+    opts.sourceMaps = 'both';
   }
 
   return opts;
-}
+};