ripple-binary-codec 2.8.0-smartcontract.0 → 2.9.0-batch.1

package/dist/binary.d.ts

@@ -88,16 +88,29 @@ declare function multiSigningData(transaction: JsonObject, signingAccount: strin
     definitions: XrplDefinitionsBase;
 }): Uint8Array;
 /**
- * Interface describing fields required for a Batch signer
- * @property flags - Flags indicating Batch transaction properties
- * @property txIDs - Array of transaction IDs included in the Batch
+ * Fields required to serialize an XLS-56 Batch V1_1 signing payload.
+ *
+ * @property account - The outer Batch transaction's `Account`.
+ * @property sequence - The outer Batch's sequence value (`Sequence`, or the
+ *   `TicketSequence` value when a ticket is used).
+ * @property flags - Flags indicating Batch transaction properties.
+ * @property txIDs - Array of inner transaction IDs included in the Batch.
+ * @property batchAccount - The `BatchSigner.Account` the signature binds to.
+ * @property signerAccount - For a multi-signed `BatchSigner`, the inner
+ *   `Signers` entry account, appended after `batchAccount`.
  */
 interface BatchObject extends JsonObject {
+    account: string;
+    sequence: number;
     flags: number;
     txIDs: string[];
+    batchAccount?: string;
+    signerAccount?: string;
 }
 /**
- * Serialize a signingClaim
+ * Serialize an XLS-56 Batch V1_1 signing payload:
+ *   HashPrefix.batch | account | sequence | flags | txIDCount | txIDs[]
+ *   [ | batchAccount [ | signerAccount ] ]
  *
  * @param batch A Batch object to serialize.
  * @returns the serialized object with appropriate prefix

package/dist/binary.js

@@ -126,28 +126,52 @@ function multiSigningData(transaction, signingAccount, opts = {
 }
 exports.multiSigningData = multiSigningData;
 /**
- * Serialize a signingClaim
+ * Serialize an XLS-56 Batch V1_1 signing payload:
+ *   HashPrefix.batch | account | sequence | flags | txIDCount | txIDs[]
+ *   [ | batchAccount [ | signerAccount ] ]
  *
  * @param batch A Batch object to serialize.
  * @returns the serialized object with appropriate prefix
  */
 function signingBatchData(batch) {
+    if (batch.account == null) {
+        throw Error('No field `account`');
+    }
+    if (batch.sequence == null) {
+        throw Error('No field `sequence`');
+    }
     if (batch.flags == null) {
-        throw Error("No field `flags'");
+        throw Error('No field `flags`');
     }
     if (batch.txIDs == null) {
         throw Error('No field `txIDs`');
     }
     const prefix = hash_prefixes_1.HashPrefix.batch;
+    const account = types_1.coreTypes.AccountID.from(batch.account).toBytes();
+    const sequence = types_1.coreTypes.UInt32.from(batch.sequence).toBytes();
     const flags = types_1.coreTypes.UInt32.from(batch.flags).toBytes();
     const txIDsLength = types_1.coreTypes.UInt32.from(batch.txIDs.length).toBytes();
     const bytesList = new binary_serializer_1.BytesList();
     bytesList.put(prefix);
+    bytesList.put(account);
+    bytesList.put(sequence);
     bytesList.put(flags);
     bytesList.put(txIDsLength);
     batch.txIDs.forEach((txID) => {
         bytesList.put(types_1.coreTypes.Hash256.from(txID).toBytes());
     });
+    if (batch.batchAccount != null) {
+        bytesList.put(types_1.coreTypes.AccountID.from(batch.batchAccount).toBytes());
+    }
+    // The wire format is positional, so `signerAccount` must follow `batchAccount`.
+    // Reject `signerAccount` without `batchAccount` to avoid binding the signature
+    // to the wrong account.
+    if (batch.signerAccount != null) {
+        if (batch.batchAccount == null) {
+            throw Error('Field `signerAccount` requires `batchAccount`');
+        }
+        bytesList.put(types_1.coreTypes.AccountID.from(batch.signerAccount).toBytes());
+    }
     return bytesList.toBytes();
 }
 exports.signingBatchData = signingBatchData;

package/dist/binary.js.map

