[FEATURE] improve memo support

- add MemoFormat property for memo - MemoFormat and MemoType must be valid ASCII - Memo content is converted on the serialization level - add parsed_* version of Memo content if the parser understand the format - support `text` and `json` MemoFormat
2025-11-20 04:05:52 +00:00 · 2014-11-05 17:07:31 -08:00
parent 74cacd5209
commit 89adcf4f4e
5 changed files with 514 additions and 71 deletions
--- a/test/serializedobject-test.js
+++ b/test/serializedobject-test.js
@@ -35,6 +35,7 @@ describe('Serialized object', function() {
      assert.deepEqual(input_json, output_json);
    });
  });
+
  describe('#from_json', function() {
    it('understands TransactionType as a Number', function() {
      var input_json = {
@@ -52,6 +53,7 @@ describe('Serialized object', function() {
      assert.equal(0, input_json.TransactionType);
      assert.equal("Payment", output_json.TransactionType);
    });
+
    it('understands LedgerEntryType as a Number', function() {
      var input_json = {
        // no, non required fields
@@ -65,6 +67,7 @@ describe('Serialized object', function() {
      assert.equal(100, input_json.LedgerEntryType);
      assert.equal("DirectoryNode", output_json.LedgerEntryType);
    });
+
    describe('Format validation', function() {
      // Peercover actually had a problem submitting transactions without a `Fee`
      // and rippled was only informing of "transaction is invalid"
@@ -80,14 +83,198 @@ describe('Serialized object', function() {
        };
        assert.throws (
          function() {
-            var output_json = SerializedObject.from_json(input_json);
+            SerializedObject.from_json(input_json);
          },
          /Payment is missing fields: \["Fee"\]/
        );
      });
    });

-  })
+    describe('Memos', function() {
+
+      var input_json;
+
+      beforeEach(function()  {
+        input_json = {
+          "Flags": 2147483648,
+          "TransactionType": "Payment",
+          "Account": "rhXzSyt1q9J8uiFXpK3qSugAAPJKXLtnrF",
+          "Amount": "1",
+          "Destination": "radqi6ppXFxVhJdjzaATRBxdrPcVTf1Ung",
+          "Sequence": 281,
+          "SigningPubKey": "03D642E6457B8AB4D140E2C66EB4C484FAFB1BF267CB578EC4815FE6CD06379C51",
+          "Fee": "12000",
+          "LastLedgerSequence": 10074214,
+          "TxnSignature": "304402201180636F2CE215CE97A29CD302618FAE60D63EBFC8903DE17A356E857A449C430220290F4A54F9DE4AC79034C8BEA5F1F8757F7505F1A6FF04D2E19B6D62E867256B"
+        };
+      });
+
+      it('should serialize and parse - full memo, all strings text/plain ', function() {
+        input_json.Memos = [
+          {
+            "Memo": {
+              "MemoType": "test",
+              "MemoFormat": "text",
+              "MemoData": "some data"
+            }
+          }
+        ];
+
+        var so = SerializedObject.from_json(input_json).to_json();
+        input_json.Memos[0].Memo.parsed_memo_type = 'test';
+        input_json.Memos[0].Memo.parsed_memo_format = 'text';
+        input_json.Memos[0].Memo.parsed_memo_data = 'some data';
+
+        assert.deepEqual(so, input_json);
+      });
+
+      it('should serialize and parse - full memo, all strings, invalid MemoFormat', function() {
+        input_json.Memos = [
+          {
+            "Memo": {
+              "MemoType": "test",
+              "MemoFormat": "application/json",
+              "MemoData": "some data"
+            }
+          }
+        ];
+
+        var so = SerializedObject.from_json(input_json).to_json();
+        input_json.Memos[0].Memo.parsed_memo_type = 'test';
+        input_json.Memos[0].Memo.parsed_memo_format = 'application/json';
+        assert.deepEqual(so, input_json);
+        assert.strictEqual(input_json.Memos[0].Memo.parsed_memo_data, void(0));
+      });
+
+      it('should throw an error - full memo, json data, invalid MemoFormat', function() {
+        input_json.Memos = [
+          {
+            "Memo": {
+              "MemoType": "test",
+              "MemoFormat": "text",
+              "MemoData": {
+                "string" : "some_string",
+                "boolean" : true
+              }
+            }
+          }
+        ];
+
+        assert.throws(function() {
+          SerializedObject.from_json(input_json);
+        }, /^Error: MemoData can only be a JSON object with a valid json MemoFormat \(Memo\) \(Memos\)/);
+      });
+
+      it('should serialize and parse - full memo, json data, valid MemoFormat', function() {
+        input_json.Memos = [
+          {
+            "Memo": {
+              "MemoType": "test",
+              "MemoFormat": "json",
+              "ignored" : "ignored",
+              "MemoData": {
+                "string" : "some_string",
+                "boolean" : true
+              }
+            }
+          }
+        ];
+
+        var so = SerializedObject.from_json(input_json).to_json();
+        delete input_json.Memos[0].Memo.ignored;
+        input_json.Memos[0].Memo.parsed_memo_type = 'test';
+        input_json.Memos[0].Memo.parsed_memo_format = 'json';
+        input_json.Memos[0].Memo.parsed_memo_data = {
+          "string" : "some_string",
+          "boolean" : true
+        };
+
+        assert.deepEqual(so, input_json);
+      });
+
+      it('should serialize and parse - full memo, json data, valid MemoFormat', function() {
+        input_json.Memos = [
+          {
+            "Memo": {
+              "MemoType": "test",
+              "MemoFormat": "json",
+              "MemoData": {
+                "string" : "some_string",
+                "boolean" : true
+              }
+            }
+          }
+        ];
+
+        var so = SerializedObject.from_json(input_json).to_json();
+        input_json.Memos[0].Memo.parsed_memo_type = 'test';
+        input_json.Memos[0].Memo.parsed_memo_format = 'json';
+        input_json.Memos[0].Memo.parsed_memo_data = {
+          "string" : "some_string",
+          "boolean" : true
+        };
+
+        assert.deepEqual(so, input_json);
+      });
+
+      it('should serialize and parse - full memo, json data, valid MemoFormat', function() {
+        input_json.Memos = [
+          {
+            "Memo": {
+              "MemoType": "test",
+              "MemoFormat": "json",
+              "MemoData": 3
+            }
+          }
+        ];
+
+        var so = SerializedObject.from_json(input_json).to_json();
+        input_json.Memos[0].Memo.parsed_memo_type = 'test';
+        input_json.Memos[0].Memo.parsed_memo_format = 'json';
+        input_json.Memos[0].Memo.parsed_memo_data = 3;
+        assert.deepEqual(so, input_json);
+      });
+
+      it('should serialize and parse - full memo, json data, valid MemoFormat', function() {
+        input_json.Memos = [
+          {
+            "Memo": {
+              "MemoType": "test",
+              "MemoFormat": "json",
+              "MemoData": 3
+            }
+          }
+        ];
+
+        var so = SerializedObject.from_json(input_json).to_json();
+        input_json.Memos[0].Memo.parsed_memo_type = 'test';
+        input_json.Memos[0].Memo.parsed_memo_format = 'json';
+        input_json.Memos[0].Memo.parsed_memo_data = 3;
+        assert.deepEqual(so, input_json);
+      });
+
+      it('should throw an error - invalid Memo field', function() {
+        input_json.Memos = [
+          {
+            "Memo": {
+              "MemoType": "test",
+              "MemoParty": "json",
+              "MemoData": 3
+            }
+          }
+        ];
+
+        assert.throws(function() {
+          SerializedObject.from_json(input_json);
+        }, /^Error: JSON contains unknown field: "MemoParty" \(Memo\) \(Memos\)/);
+      });
+
+
+    });
+
+  });
+
+
 });


--- a/test/transaction-test.js
+++ b/test/transaction-test.js
@@ -1052,26 +1052,84 @@ describe('Transaction', function() {
    var transaction = new Transaction();
    transaction.tx_json.TransactionType = 'Payment';

-    transaction.addMemo('testkey', 'testvalue');
-    transaction.addMemo('testkey2', 'testvalue2');
-    transaction.addMemo('testkey3');
-    transaction.addMemo(void(0), 'testvalue4');
+    var memoType = 'message';
+    var memoFormat = 'application/json';
+    var memoData = {
+      string: 'value',
+      bool: true,
+      integer: 1
+    };
+
+    transaction.addMemo(memoType, memoFormat, memoData);
+
+    var expected = [
+      {
+        Memo:
+        {
+          MemoType: memoType,
+          MemoFormat: memoFormat,
+          MemoData: memoData
+        }
+      }
+    ];
+
+    assert.deepEqual(transaction.tx_json.Memos, expected);
+  });
+
+  it('Add Memo - by object', function() {
+    var transaction = new Transaction();
+    transaction.tx_json.TransactionType = 'Payment';
+
+    var memo = {
+      memoType: 'type',
+      memoData: 'data'
+    };
+
+    transaction.addMemo(memo);
+
+    var expected = [
+      {
+        Memo: {
+          MemoType: memo.memoType,
+          MemoData: memo.memoData
+        }
+      }
+    ];
+
+    assert.deepEqual(transaction.tx_json.Memos, expected);
+  });
+
+  it('Add Memos', function() {
+    var transaction = new Transaction();
+    transaction.tx_json.TransactionType = 'Payment';
+
+    transaction.addMemo('testkey', void(0), 'testvalue');
+    transaction.addMemo('testkey2', void(0), 'testvalue2');
+    transaction.addMemo('testkey3', 'text/html');
+    transaction.addMemo(void(0), void(0), 'testvalue4');
+    transaction.addMemo('testkey4', 'text/html', '<html>');

    var expected = [
      { Memo: {
-        MemoType: new Buffer('testkey').toString('hex'),
-        MemoData: new Buffer('testvalue').toString('hex')
+        MemoType: 'testkey',
+        MemoData: 'testvalue'
      }},
      { Memo: {
-        MemoType: new Buffer('testkey2').toString('hex'),
-        MemoData: new Buffer('testvalue2').toString('hex')
+        MemoType: 'testkey2',
+        MemoData: 'testvalue2'
      }},
      { Memo: {
-        MemoType: new Buffer('testkey3').toString('hex')
+        MemoType: 'testkey3',
+        MemoFormat: 'text/html'
      }},
      { Memo: {
-        MemoData: new Buffer('testvalue4').toString('hex')
-      } }
+        MemoData: 'testvalue4'
+      }},
+      { Memo: {
+        MemoType: 'testkey4',
+        MemoFormat: 'text/html',
+        MemoData: '<html>'
+      }}
    ];

    assert.deepEqual(transaction.tx_json.Memos, expected);
@@ -1086,13 +1144,76 @@ describe('Transaction', function() {
    }, /^Error: MemoType must be a string$/);
  });

