Merge pull request #631 from clark800/fix-todos

Fix TODOs in schemas and update README for RippleAPI

README.md

@@ -13,88 +13,21 @@ A JavaScript API for interacting with Ripple in Node.js and the browser
 + Listen to events on the Ripple network (transaction, ledger, etc.)
 + Sign and submit transactions to the Ripple network
 
-###In this file
-
-1. [Installation](#installation)
-2. [Quick start](#quick-start)
-3. [Running tests](#running-tests)
-
-###Additional documentation
-
-1. [Guides](docs/GUIDES.md)
-2. [API Reference](docs/REFERENCE.md)
-3. [Wiki](https://ripple.com/wiki/Ripple_JavaScript_library)
-
-###Also see
-
-+ [The Ripple wiki](https://ripple.com/wiki)
-+ [ripple.com](https://ripple.com)
-
-##Installation
-
-**Via npm for Node.js**
+##Getting Started
 
+Install `ripple-lib` using npm:
 ```
   $ npm install ripple-lib
 ```
 
-**Via bower (for browser use)**
-
-```
-  $ bower install ripple
-```
-
-See the [bower-ripple repo](https://github.com/ripple/bower-ripple) for additional bower instructions.
-
-
-**Building ripple-lib for browser environments**
-
-ripple-lib uses Gulp to generate browser builds. These steps will generate minified and non-minified builds of ripple-lib in the `build/` directory.
-
-```
-  $ git clone https://github.com/ripple/ripple-lib
-  $ npm install
-  $ npm run build
-```
-
-**Restricted browser builds**
-
-You may generate browser builds that contain a subset of features. To do this, run `./node_modules/.bin/gulp build-<name>`
-
-+ `build-core` Contains the functionality to make requests and listen for events such as `ledgerClose`. Only `ripple.Remote` is currently exposed. Advanced features like transaction submission and orderbook tracking are excluded from this build.
-
-##Quick start
-
-`Remote.js` ([remote.js](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/remote.js)) is the point of entry for interacting with rippled
-
-```js
-/* Loading ripple-lib with Node.js */
-var Remote = require('ripple-lib').Remote;
-
-/* Loading ripple-lib in a webpage */
-// var Remote = ripple.Remote;
-
-var remote = new Remote({
-  // see the API Reference for available options
-  servers: [ 'wss://s1.ripple.com:443' ]
-});
-
-remote.connect(function() {
-  /* remote connected */
-  remote.requestServerInfo(function(err, info) {
-    // process err and info
-  });
-});
-```
+Then see the sample code in `docs/samples`.
 
 ##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/`)
 
-3. `npm test`
+##More Information
 
-**Generating code coverage**
-
-ripple-lib uses `istanbul` to generate code coverage. To create a code coverage report, run `npm test --coverage`. The report will be created in `coverage/lcov-report/`.
++ [Ripple Dev Portal](https://ripple.com/build/)

src/common/constants.js

@@ -39,8 +39,7 @@ const AccountFields = {
               length: 32, defaults: '0'},
   MessageKey: {name: 'messageKey'},
   Domain: {name: 'domain', encoding: 'hex'},
-  TransferRate: {name: 'transferRate', defaults: 0, shift: 9},
-  Signers: {name: 'signers'}
+  TransferRate: {name: 'transferRate', defaults: 0, shift: 9}
 };
 
 module.exports = {

src/common/schemas/output/get-ledger.json

@@ -20,7 +20,7 @@
     "closeFlags": {
       "type": "integer",
       "minimum": 0,
-      "description": "TODO"
+      "description": "A bit-map of flags relating to the closing of this ledger. Currently, the ledger has only one flag defined for `closeFlags`: **sLCF_NoConsensusTime** (value 1). If this flag is enabled, it means that validators were in conflict regarding the correct close time for the ledger, but built otherwise the same ledger, so they declared consensus while \"agreeing to disagree\" on the close time. In this case, the consensus ledger contains a `closeTime` value that is 1 second after that of the previous ledger. (In this case, there is no official close time, but the actual real-world close time is probably 3-6 seconds later than the specified `closeTime`.)"
     },
     "ledgerHash": {
       "$ref": "hash256",

src/common/schemas/output/get-settings.json

@@ -61,10 +61,6 @@
         {"type": "number", "minimum": 1, "maximum": 4.294967295}
       ]
     },
-    "signers": {
-      "type": "string",
-      "description": "TODO"
-    },
     "regularKey": {
       "oneOf": [
         {"$ref": "address"},

src/common/schemas/specifications/suspended-payment-execution.json

@@ -21,11 +21,11 @@
     },
     "digest": {
       "$ref": "hash256",
-      "description": "TODO"
+      "description": "The original `digest` from the suspended payment creation transaction."
     },
     "proof": {
       "type": "string",
-      "description": "This value will be hashed to produce the digest."
+      "description": "A value that produces the digest when hashed."
     }
   },
   "required": ["owner", "suspensionSequence"],

src/ledger/settings.js

@@ -24,7 +24,6 @@ type GetSettings = {
   messageKey?: string,
   domain?: string,
   transferRate?: ?number,
-  signers?: string,
   regularKey?: string
 }
 

src/ledger/transaction-types.js

@@ -48,7 +48,6 @@ type Settings = {
   messageKey?: string,
   domain?: string,
   transferRate?: number,
-  signers?: string,
   regularKey?: string
 }
 

src/transaction/settings-types.js

@@ -40,14 +40,11 @@ type SettingDomain = {
 type SettingTransferRate = {
   transferRate?: ?number,
 }
-type SettingSigners = {
-  signers?: string,
-}
 type SettingRegularKey = {
   regularKey?: string
 }
 
-export type Settings = SettingRegularKey | SettingSigners |
+export type Settings = SettingRegularKey |
   SettingTransferRate | SettingDomain | SettingMessageKey |
   SettingEmailHash | SettingDefaultRipple |
   SettingGlobalFreeze | SettingNoFreeze | SettingEnableTransactionIDTracking |

test/api-test.js

@@ -91,8 +91,10 @@ describe('RippleAPI', function() {
   });
 
   it('prepareOrderCancellation', function() {
-    return this.api.prepareOrderCancellation(address, 23, instructions).then(
-      _.partial(checkResult, responses.prepareOrderCancellation, 'prepare'));
+    const request = requests.prepareOrderCancellation;
+    return this.api.prepareOrderCancellation(address, request, instructions)
+      .then(_.partial(checkResult, responses.prepareOrderCancellation,
+        'prepare'));
   });
 
   it('prepareTrustline - simple', function() {

test/fixtures/requests/index.js

@@ -6,6 +6,7 @@ module.exports = {
     sell: require('./prepare-order-sell'),
     expiration: require('./prepare-order-expiration')
   },
+  prepareOrderCancellation: require('./prepare-order-cancellation'),
   preparePayment: require('./prepare-payment'),
   preparePaymentAllOptions: require('./prepare-payment-all-options'),
   preparePaymentNoCounterparty: require('./prepare-payment-no-counterparty'),

test/fixtures/requests/prepare-order-cancellation.json

@@ -0,0 +1 @@
+23