feat: data should be passed as a buffer

BREAKING: All data fields should be passed in and returned as Buffer
objects.

Author: justmoon

packages/ilp-packet/index.ts

@@ -41,12 +41,12 @@ interface IlpPacket {
 interface IlpPayment {
   amount: string,
   account: string,
-  data: string
+  data: Buffer
 }
 
 interface IlpForwardedPayment {
   account: string,
-  data: string
+  data: Buffer
 }
 
 const serializeIlpPayment = (json: IlpPayment) => {
@@ -61,7 +61,7 @@ const serializeIlpPayment = (json: IlpPayment) => {
   writer.writeVarOctetString(Buffer.from(json.account, 'ascii'))
 
   // data
-  writer.writeVarOctetString(Buffer.from(json.data || '', 'base64'))
+  writer.writeVarOctetString(json.data || Buffer.alloc(0))
 
   // extensibility
   writer.writeUInt8(0)
@@ -82,7 +82,7 @@ const deserializeIlpPayment = (binary: Buffer): IlpPayment => {
   const lowBits = reader.readUInt32()
   const amount = Long.fromBits(lowBits, highBits, true).toString()
   const account = reader.readVarOctetString().toString('ascii')
-  const data = bufferToBase64url(reader.readVarOctetString())
+  const data = reader.readVarOctetString()
 
   // Ignore remaining bytes for extensibility
 
@@ -100,7 +100,7 @@ const serializeIlpForwardedPayment = (json: IlpForwardedPayment) => {
   writer.writeVarOctetString(Buffer.from(json.account, 'ascii'))
 
   // data
-  writer.writeVarOctetString(Buffer.from(json.data || '', 'base64'))
+  writer.writeVarOctetString(json.data || Buffer.alloc(0))
 
   // extensibility
   writer.writeUInt8(0)
@@ -118,7 +118,7 @@ const deserializeIlpForwardedPayment = (binary: Buffer): IlpForwardedPayment =>
   const reader = Reader.from(contents)
 
   const account = reader.readVarOctetString().toString('ascii')
-  const data = bufferToBase64url(reader.readVarOctetString())
+  const data = reader.readVarOctetString()
 
   // Ignore remaining bytes for extensibility
 
@@ -501,14 +501,14 @@ const deserializeIlpError = (binary: Buffer): IlpError => {
 }
 
 interface IlpFulfillment {
-  data: string
+  data: Buffer
 }
 
 const serializeIlpFulfillment = (json: IlpFulfillment) => {
   const writer = new Writer()
 
   // data
-  writer.writeVarOctetString(Buffer.from(json.data || '', 'base64'))
+  writer.writeVarOctetString(json.data || Buffer.alloc(0))
 
   // extensibility
   writer.writeUInt8(0)
@@ -525,7 +525,7 @@ const deserializeIlpFulfillment = (binary: Buffer): IlpFulfillment => {
 
   const reader = Reader.from(contents)
 
-  const data = bufferToBase64url(reader.readVarOctetString())
+  const data = reader.readVarOctetString()
 
   // Ignore remaining bytes for extensibility
 
@@ -560,7 +560,7 @@ const serializeIlpRejection = (json: IlpRejection) => {
   writer.writeVarOctetString(Buffer.from(json.message, 'utf8'))
 
   // data
-  writer.writeVarOctetString(json.data)
+  writer.writeVarOctetString(json.data || Buffer.alloc(0))
 
   // extensibility
   writer.writeUInt8(0)

packages/ilp-packet/test/parser.spec.ts

@@ -13,6 +13,8 @@ describe('Parser', function () {
         it(test.name, function () {
           const json = test.json
 
+          json.data = Buffer.from(json.data, 'base64')
+
           const serialized = Parser.serializeIlpPayment(json)
 
           assert.deepEqual(serialized.toString('hex'), test.binary)
@@ -31,6 +33,8 @@ describe('Parser', function () {
 
           const parsed = Parser.deserializeIlpPayment(binary)
 
+          parsed.data = parsed.data.toString('base64')
+
           assert.deepEqual(parsed, test.json)
         })
       }
@@ -44,6 +48,8 @@ describe('Parser', function () {
         it(test.name, function () {
           const json = test.json
 
+          json.data = Buffer.from(json.data, 'base64')
+
           const serialized = Parser.serializeIlpForwardedPayment(json)
 
           assert.deepEqual(serialized.toString('hex'), test.binary)
@@ -62,6 +68,8 @@ describe('Parser', function () {
 
           const parsed = Parser.deserializeIlpForwardedPayment(binary)
 
+          parsed.data = parsed.data.toString('base64')
+
           assert.deepEqual(parsed, test.json)
         })
       }
@@ -310,6 +318,8 @@ describe('Parser', function () {
         it(test.name, function () {
           const json = test.json
 
+          json.data = Buffer.from(json.data, 'base64')
+
           const serialized = Parser.serializeIlpFulfillment(json)
 
           assert.deepEqual(serialized.toString('hex'), test.binary)
@@ -328,6 +338,8 @@ describe('Parser', function () {
 
           const parsed = Parser.deserializeIlpFulfillment(binary)
 
+          parsed.data = parsed.data.toString('base64')
+
           assert.deepEqual(parsed, test.json)
         })
       }
@@ -397,7 +409,7 @@ describe('Parser', function () {
             if (typeString === 'ilp_error') {
               parsed.data.triggeredAt = parsed.data.triggeredAt.getTime()
             }
-            if (typeString === 'ilp_rejection') {
+            if (typeString === 'ilp_payment' || typeString === 'ilp_forwarded_payment' || typeString === 'ilp_fulfillment' || typeString === 'ilp_rejection') {
               parsed.data.data = parsed.data.data.toString('base64')
             }
             assert.deepEqual(parsed, { type, typeString, data: test.json })