@@ -1 +1 @@
-{"version":3,"file":"binary.js","sourceRoot":"","sources":["../src/binary.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B,mDAAoD;AACpD,mCAAmC;AACnC,0DAAqD;AAuNnD,6FAvNO,4BAAY,OAuNP;AArNd,mDAA4C;AAC5C,kEAAwE;AAqNtE,iGArNO,oCAAgB,OAqNP;AAChB,0FAtNyB,6BAAS,OAsNzB;AArNX,qCAAoD;AA+NlD,2FA/NO,mBAAU,OA+NP;AACV,8FAhOmB,sBAAa,OAgOnB;AA/Nf,mCAIgB;AAIhB;;;;;;;GAOG;AACH,MAAM,UAAU,GAAG,CACjB,KAA0B,EAC1B,WAAiC,EACnB,EAAE,CAChB,IAAI,4BAAY,CACd,KAAK,YAAY,UAAU,CAAC,CAAC,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,EACvD,WAAW,CACZ,CAAA;AAgMD,gCAAU;AA9LZ;;;;;;;GAOG;AACH,MAAM,QAAQ,GAAG,CACf,MAAoB,EACpB,cAAmC,2BAAmB,EAC1C,EAAE,CACb,MAAM,CAAC,QAAQ,CAAC,iBAAS,CAAC,QAAQ,CAAc,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;AAoLrE,4BAAQ;AAlLV;;;;;;;GAOG;AACH,MAAM,YAAY,GAAG,CACnB,KAAa,EACb,WAAiC,EACrB,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAA;AA2KpE,oCAAY;AA7Jd;;;;;;GAMG;AACH,SAAS,eAAe,CACtB,MAAkB,EAClB,OAAqB,EAAE;IAEvB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;IACvE,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,MAAM,MAAM,GAAG,iBAAiB;QAC9B,CAAC,CAAC,CAAC,CAAgB,EAAW,EAAE,CAAC,CAAC,CAAC,cAAc;QACjD,CAAC,CAAC,SAAS,CACZ;IAAC,iBAAS,CAAC,QAA4B;SACrC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC;SACjC,WAAW,CAAC,SAAS,CAAC,CAAA;IAEzB,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AA0HC,0CAAe;AAxHjB;;;;;;;GAOG;AACH,SAAS,WAAW,CAClB,WAAuB,EACvB,SAAqB,0BAAU,CAAC,cAAc,EAC9C,OAA8C,EAAE;IAEhD,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM;QACN,iBAAiB,EAAE,IAAI;QACvB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC,CAAA;AACJ,CAAC;AAyGC,kCAAW;AA/Fb;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IACxC,MAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,MAAM,OAAO,GAAG,iBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAA;IAC/D,MAAM,MAAM,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAA;IAEnD,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACtB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AA6EC,4CAAgB;AA3ElB;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,WAAuB,EACvB,cAAkC,EAClC,OAA6C;IAC3C,WAAW,EAAE,2BAAmB;CACjC;IAED,MAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,MAAM,MAAM,GAAG,iBAAS,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,CAAA;IACjE,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM;QACN,MAAM;QACN,iBAAiB,EAAE,IAAI;QACvB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC,CAAA;AACJ,CAAC;AAkDC,4CAAgB;AAtClB;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE;QACvB,MAAM,KAAK,CAAC,kBAAkB,CAAC,CAAA;KAChC;IACD,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE;QACvB,MAAM,KAAK,CAAC,kBAAkB,CAAC,CAAA;KAChC;IACD,MAAM,MAAM,GAAG,0BAAU,CAAC,KAAK,CAAA;IAC/B,MAAM,KAAK,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAA;IAC1D,MAAM,WAAW,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAA;IAEvE,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACpB,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IAC1B,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE;QACnC,SAAS,CAAC,GAAG,CAAC,iBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;IACvD,CAAC,CAAC,CAAA;IAEF,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AAiBC,4CAAgB"}
+{"version":3,"file":"binary.js","sourceRoot":"","sources":["../src/binary.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAE/B,mDAAoD;AACpD,mCAAmC;AACnC,0DAAqD;AA2PnD,6FA3PO,4BAAY,OA2PP;AAzPd,mDAA4C;AAC5C,kEAAwE;AAyPtE,iGAzPO,oCAAgB,OAyPP;AAChB,0FA1PyB,6BAAS,OA0PzB;AAzPX,qCAAoD;AAmQlD,2FAnQO,mBAAU,OAmQP;AACV,8FApQmB,sBAAa,OAoQnB;AAnQf,mCAIgB;AAIhB;;;;;;;GAOG;AACH,MAAM,UAAU,GAAG,CACjB,KAA0B,EAC1B,WAAiC,EACnB,EAAE,CAChB,IAAI,4BAAY,CACd,KAAK,YAAY,UAAU,CAAC,CAAC,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,EACvD,WAAW,CACZ,CAAA;AAoOD,gCAAU;AAlOZ;;;;;;;GAOG;AACH,MAAM,QAAQ,GAAG,CACf,MAAoB,EACpB,cAAmC,2BAAmB,EAC1C,EAAE,CACb,MAAM,CAAC,QAAQ,CAAC,iBAAS,CAAC,QAAQ,CAAc,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;AAwNrE,4BAAQ;AAtNV;;;;;;;GAOG;AACH,MAAM,YAAY,GAAG,CACnB,KAAa,EACb,WAAiC,EACrB,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAA;AA+MpE,oCAAY;AAjMd;;;;;;GAMG;AACH,SAAS,eAAe,CACtB,MAAkB,EAClB,OAAqB,EAAE;IAEvB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,GAAG,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAA;IACvE,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,MAAM,MAAM,GAAG,iBAAiB;QAC9B,CAAC,CAAC,CAAC,CAAgB,EAAW,EAAE,CAAC,CAAC,CAAC,cAAc;QACjD,CAAC,CAAC,SAAS,CACZ;IAAC,iBAAS,CAAC,QAA4B;SACrC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC;SACjC,WAAW,CAAC,SAAS,CAAC,CAAA;IAEzB,IAAI,MAAM,EAAE;QACV,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;KACtB;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AA8JC,0CAAe;AA5JjB;;;;;;;GAOG;AACH,SAAS,WAAW,CAClB,WAAuB,EACvB,SAAqB,0BAAU,CAAC,cAAc,EAC9C,OAA8C,EAAE;IAEhD,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM;QACN,iBAAiB,EAAE,IAAI;QACvB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC,CAAA;AACJ,CAAC;AA6IC,kCAAW;AAnIb;;;;;;GAMG;AACH,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;IACxC,MAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,MAAM,OAAO,GAAG,iBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAA;IAC/D,MAAM,MAAM,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAA;IAEnD,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACtB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AAiHC,4CAAgB;AA/GlB;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,WAAuB,EACvB,cAAkC,EAClC,OAA6C;IAC3C,WAAW,EAAE,2BAAmB;CACjC;IAED,MAAM,MAAM,GAAG,0BAAU,CAAC,mBAAmB,CAAA;IAC7C,MAAM,MAAM,GAAG,iBAAS,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,EAAE,CAAA;IACjE,OAAO,eAAe,CAAC,WAAW,EAAE;QAClC,MAAM;QACN,MAAM;QACN,iBAAiB,EAAE,IAAI;QACvB,WAAW,EAAE,IAAI,CAAC,WAAW;KAC9B,CAAC,CAAA;AACJ,CAAC;AAsFC,4CAAgB;AA/DlB;;;;;;;GAOG;AACH,SAAS,gBAAgB,CAAC,KAAkB;IAC1C,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,EAAE;QACzB,MAAM,KAAK,CAAC,oBAAoB,CAAC,CAAA;KAClC;IACD,IAAI,KAAK,CAAC,QAAQ,IAAI,IAAI,EAAE;QAC1B,MAAM,KAAK,CAAC,qBAAqB,CAAC,CAAA;KACnC;IACD,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE;QACvB,MAAM,KAAK,CAAC,kBAAkB,CAAC,CAAA;KAChC;IACD,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE;QACvB,MAAM,KAAK,CAAC,kBAAkB,CAAC,CAAA;KAChC;IACD,MAAM,MAAM,GAAG,0BAAU,CAAC,KAAK,CAAA;IAC/B,MAAM,OAAO,GAAG,iBAAS,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAA;IACjE,MAAM,QAAQ,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAA;IAChE,MAAM,KAAK,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAA;IAC1D,MAAM,WAAW,GAAG,iBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAA;IAEvE,MAAM,SAAS,GAAG,IAAI,6BAAS,EAAE,CAAA;IAEjC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrB,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACtB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IACvB,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACpB,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IAC1B,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE;QACnC,SAAS,CAAC,GAAG,CAAC,iBAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;IACvD,CAAC,CAAC,CAAA;IAEF,IAAI,KAAK,CAAC,YAAY,IAAI,IAAI,EAAE;QAC9B,SAAS,CAAC,GAAG,CAAC,iBAAS,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;KACtE;IACD,gFAAgF;IAChF,+EAA+E;IAC/E,wBAAwB;IACxB,IAAI,KAAK,CAAC,aAAa,IAAI,IAAI,EAAE;QAC/B,IAAI,KAAK,CAAC,YAAY,IAAI,IAAI,EAAE;YAC9B,MAAM,KAAK,CAAC,+CAA+C,CAAC,CAAA;SAC7D;QACD,SAAS,CAAC,GAAG,CAAC,iBAAS,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;KACvE;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,CAAA;AAC5B,CAAC;AAiBC,4CAAgB"}