.circleci/config.yml

@@ -34,6 +34,8 @@ jobs:
           key: v1-dependencies-{{ checksum "package.json" }}
 
       # run tests!
+      - run: npm run lint:formatting
+
       - run: npm test
 
       - run: npm run build

.eslintrc.js

@@ -1,19 +1,28 @@
 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"
+    "project": "./tsconfig.json",
+    "tsconfigRootDir": __dirname
   },
   "plugins": [
     "import",
     "@typescript-eslint"
   ],
   "settings": {
     "import/parsers": {
-      "@typescript-eslint/parser": [".ts"]
+      "@typescript-eslint/parser": [ ".ts" ]
     },
     "import/resolver": { "typescript": {} }
   },
@@ -24,17 +33,15 @@ module.exports = {
   "rules": {
     "no-tabs": 0,
     "no-restricted-globals": 0,
-    "import/prefer-default-export": 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,
-    "import/no-cycle": 0,
     "prefer-destructuring": 0,
     "no-prototype-builtins": 0,
-    "comma-dangle": ["error", "never"],
+    "comma-dangle": "off",
     "quotes": [2, "single"],
     "eol-last": 2,
     "no-debugger": 1,
@@ -50,16 +57,21 @@ module.exports = {
     "no-console": 0,
     "prefer-const": 2,
     "new-cap": 0,
-    "semi": [2, "never"],
+    "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",
-    "@typescript-eslint/indent": [2, 2, {
-      "FunctionDeclaration": { "parameters": "first" },
-      "FunctionExpression": { "parameters": "first" },
+    "no-return-await": "off",
+    "no-useless-constructor": "off",
+    "indent": [2, 2, {
+      "FunctionDeclaration" : { "parameters": "first" },
+      "FunctionExpression" : { "parameters": "first" },
       "ObjectExpression": "first",
       "ArrayExpression": "first",
       "ImportDeclaration": "first",
@@ -74,15 +86,61 @@ module.exports = {
     "@typescript-eslint/no-angle-bracket-type-assertion": "off",
     "@typescript-eslint/prefer-interface": "off",
     "@typescript-eslint/no-use-before-define": "off",
-    "@typescript-eslint/no-unused-vars": "off",
-
-    // TODO: enable this when reasonable
+    "@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 this when reasonable
+    // 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/` "
+      }
+    ]
 
-    // TODO: enable when this is fixed https://github.com/benmosher/eslint-plugin-import/issues/1282
-    "import/named": "off"
+    // ----
   }
 }

.prettierignore

@@ -0,0 +1,66 @@
+src/wallet.ts
+src/encryption/wallet.ts
+src/encryption/index.ts
+src/encryption/ec.ts
+src/errors.ts
+src/auth/authSession.ts
+src/auth/protocolEchoDetection.ts
+src/auth/sessionData.ts
+src/auth/authMessages.ts
+src/auth/authApp.ts
+src/auth/authConstants.ts
+src/auth/sessionStore.ts
+src/auth/appConfig.ts
+src/auth/protocolLaunch.ts
+src/auth/index.ts
+src/auth/authVerification.ts
+src/auth/userSession.ts
+src/auth/authProvider.ts
+src/network.ts
+src/utils.ts
+src/operations/safety.ts
+src/operations/txbuild.ts
+src/operations/utils.ts
+src/operations/skeletons.ts
+src/operations/signers.ts
+src/operations/index.ts
+src/storage/hub.ts
+src/storage/index.ts
+src/types.ts
+src/keys.ts
+src/index.ts
+src/profiles/profileProofs.ts
+src/profiles/profileZoneFiles.ts
+src/profiles/profile.ts
+src/profiles/index.ts
+src/profiles/profileTokens.ts
+src/profiles/services/github.ts
+src/profiles/services/linkedIn.ts
+src/profiles/services/instagram.ts
+src/profiles/services/twitter.ts
+src/profiles/services/facebook.ts
+src/profiles/services/serviceUtils.ts
+src/profiles/services/index.ts
+src/profiles/services/service.ts
+src/profiles/services/hackerNews.ts
+src/profiles/profileSchemas/personUtils.ts
+src/profiles/profileSchemas/personZoneFiles.ts
+src/profiles/profileSchemas/creativework.ts
+src/profiles/profileSchemas/personLegacy.ts
+src/profiles/profileSchemas/organization.ts
+src/profiles/profileSchemas/index.ts
+src/profiles/profileSchemas/person.ts
+src/profiles/profileLookup.ts
+src/config.ts
+src/dids.ts
+src/fetchUtil.ts
+src/public.ts
+src/address.ts
+src/bn.ts
+src/encryption/aesCipher.ts
+src/encryption/cryptoRandom.ts
+src/encryption/cryptoUtils.ts
+src/encryption/hashRipemd160.ts
+src/encryption/hmacSha256.ts
+src/encryption/pbkdf2.ts
+src/encryption/sha2Hash.ts

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Tests",
+            "runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"],
+            "args": ["${workspaceFolder}/tests/unitTests/src/index.ts"],
+            "env": { "TS_NODE_PROJECT": "${workspaceFolder}/tests/unitTests/src/tsconfig.json" },
+            "console": "integratedTerminal"
+        }
+    ]
+}