-  it('Add Memo - invalid MemoData', function() {
+  it('Add Memo - invalid ASCII MemoType', function() {
    var transaction = new Transaction();
    transaction.tx_json.TransactionType = 'Payment';

    assert.throws(function() {
-      transaction.addMemo('key', 1);
-    }, /^Error: MemoData must be a string$/);
+      transaction.addMemo('한국어');
+    }, /^Error: MemoType must be valid ASCII$/);
+  });
+
+  it('Add Memo - invalid MemoFormat', function() {
+    var transaction = new Transaction();
+    transaction.tx_json.TransactionType = 'Payment';
+
+    assert.throws(function() {
+      transaction.addMemo(void(0), 1);
+    }, /^Error: MemoFormat must be a string$/);
+  });
+
+  it('Add Memo - invalid ASCII MemoFormat', function() {
+    var transaction = new Transaction();
+    transaction.tx_json.TransactionType = 'Payment';
+
+    assert.throws(function() {
+      transaction.addMemo(void(0), 'России');
+    }, /^Error: MemoFormat must be valid ASCII$/);
+  });
+
+  it('Add Memo - MemoData string', function() {
+    var transaction = new Transaction();
+    transaction.tx_json.TransactionType = 'Payment';
+
+    transaction.addMemo({memoData:'some_string'});
+
+    assert.deepEqual(transaction.tx_json.Memos, [
+      {
+        Memo: {
+          MemoData: 'some_string'
+        }
+      }
+    ]);
+  });
+
+  it('Add Memo - MemoData complex object', function() {
+    var transaction = new Transaction();
+    transaction.tx_json.TransactionType = 'Payment';
+
+    var memo = {
+      memoData: {
+        string: 'string',
+        int: 1,
+        array: [
+          {
+            string: 'string'
+          }
+        ],
+        object: {
+          string: 'string'
+        }
+      }
+    };
+
+    transaction.addMemo(memo);
+
+    assert.deepEqual(transaction.tx_json.Memos, [
+      {
+        Memo: {
+          MemoData: memo.memoData
+        }
+      }
+    ]);
  });

  it('Construct AccountSet transaction', function() {
@@ -1269,7 +1390,7 @@ describe('Transaction', function() {
    var bid = '1/USD/rsLEU1TPdCJPPysqhWYw9jD97xtG5WqSJm';
    var ask = '1/EUR/rsLEU1TPdCJPPysqhWYw9jD97xtG5WqSJm';
    assert.throws(function() {
-      var transaction = new Transaction().offerCreate('xrsLEU1TPdCJPPysqhWYw9jD97xtG5WqSJm', bid, ask);
+      new Transaction().offerCreate('xrsLEU1TPdCJPPysqhWYw9jD97xtG5WqSJm', bid, ask);
    });
  });

@@ -1302,13 +1423,13 @@ describe('Transaction', function() {

  it('Construct SetRegularKey transaction - invalid account', function() {
    assert.throws(function() {
-      var transaction = new Transaction().setRegularKey('xrsLEU1TPdCJPPysqhWYw9jD97xtG5WqSJm', 'r36xtKNKR43SeXnGn7kN4r4JdQzcrkqpWe');
+      new Transaction().setRegularKey('xrsLEU1TPdCJPPysqhWYw9jD97xtG5WqSJm', 'r36xtKNKR43SeXnGn7kN4r4JdQzcrkqpWe');
    });
  });

  it('Construct SetRegularKey transaction - invalid regularKey', function() {
    assert.throws(function() {
-      var transaction = new Transaction().setRegularKey('rsLEU1TPdCJPPysqhWYw9jD97xtG5WqSJm', 'xr36xtKNKR43SeXnGn7kN4r4JdQzcrkqpWe');
+      new Transaction().setRegularKey('rsLEU1TPdCJPPysqhWYw9jD97xtG5WqSJm', 'xr36xtKNKR43SeXnGn7kN4r4JdQzcrkqpWe');
    });
  });