From a916bfa844f333302dcf24d460dfd015decbc1e5 Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Thu, 29 Nov 2018 09:07:10 -0800 Subject: [PATCH 1/2] pkg: add lockfile --- .gitignore | 1 - package-lock.json | 268 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 268 insertions(+), 1 deletion(-) create mode 100644 package-lock.json diff --git a/.gitignore b/.gitignore index f875848a9..baf2bb14d 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,5 @@ node_modules/ docs/reference/ docker_data/ browser/bcoin* -package-lock.json npm-debug.log coverage/ diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 000000000..3f1c7661f --- /dev/null +++ b/package-lock.json @@ -0,0 +1,268 @@ +{ + "name": "bcoin", + "version": "1.0.2", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "bcfg": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/bcfg/-/bcfg-0.1.4.tgz", + "integrity": "sha512-tgweKJnFlFqg/QA3l+9i4cSJTHPcABrBriRZkUd+MM9mUCv8tBqAZFoykR0Cn3Fi9ygJ/pyWfmjDkRVZQwvPkQ==", + "requires": { + "bsert": "~0.0.5" + } + }, + "bclient": { + "version": "0.1.5", + "resolved": "https://registry.npmjs.org/bclient/-/bclient-0.1.5.tgz", + "integrity": "sha512-LtlH6i66dVIztUVyd2ItU3sRwNT/+X/zIEXP5wxz8boP0tARIRjCB1THoYg6PtPaONZ+k/W2VkzYl9XjWTsOpQ==", + "requires": { + "bcfg": "~0.1.4", + "bcurl": "~0.1.4", + "bsert": "~0.0.5" + } + }, + "bcrypto": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/bcrypto/-/bcrypto-3.0.1.tgz", + "integrity": "sha512-s8sHC9RM3fbu1JO4PYnh/8pPwqA/X3KclD0xnsSM8F0jX/omFt1zHO+A8oKm86O6CYb33TsTxBp2fH0ChOToYQ==", + "requires": { + "bindings": "~1.3.1", + "bsert": "~0.0.5", + "bufio": "~1.0.3", + "nan": "~2.11.1" + } + }, + "bcurl": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/bcurl/-/bcurl-0.1.4.tgz", + "integrity": "sha512-wy+/9uBQWrcNcMy4qCl241qATNnB0evBO5oTJboINXXG3c152wDyEnedAvypkOp4Mh0fYrlsO6yYr5RmRXnVIQ==", + "requires": { + "brq": "~0.1.4", + "bsert": "~0.0.5", + "bsock": "~0.1.4" + } + }, + "bdb": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/bdb/-/bdb-1.1.3.tgz", + "integrity": "sha512-FlbhD7vSFuh0yxM1Vmg/m+gS1dtM4uoESFz9NTgtR3doJ5XBa30XPvxV++AbYObT/46Z7EHfbJNlXc6cmGuvPw==", + "requires": { + "bindings": "~1.3.1", + "bsert": "~0.0.5", + "nan": "~2.11.1" + } + }, + "bdns": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/bdns/-/bdns-0.1.3.tgz", + "integrity": "sha512-d071TLX00NZCqhKNspsKU8N8ApqqVizSEdEB7bCE5tUQgFS1UMHjnN0C8HDd5kRYwIX3jAIsN+oNgREvZCGOcA==", + "requires": { + "bsert": "~0.0.5" + } + }, + "bevent": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/bevent/-/bevent-0.1.3.tgz", + "integrity": "sha512-bTsC1MSSWxn0E0OrjrY8j/Sz/C2u3FuAhaO2CaEyc5a5uLwcvC8MK9b14oW0fW/k0AGKQHkuebJOI1RRzArBFQ==", + "requires": { + "bsert": "~0.0.5" + } + }, + "bfile": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/bfile/-/bfile-0.1.3.tgz", + "integrity": "sha512-7OScx3u416zFsloaN2CyVXRwVAOJdFBpNrpvGlUbkVD2gEzpj+d7/38MInEXnFtcmErDiY1DFR2URBT4J/7kRg==" + }, + "bfilter": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/bfilter/-/bfilter-1.0.3.tgz", + "integrity": "sha512-ZLTgwK+licMF/dY+H3gnvT0tcYDZKTVwiKVdmXIS3W0wXHVZptg18Cc/zvlFyo4QiCHjVpxAZb5Yb376M/w90Q==", + "requires": { + "bsert": "~0.0.5", + "bufio": "~1.0.3", + "mrmr": "~0.1.4" + } + }, + "bheep": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/bheep/-/bheep-0.1.3.tgz", + "integrity": "sha512-Epqqqokl8M0o2qPx/3Z4OPxzGVFmp3JTQubzoUfWD7uucx5x3opRvcPA/UltLrSL9/b2LA+KIg1s/zyPlpGyrQ==", + "requires": { + "bsert": "~0.0.5" + } + }, + "bindings": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/bindings/-/bindings-1.3.1.tgz", + "integrity": "sha512-i47mqjF9UbjxJhxGf+pZ6kSxrnI3wBLlnGI2ArWJ4r0VrvDS7ZYXkprq/pLaBWYq4GM0r4zdHY+NNRqEMU7uew==" + }, + "binet": { + "version": "0.3.3", + "resolved": "https://registry.npmjs.org/binet/-/binet-0.3.3.tgz", + "integrity": "sha512-EQX5k4WfYDkDhiKyK11Z90jkTLC9yAw4luSpr7+zfT0VW+/fy4Zizf3FoRyAtI7CWV803NybAcfDZz94wAtziA==", + "requires": { + "bs32": "~0.1.3", + "bsert": "~0.0.5" + } + }, + "blgr": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/blgr/-/blgr-0.1.4.tgz", + "integrity": "sha512-eAYRZxI0mtInsANQbhm9zJAkpSQh4QUBYiW8pPznrLeH34NqQxTmFHY1ot3d7wFZoSGIDZ0wFBd5CDzFNP0h5A==", + "requires": { + "bsert": "~0.0.5" + } + }, + "blru": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/blru/-/blru-0.1.4.tgz", + "integrity": "sha512-qq82TVa2GDcjv/BswxH7hpDZEr2Cu8XLVoHmLt7jZMAHKZ3jzTtyQCsuUOZXILpOwduqB8AC6R79bvclNWwRKw==", + "requires": { + "bsert": "~0.0.5" + } + }, + "blst": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/blst/-/blst-0.1.3.tgz", + "integrity": "sha512-bDZC68tjfflVuC7OGy+vlF6VtlW1Jtk8isH2116LoCLE9MCgTu2N2yTaT5CFuUF3yB1s0gGiWVR3uJpF+27HFw==", + "requires": { + "bsert": "~0.0.5" + } + }, + "bmocha": { + "version": "0.1.0", + "resolved": "https://registry.npmjs.org/bmocha/-/bmocha-0.1.0.tgz", + "integrity": "sha512-xCBgECKslwrCOLnDpCCzxVH0ljBAeZr2ci3CaKICBAtSAQINyTyfJ9Rk1zCJ+xEcI5a2cndNYC8l116//0sWUg==", + "dev": true + }, + "bmutex": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/bmutex/-/bmutex-0.1.4.tgz", + "integrity": "sha512-uSlUggS46kO/ziGZQKVE6nMbZrrlhmG+uw/VgBi54dkDO32DLTTlSQsLeRQHeKj4Zl+B389Pmizvz5J+VYYKFw==", + "requires": { + "bsert": "~0.0.5" + } + }, + "brq": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/brq/-/brq-0.1.4.tgz", + "integrity": "sha512-VPQtZgDjc3awXuzpuGrjuJtqsImDKrj7z4tVWC2bMafutD4Efx50otZMyxvQzJlQz3kXK3uAKonrHLKWy0Yo+A==", + "requires": { + "bsert": "~0.0.5" + } + }, + "bs32": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/bs32/-/bs32-0.1.3.tgz", + "integrity": "sha512-pTVLcFJxmAUMjtfLqaBkqCPybquBQCjxKcpVIYEDqPpXIabctuNTnK+6W4Z8WcGyLJijkAWU9ZOI9xARexT8uQ==", + "requires": { + "bsert": "~0.0.5" + } + }, + "bsert": { + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/bsert/-/bsert-0.0.5.tgz", + "integrity": "sha512-prgSa82RHcsdEM7SKYl1S7j0tKeiE3SF8C3B39MyUrpbP66diJK16RIkbFC2pXvQx4xitN0xMgBHKBAgBldX1w==" + }, + "bsip": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/bsip/-/bsip-0.1.4.tgz", + "integrity": "sha512-ZC5Dsa5k1+24DorSOgXeDgV9f7OxLcvZiXDYYjHN1mkW8OF/abNSKlogDgVrx/znpAAZ1yJPkWgrub/FsIxEmA==", + "requires": { + "bindings": "~1.3.1", + "bsert": "~0.0.5", + "nan": "~2.11.1" + } + }, + "bsock": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/bsock/-/bsock-0.1.4.tgz", + "integrity": "sha512-3hfPScf58kC13udMqXL/GiBubUOmwwMaTljIY8xJI0pO2uOmAaDyBCqT/PiteXRHHC1lDinK2wkFayc4xX92Wg==", + "requires": { + "bsert": "~0.0.5" + } + }, + "bsocks": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/bsocks/-/bsocks-0.2.3.tgz", + "integrity": "sha512-Mc6yqYNqPHaZkYYppCctrsZUmoISGBZQmjKnd4P8xxKeKH4KnM0JZJigF6y0QTRjq+e/+7AvSSxoSsUeGh7CYQ==", + "requires": { + "binet": "~0.3.3", + "bsert": "~0.0.5" + } + }, + "bstring": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/bstring/-/bstring-0.3.4.tgz", + "integrity": "sha512-SZztleIswrgkqF2fn/8/sqdYYg9hNb6hqc1wTCjUsE2t3l0vxiwWJ6yF24iK4/qDoa38Nozgw39TVHiCVo/IgQ==", + "requires": { + "bindings": "~1.3.1", + "bsert": "~0.0.5", + "nan": "~2.11.1" + } + }, + "btcp": { + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/btcp/-/btcp-0.1.3.tgz", + "integrity": "sha512-5UV2yOHOwpIhAVqUqiC7MyHdX4coTJPcOnJik3guV+99cVo5ZK/2oKb/w+e2PBxLrsy2c93EF5/DamzmG1QqSA==" + }, + "buffer-map": { + "version": "0.0.4", + "resolved": "https://registry.npmjs.org/buffer-map/-/buffer-map-0.0.4.tgz", + "integrity": "sha512-n7GGQ9zuFPTTSWtgYduEddvdNZsM8sO19c0dTKfia3SqMYkDJYnyVOG+YOvXUmcpp97yhzLYzWB4QzK4NlaoJg==" + }, + "bufio": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/bufio/-/bufio-1.0.3.tgz", + "integrity": "sha512-3JCclITd40pHhAZX9zboZzTv35UJPrtXeY4KnI1KZb5nHWDtzzr04J8DGeSBFXjDnI6ObcJ6gbmUhWMQKub4xQ==" + }, + "bupnp": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/bupnp/-/bupnp-0.2.4.tgz", + "integrity": "sha512-7H1zZkX4Jba+CmY1sxAuceIZoEXAYGi767chlBrGfqFwwf1Bt4DYMsAw65Xxdu/zsLd2nsUSXliV20Txdf76xw==", + "requires": { + "binet": "~0.3.3", + "brq": "~0.1.4", + "bsert": "~0.0.5" + } + }, + "bval": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/bval/-/bval-0.1.4.tgz", + "integrity": "sha512-mCPe86NoWCCO/W4Yvx6dfA2Tr45wP3NAKCeZvwN01ODj5ecdllaD/UHthVjH16/yZa59nxtrA2sBi6Mi83QmXg==", + "requires": { + "bsert": "~0.0.5" + } + }, + "bweb": { + "version": "0.1.6", + "resolved": "https://registry.npmjs.org/bweb/-/bweb-0.1.6.tgz", + "integrity": "sha512-Fuyi0DrtpeQbXO0Srg8JtHWM+t5/XPFcXcXcu61zU3lVeYrYdcITu6+I+qKy6v9esRWbvc+yh117lz9/Wm/Qnw==", + "requires": { + "bsert": "~0.0.5", + "bsock": "~0.1.4" + } + }, + "mrmr": { + "version": "0.1.4", + "resolved": "https://registry.npmjs.org/mrmr/-/mrmr-0.1.4.tgz", + "integrity": "sha512-i2kWXVPLExnVOO7qP861WZxK+pfJ9Rppujfl7lS5sfqWSvQbNz8OouEUgcVk6EsRiH4tDHx6yM6LQQhl0jrjXw==", + "requires": { + "bindings": "~1.3.1", + "bsert": "~0.0.5", + "nan": "~2.11.1" + } + }, + "n64": { + "version": "0.2.5", + "resolved": "https://registry.npmjs.org/n64/-/n64-0.2.5.tgz", + "integrity": "sha512-wry9grq4tNsxvpW2hqXNJIxqv9pT3+NEs/nyg9z5nKQ4QCB6b9IF2DSpVBEC/9fxX6c6G5hJ+SzK/Iv2k+896w==" + }, + "nan": { + "version": "2.11.1", + "resolved": "https://registry.npmjs.org/nan/-/nan-2.11.1.tgz", + "integrity": "sha512-iji6k87OSXa0CcrLl9z+ZiYSuR2o+c0bGuNmXdrhTQTakxytAFsC56SArGYoiHlJlFoHSnvmhpceZJaXkVuOtA==" + } + } +} From 7b734cd36b11b1914a43c78b7a0181176d2e6d62 Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Fri, 30 Nov 2018 11:40:43 -0800 Subject: [PATCH 2/2] docs: update installation details and requirements --- docs/Beginner's-Guide.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/Beginner's-Guide.md b/docs/Beginner's-Guide.md index ccda6aca4..389e8a369 100644 --- a/docs/Beginner's-Guide.md +++ b/docs/Beginner's-Guide.md @@ -5,8 +5,8 @@ Bcoin is an _alternative_ implementation of the bitcoin protocol, written in nod ## Requirements - Linux, OSX, or Windows (\*) (\*\*) -- node.js >=v7.6.0 -- npm >=v4.0.0 +- node.js >=v8.14.0 +- npm >=v6.4.1 - python2 (for node-gyp) - gcc/g++ (for leveldb and secp256k1) - git (optional, see below) @@ -17,13 +17,7 @@ Bcoin is an _alternative_ implementation of the bitcoin protocol, written in nod ## Build & Install -Bcoin is meant to be installed via npm, but for the security conscious, it may be better to clone from github. All tagged commits for release should be signed by @chjj's [PGP key][keybase] (`B4B1F62DBAC084E333F3A04A8962AB9DE6666BBD`). Signed copies of node.js are available from [nodejs.org][node], or from your respective OS's package repositories. - -### Installing via NPM - -``` bash -$ npm install -g bcoin --production -``` +Bcoin is meant to be installed via git for security purposes, as there are security issues when installing via npm. All tagged commits for release should be signed by @chjj's [PGP key][keybase] (`B4B1F62DBAC084E333F3A04A8962AB9DE6666BBD`). Signed copies of node.js are available from [nodejs.org][node], or from your respective OS's package repositories. ### Installing via Git @@ -31,13 +25,22 @@ $ npm install -g bcoin --production $ curl https://keybase.io/chjj/pgp_keys.asc | gpg --import $ git clone git://github.com/bcoin-org/bcoin.git $ cd bcoin +``` + +For a specific release: +``` $ git tag -... -v1.0.0-alpha # latest version -$ git tag -v v1.0.0-alpha # verify signature -$ git checkout v1.0.0-alpha -$ npm install -g --production +$ git tag -v # verify signature +$ git checkout +``` + +Install dependencies: ``` +$ npm install +$ npm install -g # link globally +``` +**Note:** Dependencies are checked for integrity using `package-lock.json`. However `npm` _will not_ make these checks with `npm install -g` and it will link your installation globally so that `bcoin` is in your path _(e.g. $ bcoin)_. + ### Installing via Docker Check [bcoin-docker](https://github.com/bcoin-org/bcoin-docker)