CHANGELOG.md

@@ -4,6 +4,34 @@ All notable changes to the project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+## [21.0.0] - 2020-01-17
+### Added
+- More Blockstack error codes.
+- `putFile` and `encryptContent` can now optionally base64 encode data, for a ~33% size increase compared to the default hex encoding which has a 100% size increase. 
+
+### Changed
+- `putFile` performs client-side validation that data size is within the Gaia hub's reported maximum limit. 
+- When a `string` value is passed to `putFile` and the `contentType` option is unspecified, it is set to `text/plain; charset=UTF-8`. 
+- `getFile` now throws error on 404 instead of returning null.
+- `getFile`, `putFile`, `deleteFile`, `listfiles` now include error info upon failure.
+- `getFile` can now decrypt using a custom private key
+- Several cryptographic operations now use the native Web Crypto APIs when available. This primarily
+increases the performance of file encryption and decryption, and account seed phrase encryption and 
+decryption. 
+- The following functions now return Promises: `handleSignedEncryptedContents`, `makeAuthResponse`, 
+`encryptECIES`, `decryptECIES`, `encryptPrivateKey`, `decryptPrivateKey`, `encryptContent`, 
+`decryptContent`, `aes256CbcEncrypt`, `aes256CbcDecrypt`, `hmacSha256`.
+- `putfile` now prevents data corruption caused by race conditions by using etag values to verify that the client is updating the latest version of the file.
+- `putFile` now attempts to include `etag` values in the `If-Match` header of its request, and sets the `If-None-Match` header to `*` if it is unaware of an etag for the file it is attempting to write.
+- `putFile` now returns an `etag` in addition to the `publicURL` after successfully writing a file.
+- `PreconditionFailedError` thrown if `putFile` returns with a `412` response.
+
+## [19.4.0] - 2019-09-03
+### Changed
+- Excluded unused bip39 wordlist from dist bundle, reducing bundle size.
+
 ## [19.3.0] - 2019-08-21
 
 ### Changed

README.md

@@ -18,7 +18,19 @@ Note: If you're looking for the Blockstack CLI repo it was merged with [Blocksta
 $ npm install blockstack
 ```
 
-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, add [the mdincludes/script-dist-file.md](mdincludes/script-dist-file.md) script in your application. 
+### Using blockstack.js with a CDN
+
+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:
+
+<!-- cdn -->
+```html
+<script src="https://unpkg.com/blockstack@21.0.0/dist/blockstack.js" integrity="sha384-zbpmDp1R7a7Eyh11zgCQlx8vx50WvRyGsZ1+ke6SEogm2ahOAIrnURy+cLjYE3jq" crossorigin="anonymous"></script>
+```
+<!-- cdnstop -->
+
+_Note: this is script is bundled as standalone (UMD) lib, targeting ES6 (ECMAScript 2015)._
+
 
 
 ## About
@@ -40,7 +52,11 @@ 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 document uses ES6 in its examples but it is compiled down to Javascript (ES5) and is perfectly compatible with it. If you're using the latter, just make a few adjustments to the examples below (e.g. use "let" instead of "var")._
+_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).
+
 
 ## Documentation
 

babel.config.js

@@ -9,8 +9,11 @@ module.exports = function (api) {
   // Babel config for web browser lib dist with wide-spread browser support.
   let opts = {
     presets: [
-      "@babel/preset-env",
-      "@babel/preset-typescript"
+      ["@babel/preset-env", {
+        "targets": {
+          "esmodules": true
+        }
+      }]
     ],
     plugins: [
       "@babel/proposal-class-properties",