Merge pull request #802 from ripple/update-bignumber

Update bignumber.js, ripple-hashes, ripple-lib-transactionparser

HISTORY.md

@@ -1,9 +1,12 @@
 # ripple-lib Release History
 
-## UNRELEASED
+## 0.17.8 (UNRELEASED)
 
++ Fix: Freezing in Safari 10.1 (updated bignumber.js) (closes #762)
++ [Fix: `getSettings` should include signers](https://github.com/ripple/ripple-lib/commit/2a90f9b134e168937dceb7da283d63734eac9e7c)
 + Update for Node 6
-+ Update to use lodash 4
++ Update lodash dependency
++ Migrate to yarn
 
 ## 0.17.7 (2017-05-08)
 

README.md

@@ -17,9 +17,13 @@ A JavaScript API for interacting with the XRP Ledger
 
 See also: [RippleAPI Beginners Guide](https://ripple.com/build/rippleapi-beginners-guide/)
 
-Install `ripple-lib` using npm:
+You can use `npm`, but we recommend using `yarn` for the added assurance provided by `yarn.lock`.
+
++ [Yarn Installation Instructions](https://yarnpkg.com/en/docs/install)
+
+Install `ripple-lib`:
 ```
-$ npm install ripple-lib
+$ yarn install ripple-lib
 ```
 
 Then see the [documentation](https://github.com/ripple/ripple-lib/blob/develop/docs/index.md) and [code samples](https://github.com/ripple/ripple-lib/tree/develop/docs/samples)
@@ -27,12 +31,14 @@ Then see the [documentation](https://github.com/ripple/ripple-lib/blob/develop/d
 ## Running tests
 
 1. Clone the repository
-2. `cd` into the repository and install dependencies with `npm install`
-3. `npm test` or `npm test --coverage` (`istanbul` will create coverage reports in `coverage/lcov-report/`)
+2. `cd` into the repository and install dependencies with `yarn install`
+3. `yarn test` or `yarn test --coverage` (`istanbul` will create coverage reports in `coverage/lcov-report/`)
 
 ## Generating Documentation
 
-The continuous integration tests require that the documentation stays up-to-date. If you make changes to the JSON schemas, fixtures, or documentation sources, you must update the documentation by running `npm run docgen`.
+The continuous integration tests require that the documentation stays up-to-date. If you make changes to the JSON schemas, fixtures, or documentation sources, you must update the documentation by running `yarn run docgen`.
+
+`npm` may be used instead of `yarn` in the commands above.
 
 ## More Information
 

docs/index.md

@@ -155,9 +155,9 @@ If you omit the `server` parameter, RippleAPI operates [offline](#offline-functi
 
 ### Installation ###
 
-1. Install [Node.js](https://nodejs.org) and the Node Package Manager (npm). Most Linux distros have a package for Node.js; check that it's the version you want.
-2. Use npm to install RippleAPI:
-      `npm install ripple-lib`
+1. Install [Node.js](https://nodejs.org) and [Yarn](https://yarnpkg.com/en/docs/install). Most Linux distros have a package for Node.js; check that it's the version you want.
+2. Use yarn to install RippleAPI:
+      `yarn install ripple-lib`
 
 After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using the Node.js executable, typically named `node`:
 
@@ -2754,7 +2754,22 @@ return api.getSettings(address).then(settings =>
   "disallowIncomingXRP": true,
   "emailHash": "23463B99B62A72F26ED677CC556C44E8",
   "domain": "example.com",
-  "transferRate": 1.002
+  "transferRate": 1.002,
+  "signers": {
+    "threshold": 3,
+    "weights": [
+      {
+        "address": "rpHit3GvUR1VSGh2PXcaaZKEEUnCVxWU2i",
+        "weight": 1
+      }, {
+        "address": "rN4oCm1c6BQz6nru83H52FBSpNbC9VQcRc",
+        "weight": 1
+      }, {
+        "address": "rJ8KhCi67VgbapiKCQN3r1ZA6BMUxUvvnD",
+        "weight": 1
+      }
+    ]
+  }
 }
 ```
 

docs/src/boilerplate.md.ejs

@@ -53,9 +53,9 @@ If you omit the `server` parameter, RippleAPI operates [offline](#offline-functi
 
 ### Installation ###
 
-1. Install [Node.js](https://nodejs.org) and the Node Package Manager (npm). Most Linux distros have a package for Node.js; check that it's the version you want.
-2. Use npm to install RippleAPI:
-      `npm install ripple-lib`
+1. Install [Node.js](https://nodejs.org) and [Yarn](https://yarnpkg.com/en/docs/install). Most Linux distros have a package for Node.js; check that it's the version you want.
+2. Use yarn to install RippleAPI:
+      `yarn install ripple-lib`
 
 After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using the Node.js executable, typically named `node`:
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ripple-lib",
-  "version": "0.17.7",
+  "version": "0.17.8",
   "license": "ISC",
   "description": "A JavaScript API for interacting with Ripple in Node.js and the browser",
   "files": [
@@ -17,15 +17,15 @@
   "dependencies": {
     "babel-polyfill": "^6.3.14",
     "babel-runtime": "^6.3.19",
-    "bignumber.js": "^2.0.3",
+    "bignumber.js": "^4.1.0",
     "https-proxy-agent": "^1.0.0",
     "jsonschema": "^1.1.1",
     "lodash": "^4.17.4",
     "ripple-address-codec": "^2.0.1",
     "ripple-binary-codec": "^0.1.10",
-    "ripple-hashes": "^0.3.0",
+    "ripple-hashes": "^0.3.1",
     "ripple-keypairs": "^0.10.0",
-    "ripple-lib-transactionparser": "^0.6.1",
+    "ripple-lib-transactionparser": "^0.6.2",
     "ws": "^1.0.1"
   },
   "devDependencies": {

scripts/ci.sh

@@ -8,14 +8,14 @@ function checkEOL {
 }
 
 typecheck() {
-  npm install -g flow-bin
+  yarn install -g flow-bin
   flow --version
-  npm run typecheck
+  yarn run typecheck
 }
 
 lint() {
   echo "eslint $(node_modules/.bin/eslint --version)"
-  npm list babel-eslint
+  yarn list babel-eslint
   REPO_URL="https://raw.githubusercontent.com/ripple/javascript-style-guide"
   curl "$REPO_URL/es6/eslintrc" > ./eslintrc
   echo "parser: babel-eslint" >> ./eslintrc
@@ -25,8 +25,8 @@ lint() {
 unittest() {
   # test "src"
   mocha test --reporter mocha-junit-reporter --reporter-options mochaFile=$CIRCLE_TEST_REPORTS/test-results.xml
-  npm test --coverage
-  npm run coveralls
+  yarn test --coverage
+  yarn run coveralls
 
   # test compiled version in "dist/npm"
   $(npm bin)/babel -D --optional runtime --ignore "**/node_modules/**" -d test-compiled/ test/
@@ -46,7 +46,7 @@ unittest() {
 
   #echo "Running tests in SauceLabs"
   #http-server &
-  #npm run sauce
+  #yarn run sauce
 
   #pkill -f mocked-server.js
   #pkill -f http-server
@@ -65,7 +65,7 @@ integrationtest() {
 
 doctest() {
   mv docs/index.md docs/index.md.save
-  npm run docgen
+  yarn run docgen
   mv docs/index.md docs/index.md.test
   mv docs/index.md.save docs/index.md
   cmp docs/index.md docs/index.md.test

scripts/publish

@@ -7,12 +7,12 @@ function exit_on_error {
 
 rm -rf build
 
-npm install
+yarn install
 gulp
-npm test
+yarn test
 exit_on_error
 
 echo ""
 echo "publish to npm"
-npm publish
+yarn publish
 exit_on_error

scripts/publish_rc

@@ -7,12 +7,12 @@ function exit_on_error {
 
 rm -rf build
 
-npm install
+yarn install
 gulp
-npm test
+yarn test
 exit_on_error
 
 echo ""
 echo "publish rc to npm"
-npm publish --tag beta
+yarn publish --tag beta
 exit_on_error