doc built

Author: amougel

docs/index.md

@@ -3582,8 +3582,10 @@ return api.preparePaymentChannelFund(address, paymentChannelFund).then(prepared
 
 ## sign
 
-`sign(txJSON: string, secret: string, options: Object): {signedTransaction: string, id: string}`
-`sign(txJSON: string, keypair: Object, options: Object): {signedTransaction: string, id: string}`
+```
+sign(txJSON: string, secret: string, options: Object): {signedTransaction: string, id: string}
+sign(txJSON: string, keypair: Object, options: Object): {signedTransaction: string, id: string}
+```
 
 Sign a prepared transaction. The signed transaction must subsequently be [submitted](#submit).
 
@@ -3593,11 +3595,13 @@ Name | Type | Description
 ---- | ---- | -----------
 txJSON | string | Transaction represented as a JSON string in rippled format.
 keypair | object | *Optional* The private and public key of the account that is initiating the transaction.
+(This field is exclusive with keypair).
 *keypair.* privateKey | string | The uppercase hexadecimal representation of the secp256k1 or Ed25519 private key of the account that is initiating the transaction.
 *keypair.* publicKey | string | The uppercase hexadecimal representation of the secp256k1 or Ed25519 public key of the account that is initiating the transaction.
 options | object | *Optional* Options that control the type of signature that will be generated.
 *options.* signAs | [address](#ripple-address) | *Optional* The account that the signature should count for in multisigning.
-secret | secret string | *Optional* The secret of the account that is initiating the transaction.(This field is exclusive with keypair).
+secret | secret string | *Optional* The secret of the account that is initiating the transaction.
+(This field is exclusive with keypair).
 
 ### Return Value
 

docs/src/sign.md.ejs

@@ -1,7 +1,9 @@
 ## sign
 
-`sign(txJSON: string, secret: string, options: Object): {signedTransaction: string, id: string}
-sign(txJSON: string, keypair: Object, options: Object): {signedTransaction: string, id: string}`
+```
+sign(txJSON: string, secret: string, options: Object): {signedTransaction: string, id: string}
+sign(txJSON: string, keypair: Object, options: Object): {signedTransaction: string, id: string}
+```
 
 Sign a prepared transaction. The signed transaction must subsequently be [submitted](#submit).
 

src/common/schemas/input/sign.json

@@ -10,7 +10,7 @@
     "secret": {
       "type": "string",
       "format": "secret",
-      "description": "The secret of the account that is initiating the transaction.(This field is exclusive with keypair).",
+      "description": "The secret of the account that is initiating the transaction.\n(This field is exclusive with keypair)."
     },
     "keypair": {
       "type": "object",
@@ -24,7 +24,7 @@
           "description": "The uppercase hexadecimal representation of the secp256k1 or Ed25519 public key of the account that is initiating the transaction."
         }
       },
-      "description": "The private and public key of the account that is initiating the transaction.",
+      "description": "The private and public key of the account that is initiating the transaction.\n(This field is exclusive with keypair).",
       "required": ["privateKey", "publicKey"]
     },
     "options": {

src/transaction/sign.js

@@ -15,9 +15,6 @@ function computeSignature(tx: Object, privateKey: string, signAs: ?string) {
 function sign(txJSON: string, keypair, options?: Object = {}
 ): {signedTransaction: string; id: string} {
   if(typeof(keypair) === 'string') {
-      validate.sign({txJSON, keypair})
-      // we can't validate that the secret matches the account because
-      // the secret could correspond to the regular key
       keypair = keypairs.deriveKeypair(keypair)
   }
   const tx = JSON.parse(txJSON)

test/api-test.js

@@ -452,7 +452,7 @@ describe('RippleAPI', function() {
     const result = this.api.sign(requests.sign.normal.txJSON, keypair);
     assert.throws(() => {
       const tx = JSON.stringify(binary.decode(result.signedTransaction));
-      this.api.signWithKeypair(tx, keypair);
+      this.api.sign(tx, keypair);
     }, /txJSON must not contain "TxnSignature" or "Signers" properties/);
   });
 
@@ -858,6 +858,7 @@ describe('RippleAPI', function() {
         _.partial(checkResult,
           responses.getTransaction.paymentChannelClaim,
           'getTransaction'));
+     });
 
     it('getTransaction - no Meta', function() {
       const hash =
@@ -1597,14 +1598,14 @@ describe('RippleAPI - offline', function() {
     const secret = 'shsWGZcmZz6YsWWmcnpfr6fLTdtFV';
     const settings = requests.prepareSettings.domain;
     const instructions = {
-      sequence: 23,
-      maxLedgerVersion: 8820051,
-      fee: '0.000012'
+    sequence: 23,
+    maxLedgerVersion: 8820051,
+    fee: '0.000012'
     };
     return api.prepareSettings(address, settings, instructions).then(data => {
-      checkResult(responses.prepareSettings.flags, 'prepare', data);
-      assert.deepEqual(api.sign(data.txJSON, secret),
-        responses.prepareSettings.signed);
+    checkResult(responses.prepareSettings.flags, 'prepare', data);
+    assert.deepEqual(api.sign(data.txJSON, secret),
+      responses.prepareSettings.signed);
     });
   });